| 
1 |  | -Deployment Overview  | 
 | 1 | +# Deployment Overview  | 
 | 2 | + | 
2 | 3 | Sourcegraph is a powerful code intelligence platform that can be deployed in various ways to suit your organization's needs. This guide will help you understand the available deployment options and choose the best one for your use case.  | 
3 | 4 | 
 
  | 
4 |  | -Deployment types  | 
 | 5 | +## Deployment types  | 
 | 6 | + | 
5 | 7 | Carefully consider your organization's needs and technical expertise when selecting a Sourcegraph deployment method. Each option has different capabilities, resource requirements, and levels of technical expertise needed. Consider your organization's needs carefully, as the deployment method cannot be easily changed for a running instance.  | 
6 | 8 | 
 
  | 
7 | 9 | Sourcegraph's recommended deployment methods are, in order:  | 
 | 10 | +1. [Sourcegraph Cloud](#sourcegraph-cloud) - This povides a fully managed solution where Sourcegraph handles much of the maintence, monitoring, and upgrading tasks to give you an optimal Sourcegraph experience while immediately getting the latest features into your users' hands. This solution does require your code hosts to be connected to the Sourcegraph managed environment.  | 
 | 11 | +2. [Kubernetes Helm](#kubernetes) - Sourcegraph's Kubernetes deployment provides the most robust, scalable, and vetted self-hosted solution. This solution is ideal across many self-hosted customers capable of deploying a mult-node instance, and can be supported within many Kubernetes-capable environments.  | 
 | 12 | +3. [Docker Compose](#docker-compose) - Docker Compose provides the prefered single-node deployment solution for Sourcegraph. It can be a good option when the complexities and flexibility provided by Kubernetes Helm are not needed.  | 
 | 13 | +4. [Kubernetes Kustomize](#kubernetes) - Kustomize should only be used in place of Helm in specific circumstances. Kustomize tends to be a more advanced solution than Helm, but if it is your prefered deployment method it is a viable and supported method.  | 
 | 14 | +5. [Machine Images](#machine-images) - Sourcegraph can be deployed used dedicated Machine Images for specific Cloud providers. This can be a simple solution in specific circumstances, though has its own considerations. If you are considering this path, please discuss with your account team.  | 
 | 15 | + | 
 | 16 | +### Sourcegraph Cloud  | 
 | 17 | + | 
 | 18 | +Best for a wide range of customers open to a Sourcegraph managed [Sourcegraph Cloud](https://about.sourcegraph.com/get-started?t=enterprise) solution. Sourcegraph Cloud is hosted and maintained by Sourcegraph.  | 
8 | 19 | 
 
  | 
9 |  | -Sourcegraph Cloud - This povides a fully managed solution where Sourcegraph handles much of the maintence, monitoring, and upgrading tasks to give you an optimal Sourcegraph experience while immediately getting the latest features into your users' hands. This solution does require your code hosts to be connected to the Sourcegraph managed environment.  | 
10 |  | -Kubernetes Helm - Sourcegraph's Kubernetes deployment provides the most robust, scalable, and vetted self-hosted solution. This solution is ideal across many self-hosted customers capable of deploying a mult-node instance, and can be supported within many Kubernetes-capable environments. This is typically the preferred method for self-hosting Sourcegraph.  | 
11 |  | -Docker Compose - Docker Compose provides the prefered single-node deployment solution for Sourcegraph. It can be a good option when the complexities and flexibility provided by Kubernetes Helm are not needed.  | 
12 |  | -Kubernetes Kustomize - Kustomize should only be used in place of Helm in specific circumstances. Kustomize tends to be a more advanced solution than Helm, but if it is your prefered deployment method it is a viable and supported method.  | 
13 |  | -Machine Images - Sourcegraph can be deployed used dedicated Machine Images for specific Cloud providers. This can be a simple solution in specific circumstances, though has its own considerations. If you are considering this path, please discuss with your account team.  | 
14 |  | -Sourcegraph Cloud  | 
15 |  | -Best for a wide range of customers open to a Sourcegraph managed Sourcegraph Cloud solution. Sourcegraph Cloud is hosted and maintained by Sourcegraph.  | 
 | 20 | +<LinkCards>  | 
 | 21 | + | 
 | 22 | +  <LinkCard href="https://about.sourcegraph.com/get-started?t=enterprise" imgSrc="https://sourcegraph.com/.assets/img/sourcegraph-mark.svg" imgAlt="Sourcegraph" title="Get a single-tenant instance managed by Sourcegraph." description="Sign up and get a 30 day free trial for your team." />  | 
 | 23 | + | 
 | 24 | +</LinkCards>  | 
 | 25 | + | 
 | 26 | +### Kubernetes  | 
16 | 27 | 
 
  | 
17 |  | -Kubernetes  | 
18 | 28 | Multi-node, self hosted solution great for large enterprises and or other orgs looking for the recommended, robust, and scalable deployment method  | 
19 | 29 | 
 
  | 
20 |  | -Helm <Prefered> utilizes pre-packaged charts for templating Sourcegraph deployments  | 
21 |  | -Kustomize utilizes built-in features of kubectl for configuring Sourcegraph deployments  | 
22 |  | -Kubernetes is the recommended self hosted deployment method, though it can require specific technical knowledge required to deploy and maintain a deployment on Kubernetes. Teams without these resources should contact their Sourcegraph account representative or  [email protected] to discuss in further detail.  | 
 | 30 | +- **Helm** <<e>Prefered</e>> utilizes pre-packaged charts for templating Sourcegraph deployments  | 
 | 31 | +- **Kustomize** utilizes built-in features of kubectl for configuring Sourcegraph deployments  | 
 | 32 | + | 
 | 33 | +<QuickLinks>  | 
 | 34 | +    <QuickLink title="Helm" icon='theming' href="/admin/deploy/kubernetes" />  | 
 | 35 | +    <QuickLink title="Kustomize" icon='lightbulb' href="/admin/deploy/kubernetes/kustomize" />  | 
 | 36 | +</QuickLinks>  | 
23 | 37 | 
 
  | 
24 |  | -Docker Compose  | 
25 |  | -Single-node, self hosted solution for enterprises looking for a single-node, non-Kubernetes solution. Sourcegraph can be supported at a large variety of scales on Docker Compose, though the flexibility and robustness is less than that of a Kubernetes deployment.  | 
 | 38 | +< Callout type="note">Kubernetes is the recommended self hosted deployment method, though it can require specific technical knowledge required to deploy and maintain a deployment on Kubernetes. Teams without these resources should contact their Sourcegraph account representative or  [[email protected]](mailto:[email protected]) to discuss in further detail.</ Callout>  | 
 | 39 | + | 
 | 40 | +### Docker Compose  | 
 | 41 | + | 
 | 42 | +Single-node, self hosted solution for enterprises looking for a simpler, non-Kubernetes solution. Docker Compose can support Sourcegraph at a large range of scales, though this deployment solution tends to be less flexible and robust in comparison to our Kubernetes solution.  | 
 | 43 | + | 
 | 44 | +<QuickLinks>  | 
 | 45 | +  <QuickLink title="Docker Compose" icon='installation' href="/admin/deploy/docker-compose" />  | 
 | 46 | +</QuickLinks>  | 
 | 47 | + | 
 | 48 | +### Machine Images  | 
26 | 49 | 
 
  | 
27 |  | -Machine Images  | 
28 | 50 | Best for enterprises looking for a self-hosted solution on the Cloud provider of their choice.  | 
29 | 51 | 
 
  | 
30 | 52 | Customized machine images allow you to spin up a preconfigured Sourcegraph instance with just a few clicks, all in less than 10 minutes. Currently available in the following hosts:  | 
31 | 53 | 
 
  | 
32 |  | -See Sourcegraph Machine Images for more information.  | 
 | 54 | +<QuickLinks>  | 
 | 55 | +  <QuickLink title="Amazon Machine Image (AMI)" icon='lightbulb' href="/admin/deploy/machine-images/aws-ami" />  | 
 | 56 | +  <QuickLink title="Google Compute Image" icon='presets' href="/admin/deploy/machine-images/gce" />  | 
 | 57 | +</QuickLinks>  | 
 | 58 | + | 
 | 59 | +See [Sourcegraph Machine Images](/admin/deploy/machine-images) for more information.  | 
 | 60 | + | 
 | 61 | +<Callout type="note">Deploying with machine images requires technical expertise and the ability to maintain and manage your own infrastructure.</Callout>  | 
 | 62 | + | 
 | 63 | +### On-premises  | 
 | 64 | + | 
 | 65 | +For setting up quick **non-production** environments on-premises.  | 
33 | 66 | 
 
  | 
34 |  | -Deploying with machine images requires technical expertise and the ability to maintain and manage your own infrastructure.  | 
 | 67 | +  - [Docker Single Container](/admin/deploy/docker-single-container/) - Install Sourcegraph using a single Docker container  | 
35 | 68 | 
 
  | 
36 |  | -On-premises  | 
37 |  | -For setting up quick non-production environments on-premises.  | 
 | 69 | +### ARM / ARM64 support  | 
38 | 70 | 
 
  | 
39 |  | -Docker Single Container - Install Sourcegraph using a single Docker container  | 
40 |  | -ARM / ARM64 support  | 
41 | 71 | Running Sourcegraph on ARM / ARM64 images is not supported for production deployments at this time.  | 
0 commit comments