This extension provides Go code intelligence on Sourcegraph.
It's enabled by default!
- Enable this extension in the extension registry https://sourcegraph.example.com/extensions
- Deploy go-langserver locally in Docker or on Kubernetes (see below)
- Set
"go.serverUrl": "ws://localhost:4389"in your Sourcegraph global settings (not site config) and make sure the port matches either the Docker command or your Kubernetes config - If the address of your Sourcegraph instance in your browser (e.g.
http://localhost:7080) is different from the address at which go-langserver can access your Sourcegraph instance (e.g.http://host.docker.internal:7080, when running on your local machine in Docker), then setgo.sourcegraphUrl(e.g. tohttp://host.docker.internal:7080). - Visit a Go file and you should see code intelligence
This extension communicates with an instance of the go-langserver over WebSockets.
- Enable this extension in the extension registry https://sourcegraph.example.com/extensions
- Enable the Go language server is running (check https://sourcegraph.example.com/site-admin/code-intelligence)
- Visit a Go file and you should see code intelligence
This extension hits the LSP gateway on the Sourcegraph instance (internally it uses langserver-http).
docker run --rm --name lang-go -p 4389:4389 sourcegraph/lang-go \
go-langserver -mode=websocket -addr=:4389 -usebuildserver -usebinarypkgcache=false
You can verify it's up and running with ws:
$ go get -u github.com/hashrocket/ws
$ ws ws://localhost:4389
>
apiVersion: v1
kind: Service
metadata:
annotations:
prometheus.io/port: "6060"
prometheus.io/scrape: "true"
labels:
app: lang-go
name: lang-go
namespace: prod
spec:
loadBalancerIP: your.static.ip.address
ports:
- name: debug
port: 6060
targetPort: debug
- name: lsp
port: 443
targetPort: lsp
selector:
app: lang-go
type: LoadBalancerapiVersion: extensions/v1beta1
kind: Deployment
metadata:
annotations:
description: Go code intelligence provided by go-langserver
name: lang-go
namespace: prod
spec:
minReadySeconds: 10
replicas: 1
revisionHistoryLimit: 10
strategy:
rollingUpdate:
maxSurge: 1
maxUnavailable: 1
type: RollingUpdate
template:
metadata:
labels:
app: lang-go
spec:
containers:
- args:
- go-langserver
- -mode=websocket
- -addr=:4389
- -usebuildserver
- -usebinarypkgcache=false
env:
- name: LIGHTSTEP_ACCESS_TOKEN
value: '???'
- name: LIGHTSTEP_INCLUDE_SENSITIVE
value: "true"
- name: LIGHTSTEP_PROJECT
value: sourcegraph-prod
# TLS is optional
- name: TLS_CERT
valueFrom:
secretKeyRef:
key: cert
name: tls
- name: TLS_KEY
valueFrom:
secretKeyRef:
key: key
name: tls
- name: POD_NAME
valueFrom:
fieldRef:
fieldPath: metadata.name
- name: CACHE_DIR
value: /mnt/cache/$(POD_NAME)
image: sourcegraph/lang-go:latest
livenessProbe:
initialDelaySeconds: 5
tcpSocket:
port: lsp
timeoutSeconds: 5
name: lang-go
ports:
- containerPort: 4389
name: lsp
- containerPort: 6060
name: debug
readinessProbe:
tcpSocket:
port: 4389
resources:
limits:
cpu: "8"
memory: 10G
requests:
cpu: "1"
memory: 10G
volumeMounts:
- mountPath: /mnt/cache
name: cache-ssd
volumes:
- hostPath:
path: /mnt/disks/ssd0/pod-tmp
name: cache-ssdFrom ./src/settings.ts:
export interface FullSettings {
/**
* The address to the Go language server listening for WebSocket connections.
*/
'go.serverUrl': string
/**
* The key in settings where this extension looks to find the access token
* for the current user.
*/
'go.accessToken': string
/**
* Whether or not to return external references (from other repositories)
* along with local references.
*/
'go.showExternalReferences': boolean
/**
* The maximum number of repositories to look in when searching for external
* references for a symbol (defaults to 50).
*/
'go.maxExternalReferenceRepos': number
/**
* When set, will cause this extension to use to use gddo's (Go Doc Dot Org)
* API (https://github.com/golang/gddo) to find packages that import a given
* package (used in finding external references). For example:
* `https://godoc.org`.
*/
'go.gddoURL': string
/**
* Address of a cors-anywhere service. This will cause the extension to send
* GDDO requests to this service instead of directly to api.godoc.org. For
* example:
*
* https://cors-anywhere.sourcegraph.com/https://api.godoc.org/importers/github.com/sourcegraph/go-lsp
*
* This would not be necessary if godoc.org set CORS headers.
*/
'go.corsAnywhereURL': string
/**
* The URL of the Sourcegraph instance from the perspective of the Go
* language server. This is useful for development when Sourcegraph is
* running on localhost and the Go language server is running in a Docker
* container. When developing on macOS, set this to
* 'http://host.docker.internal:3080'. See
* https://stackoverflow.com/a/43541681/2061958
*/
'go.sourcegraphUrl': string
}Make sure your $HOME/.netrc contains:
machine codeload.github.com
login <your username>
password <your password OR access token>
Mount it into the container:
docker run ... -v "$HOME/.netrc":/root/.netrc ...
Verify fetching works:
$ docker exec -ti lang-go sh
# curl -n https://codeload.github.com/you/your-private-repo/zip/master
HTTP/1.1 200 OK
...
Make sure your ~/.gitconfig contains these lines:
[url "[email protected]:"]
insteadOf = https://github.com/
Mount that and your SSH keys into the container:
docker run ... -v "$HOME/.gitconfig":/root/.gitconfig -v "$HOME/.ssh":/root/.ssh ...
Verify cloning works:
$ docker exec -ti lang-go sh
# git clone https://github.com/you/your-private-repo
Cloning into 'your-private-repo'...
You can run multiple instances of the go-langserver and distribute connections between them in Kubernetes by setting spec.replicas in the deployment YAML:
spec:
minReadySeconds: 10
- replicas: 1
+ replicas: 5
revisionHistoryLimit: 10