Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion docs/self-hosted/deploy/docker-compose/operations.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ docker exec codeinsights-db sh -c 'pg_dump -C --clean --if-exists --username pos

### Restore Sourcegraph databases into a new environment

The following instructions apply **only if you are restoring your databases into a new deployment** of Sourcegraph ie: a new virtual machine. If you are restoring a previously running environment, see the instructions for [restoring a previously running deployment](#restoring-sourcegraph-databases-into-an-existing-environment)
The following instructions apply **only if you are restoring your databases into a new deployment** of Sourcegraph ie: a new virtual machine. If you are restoring a previously running environment, see the instructions for [restoring a previously running deployment](#restore-sourcegraph-databases-into-an-existing-environment)

1\. Copy the database dump files into the `deploy-sourcegraph-docker/docker-compose` directory.

Expand Down
2 changes: 1 addition & 1 deletion docs/self-hosted/deploy/docker-compose/upgrade.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ This document describes the process to update a Docker Compose Sourcegraph insta

A [standard upgrade](/self-hosted/updates/#upgrade-types) occurs between a Sourcegraph version and the minor or major version released immediately after it. If you would like to jump forward several versions, you must perform a [multi-version upgrade](#multi-version-upgrades) instead.

If you've [configured Docker Compose with a release branch](/self-hosted/deploy/docker-compose/#step-1-prepare-the-deployment-repository), please merge the upstream release tag for the next minor version into your `release` branch.
If you've [configured Docker Compose with a release branch](/self-hosted/deploy/docker-compose#step-1-fork-the-deployment-repository), please merge the upstream release tag for the next minor version into your `release` branch.

In the following example, the release branch is being upgraded to <CURRENT_VERSION_STRING />.

Expand Down
2 changes: 1 addition & 1 deletion docs/self-hosted/deploy/kubernetes/azure.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ Connect to the cluster for future `kubectl` commands:
az aks get-credentials --resource-group sourcegraphResourceGroup --name sourcegraphCluster
```

Follow the [Sourcegraph cluster installation instructions](/self-hosted/deploy/kubernetes/configure#configure-a-storage-class) with `storageClass` set to `managed-premium` in `config.json`:
Follow the [Sourcegraph cluster installation instructions](/self-hosted/deploy/kubernetes/configure#storage-class) with `storageClass` set to `managed-premium` in `config.json`:

```diff
- "storageClass": "default"
Expand Down
26 changes: 13 additions & 13 deletions docs/self-hosted/deploy/kubernetes/configure.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,9 @@ This guide will demonstrate how to customize a Kubernetes deployment (**non-Helm

## Overview

To ensure optimal performance and functionality of your Sourcegraph deployment, please only include components listed in the [kustomization.template.yaml file](/self-hosted/deploy/kubernetes/kustomize/#kustomization-yaml) for your instance overlay. These components include settings that have been specifically designed and tested for Sourcegraph and do not require any additional configuration changes.
To ensure optimal performance and functionality of your Sourcegraph deployment, please only include components listed in the [kustomization.template.yaml file](/self-hosted/deploy/kubernetes/kustomize#step-3-set-up-the-configuration-files) for your instance overlay. These components include settings that have been specifically designed and tested for Sourcegraph and do not require any additional configuration changes.

The order of components listed in the [kustomization.template.yaml file](/self-hosted/deploy/kubernetes/kustomize/#kustomization-yaml) is important and should be maintained. The components are listed in a specific order to ensure proper dependency management and compatibility between components. Reordering components can introduce conflicts or prevent components from interacting as expected. Only modify the component order if explicitly instructed to do so by the documentation. Otherwise, leave the component order as-is to avoid issues.
The order of components listed in the [kustomization.template.yaml file](/self-hosted/deploy/kubernetes/kustomize#step-3-set-up-the-configuration-files) is important and should be maintained. The components are listed in a specific order to ensure proper dependency management and compatibility between components. Reordering components can introduce conflicts or prevent components from interacting as expected. Only modify the component order if explicitly instructed to do so by the documentation. Otherwise, leave the component order as-is to avoid issues.

Following these guidelines will help you create a seamless deployment and avoid conflicts.

Expand All @@ -45,7 +45,7 @@ To enable cluster metrics monitoring, you will need to [deploy cAdvisor](#deploy

### RBAC

Sourcegraph has removed Role-Based Access Control (RBAC) resources from the default base cluster for the Kustomize deployment. This means that [service discovery](#service-discovery) is not enabled by default, and the endpoints for each service replica must be manually added to the frontend ConfigMap. When using the [size components](#instance-size-based-resources) included in the [kustomization file built for Sourcegraph](/self-hosted/deploy/kubernetes/kustomize/#kustomization-yaml), service endpoints are automatically added to the ConfigMap.
Sourcegraph has removed Role-Based Access Control (RBAC) resources from the default base cluster for the Kustomize deployment. This means that [service discovery](#service-discovery) is not enabled by default, and the endpoints for each service replica must be manually added to the frontend ConfigMap. When using the [size components](#instance-size-based-resources) included in the [kustomization file built for Sourcegraph](/self-hosted/deploy/kubernetes/kustomize#step-3-set-up-the-configuration-files), service endpoints are automatically added to the ConfigMap.

### Non-Privileged

Expand Down Expand Up @@ -550,7 +550,7 @@ components:
- ../../components/storage-class/name-update
```

**Step 2**: Enter the value of your existing storage class name in your [buildConfig.yaml file](/self-hosted/deploy/kubernetes/kustomize#buildconfig-yaml) using the `STORAGECLASS_NAME` config key
**Step 2**: Enter the value of your existing storage class name in your [buildConfig.yaml file](/self-hosted/deploy/kubernetes/kustomize#step-3-set-up-the-configuration-files) using the `STORAGECLASS_NAME` config key

Example, add `STORAGECLASS_NAME=sourcegraph` if `sourcegraph` is the name for the existing storage class:

Expand All @@ -577,7 +577,7 @@ components:
- ../../components/storage-class/name-update
```

**Step 2**: Enter the value of your existing storage class name in your [buildConfig.yaml](/self-hosted/deploy/kubernetes/kustomize/#buildconfig-yaml) file using the `STORAGECLASS_NAME` config key
**Step 2**: Enter the value of your existing storage class name in your [buildConfig.yaml](/self-hosted/deploy/kubernetes/kustomize#step-3-set-up-the-configuration-files) file using the `STORAGECLASS_NAME` config key

Example, set `STORAGECLASS_NAME=sourcegraph` if `sourcegraph` is the name for the existing storage class:

Expand All @@ -601,7 +601,7 @@ components:
- ../../components/storage-class/cloud
```

Update the following variables in your [buildConfig.yaml](/self-hosted/deploy/kubernetes/kustomize/#buildconfig-yaml) file. Replace them with the correct values according to the instructions provided by your cloud provider:
Update the following variables in your [buildConfig.yaml](/self-hosted/deploy/kubernetes/kustomize#step-3-set-up-the-configuration-files) file. Replace them with the correct values according to the instructions provided by your cloud provider:

```yaml
# instances/$INSTANCE_NAME/buildConfig.yaml
Expand Down Expand Up @@ -693,7 +693,7 @@ data:
# the data is abbreviated in this example
```

**Step 3**: Configure the TLS settings of your Ingress by adding the following variables to your [buildConfig.yaml](/self-hosted/deploy/kubernetes/kustomize/#buildconfig-yaml) file:
**Step 3**: Configure the TLS settings of your Ingress by adding the following variables to your [buildConfig.yaml](/self-hosted/deploy/kubernetes/kustomize#step-3-set-up-the-configuration-files) file:

- **TLS_HOST**: your domain name
- **TLS_INGRESS_CLASS_NAME**: ingress class name required by your cluster-issuer
Expand Down Expand Up @@ -783,7 +783,7 @@ components:

To configure the hostname for your Sourcegraph ingress, follow these steps:

**Step 1**: In your [buildConfig.yaml](/self-hosted/deploy/kubernetes/kustomize/#buildconfig-yaml) file, include the `HOST_DOMAIN` variable and set it to your desired hostname, for example:
**Step 1**: In your [buildConfig.yaml](/self-hosted/deploy/kubernetes/kustomize#step-3-set-up-the-configuration-files) file, include the `HOST_DOMAIN` variable and set it to your desired hostname, for example:

```yaml
# instances/$INSTANCE_NAME/buildConfig.yaml
Expand Down Expand Up @@ -955,7 +955,7 @@ components:

### Frontend

To update the environment variables for the **sourcegraph-frontend** service, add the new environment variables to the end of the _FRONTEND ENV VARS_ section at the bottom of your [kustomization file](/self-hosted/deploy/kubernetes/kustomize/#kustomizationyaml). For example:
To update the environment variables for the **sourcegraph-frontend** service, add the new environment variables to the end of the _FRONTEND ENV VARS_ section at the bottom of your [kustomization file](/self-hosted/deploy/kubernetes/kustomize#step-3-set-up-the-configuration-files). For example:

```yaml
# instances/$INSTANCE_NAME/kustomization.yaml
Expand Down Expand Up @@ -1065,7 +1065,7 @@ Similar changes will be required for other pods and services, depending on the s

For optimal performance and resilience, it is recommended to use an external database when deploying Sourcegraph. For more information on database requirements, please refer to the [Postgres guide](/self-hosted/postgres).

To connect Sourcegraph to an existing PostgreSQL instance, add the relevant environment variables ([such as PGHOST, PGPORT, PGUSER, etc.](http://www.postgresql.org/docs/current/static/libpq-envars.html)) to the frontend ConfigMap by adding the new environment variables to the end of the _FRONTEND ENV VARS_ section at the bottom of your [kustomization file](/self-hosted/deploy/kubernetes/kustomize/#kustomizationyaml). For example:
To connect Sourcegraph to an existing PostgreSQL instance, add the relevant environment variables ([such as PGHOST, PGPORT, PGUSER, etc.](http://www.postgresql.org/docs/current/static/libpq-envars.html)) to the frontend ConfigMap by adding the new environment variables to the end of the _FRONTEND ENV VARS_ section at the bottom of your [kustomization file](/self-hosted/deploy/kubernetes/kustomize#step-3-set-up-the-configuration-files). For example:

```yaml
# instances/$INSTANCE_NAME/kustomization.yaml
Expand Down Expand Up @@ -1235,7 +1235,7 @@ components:
- ../../components/enable/private-registry
```

**Step 2:** Set the `PRIVATE_REGISTRY` variable in your [buildConfig.yaml](/self-hosted/deploy/kubernetes/kustomize/#buildconfig-yaml) file. For example:
**Step 2:** Set the `PRIVATE_REGISTRY` variable in your [buildConfig.yaml](/self-hosted/deploy/kubernetes/kustomize#step-3-set-up-the-configuration-files) file. For example:

```yaml
# instances/$INSTANCE_NAME/buildConfig.yaml
Expand All @@ -1255,7 +1255,7 @@ components:
- ../../components/resources/imagepullsecrets
```

**Step 2:** Set the `IMAGE_PULL_SECRET_NAME` variable in your [buildConfig.yaml](/self-hosted/deploy/kubernetes/kustomize/#buildconfig-yaml) file.
**Step 2:** Set the `IMAGE_PULL_SECRET_NAME` variable in your [buildConfig.yaml](/self-hosted/deploy/kubernetes/kustomize#step-3-set-up-the-configuration-files) file.

For example:

Expand Down Expand Up @@ -1285,7 +1285,7 @@ patches:

## Multi-version upgrade

In order to perform a [multi-version upgrade](/self-hosted/updates/#multi-version-upgrades), all pods must be scaled down to 0 except databases, which can be handled by including the `utils/multi-version-upgrade` component:
In order to perform a [multi-version upgrade](/self-hosted/updates#upgrade-types), all pods must be scaled down to 0 except databases, which can be handled by including the `utils/multi-version-upgrade` component:

```yaml
# instances/$INSTANCE_NAME/kustomization.yaml
Expand Down
4 changes: 2 additions & 2 deletions docs/self-hosted/deploy/kubernetes/kustomize.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -66,15 +66,15 @@ Create a copy of the [instances/template](/self-hosted/deploy/kubernetes/kustomi

### **Step 3**: Set up the configuration files

**1.** Rename the [kustomization.template.yaml](/self-hosted/deploy/kubernetes/kustomize/#kustomization-yaml) file in `instances/my-sourcegraph` to `kustomization.yaml`.
**1.** Rename the [kustomization.template.yaml](/self-hosted/deploy/kubernetes/kustomize#step-3-set-up-the-configuration-files) file in `instances/my-sourcegraph` to `kustomization.yaml`.

- The `kustomization.yaml` file is used to configure your Sourcegraph instance.

```bash
$ mv instances/my-sourcegraph/kustomization.template.yaml instances/my-sourcegraph/kustomization.yaml
```

**2.** Rename the [buildConfig.template.yaml](/self-hosted/deploy/kubernetes/kustomize/#buildconfig-yaml) file in `instances/my-sourcegraph` to `buildConfig.yaml`.
**2.** Rename the [buildConfig.template.yaml](/self-hosted/deploy/kubernetes/kustomize#step-3-set-up-the-configuration-files) file in `instances/my-sourcegraph` to `buildConfig.yaml`.

- The `buildConfig.yaml` file is used to configure components included in your `kustomization` file if required.

Expand Down
2 changes: 1 addition & 1 deletion docs/self-hosted/deploy/kubernetes/kustomize/eks.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,7 @@ components:
- ../../components/clusters/aws/managed-cert
```

Step 2: Set the `AWS_MANAGED_CERT_ARN` variable with the `ARN of your AWS-managed TLS certificate` under the [BUILD CONFIGURATIONS](/self-hosted/deploy/kubernetes/kustomize/#buildconfig-yaml) section:
Step 2: Set the `AWS_MANAGED_CERT_ARN` variable with the `ARN of your AWS-managed TLS certificate` under the [BUILD CONFIGURATIONS](/self-hosted/deploy/kubernetes/kustomize#step-3-set-up-the-configuration-files) section:

```yaml
# instances/$INSTANCE_NAME/buildConfig.yaml
Expand Down
2 changes: 1 addition & 1 deletion docs/self-hosted/deploy/kubernetes/kustomize/gke.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -129,7 +129,7 @@ components:
- ../../components/clusters/gke/managed-cert
```

Step 2: Set the `GKE_MANAGED_CERT_NAME` variable with your Google-managed certificate name under the [BUILD CONFIGURATIONS](/self-hosted/deploy/kubernetes/kustomize#buildconfig-yaml) section:
Step 2: Set the `GKE_MANAGED_CERT_NAME` variable with your Google-managed certificate name under the [BUILD CONFIGURATIONS](/self-hosted/deploy/kubernetes/kustomize#step-3-set-up-the-configuration-files) section:

```yaml
# instances/$INSTANCE_NAME/buildConfig.yaml
Expand Down
4 changes: 2 additions & 2 deletions docs/self-hosted/deploy/kubernetes/kustomize/migrate.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ Create a copy of the [instances/template](/self-hosted/deploy/kubernetes/kustomi

The `kustomization.yaml` file is used to configure your Sourcegraph instance.

**1.** Rename the [kustomization.template.yaml](/self-hosted/deploy/kubernetes/kustomize/#kustomization-yaml) file in `instances/my-sourcegraph` to `kustomization.yaml`.
**1.** Rename the [kustomization.template.yaml](/self-hosted/deploy/kubernetes/kustomize#step-3-set-up-the-configuration-files) file in `instances/my-sourcegraph` to `kustomization.yaml`.

- The `kustomization.yaml` file is used to configure your Sourcegraph instance.

Expand All @@ -85,7 +85,7 @@ The `kustomization.yaml` file is used to configure your Sourcegraph instance.

#### buildConfig.yaml

**2.** Rename the [buildConfig.template.yaml](/self-hosted/deploy/kubernetes/kustomize/#buildconfig-yaml) file in `instances/my-sourcegraph` to `buildConfig.yaml`.
**2.** Rename the [buildConfig.template.yaml](/self-hosted/deploy/kubernetes/kustomize#step-3-set-up-the-configuration-files) file in `instances/my-sourcegraph` to `buildConfig.yaml`.

- The `buildConfig.yaml` file is used to configure components included in your `kustomization` file when required.

Expand Down
2 changes: 1 addition & 1 deletion docs/self-hosted/deploy/kubernetes/operations.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Operations guides specific to managing [Sourcegraph on Kubernetes](/self-hosted/

## Featured guides

Trying to deploy Sourcegraph on Kubernetes? Refer to our [installation guide](/self-hosted/deploy/kubernetes/#installation).
Trying to deploy Sourcegraph on Kubernetes? Refer to our [installation guide](/self-hosted/deploy/kubernetes#quickstart).

## Configure

Expand Down
2 changes: 1 addition & 1 deletion docs/self-hosted/deploy/kubernetes/troubleshoot.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ Run `kubectl version` to verify the **Client Version** matches the **Server Vers

Run `kubectl get ingresses -A` to check if there is more than one ingress for `sourcegraph-frontend`. You can delete the duplicate with `kubectl delete ingress sourcegraph-frontend --namespace $YOUR_NAMESPACE`

> NOTE: See our ["configuration guide"](/self-hosted/deploy/kubernetes/configure#security-configure-network-access) for more information on network access.
> NOTE: See our ["configuration guide"](/self-hosted/deploy/kubernetes/configure#network-access) for more information on network access.

#### Error: error when creating "base/cadvisor/cadvisor.ClusterRoleBinding.yaml": subjects[0].namespace: Required value

Expand Down
2 changes: 1 addition & 1 deletion docs/self-hosted/deploy/machine-images/aws-ami.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -187,7 +187,7 @@ Now that your instance is confirmed to be working, and you have HTTPS working th
Please take time to review the following before proceeding with the upgrades:

- [Technical changelog](https://sourcegraph.com/changelog/releases)
- [Update policy](/self-hosted/updates#update-policy)
- [Update policy](/self-hosted/updates#release-schedule-and-versioning)
- [Update notes](https://sourcegraph.com/changelog/self-hosted/kubernetes)

<Callout type="warning">Back up your volumes before each upgrade!</Callout>
Expand Down
2 changes: 1 addition & 1 deletion docs/self-hosted/deploy/machine-images/gce.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -165,7 +165,7 @@ As a result, setting up a static IP for your Sourcegraph instance is strongly re
Please take time to review the following before proceeding with the upgrades:

- [Technical changelog](https://sourcegraph.com/changelog/releases)
- [Update policy](/self-hosted/updates#update-policy)
- [Update policy](/self-hosted/updates#release-schedule-and-versioning)
- [Update notes](https://sourcegraph.com/changelog/self-hosted/kubernetes)
- [Multi-version upgrade procedure](https://sourcegraph.com/changelog/self-hosted/kubernetes)

Expand Down
2 changes: 1 addition & 1 deletion docs/self-hosted/deploy/repositories.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -75,4 +75,4 @@ git checkout $YOUR_RELEASE_BRANCH
git merge {CURRENT_VERSION}
```

A [standard upgrade](/self-hosted/updates#standard-upgrades) occurs between two minor versions of Sourcegraph. If you are looking to jump forward several versions, you must perform a [multi-version upgrade](/self-hosted/updates#multi-version-upgrades) instead.
A [standard upgrade](/self-hosted/updates#upgrade-types) occurs between two minor versions of Sourcegraph. If you are looking to jump forward several versions, you must perform a [multi-version upgrade](/self-hosted/updates#upgrade-types) instead.
2 changes: 1 addition & 1 deletion docs/self-hosted/deploy/single-node/script.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ We recommend deploying your own reverse proxy to terminate TLS connections with
## Upgrade

- [Technical changelog](https://sourcegraph.com/changelog/releases)
- [Update policy](/self-hosted/updates#update-policy)
- [Update policy](/self-hosted/updates#release-schedule-and-versioning)
- [Update notes](https://sourcegraph.com/changelog/self-hosted/kubernetes)
- [Multi-version upgrade procedure](https://sourcegraph.com/changelog/self-hosted/kubernetes)

Expand Down
2 changes: 1 addition & 1 deletion docs/self-hosted/external-services/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ See the following guides to use an external or managed version of each service t
- See [Using your own PostgreSQL server](/self-hosted/external-services/postgres) to replace the bundled PostgreSQL instances.
- See [Using your own Redis server](/self-hosted/external-services/redis) to replace the bundled Redis instances.
- See [Using a managed object storage service (S3 or GCS)](/self-hosted/external-services/object-storage) to replace the bundled blobstore instance.
- See [Using an external Jaeger instance](/self-hosted/observability/tracing#Use-an-external-Jaeger-instance) to replace the bundled Jaeger instance.
- See [Using an external Jaeger instance](/self-hosted/observability/tracing#jaeger) to replace the bundled Jaeger instance.

> NOTE: Using Sourcegraph with an external service is a [paid feature](https://about.sourcegraph.com/pricing). [Contact us](https://about.sourcegraph.com/contact/sales) to get a trial license.

Expand Down
Loading
Loading