Sourcegraph DocsSourcegraph Docs
Changelog↗
Theme
  1. Docs
  2. self-hosted
  3. deployment-best-practices

Sourcegraph Deployment Best Practices

What does "best practice" mean to us?

Sourcegraph is a highly scalable and configurable application. As an open source company we hope our customers will feel empowered to customize Sourcegraph to meet their unique needs, but we cannot guarantee whether deviations from the below guidelines will work or be supportable by Sourcegraph. If in doubt, please contact your Customer Engineer or reach out to support.

Sourcegraph Performance Dependencies

  • number of users associated to instance
  • user's engagement level
  • number and size of code repositories synced to Sourcegraph.

To get a better idea of your resource requirements for your instance use our resource estimator.

Deployment Best Practices

A comparison table of supported self-hosted deployment methodologies can be found here.

Kubernetes

Kubernetes deployments may be customized in a variety of ways, we consider the following best practice:

  • If Helm cannot be used, Kustomize can be used to apply configuration changes, though Kustomize is planned for deprecation. Helm is strongly preferred.
  • As a last resort, the manifests can be edited in a forked copy of the Sourcegraph repository.
  • The suggested Kubernetes version is the current GKE Stable release version
  • We attempt to support new versions of Kubernetes 2-3 months after their release.
  • Users are expected to run a compliant Kubernetes version (a CNCF certified Kubernetes distribution)
  • The cluster must have access to persistent SSD storage
  • We test against Google Kubernetes Engine

Unless scale, resiliency, or some other legitimate need exists that necessitates the use of Kubernetes (over a much simpler Docker Compose installation), it's recommended that Docker-Compose be used.

Docker Compose

  • Be sure your deployment meets our Docker Compose requirements.
  • Review the configuration section of our Docker Compose deployment docs.

Additional support information

Precise code navigation and Batch Changes

  • The list of languages currently supported for precise code navigation can be found here
  • Requirements to set-up Batch Changes can be found here

Browser extensions

Sourcegraph supports Chrome, Edge, Firefox, and Safari releases from the last 12 months, including point releases. Firefox Extended Support Release (ESR) versions are also supported for as long as Mozilla supports them.

Older browser versions receive fixes only for critical issues or customer escalations. This policy never blocks access to Sourcegraph; it only warns users of unsupported browser versions.

Users on unsupported browser versions see a dismissible warning across the app and a permanent notice in user settings. The warning stays dismissed once dismissed. These notices explain that parts of Sourcegraph may be slow or not work and recommend updating the browser.

Editor extensions

Only the latest versions of IDEs are generally supported, but most versions within a few months up-to-date generally work.

  • VS Code
  • Visual Studio
  • JetBrains IDEs — we mainly test the plugin with IntelliJ IDEA, but it should work with no issues in all JetBrains IDEs, including:
    • IntelliJ IDEA
    • IntelliJ IDEA Community Edition
    • PhpStorm
    • WebStorm
    • PyCharm
    • PyCharm Community Edition
    • RubyMine
    • AppCode
    • CLion
    • GoLand
    • DataGrip
    • Rider
    • Android Studio

On this page

  1. Sourcegraph Deployment Best Practices

    1. What does "best practice" mean to us?
    1. Sourcegraph Performance Dependencies
    1. Deployment Best Practices
    1. Additional support information

Edit this page on GitHub
View as Markdown