Skip to content

updated overview section #858

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Dec 17, 2024
Merged

updated overview section #858

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 4 additions & 6 deletions docs/admin/deploy/kubernetes/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,20 +21,18 @@ Helm offers a simple deployment process on Kubernetes using well known and stand

</QuickLinks>

<Callout type="warning">Sourcegraph currently does not support migration from an existing Sourcegraph deployment without Helm to a Sourcegraph deployment using Helm. The information you are looking at is currently recommended for a new install of Sourcegraph. We are currently working to provide migration guidance from a non-Helm deployment. If you are inquiring about performing such a migration please email `support@sourcegraph.com`.</Callout>

## Why use Helm

Our Helm chart has a lot of sensible defaults baked into the values.yaml so that when an override file is used to make the changes, you _never_ have to deal with merge conflicts during upgrades (see more about customizations in the [configuration](#configuration) section).

## High-level overview of how to use Helm with Sourcegraph

1. Prepare any required customizations
- Most environments are likely to need changes from the defaults—use the guidance in [Configuration](#configuration).
- These changes are inclusive of updates to resourcing for each service. See our [resource estimator](/admin/deploy/resource_estimator) for more information.
1. Review the changes
- Most environments will likely require some customizations to the default Helm chart values. See _[Configuration](#configuration)_ for more information.
- Additionally, resource allocations for individual services may need to be adjusted. See our _[Resource Estimator](/admin/deploy/resource_estimator)_ for more information.
2. Review the customized Helm chart
- There are [three mechanisms](#reviewing-changes) that can be used to review any customizations made, this is an optional step, but may be useful the first time you deploy Sourcegraph, for peace of mind.
1. Select your deployment method and follow the guidance:
3. Follow the relevant platform-specific guide below to deploy Sourcegraph to your environment:
- [Google GKE](#configure-sourcegraph-on-google-kubernetes-engine-gke)
- [AWS EKS](#configure-sourcegraph-on-elastic-kubernetes-service-eks)
- [Azure AKS](#configure-sourcegraph-on-azure-managed-kubernetes-service-aks)
Expand Down
Loading