Skip to content

Commit 3ff1a50

Browse files
anorrishloujar
andauthored
Update index.mdx for Deployment Details and Recommendations (#680)
Updating the deployment landing page and including our recommendations. --------- Co-authored-by: loujar <[email protected]>
1 parent 8054439 commit 3ff1a50

File tree

1 file changed

+21
-12
lines changed

1 file changed

+21
-12
lines changed

docs/admin/deploy/index.mdx

Lines changed: 21 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,18 @@ Sourcegraph is a powerful code intelligence platform that can be deployed in var
44

55
## Deployment types
66

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.
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. Changing deployment methods in the future requires a complete redeployment and database migration.
8+
9+
Sourcegraph's recommended deployment methods are, in order:
10+
1. [Sourcegraph Cloud](#sourcegraph-cloud) - This provides a fully managed solution where Sourcegraph handles all 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 multi-node instance, and can be supported by all mainstream managed Kubernetes platforms.
12+
3. [Docker Compose](#docker-compose) - Docker Compose provides the preferred 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) - Helm is Sourcegraph's more standardized and vetted approach to deploying with Kubernetes, but if Kustomize is your preferred deployment method it is a viable and supported approach.
14+
5. [Machine Images](#machine-images) - Sourcegraph can be deployed using 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.
815

916
### Sourcegraph Cloud
1017

11-
Best for enterprises looking for a managed [Sourcegraph Cloud](https://about.sourcegraph.com/get-started?t=enterprise) solution. Sourcegraph Cloud is hosted and maintained by Sourcegraph.
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.
1219

1320
<LinkCards>
1421

@@ -18,19 +25,25 @@ Best for enterprises looking for a managed [Sourcegraph Cloud](https://about.sou
1825

1926
### Kubernetes
2027

21-
Best for large enterprises that require a multi-node, self-hosted solution.
28+
Multi-node, self hosted solution great for large enterprises and/or other orgs looking for the recommended, robust, and scalable deployment method
2229

23-
- **Helm** utilizes pre-packaged charts for templating Sourcegraph deployments
30+
- **Helm** (Preferred) utilizes pre-packaged charts for templating Sourcegraph deployments
2431
- **Kustomize** utilizes built-in features of kubectl for configuring Sourcegraph deployments
2532

2633
<QuickLinks>
27-
2834
<QuickLink title="Helm" icon='theming' href="/admin/deploy/kubernetes" />
2935
<QuickLink title="Kustomize" icon='lightbulb' href="/admin/deploy/kubernetes/kustomize" />
30-
3136
</QuickLinks>
3237

33-
<Callout type="note">Given the technical knowledge required to deploy and maintain a deployment on Kubernetes, teams without these resources should contact their Sourcegraph representative at [[email protected]](mailto:[email protected]) to discuss alternative deployment options</Callout>
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 in-house Kubernetes expertise 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>
3447

3548
### Machine Images
3649

@@ -49,11 +62,7 @@ See [Sourcegraph Machine Images](/admin/deploy/machine-images) for more informat
4962

5063
### On-premises
5164

52-
Best for enterprises looking for a fully self-hosted solution.
53-
54-
- [Docker Compose](/admin/deploy/docker-compose/) - Install Sourcegraph using Docker Compose
55-
56-
For setting up **non-production** environments on-premises.
65+
For setting up quick **non-production** environments on-premises.
5766

5867
- [Docker Single Container](/admin/deploy/docker-single-container/) - Install Sourcegraph using a single Docker container
5968

0 commit comments

Comments
 (0)