New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve cloud provider deployment process #2068

sqs opened this Issue Jan 30, 2019 · 0 comments


None yet
5 participants
Copy link

sqs commented Jan 30, 2019

User story

As a developer who wants to use Sourcegraph for my organization's code, I want to deploy Sourcegraph so that my whole organization can access it. This means [for many orgs] installing it on a public cloud provider such as AWS, Google Cloud, DigitalOcean, etc.

Notes (moved from

  • Our docs lack specific RAM/CPU recommendations (I also don’t think this exists for sourcegraph/server in general)
  • Our docs don’t tell you how to backup Sourcegraph’s Postgres data. We should tell people to mount an EBS volume to their EC2 instance
  • The docs don’t tell you how to set up a VPC/subnet/security group that correctly exposes HTTP/HTTPS, ssh, and the management console. (This isn’t trivial)

I think that GitLab’s AWS documentation is an excellent model to follow (I used it for setting up my test Sourcegraph instance):

  • Lots of screenshots so that the process is easy to follow
  • The tutorial is complete and leaves you with a robust system (walks you through firewall configuration, properly backed-up database w/ EBS, ...)

The above also applies to our GCP docs.

Impact: Good tutorials give our users the confidence to deploy and share Sourcegraph with the rest of their team, which feeds into our 1-20 goal.

Plan (WIP)

  • Improve documentation #72
  • TODO

Test/review plan

  • Code reviewer: TODO
  • Tester: TODO

@sqs sqs added this to the 3.1 milestone Jan 30, 2019

@sqs sqs changed the title Improve deployment process to cloud providers Improve cloud provider deployment process Jan 30, 2019

@beyang beyang assigned slimsag and ggilmore and unassigned beyang, slimsag and ggilmore Feb 12, 2019

@ggilmore ggilmore modified the milestones: 3.1, 3.2 Feb 15, 2019

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment