Pure-Docker Sourcegraph cluster deployment reference
There are two recommended ways to deploy Sourcegraph:
But what if your organization wants a multi-machine deployment without using Kubernetes? What if you use a different container management platform, for example? This project aims to solve that, by providing a pure-Docker deployment option.
The goal is that anyone using a container management platform other than Kubernetes (Netflix's Titus, Apache's Mesos, etc.) would be able to use this repository as a reference for how to deploy Sourcegraph.
⚠️ Alpha release
This project is using an alpha release of Sourcegraph v3.0.0. It is not yet heavily tested, and there may be major bugs or regressions.
When Sourcegraph v3.0.0 preview is released, this repository will be updated and code intelligence will work.
First clone the repository, then:
Visit http://localhost:3080 to visit the running Sourcegraph instance!
Tearing down the deployment
To understand the system topology:
- Look at
deploy.shto get an overview of services.
- Every service (
deploy-*.sh) has documentation inline indicating:
- What the service does / provides.
- What ports the service exposes.
- What other services it talks to (see environment variables).
Service system requirements
Every service (
deploy-*.sh) documents inline what the system requirements are (CPU/Memory/Disk allocation). For example, the frontend service.
Scaling / replicas
To scale the cluster deployment, you will need to:
- Deploy more instances of
symbolsservices as desired.
- Configure the
frontend-internalto communicate with the new instances.
- You're done! You do not need to configure or restart any other services.
Configuring SSH cloning
- Ensure your Site admin > External services code host configuration is configured to use SSH. For example, by setting the
"ssh". You may still need to configure an access token or other codehost authentication method in order for Sourcegraph to discover your repositories.
Alternatively, you may use the
OTHER codehost type under External services, which allows you to directly specify Git repository URLs for cloning.
- Provide your
gitserverinstances with your SSH / Git configuration (usually just
.ssh/known_hosts-- but you can also provide other files like
.gitconfig, etc. if needed) by mounting it into the
sourcegraphusers home directory in the
gitservercontainers. For example, by adding the following flag:
All future Git cloning operations will use the credentials configured there.
If you wish, you can test that cloning with your configuration is working by performing the clone in a gitserver container shell, e.g. first acquire shell access:
$ docker exec -it gitserver-0 sh
Then try cloning the repository:
$ git clone ssh://firstname.lastname@example.org/my/repo /tmp/my-repo