diff --git a/docs/admin/deploy/index.mdx b/docs/admin/deploy/index.mdx index a0d39144c..e79d6900c 100644 --- a/docs/admin/deploy/index.mdx +++ b/docs/admin/deploy/index.mdx @@ -4,11 +4,18 @@ Sourcegraph is a powerful code intelligence platform that can be deployed in var ## Deployment types -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. +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. + +Sourcegraph's recommended deployment methods are, in order: +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. +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. +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. +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. +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. ### Sourcegraph Cloud -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. +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. @@ -18,19 +25,25 @@ Best for enterprises looking for a managed [Sourcegraph Cloud](https://about.sou ### Kubernetes -Best for large enterprises that require a multi-node, self-hosted solution. +Multi-node, self hosted solution great for large enterprises and/or other orgs looking for the recommended, robust, and scalable deployment method -- **Helm** utilizes pre-packaged charts for templating Sourcegraph deployments +- **Helm** (Preferred) utilizes pre-packaged charts for templating Sourcegraph deployments - **Kustomize** utilizes built-in features of kubectl for configuring Sourcegraph deployments - - -Given the technical knowledge required to deploy and maintain a deployment on Kubernetes, teams without these resources should contact their Sourcegraph representative at [sales@sourcegraph.com](mailto:sales@sourcegraph.com) to discuss alternative deployment options +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 [sales@sourcegraph.com](mailto:sales@sourcegraph.com) to discuss in further detail. + +### Docker Compose + +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. + + + + ### Machine Images @@ -49,11 +62,7 @@ See [Sourcegraph Machine Images](/admin/deploy/machine-images) for more informat ### On-premises -Best for enterprises looking for a fully self-hosted solution. - - - [Docker Compose](/admin/deploy/docker-compose/) - Install Sourcegraph using Docker Compose - -For setting up **non-production** environments on-premises. +For setting up quick **non-production** environments on-premises. - [Docker Single Container](/admin/deploy/docker-single-container/) - Install Sourcegraph using a single Docker container