diff --git a/docs/self-hosted/deploy/docker-compose/upgrade.mdx b/docs/self-hosted/deploy/docker-compose/upgrade.mdx index c9613db80..d5e774f01 100644 --- a/docs/self-hosted/deploy/docker-compose/upgrade.mdx +++ b/docs/self-hosted/deploy/docker-compose/upgrade.mdx @@ -5,7 +5,7 @@ import {CURRENT_VERSION_STRING} from 'src/components/PreCodeBlock'; This document describes the process to update a Docker Compose Sourcegraph instance. If you are unfamiliar with sourcegraph versioning or releases see our [general concepts documentation](/self-hosted/updates/). > -> Always consult the [release notes](/self-hosted/updates/docker-compose) for the +> Always consult the [release notes](https://sourcegraph.com/changelog/self-hosted/docker-compose) for the > versions your upgrade will pass over and end on. > @@ -74,7 +74,7 @@ To perform a multi-version upgrade via migrators [upgrade](/self-hosted/updates/ 1. **Check Upgrade Readiness**: - - Check the [upgrade notes](/self-hosted/updates/docker-compose#docker-compose-upgrade-notes) for the version range you're passing through. + - Check the [upgrade notes](https://sourcegraph.com/changelog/self-hosted/docker-compose) for the version range you're passing through. - Check the `Site Admin > Updates` page to determine [upgrade readiness](/self-hosted/updates/#upgrade-readiness). 2. **Pull and merge upstream changes**: diff --git a/docs/self-hosted/deploy/docker-single-container/index.mdx b/docs/self-hosted/deploy/docker-single-container/index.mdx index fdfd486b9..92d691e71 100644 --- a/docs/self-hosted/deploy/docker-single-container/index.mdx +++ b/docs/self-hosted/deploy/docker-single-container/index.mdx @@ -156,7 +156,7 @@ From sourcegraph version 5.11 onwards, the Sourcegraph single container Docker i **Before performing a multi-version upgrade**: - Read our [update policy](/self-hosted/updates/#update-policy) to learn about Sourcegraph updates. -- Find the entries that apply to the version range you're passing through in the [update notes for Sourcegraph with Docker Single Container](/self-hosted/updates/server#multi-version-upgrade-procedure). +- Find the entries that apply to the version range you're passing through in the [update notes for Sourcegraph with Docker Single Container](https://sourcegraph.com/changelog/self-hosted/server). 0. You must first shutdown the container instance via `docker stop [CONTAINER]`. 1. Start a temporary Postgres container on top of the Postgres data directory used by the old `sourcegraph/server` image. You must use the _new_ postgresql-16-codeinsights image, which is based on the new Postgresql 16 image, and provides an automatic upgrade script to move from Postgresql 12 to Postgresql 16. @@ -177,7 +177,7 @@ A [standard upgrade](/self-hosted/updates/#standard-upgrades) occurs between two **Before upgrading:** - Read our [update policy](/self-hosted/updates/#update-policy) to learn about Sourcegraph updates. -- Find the relevant entry for your update in the [update notes for single-container Sourcegraph with Docker](/self-hosted/updates/server). +- Find the relevant entry for your update in the [update notes for single-container Sourcegraph with Docker](https://sourcegraph.com/changelog/self-hosted/server). To update, just use the newer `sourcegraph/server:N.N.N` Docker image (where `N.N.N` is a patch or single minor release away your current version) in place of the older one, using the same Docker volumes. Your server's data will be migrated automatically if needed. You can always find the version number details of the latest release via the [technical changelog](/technical-changelog). @@ -204,7 +204,7 @@ A [multi-version upgrade](/self-hosted/updates/#multi-version-upgrades) is a dow **Before performing a multi-version upgrade**: - Read our [update policy](/self-hosted/updates/#update-policy) to learn about Sourcegraph updates. -- Find the entries that apply to the version range you're passing through in the [update notes for Sourcegraph with Docker Single Container](/self-hosted/updates/server#multi-version-upgrade-procedure). +- Find the entries that apply to the version range you're passing through in the [update notes for Sourcegraph with Docker Single Container](https://sourcegraph.com/changelog/self-hosted/server). To perform a multi-version upgrade on a Sourcegraph instance running on Docker Single Container: diff --git a/docs/self-hosted/deploy/kubernetes/index.mdx b/docs/self-hosted/deploy/kubernetes/index.mdx index fca9e2fd3..95a710ed5 100644 --- a/docs/self-hosted/deploy/kubernetes/index.mdx +++ b/docs/self-hosted/deploy/kubernetes/index.mdx @@ -1017,7 +1017,7 @@ When all pods have restarted and show as Running, you can browse to your Sourceg **Step 1:** Check Upgrade Readiness: -- Check the [upgrade notes](/self-hosted/updates/kubernetes#kubernetes-upgrade-notes) for the version range you're passing through. +- Check the [upgrade notes](https://sourcegraph.com/changelog/self-hosted/kubernetes) for the version range you're passing through. - Check the `Site Admin > Updates` page to determine [upgrade readiness](/self-hosted/updates/#upgrade-readiness). **Step 2:** diff --git a/docs/self-hosted/deploy/kubernetes/upgrade.mdx b/docs/self-hosted/deploy/kubernetes/upgrade.mdx index b4f01dd9f..d134bfc87 100644 --- a/docs/self-hosted/deploy/kubernetes/upgrade.mdx +++ b/docs/self-hosted/deploy/kubernetes/upgrade.mdx @@ -6,7 +6,7 @@ This guide is **not for use with Helm**. Please refer to the [Upgrading Sourcegr > **_⚠️ Attention:_** > -> - **_Always consult the [release notes](/self-hosted/updates/kubernetes) for the versions your upgrade will pass over and end on._** +> - **_Always consult the [release notes](https://sourcegraph.com/changelog/self-hosted/kubernetes) for the versions your upgrade will pass over and end on._** > - _This guide assumes you have created a `release` branch following the [reference repositories docs](/self-hosted/deploy/repositories)_ > - **\*please see our [cautionary note](/self-hosted/updates/#best-practices) on upgrades**, if you have any concerns about running a multiversion upgrade, please reach out to us at [support@sourcegraph.com](mailto:support@sourcegraph.com) for advisement.\* @@ -82,7 +82,7 @@ To perform a multi-version upgrade via migrators [upgrade](/self-hosted/updates/ 1. **Check Upgrade Readiness**: - - Check the [upgrade notes](/self-hosted/updates/kubernetes#kubernetes-upgrade-notes) for the version range you're passing through. + - Check the [upgrade notes](https://sourcegraph.com/changelog/self-hosted/kubernetes) for the version range you're passing through. - Check the `Site Admin > Updates` page to determine [upgrade readiness](/self-hosted/updates/#upgrade-readiness). 2. **Pull and merge upstream changes**: diff --git a/docs/self-hosted/deploy/machine-images/aws-ami.mdx b/docs/self-hosted/deploy/machine-images/aws-ami.mdx index 842095be7..5cbfa31f0 100644 --- a/docs/self-hosted/deploy/machine-images/aws-ami.mdx +++ b/docs/self-hosted/deploy/machine-images/aws-ami.mdx @@ -184,7 +184,7 @@ Please take time to review the following before proceeding with the upgrades: - [Technical changelog](/technical-changelog) - [Update policy](/self-hosted/updates#update-policy) -- [Update notes](/self-hosted/updates/kubernetes) +- [Update notes](https://sourcegraph.com/changelog/self-hosted/kubernetes) Back up your volumes before each upgrade! diff --git a/docs/self-hosted/deploy/machine-images/gce.mdx b/docs/self-hosted/deploy/machine-images/gce.mdx index c058fc230..bcebf5e7d 100644 --- a/docs/self-hosted/deploy/machine-images/gce.mdx +++ b/docs/self-hosted/deploy/machine-images/gce.mdx @@ -171,8 +171,8 @@ Please take time to review the following before proceeding with the upgrades: - [Technical changelog](/technical-changelog) - [Update policy](/self-hosted/updates#update-policy) -- [Update notes](/self-hosted/updates/kubernetes) -- [Multi-version upgrade procedure](/self-hosted/updates/kubernetes#multi-version-upgrade-procedure) +- [Update notes](https://sourcegraph.com/changelog/self-hosted/kubernetes) +- [Multi-version upgrade procedure](https://sourcegraph.com/changelog/self-hosted/kubernetes) IMPORTANT: **Back up your volumes before each upgrade** @@ -228,7 +228,7 @@ You can terminate the stopped Sourcegraph Google Image instance once you have co You must follow the [multi-version upgrade - procedure](/self-hosted/updates/kubernetes#multi-version-upgrade-procedure) if you + procedure](https://sourcegraph.com/changelog/self-hosted/kubernetes) if you are attempting a multi-version upgrade. diff --git a/docs/self-hosted/deploy/single-node/script.mdx b/docs/self-hosted/deploy/single-node/script.mdx index dbd082468..1bd708e92 100644 --- a/docs/self-hosted/deploy/single-node/script.mdx +++ b/docs/self-hosted/deploy/single-node/script.mdx @@ -80,8 +80,8 @@ We recommend deploying your own reverse proxy to terminate TLS connections with - [Technical changelog](/technical-changelog) - [Update policy](/self-hosted/updates#update-policy) -- [Update notes](/self-hosted/updates/kubernetes) -- [Multi-version upgrade procedure](/self-hosted/updates/kubernetes#multi-version-upgrade-procedure) +- [Update notes](https://sourcegraph.com/changelog/self-hosted/kubernetes) +- [Multi-version upgrade procedure](https://sourcegraph.com/changelog/self-hosted/kubernetes) > Important: Back up your volumes before each upgrade diff --git a/docs/self-hosted/how-to/precise-code-intel-worker-crashloopbackoff.mdx b/docs/self-hosted/how-to/precise-code-intel-worker-crashloopbackoff.mdx index 693fabd0c..123e99458 100644 --- a/docs/self-hosted/how-to/precise-code-intel-worker-crashloopbackoff.mdx +++ b/docs/self-hosted/how-to/precise-code-intel-worker-crashloopbackoff.mdx @@ -2,7 +2,7 @@ This document will discuss one of the main reasons why the `precise-code-intel-worker` goes into a `CrashLoopBackOff` state in a Kubernetes. It does not attempt to solve _all_ reasons why this state can happen. -This commonly happens when upgrading from a Sourcegraph version prior to 3.22 to a later version and failing to deploy the MinIO container. This is because in [3.21 -> 3.22 we removed the `code intel bundle manager` and replaced it with `MinIO`.](/self-hosted/updates/kubernetes#3-21-3-22) +This commonly happens when upgrading from a Sourcegraph version prior to 3.22 to a later version and failing to deploy the MinIO container. This is because in [3.21 -> 3.22 we removed the `code intel bundle manager` and replaced it with `MinIO`.](https://sourcegraph.com/changelog/self-hosted/kubernetes) ## Symptoms diff --git a/docs/self-hosted/index.mdx b/docs/self-hosted/index.mdx index 8eb4949ce..ddd6e9603 100644 --- a/docs/self-hosted/index.mdx +++ b/docs/self-hosted/index.mdx @@ -34,10 +34,10 @@ Get started running Sourcegraph on-prem. ## [Upgrade Sourcegraph](/self-hosted/updates) - [Upgrade Overview](/self-hosted/updates/) -- [Docker Compose upgrades](/self-hosted/updates/docker-compose) -- [Kubernetes upgrades](/self-hosted/updates/kubernetes) +- [Docker Compose upgrades](https://sourcegraph.com/changelog/self-hosted/docker-compose) +- [Kubernetes upgrades](https://sourcegraph.com/changelog/self-hosted/kubernetes) - [Pure Docker upgrades](/self-hosted/updates/pure-docker) -- [Server upgrades](/self-hosted/updates/server) +- [Server upgrades](https://sourcegraph.com/changelog/self-hosted/server) - [Migrator](/self-hosted/updates/migrator/) - [Upgrading PostgreSQL](/self-hosted/postgres#upgrading-postgresql) diff --git a/docs/self-hosted/updates/automatic.mdx b/docs/self-hosted/updates/automatic.mdx index 4757b0e7b..5afe24d18 100644 --- a/docs/self-hosted/updates/automatic.mdx +++ b/docs/self-hosted/updates/automatic.mdx @@ -16,7 +16,7 @@ From **Sourcegraph 5.1 through 6.11.x**, multi-version upgrades could be perform 1. Determine if your instance is ready to Upgrade: 1. Check your Sourcegraph instances `Site admin > Updates` page. ([more info](/self-hosted/updates/#upgrade-readiness)) - 2. Consult upgrade notes for your deployment type accross the range of your upgrade. ([Kubernetes](/self-hosted/updates/kubernetes), [Docker-compose](/self-hosted/updates/docker-compose), [Server](/self-hosted/updates/server)) + 2. Consult upgrade notes for your deployment type accross the range of your upgrade. ([Kubernetes](https://sourcegraph.com/changelog/self-hosted/kubernetes), [Docker-compose](https://sourcegraph.com/changelog/self-hosted/docker-compose), [Server](https://sourcegraph.com/changelog/self-hosted/server)) 2. Merge the latest Sourcegraph release into your deployment manifests. 3. With upstream changes to your manifests merged, start the new instance. diff --git a/docs/self-hosted/updates/docker-compose.mdx b/docs/self-hosted/updates/docker-compose.mdx deleted file mode 100644 index 21537373d..000000000 --- a/docs/self-hosted/updates/docker-compose.mdx +++ /dev/null @@ -1,329 +0,0 @@ -# Docker Compose Upgrade Notes - -This page lists the changes that are relevant for upgrading Sourcegraph on **Docker Compose**. - -For upgrade procedures or general info about sourcegraph versioning see the links below: - -- [Docker Compose Upgrade Procedures](/self-hosted/deploy/docker-compose/upgrade) -- [General Upgrade Info](/self-hosted/updates/) -- [Technical changelog](/technical-changelog) - -> **\*Attention:** These notes may contain relevant information about the infrastructure update such as resource requirement changes or versions of depencies (Docker, Docker Compose, externalized databases).\* -> -> **_If the notes indicate a patch release exists, target the highest one._** - -## v6.3 patch 1 - -- Grafana's port 3370 is no longer open by default for unauthenticated access for Docker Compose and Pure Docker deployments. Admins can still access Grafana by logging in to their Sourcegraph instance, navigating to the Site Admin page, then clicking Monitoring from the left navigation menu. If customers require port 3370 to be open, see [[PR 1204](https://github.com/sourcegraph/deploy-sourcegraph-docker/pull/1204/files)] for insight on how to add this port to their `docker-compose.override.yaml` file. - -## v6.2.2553 - -### Known issues - -Customers running Sourcegraph versions prior to v6.2.2553 and using the Sourcegraph provided PostgreSQL containers may encounter PostgreSQL collation version mismatch warnings after upgrading to more recent Sourcegraph versions due to an underlying glibc version update. - -When logging into the database via psql or similar tools you may see the following warning: - -```shell -WARNING: database "sg" has a collation version mismatch DETAIL: The database was created using collation version 2.40, but the operating system provides version 2.41. -``` - -Mismatched collation versions can lead to database index corruption if left unchecked. - -Affected Services - -- pgsql container -- codeintel-db container -- codeinsights-db container - -Only self-hosted customers using the Sourcegraph provided PostgreSQL container images are affected. - -Self-hosted customers using external databases, such as AWS RDS, GCP CloudSQL, or another self-managed solution are NOT affected. - -See our [PostgreSQL Collation Version Mismatch Resolution](/self-hosted/postgresql-collation-version-mismatch-resolution) notes for more details. - -## v6.0.0 - -- Sourcegraph 6.0.0 no longer supports PostgreSQL 12, admins must upgrade to PostgreSQL 16. See our [postgres 12 end of life](/self-hosted/postgres12-end-of-life-notice) notice! As well as [supporting documentation](/self-hosted/postgres) and advisements on how to upgrade. - -## v5.9.0 ➔ v5.10.1164 - -- This release resolves an issue in the v5.10.0 release which prevented multiversion upgrades from working. You may now target `v5.10.1164` using migrator's `upgrade` command. - -> **Note:** For versions prior to 6.12.0, you could also use autoupgrade by setting the environment variable `SRC_AUTOUPGRADE_IGNORE_DRIFT=true` on the `frontend` container. Autoupgrade has been removed in Sourcegraph 6.12.0 and later. - -## v5.9.0 ➔ v5.10.0 - -> Warning: Admins are advised to upgrade directly to v5.10.1164 circumventing this release. -> -> Warning: This release updates the database container images from Postgres 12 to Postgres 16, and begins using Wolfi based images. Customers are advised to take a database backup before upgrading! See our [postgres 12 end of life](https://sourcegraph.com/docs/self-hosted/postgres12-end-of-life-notice#postgres-12-end-of-life) notice! -> -> Warning: `automatic` and migrator `upgrade` command will not work for this release, please upgrade directly to `v5.10.1164`, or to a 5.9 version and conduct a standard upgrade using migrator's default `up` command! - -#### Notes: - -- The container image for pgsql and codeintel-db have been renamed from `postgres-12-alpine` and `codeintel-db` respectively to `postgresql-16`. The `codeinsights-db` container has been renamed to `postgresql-16-codeinsights`. -- **Admins using external dbs who have not yet upgraded from postgres 12 to postgres 16**, can expect to see database drift after upgrading to `5.10.0`. The new expected schema definition for Sourcegraph is based on postgres 16. The schema drift is the result of automatic changes made to the schema by pg_upgrade utils, and will not cause issues in the application. - - Admins should not run migrators suggested drift fixes, and should instead upgrade their database from postgres 12 to postgres 16. -- For versions prior to 6.12.0, the [Autoupgrade](/self-hosted/updates/automatic) upgrade method would detect drift and exit before conducting the upgrade unless the env var `SRC_AUTOUPGRADE_IGNORE_DRIFT=true` was set in the server container. **Note:** Autoupgrade has been removed in Sourcegraph 6.12.0 and later. -- Postgres 12 image containers cannot be started with data volumes which have been upgraded by postgres 16. - -## v5.1.4 ➔ v5.1.5 - -#### Notes: - -- Upgrades from versions `v5.0.3`, `v5.0.4`, `v5.0.5`, and `v5.0.6` to `v5.1.5` are affected by an ordering error in the `frontend` databases migration tree. - -## v5.1.3 ➔ v5.1.4 - -#### Notes: - -- Migrator images were built without the `v5.1.x` tag in this version, as such multiversion upgrades using this image version will fail to upgrade to versions in `v5.1.x`. - -## v5.1.2 ➔ v5.1.3 - -#### Notes: - -- Migrator images were built without the `v5.1.x` tag in this version, as such multiversion upgrades using this image version will fail to upgrade to versions in `v5.1.x`. - -## v5.1.1 ➔ v5.1.2 - -#### Notes: - -- Migrator images were built without the `v5.1.x` tag in this version, as such multiversion upgrades using this image version will fail to upgrade to versions in `v5.1.x`. - -## v5.1.0 ➔ v5.1.1 - -#### Notes: - -- Migrator images were built without the `v5.1.x` tag in this version, as such multiversion upgrades using this image version will fail to upgrade to versions in `v5.1.x`. - -## v5.0.6 ➔ v5.1.0 - -#### Notes: - -- See note under v5.1.5 release on issues with standard and multiversion upgrades to v5.1.5. - -## v5.0.5 ➔ v5.0.6 - -#### Notes: - -- See note under v5.1.5 release on issues with standard and multiversion upgrades to v5.1.5. - -## v5.0.4 ➔ v5.0.5 - -#### Notes: - -- See note under v5.1.5 release on issues with standard and multiversion upgrades to v5.1.5. - -## v5.0.3 ➔ v5.0.4 - -#### Notes: - -- See note under v5.1.5 release on issues with standard and multiversion upgrades to v5.1.5. - -## v4.4.2 ➔ v4.5.0 - -#### Notes: - -This release introduces a background job that will convert all LSIF data into SCIP. **This migration is irreversible** and a rollback from this version may result in loss of precise code intelligence data. Please see the [migration notes](/admin/how-to/lsif-scip-migration) for more details. - -## v4.3 ➔ v4.4.1 - -#### Notes: - -- Users attempting a multi-version upgrade to v4.4.0 may be affected by a bug in which an outdated schema migration is included in the upgrade process. _This issue is fixed in patch v4.4.2_ -- The error will be encountered while running `upgrade`, and contains the following text: `"frontend": failed to apply migration 1648115472`. - - To resolve this issue run migrator with the args `'add-log', '-db=frontend', '-version=1648115472'`. - - If migrator was stopped while running `upgrade` the next run of upgrade will encounter drift, this drift should be disregarded by providing migrator with the `--skip-drift-check` flag. - -## v4.1 ➔ v4.2.1 - -#### Notes: - -- This upgrade adds the [node-exporter](https://github.com/prometheus/node_exporter) deployment, which collects crucial machine-level metrics that help Sourcegraph scale your deployment. - -## v3.43 ➔ v4.0 - -#### Notes: - -- Target the tag [`v4.0.1`](https://github.com/sourcegraph/deploy-sourcegraph-docker/tree/v4.0.1/docker-compose) when fetching upstream from `deploy-sourcegraph-docker`. -- `jaeger` (deployed with the `jaeger-all-in-one` image) has been removed in favor of an [OpenTelemetry Collector](https://opentelemetry.io/docs/collector/) DaemonSet + Deployment configuration. See [Configure a tracing backend](/self-hosted/deploy/docker-compose/operations#configure-a-tracing-backend) -- Exporting traces to an external observability backend is now available. Read the [documentation](/self-hosted/deploy/docker-compose/operations#configure-a-tracing-backend) to configure. -- The bundled Jaeger instance is now disabled by default. It can be [enabled](/self-hosted/deploy/docker-compose/operations#enable-the-bundled-jaeger-deployment) if you do not wish to utilise your own external tracing backend. - -## v3.42 ➔ v3.43 - -#### Notes: - -- Target the tag [`v3.43.2`](https://github.com/sourcegraph/deploy-sourcegraph-docker/tree/v3.43.2/docker-compose) when fetching upstream from `deploy-sourcegraph-docker`. - -## v3.41 ➔ v3.42 - -#### Notes: - -- Target the tag [`v3.42.2`](https://github.com/sourcegraph/deploy-sourcegraph-docker/tree/v3.42.2/docker-compose) when fetching upstream from `deploy-sourcegraph-docker`. - -## v3.40 ➔ v3.41 - -#### Notes: - -- Target the tag [`v3.41.0`](https://github.com/sourcegraph/deploy-sourcegraph-docker/tree/v3.41.0/docker-compose) when fetching upstream from `deploy-sourcegraph-docker`. -- `caddy` is upgraded to version 2.5.1 and contains a breaking change from version 2.5.0. Incoming `X-Forwarded-*` headers will no longer be trusted automatically. In order to preserve existing product functionality, the Caddyfile was updated to trust all incoming `X-Forwarded-*` headers. [#828](https://github.com/sourcegraph/deploy-sourcegraph-docker/pull/828) -- The Postgres DBs `frontend` and `codeintel-db` are now given 1 hour to begin accepting connections before Kubernetes restarts the containers. [#4136](https://github.com/sourcegraph/deploy-sourcegraph/pull/4136) - -## v3.39 ➔ v3.40 - -#### Notes: - -- Target the tag [`v3.40.2`](https://github.com/sourcegraph/deploy-sourcegraph-docker/tree/v3.40.2/docker-compose) when fetching upstream from `deploy-sourcegraph-docker`. -- `cadvisor` now defaults to run in `privileged` mode. This allows `cadvisor` to collect out of memory events happening to containers which can be used to discover underprovisoned resources. [#804](https://github.com/sourcegraph/deploy-sourcegraph-docker/pull/804) - -## v3.38 ➔ v3.39 - -#### Notes: - -- Target the tag [`v3.39.1`](https://github.com/sourcegraph/deploy-sourcegraph-docker/tree/v3.39.1/docker-compose) when fetching upstream from `deploy-sourcegraph-docker`. - -- `v3.39.1` - -#### Notes: - -- We made a number of changes to our built-in postgres databases (the `pgsql`, `codeintel-db`, and `codeinsights-db` container) - - **CAUTION**: Added the ability to customize postgres server configuration by mounting external configuration files. If you have customized the config in any way, you should copy your changes to the added `postgresql.conf` files [sourcegraph/deploy-sourcegraph-docker#792](https://github.com/sourcegraph/deploy-sourcegraph-docker/pull/792). - - Increased the minimal memory requirement of `pgsql` and `codeintel-db` from `2GB` to `4GB`. -`codeinsights-db` container no longer uses TimescaleDB and is now based on the standard Postgres image [sourcegraph/deploy-sourcegraph-docker#780](https://github.com/sourcegraph/deploy-sourcegraph-docker/pull/780). Metrics scraping is also enabled. - -## v3.37 ➔ v3.38 - -#### Notes: - -- Target the tag [`v3.38.1`](https://github.com/sourcegraph/deploy-sourcegraph-docker/tree/v3.38.1/docker-compose) when fetching upstream from `deploy-sourcegraph-docker`. - -- `v3.38.1` - -#### Notes: - -- **Minimum version of 1.29 for docker compose is required for this update** -- This release adds the requirement that the environment variables `SRC_GIT_SERVERS`, `SEARCHER_URL`, `SYMBOLS_URL`, and `INDEXED_SEARCH_SERVERS` are set for the worker process. - -## v3.36 ➔ v3.37 - -#### Notes: - -- Target the tag [`v3.37.0`](https://github.com/sourcegraph/deploy-sourcegraph-docker/tree/v3.37.0/docker-compose) when fetching upstream from `deploy-sourcegraph-docker`. -- This release adds a new container that runs database migrations (`migrator`) independently of the frontend container. Confirm the environment variables on this new container match your database settings. -- **If performing a multiversion upgrade from an instance prior to this version see our [upgrading early versions documentation](/self-hosted/updates/migrator/upgrading-early-versions#before-v3370)** - -## v3.35 ➔ v3.36 - -#### Notes: - -- Target the tag [`v3.36.0`](https://github.com/sourcegraph/deploy-sourcegraph-docker/tree/v3.36.0/docker-compose) when fetching upstream from `deploy-sourcegraph-docker`. - -## v3.34 ➔ v3.35 - -#### Notes: - -- Target the tag [`v3.35.1`](https://github.com/sourcegraph/deploy-sourcegraph-docker/tree/v3.35.1/docker-compose) when fetching upstream from `deploy-sourcegraph-docker`. -- The `query-runner` service has been decommissioned in the 3.35 release and will be removed during the upgrade. To delete the `query-runner` service, specify `--remove-orphans` to your `docker-compose` command. -- There is a [known issue](/code-insights/how-tos/Troubleshooting#oob-migration-has-made-progress-but-is-stuck-before-reaching-100) with the Code Insights out-of-band settings migration not reaching 100% complete when encountering deleted users or organizations. - -## v3.33 ➔ v3.34 - -#### Notes: - -- Target the tag [`v3.34.0`](https://github.com/sourcegraph/deploy-sourcegraph-docker/tree/v3.34.0/docker-compose) when fetching upstream from `deploy-sourcegraph-docker`. - -## v3.32 ➔ v3.33 - -#### Notes: - -- Target the tag [`v3.33.0`](https://github.com/sourcegraph/deploy-sourcegraph-docker/tree/v3.33.0/docker-compose) when fetching upstream from `deploy-sourcegraph-docker`. - -## v3.31 ➔ v3.32 - -#### Notes: - -- Target the tag [`v3.32.0`](https://github.com/sourcegraph/deploy-sourcegraph-docker/tree/v3.32.0/docker-compose) when fetching upstream from `deploy-sourcegraph-docker`. - -## v3.30 ➔ v3.31 - -> WARNING: **This upgrade must originate from `v3.30.3`.** - -#### Notes: - -- Target the tag [`v3.31.2`](https://github.com/sourcegraph/deploy-sourcegraph-docker/tree/v3.31.2/docker-compose) when fetching upstream from `deploy-sourcegraph-docker`. -- The **built-in** main Postgres (`pgsql`) and codeintel (`codeintel-db`) databases have switched to an alpine-based Docker image. Upon upgrading, Sourcegraph will need to re-index the entire database. - -## v3.29 ➔ v3.30 - -> WARNING: **If you have already upgraded to 3.30.0, 3.30.1, or 3.30.2** please see the rebuild corrupt postgres indexes guide for recovery steps. - -#### Notes: - -- Target the tag [`v3.30.3`](https://github.com/sourcegraph/deploy-sourcegraph-docker/tree/v3.30.3/docker-compose) when fetching upstream from `deploy-sourcegraph-docker`. - -## v3.28 ➔ v3.29 - -#### Notes: - -- Target the tag [`v3.29.0`](https://github.com/sourcegraph/deploy-sourcegraph-docker/tree/v3.29.0/docker-compose) when fetching upstream from `deploy-sourcegraph-docker`. -- This upgrade adds a new `worker` service that runs a number of background jobs that were previously run in the `frontend` service. See [notes on deploying workers](/self-hosted/workers#deploying-workers) for additional details. Good initial values for CPU and memory resources allocated to this new service should match the `frontend` service. - -## v3.27 ➔ v3.28 - -#### Notes: - -- Target the tag [`v3.28.0`](https://github.com/sourcegraph/deploy-sourcegraph-docker/tree/v3.28.0/docker-compose) when fetching upstream from `deploy-sourcegraph-docker`. -- The memory requirements for `redis-cache` and `redis-store` have been increased by 1GB. See https://github.com/sourcegraph/deploy-sourcegraph-docker/pull/373 for more context. - -## v3.26 ➔ v3.27 - -> WARNING: Sourcegraph 3.27 now requires **Postgres 12+**. - -#### Notes: - -- Target the tag [`v3.27.0`](https://github.com/sourcegraph/deploy-sourcegraph-docker/tree/v3.27.0/docker-compose) when fetching upstream from `deploy-sourcegraph-docker`. -- If you are using an external database, [upgrade your database](/self-hosted/postgres#upgrading-external-postgresql-instances) to Postgres 12 or above prior to upgrading Sourcegraph. No action is required if you are using the supplied supplied database images. -- **If performing a multiversion upgrade from an instance prior to this version see our [upgrading early versions documentation](/self-hosted/updates/migrator/upgrading-early-versions#before-v3270)** - -## v3.25 ➔ v3.26 - -#### Notes: - -- Target the tag [`v3.26.0`](https://github.com/sourcegraph/deploy-sourcegraph-docker/tree/v3.26.0/docker-compose) when fetching upstream from `deploy-sourcegraph-docker`. - -## v3.24 ➔ v3.25 - -#### Notes: - -- Target the tag [`v3.25.0`](https://github.com/sourcegraph/deploy-sourcegraph-docker/tree/v3.25.0/docker-compose) when fetching upstream from `deploy-sourcegraph-docker`. -- Go `1.15` introduced changes to SSL/TLS connection validation which requires certificates to include a `SAN`. This field was not included in older certificates and clients relied on the `CN` field. You might see an error like `x509: certificate relies on legacy Common Name field`. We recommend that customers using Sourcegraph with an external database and and connecting to it using SSL/TLS check whether the certificate is up to date. - - AWS RDS customers please reference [AWS' documentation on updating the SSL/TLS certificate](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL-certificate-rotation.html) for steps to rotate your certificate. - -## v3.23 ➔ v3.24 - -#### Notes: - -- Target the tag [`v3.24.0`](https://github.com/sourcegraph/deploy-sourcegraph-docker/tree/v3.24.0/docker-compose) when fetching upstream from `deploy-sourcegraph-docker`. - -## v3.22 ➔ v3.23 - -#### Notes: - -- Target the tag [`v3.23.0`](https://github.com/sourcegraph/deploy-sourcegraph-docker/tree/v3.23.0/docker-compose) when fetching upstream from `deploy-sourcegraph-docker`. - -## v3.21 ➔ v3.22 - -#### Notes: - -- Target the tag [`v3.22.0`](https://github.com/sourcegraph/deploy-sourcegraph-docker/tree/v3.22.0/docker-compose) when fetching upstream from `deploy-sourcegraph-docker`. -- This upgrade removes the `code intel bundle manager`. This service has been deprecated and all references to it have been removed. -- This upgrade also adds a MinIO container that doesn't require any custom configuration. You can find more detailed documentation [here](/self-hosted/external-services/object-storage). - -## v3.20 ➔ v3.21 - -#### Notes: - -- Target the tag [`v3.21.1`](https://github.com/sourcegraph/deploy-sourcegraph-docker/tree/v3.21.1/docker-compose) when fetching upstream from `deploy-sourcegraph-docker`. -- This release introduces a second database instance, `codeintel-db`. If you have configured Sourcegraph with an external database, then update the `CODEINTEL_PG*` environment variables to point to a new external database as described in the [external database documentation](/self-hosted/external-services/postgres). Again, these must not point to the same database or the Sourcegraph instance will refuse to start. diff --git a/docs/self-hosted/updates/index.mdx b/docs/self-hosted/updates/index.mdx index dc9df0b09..991e1b781 100644 --- a/docs/self-hosted/updates/index.mdx +++ b/docs/self-hosted/updates/index.mdx @@ -116,7 +116,7 @@ If your instance has schema drift or unfinished oob migrations you may need to a - **Sourcegraph with Docker Compose** - [Standard Upgrade Operations](/self-hosted/deploy/docker-compose/upgrade#standard-upgrades) - [Multiversion Upgrade Operations](/self-hosted/deploy/docker-compose/upgrade#multi-version-upgrades) - - [Upgrade Notes](/self-hosted/updates/docker-compose) + - [Upgrade Notes](https://sourcegraph.com/changelog/self-hosted/docker-compose) - **Sourcegraph with Kubernetes** - **Kustomize** - [Standard Upgrade Operations](/self-hosted/deploy/kubernetes/upgrade#standard-upgrades) @@ -124,11 +124,11 @@ If your instance has schema drift or unfinished oob migrations you may need to a - **Helm** - [Standard Upgrade Operations](/self-hosted/deploy/kubernetes#standard-upgrades) - [Multiversion Upgrade Operations](/self-hosted/deploy/kubernetes#multi-version-upgrades) - - [Upgrade Notes](/self-hosted/updates/kubernetes) + - [Upgrade Notes](https://sourcegraph.com/changelog/self-hosted/kubernetes) - **Single-container Sourcegraph with Docker** - [Standard Upgrade Operations](/self-hosted/deploy/docker-single-container/#standard-upgrades) - [Multiversion Upgrade Operations](/self-hosted/deploy/docker-single-container/#multi-version-upgrades) - - [Upgrade Notes](/self-hosted/updates/server) + - [Upgrade Notes](https://sourcegraph.com/changelog/self-hosted/server) - [**Pure-docker custom deployments**](/self-hosted/updates/pure-docker) - [**Sourcegraph AWS AMI instances**](/self-hosted/deploy/machine-images/aws-ami#upgrade) diff --git a/docs/self-hosted/updates/kubernetes.mdx b/docs/self-hosted/updates/kubernetes.mdx deleted file mode 100644 index 9fae561d8..000000000 --- a/docs/self-hosted/updates/kubernetes.mdx +++ /dev/null @@ -1,266 +0,0 @@ -# Kubernetes Sourcegraph Upgrade Notes - -This page lists the changes that are relevant for upgrading Sourcegraph on **Kubernetes with Kustomize and Helm**. - -For upgrade procedures or general info about sourcegraph versioning see the links below: - -- [Kubernetes Kustomize Upgrade Procedures](/self-hosted/deploy/kubernetes/upgrade) -- [Kubernetes Helm Upgrade Procedures](/self-hosted/deploy/kubernetes#upgrading-sourcegraph) -- [General Upgrade Info](/self-hosted/updates) -- [Technical changelog](/technical-changelog) - -> **\*Attention:** These notes may contain relevant information about the infrastructure update such as resource requirement changes or versions of dependencies (Docker, kubernetes, externalized databases).\* -> -> **_If the notes indicate a patch release exists, target the highest one._** - -## v6.10.0 - -- Port names have been updated on services and pods, to unblock Kubernetes service meshes from auto-configuring themselves for the traffic type, since most inter-pod communication has been switched from http to gRPC [[PR 756](https://github.com/sourcegraph/deploy-sourcegraph-helm/pull/756)]. If you are using Istio (or similar service meshes), and [our Envoy filter example](https://github.com/sourcegraph/deploy-sourcegraph-helm/tree/main/charts/sourcegraph/examples/envoy), and your pods fail to communicate after upgrading to >= v6.10, please remove the Envoy filter and try again so your service mesh can auto-configure itself based on the new port names. - -## v6.4.0 - -- The repo-updater service is no longer needed and will be removed from deployment methods going forward. -- The symbols service and searcher service have been merged and symbols will be removed from deployment methods going forward. Consider moving env vars set on symbols to the searcher deployment before upgrading and reallocating resources from symbols to searcher. - -## v6.2.2553 - -### Known issues - -Customers running Sourcegraph versions prior to v6.2.2553 and using the Sourcegraph provided PostgreSQL containers may encounter PostgreSQL collation version mismatch warnings after upgrading to more recent Sourcegraph versions due to an underlying glibc version update. - -When logging into the database via psql or similar tools you may see the following warning: - -```shell -WARNING: database "sg" has a collation version mismatch DETAIL: The database was created using collation version 2.40, but the operating system provides version 2.41. -``` - -Mismatched collation versions can lead to database index corruption if left unchecked. - -Affected Services - -- pgsql container -- codeintel-db container -- codeinsights-db container - -Only self-hosted customers using the Sourcegraph provided PostgreSQL container images are affected. - -Self-hosted customers using external databases, such as AWS RDS, GCP CloudSQL, or another self-managed solution are NOT affected. - -See our [PostgreSQL Collation Version Mismatch Resolution](/self-hosted/postgresql-collation-version-mismatch-resolution) notes for more details. - -## v6.0.0 - -- Sourcegraph 6.0.0 no longer supports PostgreSQL 12, admins must upgrade to PostgreSQL 16. See our [postgres 12 end of life](/self-hosted/postgres12-end-of-life-notice) notice! As well as [supporting documentation](/self-hosted/postgres) and advisements on how to upgrade. -- - The Kubernetes Helm deployment type does not support MVU from - Sourcegraph `v5.9.45` versions and earlier to Sourcegraph `v6.0.0`. - Admins seeking to upgrade to Sourcegraph `v6.0.0` should upgrade to - `v5.11.6271` then use the standard upgrade procedure to get to `v6.0.0`. - This is because migrator v6.0.0 will no longer connect to Postgres 12 - databases. For more info see our [PostgreSQL upgrade - docs](/self-hosted/postgres#requirements). - - -## v5.9.0 ➔ v5.10.1164 - -- This release resolves an issue in the v5.10.0 release which prevented multiversion upgrades from working. You may now target `v5.10.1164` using migrator's `upgrade` command. - -> **Note:** For versions prior to 6.12.0, you could also use autoupgrade by setting the environment variable `SRC_AUTOUPGRADE_IGNORE_DRIFT=true` on the `frontend` deployment. Autoupgrade has been removed in Sourcegraph 6.12.0 and later. - -## v5.9.0 ➔ v5.10.0 - -> Warning: Admins are advised to upgrade directly to v5.10.1164 circumventing this release. -> -> Warning: This release updates the database container images from Postgres 12 to Postgres 16, and begins using Wolfi based images. Customers are advised to take a database backup before upgrading! See our [postgres 12 end of life](https://sourcegraph.com/docs/self-hosted/postgres12-end-of-life-notice#postgres-12-end-of-life) notice! -> -> Warning: `automatic` and migrator `upgrade` command will not work for this release, please upgrade directly to `v5.10.1164`, or to a 5.9 version and conduct a standard upgrade using migrator's default `up` command! - -#### Notes: - -- The container image for pgsql and codeintel-db have been renamed from `postgres-12-alpine` and `codeintel-db` respectively to `postgresql-16`. The `codeinsights-db` container has been renamed to `postgresql-16-codeinsights`. -- **Admins using external dbs who have not yet upgraded from postgres 12 to postgres 16**, can expect to see database drift after upgrading to `5.10.0`. The new expected schema definition for Sourcegraph is based on postgres 16. The schema drift is the result of automatic changes made to the schema by pg_upgrade utils, and will not cause issues in the application. - - Admins should not run migrators suggested drift fixes, and should instead upgrade their database from postgres 12 to postgres 16. -- Postgres 12 image containers cannot be started with data volumes which have been upgraded by postgres 16. - -## v5.1.0 -> v5.2.0 - -#### Notes: - -- The GitHub proxy service has been removed and is no longer required. You can safely remove it. - -## v5.1.6 ➔ v5.1.7 - -#### Notes: - -- v5.1.7 of the [`deploy-sourcegraph-helm`](https://github.com/sourcegraph/deploy-sourcegraph-helm) repo was initially released with the precise-code-intel worker service unable to write to `/tmp`. The release was [overwritten](https://github.com/sourcegraph/deploy-sourcegraph-helm/pull/343/files), users who have not yet upgraded will be unaffected. Users who have already upgraded may ammend this issue by pulling in the fix with `helm repo update` and rerunning `helm upgrade`. - -## v5.1.4 ➔ v5.1.5 - -#### Notes: - -- Upgrades from versions `v5.0.3`, `v5.0.4`, `v5.0.5`, and `v5.0.6` to `v5.1.5` are affected by an ordering error in the `frontend` databases migration tree. - -## v4.4.2 ➔ v4.5.0 - -#### Notes: - -- Our new [`kustomize` repo](https://github.com/sourcegraph/deploy-sourcegraph-k8s) is introduced. Admins are advised to follow our [migrate procedure](/self-hosted/deploy/kubernetes/kustomize/migrate) to migrate away from our [legacy deployment](https://github.com/sourcegraph/deploy-sourcegraph) - - - **See our [note](/self-hosted/deploy/kubernetes/upgrade#using-mvu-to-migrate-to-kustomize) on multiversion upgrades coinciding with this migration. Admins are advised to stop at this version, [migrate](/self-hosted/deploy/kubernetes/kustomize/migrate), and then proceed with upgrading.** - -- This release introduces a background job that will convert all LSIF data into SCIP. **This migration is irreversible** and a rollback from this version may result in loss of precise code intelligence data. Please see the [migration notes](/admin/how-to/lsif-scip-migration) for more details. - -**Kubernetes with Helm** - -- Searcher and Symbols now use StatefulSets and PVCs to avoid large `ephermeralStorage` requests [#242](https://github.com/sourcegraph/deploy-sourcegraph-helm/pull/242) -- This release updates `searcher` and `symbols` services to be headless. - - Before upgrading, delete your `searcher` and `symbols` services (ex: `kubectl delete svc/searcher svc/symbols`) [#250](https://github.com/sourcegraph/deploy-sourcegraph-helm/pull/250) -- An env var `CACHE_DIR` was renamed to `SYMBOLS_CACHE_DIR` in `sourcegraph/sourcegraph`. This change was missed in the Helm charts, which caused a permissions issue during some symbols searches. For more details, see the PR to fix the env var: [#258](https://github.com/sourcegraph/deploy-sourcegraph-helm/pull/258). - - A revision to the 4.5.1 chart (`4.5.1-rev.1`) was released to address the above issue. Use this revision for upgrades to 4.5.1. (ex: `helm upgrade --install --version 4.5.1-rev.1`) [#259](https://github.com/sourcegraph/deploy-sourcegraph-helm/pull/259) - -## v4.3 ➔ v4.4.1 - -#### Notes: - -- Users attempting a multi-version upgrade to v4.4.0 may be affected by a bug in which an outdated schema migration is included in the upgrade process. _This issue is fixed in patch v4.4.2_ - - - The error will be encountered while running `upgrade`, and contains the following text: `"frontend": failed to apply migration 1648115472`. - - To resolve this issue run migrator with the args `'add-log', '-db=frontend', '-version=1648115472'`. - - If migrator was stopped while running `upgrade` the next run of upgrade will encounter drift, this drift should be disregarded by providing migrator with the `--skip-drift-check` flag. - -## v4.1 ➔ v4.2.1 - -#### Notes: - -- The `worker-executors` Service object is now included in manifests generated using `kustomize`. This object was already introduced in the base manifest, but omitted from manifests generated using `kustomize`. Its purpose is to enable ingested executor metrics to be scraped by Prometheus. It should have no impact on behavior. -- `minio` has been replaced with `blobstore`. Please see the update notes [here](/self-hosted/how-to/blobstore-update-notes) -- This upgrade adds a [node-exporter](https://github.com/prometheus/node_exporter) DaemonSet, which collects crucial machine-level metrics that help Sourcegraph scale your deployment. - - - **Note**: Similarly to `cadvisor`, `node-exporter`: - - runs as a DaemonSet - - needs to mount various read-only directories from the host machine (`/`, `/proc`, and `/sys`) - - ideally shares the machine's PID namespace - - For more information, see [deploy-sourcegraph-helm's Changelog](https://github.com/sourcegraph/deploy-sourcegraph-helm/blob/main/charts/sourcegraph/CHANGELOG) or contact customer support. - -## v3.43 ➔ v4.0 - -#### Notes: - -- `jaeger-agent` sidecars have been removed in favor of an [OpenTelemetry Collector](https://opentelemetry.io/docs/collector/) DaemonSet + Deployment configuration. See [Configure a tracing backend section.](#configure-a-tracing-backend) -- Exporting traces to an external observability backend is now available. Read the [documentation](/self-hosted/deploy/kubernetes/configure#configure-a-tracing-backend) to configure. -- The bundled Jaeger instance is now disabled by default. It can be [enabled](/self-hosted/deploy/kubernetes/configure#enable-the-bundled-jaeger-deployment) if you do not wish to utilise your own external tracing backend. - -## v3.40 ➔ v3.41 - -#### Notes: - -- The Postgres DBs `frontend` and `codeintel-db` are now given 1 hour to begin accepting connections before Kubernetes restarts the containers. [#4136](https://github.com/sourcegraph/deploy-sourcegraph/pull/4136) - -## v3.39 ➔ v3.40 - -#### Notes: - -- `cadvisor` now defaults to run in `privileged` mode. This allows `cadvisor` to collect out of memory events happening to containers which can be used to discover underprovisoned resources. This is disabled by default in `non-privileged` overlay. [#4126](https://github.com/sourcegraph/deploy-sourcegraph/pull/4126) -- Updated the Nginx ingress controller to v1.2.0. Previously this image originated from quay.io, now it is pulled from the official k8s repository. A redeployment of the ingress - controller may be necessary if your deployment used the manifests provided in `configure/ingress-nginx`. [#4128](https://github.com/sourcegraph/deploy-sourcegraph/pull/4128) -- The alpine-3.12 docker images used as init containers for some deployments have been replaced with images based on alpine-3.14. [#4129](https://github.com/sourcegraph/deploy-sourcegraph/pull/4129) - -## v3.38 ➔ v3.39 - -#### Notes: - -- The`codeinsights-db` container no longer uses TimescaleDB and is now based on the standard Postgres image [sourcegraph/deploy-sourcegraph#4103](https://github.com/sourcegraph/deploy-sourcegraph/pull/4103). Metrics scraping is also enabled. -- **CAUTION**: If you use a custom Code Insights postgres config, you must update the `shared_preload_libraries` list to remove timescaledb. The [above PR](https://github.com/sourcegraph/deploy-sourcegraph/pull/4103/files#diff-e5f8d6e46f8c9335c489c0d8e9ae9be4f4655f878f3ac569c73ebb3865b0eeeeL695-R688) demonstrates this change. - -## v3.36 ➔ v3.37 - -#### Notes: - -- This release adds a new `migrator` initContainer to the frontend deployment to run database migrations. Confirm the environment variables on this new container match your database settings. [Docs](/self-hosted/deploy/kubernetes/#database-migrations) -- **If performing a multiversion upgrade from an instance prior to this version see our [upgrading early versions documentation](/self-hosted/updates/migrator/upgrading-early-versions#before-v3370)** - -## v3.35 ➔ v3.36 - -#### Notes: - -- The `backend` service has been removed, so if you deploy with a method other than `kubectl-apply-all.sh`, a manual removal of the service may be necessary. - -## v3.34 ➔ v3.35 - -#### Notes: - -- The query-runner deployment has been removed, so if you deploy with a method other than the `kubectl-apply-all.sh`, a manual removal of the deployment may be necessary. - Follow the [standard upgrade procedure](/self-hosted/deploy/kubernetes/upgrade) to upgrade your deployment. -- There is a [known issue](/code-insights/how-tos/Troubleshooting#oob-migration-has-made-progress-but-is-stuck-before-reaching-100) with the Code Insights out-of-band settings migration not reaching 100% complete when encountering deleted users or organizations. - -## v3.30 ➔ v3.31 - -> WARNING: **This upgrade must originate from `v3.30.3`.** - -#### Notes: - -- The **built-in** main Postgres (`pgsql`) and codeintel (`codeintel-db`) databases have switched to an alpine-based Docker image. Upon upgrading, Sourcegraph will need to re-index the entire database. - -## v3.29 ➔ v3.30 - -> WARNING: **If you have already upgraded to 3.30.0, 3.30.1, or 3.30.2** please see the rebuild corrupt postgres indexes guide for recovery steps. - -#### Notes: - -- This upgrade removes the `non-root` overlay, in favor of using only the `non-privileged` overlay for deploying Sourcegraph in secure environments. If you were - previously deploying using the `non-root` overlay, you should now generate overlays using the `non-privileged` overlay. - -## v3.28 ➔ v3.29 - -#### Notes: - -- This upgrade adds a new `worker` service that runs a number of background jobs that were previously run in the `frontend` service. See [notes on deploying workers](/self-hosted/workers#deploying-workers) for additional details. Good initial values for CPU and memory resources allocated to this new service should match the `frontend` service. - -## v3.27 ➔ v3.28 - -#### Notes: - -- All Sourcegraph images now have a registry prefix. [#2901](https://github.com/sourcegraph/deploy-sourcegraph/pull/2901) -- The memory requirements for `redis-cache` and `redis-store` have been increased by 1GB. See https://github.com/sourcegraph/deploy-sourcegraph/pull/2898 for more context. - -## v3.26 ➔ v3.27 - -> WARNING: Sourcegraph 3.27 now requires **Postgres 12+**. - -#### Notes: - -> WARNING: We have updated the default replicas for `sourcegraph-frontend` and `precise-code-intel-worker` to `2`. If you use a custom value, make sure you do not merge the replica change. - -> NOTE: The Postgres 12 database migration scales with the size of your database, and the resources provided to the container. -> Expect to have downtime relative to the size of your database. Additionally, you must ensure that have enough storage -> space to accommodate the migration. A rough guide would be 2x the current on-disk database size - -- If you are using an external database, [upgrade your database](/self-hosted/postgres#upgrading-external-postgresql-instances) to Postgres 12 or above prior to upgrading Sourcegraph. No action is required if you are using the supplied database images. -- **If performing a multiversion upgrade from an instance prior to this version see our [upgrading early versions documentation](/self-hosted/updates/migrator/upgrading-early-versions#before-v3270)** - -## v3.24 ➔ v3.25 - -#### Notes: - -- Go `1.15` introduced changes to SSL/TLS connection validation which requires certificates to include a `SAN`. This field was not included in older certificates and clients relied on the `CN` field. You might see an error like `x509: certificate relies on legacy Common Name field`. We recommend that customers using Sourcegraph with an external database and and connecting to it using SSL/TLS check whether the certificate is up to date. - - AWS RDS customers please reference [AWS' documentation on updating the SSL/TLS certificate](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL-certificate-rotation.html) for steps to rotate your certificate. - -## v3.21 ➔ v3.22 - -#### Notes: - -- This upgrade removes the `code intel bundle manager`. This service has been deprecated and all references to it have been removed. -- This upgrade also adds a MinIO container that doesn't require any custom configuration. You can find more detailed documentation in [here](/self-hosted/external-services/object-storage). - -## v3.20 ➔ v3.21 - -#### Notes: - -- This release introduces a second database instance, `codeintel-db`. If you have configured Sourcegraph with an external database, then update the `CODEINTEL_PG*` environment variables to point to a new external database as described in the [external database documentation](/self-hosted/external-services/postgres). Again, these must not point to the same database or the Sourcegraph instance will refuse to start. - -## v3.18 ➔ v3.19 - -#### Notes: - -- **WARNING**: If you use an overlay that does not reference one of the provided overlays, please add `- /admin/bases/pvcs` as an additional base to your `kustomization.yaml` file. Otherwise the PVCs could be pruned if `kubectl apply -prune` is used. diff --git a/docs/self-hosted/updates/server.mdx b/docs/self-hosted/updates/server.mdx deleted file mode 100644 index e8d68c948..000000000 --- a/docs/self-hosted/updates/server.mdx +++ /dev/null @@ -1,97 +0,0 @@ -# Single-image Sourcegraph Upgrade Notes - -This page lists the changes that are relevant for upgrading Sourcegraph on a **single-node Sourcegraph instance**. - -For upgrade procedures or general info about sourcegraph versioning see the links below: - -- [Single Container Upgrade Procedures](/self-hosted/deploy/docker-single-container#upgrade) -- [General Upgrade Info](/self-hosted/updates/) -- [Technical changelog](/technical-changelog) - -> **\*Attention:** These notes may contain relevant information about the infrastructure update such as resource requirement changes or versions of depencies (Docker, externalized databases).\* -> -> **_If the notes indicate a patch release exists, target the highest one._** - -## Unreleased - -## v5.9.0 ➔ v5.10.1164 - -- This release resolves an issue in the v5.10.0 release which prevented multiversion upgrades from working. You may now target `v5.10.1164` using migrator's `upgrade` command. - -> **Note:** For versions prior to 6.12.0, you could also use autoupgrade by setting the environment variable `SRC_AUTOUPGRADE_IGNORE_DRIFT=true` on the sourcegraph container. Autoupgrade has been removed in Sourcegraph 6.12.0 and later. - -## v5.9.0 -> v5.10.0 - -#### Notes: - -> Warning: Admins are advised to upgrade directly to v5.10.1164 circumventing this release. -> -> Warning: **In 5.10 the Sourcegraph database images are being updated from postgres 12 to postgres 16 to avoid postgres 12's end of life. This update will not yet be applied to Sourcegraph server's all in one database.** -> -> Warning: `automatic` and migrator `upgrade` command will not work for this release, please upgrade directly to `v5.10.1164`, or to a 5.9 version and conduct a standard upgrade using migrator's default `up` command! - -**What does this mean for admins?** - -- During the postgres version upgrade `pg_upgrade` automatically makes some changes to the database schema. -- The new canonical database schema is now based on postgres 16, the drift detection tool will report drift between the old and new database schema. This is expected and is a result of the postgres upgrade. -- Admins should not run migrators suggested drift fixes until the database is upgraded. - -## v5.0.6 ➔ v5.1.0 - -#### Notes: - -- The Docker Single Container Deployment image has switched to a Wolfi-based container image. Upon upgrading, Sourcegraph will need to re-index the entire database. - -## v4.4.2 ➔ v4.5.0 - -#### Notes: - -- This release introduces a background job that will convert all LSIF data into SCIP. **This migration is irreversible** and a rollback from this version may result in loss of precise code intelligence data. Please see the [migration notes](/admin/how-to/lsif-scip-migration) for more details. - -## v3.34 ➔ v3.35 - -#### Notes: - -- There is a [known issue](/code-insights/how-tos/Troubleshooting#oob-migration-has-made-progress-but-is-stuck-before-reaching-100) with the Code Insights out-of-band settings migration not reaching 100% complete when encountering deleted users or organizations. - -## v3.30 ➔ v3.31 - -> WARNING: **This upgrade must originate from `v3.30.3`.** - -#### Notes: - -- The **built-in** main Postgres (`pgsql`) and codeintel (`codeintel-db`) databases have switched to an alpine-based Docker image. Upon upgrading, Sourcegraph will need to re-index the entire database. - -## v3.29 ➔ v3.30 - -> WARNING: **If you have already upgraded to 3.30.0, 3.30.1, or 3.30.2** please see the rebuild corrupt postgres indexes guide for recovery steps. - -## v3.26 ➔ v3.27 - -> WARNING: Sourcegraph 3.27 now requires **Postgres 12+**. - -#### Notes: - -- If you are using an external database, [upgrade your database](/self-hosted/postgres#upgrading-external-postgresql-instances) to Postgres 12 or above prior to upgrading Sourcegraph. If you are using the embedded database, [prepare your data for migration](/self-hosted/postgres#upgrading-single-node-docker-deployments) prior to upgrading Sourcegraph. - -## v3.24 ➔ v3.25 - -#### Notes: - -- Go `1.15` introduced changes to SSL/TLS connection validation which requires certificates to include a `SAN`. This field was not included in older certificates and clients relied on the `CN` field. You might see an error like `x509: certificate relies on legacy Common Name field`. We recommend that customers using Sourcegraph with an external database and and connecting to it using SSL/TLS check whether the certificate is up to date. - - AWS RDS customers please reference [AWS' documentation on updating the SSL/TLS certificate](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL-certificate-rotation.html) for steps to rotate your certificate. - -## v3.21 ➔ v3.22 - -> WARNING: **This upgrade must originate from `v3.20.1`.** - -No upgrade notes. - -## v3.20 ➔ v3.21 - -> WARNING: **This upgrade must originate from `v3.17.2`** due to a patched bug in our release. - -#### Notes: - -- This release introduces a second database instance, `codeintel-db`. If you have configured Sourcegraph with an external database, then update the `CODEINTEL_PG*` environment variables to point to a new external database as described in the [external database documentation](/self-hosted/external-services/postgres). Again, these must not point to the same database or the Sourcegraph instance will refuse to start. -- **Turn off database secrets encryption**. In Sourcegraph version 3.20, we would automatically generate a secret key file (`/var/lib/sourcegraph/token`) inside the container for encrypting secrets stored in the database. However, it is not yet ready for general use and format of the secret key file might change. Therefore, it is best to delete the secret key file (`/var/lib/sourcegraph/token`) and turn off the database secrets encryption. diff --git a/docs/technical-changelog.mdx b/docs/technical-changelog.mdx index 54a143f2a..adbbca44e 100644 --- a/docs/technical-changelog.mdx +++ b/docs/technical-changelog.mdx @@ -12499,8 +12499,8 @@ The following PRs were merged onto the previous release branch but could not be - Added `codeIntelAutoIndexing.indexerMap` to site-config that allows users to update the indexers used when inferring precise code intelligence auto-indexing jobs (without having to overwrite the entire inference scripts). For example, `"codeIntelAutoIndexing.indexerMap": {"go": "my.registry/sourcegraph/lsif-go"}` will cause Go projects to use the specified container (in a alternative Docker registry). [#43199](https://github.com/sourcegraph/sourcegraph-public-snapshot/pull/43199) - Code Insights data points that do not contain any results will display zero instead of being omitted from the visualization. Only applies to insight data created after 4.2. [#43166](https://github.com/sourcegraph/sourcegraph-public-snapshot/pull/43166) - Sourcegraph ships with node-exporter, a Prometheus tool that provides hardware / OS metrics that helps Sourcegraph scale your deployment. See your deployment update for more information: - - [Kubernetes](/self-hosted/updates/kubernetes) - - [Docker Compose](/self-hosted/updates/docker-compose) + - [Kubernetes](https://sourcegraph.com/changelog/self-hosted/kubernetes) + - [Docker Compose](https://sourcegraph.com/changelog/self-hosted/docker-compose) - A structural search diagnostic to warn users when a language filter is not set. [#43835](https://github.com/sourcegraph/sourcegraph-public-snapshot/pull/43835) - GitHub/GitLab OAuth success/fail attempts are now a part of the audit log. [#43886](https://github.com/sourcegraph/sourcegraph-public-snapshot/pull/43886) - When rendering a file which is backed by Git LFS, we show a page informing the file is LFS and linking to the file on the codehost. Previously we rendered the LFS pointer. [#43686](https://github.com/sourcegraph/sourcegraph-public-snapshot/pull/43686) diff --git a/src/data/redirects.ts b/src/data/redirects.ts index 3fd90bf86..ed00c1ce4 100644 --- a/src/data/redirects.ts +++ b/src/data/redirects.ts @@ -6328,7 +6328,7 @@ const redirectsData = [ }, { source: '/admin/updates/docker_compose', - destination: '/self-hosted/updates/docker_compose', + destination: 'https://sourcegraph.com/changelog/self-hosted/docker-compose', permanent: true }, { @@ -6338,7 +6338,7 @@ const redirectsData = [ }, { source: '/admin/updates/kubernetes', - destination: '/self-hosted/updates/kubernetes', + destination: 'https://sourcegraph.com/changelog/self-hosted/kubernetes', permanent: true }, { @@ -6378,7 +6378,7 @@ const redirectsData = [ }, { source: '/admin/updates/server', - destination: '/self-hosted/updates/server', + destination: 'https://sourcegraph.com/changelog/self-hosted/server', permanent: true }, { @@ -7049,7 +7049,7 @@ const redirectsData = [ }, { source: '/self-hosted/updates/docker_compose', - destination: '/self-hosted/updates/docker-compose', + destination: 'https://sourcegraph.com/changelog/self-hosted/docker-compose', permanent: true }, {