diff --git a/docs/admin/auth/login-form.mdx b/docs/admin/auth/login-form.mdx index 38576c8a9..a681ef35d 100644 --- a/docs/admin/auth/login-form.mdx +++ b/docs/admin/auth/login-form.mdx @@ -6,8 +6,6 @@ The login form allows users to sign in to Sourcegraph using [configured auth pro ## Configuration -Supported for Sourcegraph versions 5.1 or more. - These options do not apply to [`builtin`](/admin/auth/#builtin-password-authentication) and [`http-header`](/admin/auth/#http-authentication-proxies) auth providers. diff --git a/docs/admin/auth/troubleshooting.mdx b/docs/admin/auth/troubleshooting.mdx index b73b8b6f3..9671de15c 100644 --- a/docs/admin/auth/troubleshooting.mdx +++ b/docs/admin/auth/troubleshooting.mdx @@ -2,7 +2,7 @@ ## Basic principles -As of 3.20, Sourcegraph supports 6 authentication methods as listed in our [User authentication (SSO)](/admin/auth) page, details about how to configure those methods should refer to the relevant document pages. +Sourcegraph supports 6 authentication methods as listed in our [User authentication (SSO)](/admin/auth) page, details about how to configure those methods should refer to the relevant document pages. Among these authentication methods, there are 4 that require Sourcegraph to send requests to the authentication provider, including GitHub OAuth, GitLab OAuth, OpenID Connect and SAML. diff --git a/docs/admin/code-hosts/aws-codecommit.mdx b/docs/admin/code-hosts/aws-codecommit.mdx index 54b70f895..6e58878c9 100644 --- a/docs/admin/code-hosts/aws-codecommit.mdx +++ b/docs/admin/code-hosts/aws-codecommit.mdx @@ -16,7 +16,7 @@ To connect AWS CodeCommit to Sourcegraph: ## AWS CodeCommit Git credentials -Since version **3.4** of Sourcegraph, the AWS CodeCommit service **requires** [Git credentials](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_ssh-keys.html#git-credentials-code-commit) in order to clone repositories via HTTPS. Git credentials consist of a username and a password that you can create in AWS IAM. +The AWS CodeCommit service **requires** [Git credentials](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_ssh-keys.html#git-credentials-code-commit) in order to clone repositories via HTTPS. Git credentials consist of a username and a password that you can create in AWS IAM. For detailed instructions on how to create the credentials in IAM, see: [Setup for HTTPS Users Using Git Credentials](https://docs.aws.amazon.com/codecommit/latest/userguide/setting-up-gc.html) diff --git a/docs/admin/code-hosts/github.mdx b/docs/admin/code-hosts/github.mdx index a63419b0c..e941d49a5 100644 --- a/docs/admin/code-hosts/github.mdx +++ b/docs/admin/code-hosts/github.mdx @@ -23,8 +23,6 @@ There are 2 ways to connect with GitHub: ## Using a GitHub App -Sourcegraph 5.1+ - {/* */} There are two ways to connect a GitHub App: @@ -378,7 +376,7 @@ Follow the link to [configure webhooks for permissions for Github](/admin/webhoo > NOTE: This is an experimental feature. -> WARNING: The following section is experimental and might not work properly anymore on new Sourcegraph versions (post 4.0+). Please prefer [configuring webhooks for permissions instead](/admin/webhooks/incoming#user-permissions) +> WARNING: The following section is experimental and might not work properly. Please prefer [configuring webhooks for permissions instead](/admin/webhooks/incoming#user-permissions) Github code host can leverage caching mechanisms to reduce the number of API calls used when syncing permissions. This can significantly reduce the amount of time it takes to perform a full cycle of permissions sync due to reduced instances of being rate limited by the code host, and is useful for code hosts with very large numbers of users and repositories. diff --git a/docs/admin/code-hosts/non-git.mdx b/docs/admin/code-hosts/non-git.mdx index fb4b8705c..5a5fcb3f0 100644 --- a/docs/admin/code-hosts/non-git.mdx +++ b/docs/admin/code-hosts/non-git.mdx @@ -11,7 +11,7 @@ Sourcegraph natively supports all Git-based Version Control Systems (VCSs) and c ## Use `src serve-git` -Since Sourcegraph 3.19 we recommend users to use [`src serve-git`](/admin/code-hosts/src-serve-git). `src serve-git` only provides the serving of git repositories (no snapshotting). We found users generally wanted to control the git repos and snapshotting complicated the setup. Additionally `src serve-git` uses a fast and modern git transfer protocol. +We recommend users to use [`src serve-git`](/admin/code-hosts/src-serve-git). `src serve-git` only provides the serving of git repositories (no snapshotting). We found users generally wanted to control the git repos and snapshotting complicated the setup. Additionally `src serve-git` uses a fast and modern git transfer protocol. ## Installing `src-expose` diff --git a/docs/admin/code-hosts/src-serve-git.mdx b/docs/admin/code-hosts/src-serve-git.mdx index 6e57b2338..f7017b6c8 100644 --- a/docs/admin/code-hosts/src-serve-git.mdx +++ b/docs/admin/code-hosts/src-serve-git.mdx @@ -49,7 +49,3 @@ docker run \ ``` To confirm this is working visit http://localhost:3434 - -## src-expose - -Before Sourcegraph 3.19 we recommend users to still use [`src-expose`](/admin/code-hosts/non-git). diff --git a/docs/admin/config/batch-changes.mdx b/docs/admin/config/batch-changes.mdx index f87655a59..8b6aaee93 100644 --- a/docs/admin/config/batch-changes.mdx +++ b/docs/admin/config/batch-changes.mdx @@ -206,8 +206,7 @@ To enable **commit signing as a site admin**, navigate to **Site Admin > Section ### Commit signing with GitHub apps - Commit signing with GitHub apps is currently in Beta and is supported with - Sourcegraph v5.1 or more. + Commit signing with GitHub apps is currently in Beta. Sourcegraph can be configured to [sign commits pushed to GitHub](https://docs.github.com/en/authentication/managing-commit-signature-verification/about-commit-signature-verification) using a GitHub App. Commit signing prevents tampering by unauthorized parties and provides a way to ensure that commits pushed to branches created by Batch Changes actually do come from Sourcegraph. Enabling commit signing for Batch Changes can also help pass checks in build systems or CI/CD pipelines that require that all commits are signed and verified before they can be merged. diff --git a/docs/admin/how-to/converting-version-contexts-to-search-contexts.mdx b/docs/admin/how-to/converting-version-contexts-to-search-contexts.mdx deleted file mode 100644 index 850c917c7..000000000 --- a/docs/admin/how-to/converting-version-contexts-to-search-contexts.mdx +++ /dev/null @@ -1,44 +0,0 @@ -# How to convert version contexts to search contexts - -This guide will provide steps for migrating from [version contexts](/code-search/features#version-contexts-sunsetting) to [search contexts](/code-search/features#search-contexts) on your private Sourcegraph instance. - -## Prerequisites - -- This document assumes that you have already configured version contexts in your site configuration. -- Search contexts and search context management are enabled in global settings. - -Site admins can enable search contexts on private Sourcegraph instances in **global settings** using the following: - -```json -"experimentalFeatures": { - "showSearchContext": true, -} -``` - -**Note**: While version contexts are located in the site configuration, search contexts are enabled through the global settings. - -Reload after saving changes to see search contexts enabled. - -## Steps to convert version contexts to search contexts - -1. Log in to your private Sourcegraph instance as a site admin. -2. Navigate to `https://your_sourcegraph_instance.com/contexts`. -3. Press `Convert version contexts`. A list of [existing version contexts](/code-search/features#version-contexts-sunsetting) found in the site configuration will be shown. -4. Convert either all version contexts at once, or specific individual version contexts as desired. -5. Navigate back to `https://your_sourcegraph_instance.com/contexts`. Converted version contexts will be listed. - -Converted search contexts can be used immediately by users on the Sourcegraph instance. The contexts selector will be shown in the search input. - -## Discontinuing use of version contexts on your private Sourcegraph instance - -Once desired existing version contexts have been converted into search contexts, we recommend discontinuing use of version contexts. - -To discontinue use of version contexts: - -1. Navigate to your site configuration. -2. Locate `experimentalFeatures.versionContexts` in the site configuration, and remove the `versionContexts` object and all of its contents. -3. Save changes. - -After removing version contexts from the site configuration, reload the page. The version contexts UI dropdown will no longer be shown in the search input. - -**Note:** Once version contexts are removed from site configuration, they will no longer be available for use or conversion into search contexts. diff --git a/docs/admin/how-to/index.mdx b/docs/admin/how-to/index.mdx index b7cc5d376..605416a80 100644 --- a/docs/admin/how-to/index.mdx +++ b/docs/admin/how-to/index.mdx @@ -2,7 +2,6 @@ - [How to enable or disable an experimental feature](/admin/how-to/enable-experimental-feature) - [How to diagnose an `Unknown Error` during login to your Sourcegraph instance](/admin/how-to/unknown-error-login) -- [How to convert version contexts to search contexts](/admin/how-to/converting-version-contexts-to-search-contexts) - [How to troubleshoot a repository that is not being updated](/admin/how-to/repo-not-updated) - [How to configure submodules](/admin/how-to/submodule-configuration) - [How to remove users or edit users with the GraphQL API](/admin/how-to/mutate-user-api) @@ -11,5 +10,4 @@ - [How to purge deleted repository data from Sourcegraph](/admin/how-to/remove-repo#manually-purge-deleted-repository-data-from-disk) - [How to address common monorepo problems](/admin/how-to/monorepo-issues) - [How to import a set of internal repositories to Sourcegraph](/admin/how-to/internal-github-repos) -- [Migrating code intelligence data from LSIF to SCIP (Sourcegraph 4.5 -> 4.6)](/admin/how-to/lsif-scip-migration) - [How to export search results](/admin/how-to/export-search-results) diff --git a/docs/admin/how-to/lsif-scip-migration.mdx b/docs/admin/how-to/lsif-scip-migration.mdx deleted file mode 100644 index 8fbcabbeb..000000000 --- a/docs/admin/how-to/lsif-scip-migration.mdx +++ /dev/null @@ -1,13 +0,0 @@ -# Migrating code intelligence data from LSIF to SCIP (Sourcegraph 4.5 -> 4.6) - -> WARNING: The migration from LSIF -> SCIP is **destructive and irreversible**. A downgrade from 4.6 to a previous version will result in the inability to access migrated code intelligence data (powering precise code navigation features). - -Sourcegraph 4.5 introduced an [out-of-band migration](/self-hosted/how-to/unfinished-migration#checking-progress) that re-encodes LSIF code intelligence data as SCIP in the `codeintel-db`. This migration is required to complete prior to a subsequent upgrade to 4.6, as support for reading LSIF-encoded data has been removed as of this version. - -As of [src-cli 4.5](https://github.com/sourcegraph/src-cli/releases/tag/4.5.0), LSIF indexes will be converted to SCIP prior to upload. This ensures that only _existing_ data needs to be migrated in the background. Using an older version of src-cli to upload code intelligence to your index may continue to feed additional LSIF data that needs to be subsequently migrated. This will ultimately block the ability to upgrade to the next version as the migration will never reach 100% (and remain there). - -Once the migration has completed, Postgres may continue to hold on to disk space that was previously occupied by LSIF data. Future versions of Sourcegraph will drop these tables completely, freeing this space. Heavier users of precise code intelligence may wish to reclaim this disk space earlier. Once the migration is complete, you can [truncate the LSIF data tables](/self-hosted/how-to/clear-codeintel-data#clearing-lsif-data) to immediately reclaim this space. - ---- - -If you wish to take the scorched earth route and clear all existing code intelligence data from your instance and start fresh, follow the entire guide on [clearing code intelligence data](/self-hosted/how-to/clear-codeintel-data). diff --git a/docs/admin/permissions/syncing.mdx b/docs/admin/permissions/syncing.mdx index a4134af5c..60b03d5d6 100644 --- a/docs/admin/permissions/syncing.mdx +++ b/docs/admin/permissions/syncing.mdx @@ -114,8 +114,6 @@ to Sourcegraph is the same as the [lag-time](#lag-time) defined below. So as lon ### Verify via UI -Sourcegraph 5.0+ - The state of user or repository permissions can be checked directly in the Sourcegraph UI. **User permissions** @@ -132,8 +130,6 @@ The state of user or repository permissions can be checked directly in the Sourc ### Verify the state via API calls -before Sourcegraph 5.0 - The GraphQL API can also be used: ```graphql @@ -325,8 +321,6 @@ In some cases, user-centric and repo-centric permission sync can conflict. This ### Disable repo-centric permission sync -> IMPORTANT: This feature is only supported in Sourcegraph 5.0.4 and later. - > IMPORTANT: Disabling repo-centric permission sync can break your permission setup depending on your code host and user authentication method. Contact Sourcegraph support before disabling repo-centric permission sync. To completely disable repo-centric permission sync scheduling, use this site configuration: diff --git a/docs/admin/repo/auth.mdx b/docs/admin/repo/auth.mdx index 495585d9e..2dc3e274c 100644 --- a/docs/admin/repo/auth.mdx +++ b/docs/admin/repo/auth.mdx @@ -58,7 +58,7 @@ See [git configuration](/admin/repo/git-config) for more details. ### Error: `sign_and_send_pubkey: no mutual signature supported` -In Sourcegraph 5.1.0 and later, the insecure SSH rsa-sha1 signature algorithm is no longer supported when fetching data from code hosts. +The insecure SSH rsa-sha1 signature algorithm is not supported when fetching data from code hosts. If you use an RSA SSH key to authenticate to your code host, you should ensure that your code host runs OpenSSL 7.2 or newer. diff --git a/docs/admin/repo/perforce.mdx b/docs/admin/repo/perforce.mdx index f3cdda69e..c5d723427 100644 --- a/docs/admin/repo/perforce.mdx +++ b/docs/admin/repo/perforce.mdx @@ -300,7 +300,7 @@ We are actively working to significantly improve Sourcegraph's Perforce support. ## Configure experimental features -As of Sourcegraph 5.1, there are the following experimental features for Perforce depots. These are merely for providing feedback and have [limited support](/beta-and-experimental#experimental-features). +The following experimental features are available for Perforce depots. These are merely for providing feedback and have [limited support](/beta-and-experimental#experimental-features). ### Changelist ID in URLs @@ -325,7 +325,7 @@ When enabled, URLs for Perforce code hosts will use the Changelist (CL) ID inste ### Searching within a specific changelist -As of Sourcegraph 5.5, you can search within a specific changelist by referring to the changelist as a reference path like `changelist/123` where 123 is the changelist id. For example, given a repo path of `Talkhouse/main` and a changelist id of `123`, you can search within that changelist by using the following query: +You can search within a specific changelist by referring to the changelist as a reference path like `changelist/123` where 123 is the changelist id. For example, given a repo path of `Talkhouse/main` and a changelist id of `123`, you can search within that changelist by using the following query: ``` repo:^Talkhouse/main$@changelist/123 text to find diff --git a/docs/admin/telemetry/index.mdx b/docs/admin/telemetry/index.mdx index eaa2e9140..79c78d1cf 100644 --- a/docs/admin/telemetry/index.mdx +++ b/docs/admin/telemetry/index.mdx @@ -47,14 +47,10 @@ You can reach out to support@sourcegraph.com for additional information about ho ## Allowlist IPs / CIDR ranges for Sourcegraph -Starting 5.2.0: - - For `pings.sourcegraph.com`, allowlist the IP address: `34.36.231.254` - For `telemetry-gateway.sourcegraph.com`, allowlist the IP address: `34.107.157.31` - For `sourcegraph.com`, allowlist the full [Cloudflare IP ranges](https://www.cloudflare.com/ips/) -Prior to 5.2.0, allowlist the full [Cloudflare IP ranges](https://www.cloudflare.com/ips/). - ## Architecture To learn more about how telemetry data is processed, refer to the [Architecture page](/admin/architecture#analytics-and-telemetry). diff --git a/docs/admin/webhooks/incoming.mdx b/docs/admin/webhooks/incoming.mdx index da5d3e194..7f47062d9 100644 --- a/docs/admin/webhooks/incoming.mdx +++ b/docs/admin/webhooks/incoming.mdx @@ -22,16 +22,14 @@ To receive webhooks both Sourcegraph and the code host need to be configured. To ## Deprecation notice -As of Sourcegraph 4.3.0 webhooks added via code host configuration are deprecated and support will be removed in release 5.1.0. - -This includes any webhooks pointed at URLs starting with the following: +Webhooks added via code host configuration are no longer supported. This includes any webhooks pointed at URLs starting with the following: - `.api/github-webhooks` - `.api/gitlab-webhooks` - `.api/bitbucket-server-webhooks` - `.api/bitbucket-cloud-webhooks` -In order to continue using webhooks you need to follow the steps below to [add an incoming webhook](#adding-an-incoming-webhook) and then update the webhook configured on your code host with the new webhook url which will look something like `https://sourcegraph-instance/.api/webhooks/{UUID}` +If your code host still points at one of these URLs, follow the steps below to [add an incoming webhook](#adding-an-incoming-webhook) and then update the webhook configured on your code host with the new webhook url which will look something like `https://sourcegraph-instance/.api/webhooks/{UUID}` ## Adding an incoming webhook @@ -240,8 +238,8 @@ Done! Sourcegraph will now receive webhook events to sync data with lower latenc ### Azure DevOps - Experimental webhook support for Azure DevOps was added in Sourcegraph 5.0, - and does not currently support secrets. Please{' '} + Webhook support for Azure DevOps is experimental and does not currently + support secrets. Please{' '} contact us with any issues found while using webhooks. diff --git a/docs/analytics/index.mdx b/docs/analytics/index.mdx index 0b68de840..f65d79ed7 100644 --- a/docs/analytics/index.mdx +++ b/docs/analytics/index.mdx @@ -9,7 +9,7 @@ Enterprise customers can use Sourcegraph Analytics to get a clear view of usage, Our managed [Sourcegraph Analytics service](https://analytics.sourcegraph.com) for Cody and Code Search usage data is available for: - [Sourcegraph Cloud](/cloud) customers -- Self-hosted customers that have fully enabled usage telemetry and are running a supported version of Sourcegraph (5.9+) +- Self-hosted customers that have fully enabled usage telemetry and are running a supported version of Sourcegraph - [Sourcegraph workspaces](https://workspaces.sourcegraph.com) To get started, follow our [enablement instructions](#enablement-instructions). @@ -163,7 +163,7 @@ Cody-specific user metrics with slightly different user definitions: #### Commands -_As of Sourcegraph version 5.10, commands are being deprecated in favor of chat prompts. If your Sourcegraph instance is running version 5.10 or later, you may see decreased command usage._ +_Commands are deprecated in favor of chat prompts, so you may see decreased command usage._ | **Metric** | **Description** | | ----------------------- | ----------------------------------------------------------------------------------------------------------- | diff --git a/docs/batch-changes/batch-spec-templating.mdx b/docs/batch-changes/batch-spec-templating.mdx index 09c6e3fe7..d496aac3f 100644 --- a/docs/batch-changes/batch-spec-templating.mdx +++ b/docs/batch-changes/batch-spec-templating.mdx @@ -108,7 +108,7 @@ The following template variables are available in the fields under `changesetTem | `steps.deleted_files` | `list of strings` | List of files deleted by the `steps`. Empty list if no files have been deleted | | `steps.path` | `string` | Path (relative to the root of the directory, no leading `/` or `.`) in which the `steps` have been executed. Empty if no workspaces have been used and the `steps` were executed in the root of the repository | | `outputs.` | depends on `outputs..format`, default: `string` | Value of an [`output`](batch-spec-yaml-reference#stepsoutputs) set by `steps`. If the [`outputs..format`](batch-spec-yaml-reference#stepsoutputsnameformat) is `yaml` or `json` and the `value` a data structure (i.e., array, object, ...), then subfields can be accessed too. See [Templating Examples](#templating-examples) below | -| `batch_change_link` | `string` | Only available in `changesetTemplate.body`
Link back to the batch change that produced the changeset on Sourcegraph. If omitted, the link will be automatically appended to the end of the body.
Requires [Sourcegraph CLI](/cli/) 3.40.9 or later | +| `batch_change_link` | `string` | Only available in `changesetTemplate.body`
Link back to the batch change that produced the changeset on Sourcegraph. If omitted, the link will be automatically appended to the end of the body. | ## Template helper functions diff --git a/docs/batch-changes/batch-spec-yaml-reference.mdx b/docs/batch-changes/batch-spec-yaml-reference.mdx index 82e595549..cfcd99a97 100644 --- a/docs/batch-changes/batch-spec-yaml-reference.mdx +++ b/docs/batch-changes/batch-spec-yaml-reference.mdx @@ -14,13 +14,12 @@ We recommend to always specify the version. ### Version 1 -The schema version before Sourcegraph version 5.5. +The legacy schema version. For now, if no version is specified, batch changes will use this schema version. It is recommended to switch to version 2. ### Version 2 (recommended) -Introduced in Sourcegraph version 5.5. Queries defined under [`on.repositoriesMatchingQuery`](#onrepositoriesmatchingquery) default to keyword search instead of standard search. Authors can override the default by specifying the pattern type explicitly. Refer to the [search syntax docs](/code-search/queries) for more information about pattern types. @@ -110,13 +109,6 @@ on: A specific repository (and, optionally, one or more branches) that's added to the list of repositories on which the batch change will run. - - For Sourcegraph version 3.35 or less, if multiple branches are specified, - then only the last-named branch will be used, and only a single `branch` - could be provided. For Sourcegraph version 3.35 or more, all branches are - used. - - To match a branch other than the default, `branch` or `branches` can be used to specify one or multiple branches, respectively. Only one of `branch` or `branches` can be set. @@ -443,15 +435,7 @@ steps: ## `steps.mount` - This feature is available only for{' '} - - Sourcegraph CLI - - . Using `mount` locally is supported in Sourcegraph v3.41 and [Sourcegraph - CLI 3.41](https://sourcegraph.com/github.com/sourcegraph/src-cli). Using - `mount` in batch changes server-side is supported in Sourcegraph v4.1 and - [Sourcegraph CLI - 4.0.1](https://sourcegraph.com/github.com/sourcegraph/src-cli). + This feature is available only for the [Sourcegraph CLI](https://sourcegraph.com/github.com/sourcegraph/src-cli). `steps.mount` functionality makes running custom scripts/binaries easier. It mounts a local `path` to a `path` in a Docker container. Mounted paths are accessible to the step's `run` command. @@ -774,10 +758,6 @@ changesetTemplate: ## `changesetTemplate.fork` - - It is supported on Sourcegraph versions 5.1 or more. - - Whether or not each changeset should be created on a fork of the upstream repository in the namespace of the user publishing them (or the namespace of the service account if [global credentials](/batch-changes/configuring-credentials#global-service-account-tokens) are used). This value will override the setting if the site config setting [`batchChanges.enforceForks`](/admin/config/batch-changes#forks) is enabled. For example, explicitly setting `fork: false` when the site config setting is enabled will publish changesets directly to the target repos. If omitted, the site config setting will be used. diff --git a/docs/batch-changes/faq.mdx b/docs/batch-changes/faq.mdx index 934be401f..db85f8c74 100644 --- a/docs/batch-changes/faq.mdx +++ b/docs/batch-changes/faq.mdx @@ -151,7 +151,7 @@ Commit author is determined when running `src batch [apply|preview]`. If no [aut ## Why is the checkbox on my changeset disabled when previewing a batch change? -Since Sourcegraph 3.31, it is possible to publish many types of changesets when previewing a batch change by modifying the publication state for the changeset directly from the UI (see ["Publishing changesets"](/batch-changes/publishing-changesets#from-the-preview)). However, not every changeset can be published by Sourcegraph. By hovering over your changeset's disabled checkbox, you can see why that specific changeset is not currently publishable. The most common reasons include: +It is possible to publish many types of changesets when previewing a batch change by modifying the publication state for the changeset directly from the UI (see ["Publishing changesets"](/batch-changes/publishing-changesets#from-the-preview)). However, not every changeset can be published by Sourcegraph. By hovering over your changeset's disabled checkbox, you can see why that specific changeset is not currently publishable. The most common reasons include: - The changeset is already published (we cannot unpublish a changeset or convert it back to a draft) - The changeset's publication state is being controlled from your batch spec file (i.e., you have the [`published` flag set in your batch spec](/batch-changes/batch-spec-yaml-reference#changesettemplatepublished)); the batch spec takes precedence over the UI @@ -243,34 +243,3 @@ If the execution of a step on a given repository fails, that repository will be ### How do executors interact with code hosts? Will they clone repos directly? Executors do not interact directly with code hosts. They behave in a way [similar to src CLI](/batch-changes/how-src-executes-a-batch-spec) today: executors interact with the Sourcegraph instance, the Sourcegraph instance interacts with the code host. In particular, executors download code from the Sourcegraph instance and executors do not need to access code hosts credentials directly. - -## From Campaigns to Batch Changes - -We are sunsetting the name **Campaigns** and renaming it to **Batch Changes** starting from Sourcegraph version 3.26 (released 2021-03-20). The name change happened so that it is more descriptive and approachable for new users. - -### What action should I take? - -- Campaigns is called **Batch Changes** from Sourcegraph v3.26 -- We recommend migrating and upgrading to the latest Sourcegraph version to benefit from the new functionalities -- There are no breaking changes in **release 3.26 to 3.33**, and URLs, CLI commands, and API endpoints using the previous name (campaigns) will still work. **These will be removed in Sourcegraph 3.34.** - -### What changes with the name change? - -- **Campaigns** is replaced by **Batch Changes** in the GUI, docs, customer and internal material -- `/campaigns/*` URLs are changed to `/batch-changes/*` -- The CLI prompt `src campaigns` is replaced by `src batch` -- Campaign specs are now called **batch specs** - -### What's the deprecation plan? - -From v3.26 to v3.33 (inclusive): - -- All `/campaigns/*` URLs are deprecated. They will still work and will be removed in the future -- The CLI prompt `src campaigns` and its alias `src campaign` are deprecated. They will still work and will be removed in the future -- `campaigns` GraphQL API endpoints are deprecated. They are intended to work, so contact us if you are querying the GraphQL API to ensure we can support you. They will be removed in the future - -From v3.34: - -- All `/campaigns/*` URLs are removed -- The CLI prompt `src campaigns` and its alias `src campaign` are removed -- `/campaigns` GraphQL API endpoints are removed diff --git a/docs/batch-changes/publishing-changesets.mdx b/docs/batch-changes/publishing-changesets.mdx index dc7a04281..80f81fd91 100644 --- a/docs/batch-changes/publishing-changesets.mdx +++ b/docs/batch-changes/publishing-changesets.mdx @@ -189,20 +189,10 @@ If you have previously published changesets as drafts on code hosts by setting ` ## Within the UI - - {' '} - This feature is supported in Sourcegraph versions 3.30 or more. - - To publish from the Sourcegraph UI, you'll need to remove (or omit) the `published` field from your batch spec. When you apply a batch change without an explicit `published` field, all changesets are left unpublished. ### From the preview - - {' '} - This feature is supported in Sourcegraph versions 3.31 or more. - - When you run `src batch preview` against your batch spec and open the preview link, you'll see the current status of each of your changesets, as well as a preview of the actions that will be performed when you apply: ![publish_ui_browser_preview](https://sourcegraphstatic.com/docs/images/batch_changes/publish_ui_browser_preview.png) diff --git a/docs/cli/explanations/versioning.mdx b/docs/cli/explanations/versioning.mdx index 76497c7b2..c37816466 100644 --- a/docs/cli/explanations/versioning.mdx +++ b/docs/cli/explanations/versioning.mdx @@ -44,8 +44,6 @@ or with npm/npx: npx @sourcegraph/src@{CURRENT_VERSION_NO_V} version ``` -> Note: Versioned formulas are available on Homebrew for Sourcegraph versions 3.43.2 and later. - ## Installation: Linux ### Latest version diff --git a/docs/code-insights/explanations/administration-and-security-of-code-insights.mdx b/docs/code-insights/explanations/administration-and-security-of-code-insights.mdx index 970e2a92a..08d2551af 100644 --- a/docs/code-insights/explanations/administration-and-security-of-code-insights.mdx +++ b/docs/code-insights/explanations/administration-and-security-of-code-insights.mdx @@ -65,10 +65,6 @@ The following setting(s) apply to both backfilling data and adding new data ## Language Stats Performance Configuration - - This feature is supported for Sourcegraph versions 5.4 or more. - - To create language stats for a repository the Sourcegraph instance analyzes all files from the target repository. Depending on the repository's size this can take from a few seconds to multiple minutes. If you need to analyze a repository that's larger than 10GB feel free to reach out to Sourcegraph support. diff --git a/docs/code-insights/explanations/automatically-generated-data-series.mdx b/docs/code-insights/explanations/automatically-generated-data-series.mdx index 04fe3867c..b6c194308 100644 --- a/docs/code-insights/explanations/automatically-generated-data-series.mdx +++ b/docs/code-insights/explanations/automatically-generated-data-series.mdx @@ -28,7 +28,7 @@ This feature has some yet-released limitations. In rough order, with limitations ### Limited to 20 matches -Capture groups will only display 20 returned match values to prevent extremely large result sets from being rendered. As of version 3.41.0 controls are available to make this deterministic and configurable. +Capture groups will only display 20 returned match values to prevent extremely large result sets from being rendered. Controls are available to make this deterministic and configurable. ### No capture groups in filter strings diff --git a/docs/code-insights/explanations/current-limitations-of-code-insights.mdx b/docs/code-insights/explanations/current-limitations-of-code-insights.mdx index 510610108..3b06f1014 100644 --- a/docs/code-insights/explanations/current-limitations-of-code-insights.mdx +++ b/docs/code-insights/explanations/current-limitations-of-code-insights.mdx @@ -99,20 +99,11 @@ If desired, a Sourcegraph admin can enable Code Insights access to repositories ## Feature parity limitations -### Features currently available only on insights over all your repositories - -- **[Filtering insights](/code-insights/explanations/code-insights-filters)**: available in 3.41+ ~~we do not yet allow filtering for insights that run over explicitly defined lists of repositories, except for "detect and track" insights.~~ - ### Features currently available only on insights over explicitly defined repository lists Because these insights need to run dramatically fewer queries than insights over thousands of repositories, you will have access to a number of features not _yet_ supported for insights over all repositories. These are: - **Live previews**: showing the preview of your insight in real time -- **[Released] Dynamic x-axis ranges**: available in 3.35+ ~~set a custom amount of historical data you care about~~ -- **[Released] Editing data series queries after creation**: available in 3.35+ ~~for insights over all repositories, you must make a new insight if you wish to run a different query~~ -- **[Released] "Diff click"**: available in 3.36+ ~~click a datapoint on your insight and be taken to a diff search showing any changes contributing to the difference between a datapoint and the prior one~~ - -> NOTE: many of the above-listed features will become available for insights over all repositories as well. The above list is ordered top-down, where items on the top of the list will arrive roughly sooner than items on the bottom. ### Limitations specific to "Detect and track patterns" insights (automatically generated data series) @@ -121,17 +112,3 @@ Please see [Current limitations of automatically generated data series](/code-in ## In certain cases, chart datapoints don't match the result count of a Sourcegraph search There are currently a few subtle differences in how code insights and Sourcegraph web app searches handle defaults when searching over all repositories. Refer to [Common reasons code insights may not match search results](/code-insights/references/common-reasons-code-insights-may-not-match-search-results). - -## Older versions' limitations - -### Version 3.30 (July 2021) or older - -#### Search-based Code Insights can only run over ~50-70 repositories - -Because this version of the prototype runs on frontend API calls to Sourcegraph searches, it may run slowly (or possibly timeout) if you're using it over many repositories or with many data series for each insight. - -#### The max match count is 5,000 matches per repository - -The current limit on searching over historical versions of repositories, which is an unindexed search, is 5,000 results per repository. If there are more than 5,000 matches, the search stops and returns a count of 5,000, and the code insight graph will calculate the overall chart using 5,000 as the match count for that repository. (This means if you query over two repositories and one of them hits this limit, the value shown on the graph will be 5,000 + [the match count in the other repository]). - -\_This limit was lifted in the August 2021 release of Sourcegraph `3.31` diff --git a/docs/code-insights/explanations/data-retention.mdx b/docs/code-insights/explanations/data-retention.mdx index 896b28531..c002233e8 100644 --- a/docs/code-insights/explanations/data-retention.mdx +++ b/docs/code-insights/explanations/data-retention.mdx @@ -1,12 +1,9 @@ # Code Insights data retention -> NOTE: This reference is only relevant from the 4.5 release. - On creation a Code Insight will show you 12 data points per series. Your Code Insight will then get an additional ephemeral data point daily, and a persisted additional data point at every interval that was specified on insight creation. -Prior to release 4.5, this growth was unbound. -From 4.5, the oldest data points will be truncated and stored separately according to the sample size specified in the site configuration with the setting shown below. +The oldest data points will be truncated and stored separately according to the sample size specified in the site configuration with the setting shown below. This means that if you have an insight with 50 data points, and a maximum sample size of 30, the oldest 20 points will be truncated and archived in a separate table. ```json @@ -52,17 +49,3 @@ Adjusting this setting will only apply to one insight and will not have any impa - Code Insights should be faster to load. - Code Insights with a lot of data points that were previously hard to read or hover over will now be more legible. - Code Insights data can now be exported in CSV format. - -## Accessing this feature prior to 4.5 - -You can enable this retention procedure from Sourcegraph _4.4_ if you are a site admin with the following setting: - -```json -{ - "experimentalFeatures": { - "insightsDataRetention": true - } -} -``` - -You will however **only be able to export all the code insights data from the 4.5 release**, so use the experimental version at your own risk. diff --git a/docs/code-insights/explanations/search-results-aggregations.mdx b/docs/code-insights/explanations/search-results-aggregations.mdx index 441ab41aa..9d1f2def8 100644 --- a/docs/code-insights/explanations/search-results-aggregations.mdx +++ b/docs/code-insights/explanations/search-results-aggregations.mdx @@ -1,6 +1,6 @@ # Search results aggregations -In version 4.0 and later, Code Insights provides aggregations shown on the search screen. +Code Insights provides aggregations shown on the search screen. This lets you track version and license spread, library adoption, common commit messages, lengths of specific files, usage frequencies, and the [many common use case examples here](/code-insights/references/search-aggregations-use-cases). diff --git a/docs/code-insights/quickstart.mdx b/docs/code-insights/quickstart.mdx index 2f2533c09..61f5c58a1 100644 --- a/docs/code-insights/quickstart.mdx +++ b/docs/code-insights/quickstart.mdx @@ -15,48 +15,28 @@ For more information about Code Insights see the [Code Insights](/code-insights/ - You are a Sourcegraph enterprise customer. (Want code insights but aren't enterprise? [Let us know](mailto:feedback@sourcegraph.com).) - Your Sourcegraph instance has at least 1 repository. (See "[Quickstart](/#quick-install)" on how to setup a Sourcegraph instance.) - Your Sourcegraph instance is deployed via [Docker Compose](/self-hosted/deploy/docker-compose/) or [Kubernetes](/self-hosted/deploy/kubernetes/). -- You are running Sourcegraph version 3.31.1 (August 2021 release) or later. - - Note: If you're on Sourcegraph version 3.24 to 3.28, you can instead follow [this gist](https://gist.github.com/Joelkw/f0582b164578aabc3ac936dee43f23e0) to create an insight. Due to the early stage of the product, it's more likely you'll run into trouble, though, so we recommend that you either upgrade your Sourcegraph or reach out to your Sourcegraph reps for help. -## Enable Code Insights +## Create a code insight -### 1. [If need be] Enable the experimental feature flag +### 1. Visit your example.sourcegraph.com/insights page and select "+ Create insight" -**If you're on Sourcegraph version 3.31 or earlier** and you don't already see the "Insights" item in your main nav bar, you'll need to add the following to either your Sourcegraph user settings `sourcegraph.example.com/users/[username]/settings` or organization settings `sourcegraph.example.com/organizations/[your_org]/settings` (and _not_ in your site configuration settings): - -```json -"experimentalFeatures": { "codeInsights": true }, - "extensions": { - "sourcegraph/code-stats-insights": true, - "sourcegraph/search-insights": true - } -``` - -If you put this in your organization settings, everyone on your Sourcegraph insights will be able to see the "Insights" navbar menu item and create their own code insights. If you put the flag in your user settings, only you will have those abilities. - -(Enabling code insights organization-wide doesn't mean that other users can automatically see the code insights you create, however – you can control that visibility per individual insight.) - -### 2. Visit your example.sourcegraph.com/insights page and select "+ Create insight" - -### 3. On the insight type selection page, select "Track changes" +### 2. On the insight type selection page, select "Track changes" This creates a code insight tracking an arbitrary input that you could run a Sourcegraph search for. Your other options are to: -- [create a "Detect and track" insight](/code-insights/explanations/automatically-generated-data-series) to automatically generate your data series according to capture group matching (3.35+). +- [create a "Detect and track" insight](/code-insights/explanations/automatically-generated-data-series) to automatically generate your data series according to capture group matching. - [create a language-based insight](/code-insights/language-insight-quickstart) to show you language breakdown in your repositories. -### 4. Select the repositories you want to search +### 3. Select the repositories you want to search If you want an insight running over a specific amount of repositories, enter the repositories in the repository URL format, like `github.com/sourcegraph/sourcegraph`. Separate multiple repositories with a comma. The form field will validate that you've entered the repository correctly. -If you want to run an insight over all repositories, instead check the box to do so (available in Sourcegraph 3.31.1 and later). If you otherwise want to exclude specific repositories, you can do so after creating the insight by using filters (step 10). - -From Sourcegraph 4.5 you are able to define the repositories you want your insight to run over using a Sourcegraph search query. [Read the reference to learn more](/code-insights/references/repository-scope). +You can also define the repositories you want your insight to run over using a Sourcegraph search query, for example `repo:.*` to run over all repositories. [Read the reference to learn more](/code-insights/references/repository-scope). If you want to exclude specific repositories, you can do so after creating the insight by using filters (step 8). -### 5. Define a data series to track the incidence of `TODO` +### 4. Define a data series to track the incidence of `TODO` A data series becomes a line on your graph. @@ -66,19 +46,19 @@ To track the incidence of TODOs, you can set your **Search query** to be simply You can also select the color of your data series. -### 6. Add a title to the insight +### 5. Add a title to the insight Enter a descriptive **Title** for the chart, like `Count of TODOs in [repository name]`. -### 7. Set the distance between data points +### 6. Set the distance between data points Code insights give you twelve datapoints for each data series on insight creation. Setting it to one month means you'll see the results over the last year. -### 8. Click "create code insight" and view your insight. +### 7. Click "create code insight" and view your insight. You'll be taken to the `example.sourcegraph.com/insights` page and can view your insight. -### 9. Filter your insight to explore it further +### 8. Filter your insight to explore it further Click the filter button in the top right of an insight card to open the filters panel. This allows you to filter the insight down to a subset of repositories through inclusion or exclusion using regular expressions. For more details, see [How to filter an insight](/code-insights/how-tos/filtering-an-insight). diff --git a/docs/code-insights/references/common-reasons-code-insights-may-not-match-search-results.mdx b/docs/code-insights/references/common-reasons-code-insights-may-not-match-search-results.mdx index 315243947..0a67b2b52 100644 --- a/docs/code-insights/references/common-reasons-code-insights-may-not-match-search-results.mdx +++ b/docs/code-insights/references/common-reasons-code-insights-may-not-match-search-results.mdx @@ -4,12 +4,6 @@ There are a few reasons why chart data series' most recent datapoint may show yo ## If the chart data point shows _higher_ counts than a manual search -### [For versions pre-3.40] Not including `fork:no` and `archived:no` in your insight query - -Because code insights historical search defaults to `fork:yes` and `archived:yes`, but a Sourcegraph search via the web interface or CLI does not, it may be that your insight data series is including results from repositories that are excluded from a Sourcegraph search. Try running the same search again manually with `fork:yes` and `archived:yes` filters. - -> NOTE: 3.40+ version defaults to `fork:no` and `archived:no`, the same way the search UI does. - ### Manual search will not include unindexed repositories All repositories in a historical search are unindexed, but a manual Sourcegraph search only includes indexed repositories. It's possible your manual searches are missing results from unindexed repositories. @@ -49,4 +43,4 @@ query debug { where `INSIGHT_ID` can be found in the "edit" page for the insight (selectable from the three-dot dropdown on the insight) after `...edit/`. It will look like `https://yourdomain.sourcegraph.com/insights/edit/INSIGHT_ID?dashboardId=all`. The `INSIGHT_ID` can also be found in the url of the single insight view found by clicking on the title of the insight. The ID will be in the url, for example, `https://sourcegraph.yourdomain.com/insights/insight/{INSIGHT_ID}` If there are `failedJobs`, there may be timeouts or similar issues affecting your insight. -`insightViewDebug` was added in 4.2 to give you more raw information on your insight. +`insightViewDebug` gives you more raw information on your insight. diff --git a/docs/code-insights/references/incomplete-data-points.mdx b/docs/code-insights/references/incomplete-data-points.mdx index 1411feb5a..99686fae2 100644 --- a/docs/code-insights/references/incomplete-data-points.mdx +++ b/docs/code-insights/references/incomplete-data-points.mdx @@ -104,15 +104,12 @@ Add `count:all` to your query to get comparable results. When Code Insights runs a search query, it will do so for 12 commits spread out over the configured time range. This unindexed search can take longer the further back in time the search goes. -To test that the slowest search will succeed in time, we recommend using the `rev:at.time(...)` (available from version 5.4.0) +To test that the slowest search will succeed in time, we recommend using the `rev:at.time(...)` filter with the time range that you selected. E.g. if your Code Insight looks at the last 2 years you should use `rev:at.time(2y)`. For example the Code Insights query `file:.*\.md hello repo:^github\.com/my_org/my_repo count:all` should be written as `context:global file:.*\.md hello repo:^github\.com/my_org/my_repo count:all rev:at.time(2y)` in Code Search. -If your Sourcegraph instance is on a version older than 5.4.0, you can pick a commit sha from e.g. 2 years ago. Here the query -`file:.*\.md hello repo:^github\.com/my_org/my_repo count:all` becomes `context:global file:.*\.md hello repo:^github\.com/my_org/my_repo@my_commit_sha count:all`. - #### Timeout If the query fails with a timeout before one minute has passed, add the parameter `timeout:1m`. diff --git a/docs/code-insights/references/repository-scope.mdx b/docs/code-insights/references/repository-scope.mdx index 7db4d63af..eb4a4bb28 100644 --- a/docs/code-insights/references/repository-scope.mdx +++ b/docs/code-insights/references/repository-scope.mdx @@ -3,10 +3,8 @@ A Code Insight runs on a list of repositories as specified on insight creation. The scope options are: - Manually specify a list of repositories -- Run the insight over all repositories (Sourcegraph 3.31.1+). - - From Sourcegraph 4.5 this is achieved through a `repo:.*` search query. -- Run the insight over repositories as returned from a repository search query (Sourcegraph 4.5+) - - This replaces the "Run your insight over all repositories" checkbox in prior versions +- Run the insight over repositories as returned from a repository search query + - To run the insight over all repositories, use a `repo:.*` search query. ## Using the repository search query box diff --git a/docs/code-navigation/envvars.mdx b/docs/code-navigation/envvars.mdx index b74815c5f..1bd4fa1ec 100644 --- a/docs/code-navigation/envvars.mdx +++ b/docs/code-navigation/envvars.mdx @@ -12,7 +12,7 @@ The following settings should be the same for the [`precise-code-intel-worker`]( | **Name** | **Default** | **Description** | | ----------------------------------------- | -------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `PRECISE_CODE_INTEL_UPLOAD_BACKEND` | `blobstore` | The target file service for code graph uploads. S3, GCS, and Blobstore are supported. In older versions of Sourcegraph (before v3.4.2) `Minio` was also a valid value. | +| `PRECISE_CODE_INTEL_UPLOAD_BACKEND` | `blobstore` | The target file service for code graph uploads. S3, GCS, and Blobstore are supported. | | `PRECISE_CODE_INTEL_UPLOAD_MANAGE_BUCKET` | `false` | Whether or not the client should manage the target bucket configuration | | `PRECISE_CODE_INTEL_UPLOAD_BUCKET` | `lsif-uploads` | The name of the bucket to store LSIF uploads in | diff --git a/docs/code-navigation/troubleshooting.mdx b/docs/code-navigation/troubleshooting.mdx index 5d726039a..73bff8977 100644 --- a/docs/code-navigation/troubleshooting.mdx +++ b/docs/code-navigation/troubleshooting.mdx @@ -37,7 +37,7 @@ The following details should always be supplied. - frontend - precise-code-intel-worker - codeintel-db - - blobstore (or `minio` in versions of Sourcegraph before v3.4.2) + - blobstore If the customer is running a custom patch or an insiders version, we need the docker image tags and SHAs of the following containers: diff --git a/docs/code-search/features.mdx b/docs/code-search/features.mdx index b86a4d8f3..9d3610fca 100644 --- a/docs/code-search/features.mdx +++ b/docs/code-search/features.mdx @@ -59,8 +59,6 @@ Search contexts help you search the code you care about on Sourcegraph. A search Every search on Sourcegraph uses a search context. Search contexts can be defined with the contexts selector shown in the search input, or entered directly in a search query. -If you currently use version contexts, you can automatically [convert your existing version contexts to search contexts](/admin/how-to/converting-version-contexts-to-search-contexts). We recommend migrating to search contexts for a more intuitive, powerful search experience and the latest improvements and updates. - See the [search contexts](/code-search/working/search-contexts) documentation to learn how to use and create search contexts. ## Multi-branch indexing @@ -100,7 +98,7 @@ src search --json --stream -- "/$re2_regex/" \ ## Search experience -Users on Sourcegraph instance `v5.9.0` or more get the improved and new Code Search experience set by default. Sourcegraph Enterprise users' site admins can optionally opt-out and revert to the old view. +The improved Code Search experience is enabled by default. Sourcegraph Enterprise users' site admins can optionally opt-out and revert to the old view. You get the following improvements: diff --git a/docs/code-search/how-to/opengrok.mdx b/docs/code-search/how-to/opengrok.mdx index 5ec10f588..fa248db09 100644 --- a/docs/code-search/how-to/opengrok.mdx +++ b/docs/code-search/how-to/opengrok.mdx @@ -29,7 +29,7 @@ Sourcegraph provides a search filter (`repo:`) that supports regexp and partial | - To search in a distinct list of repositories, you can use a ` |` character as a regexp OR operator: `pattern repo:github.com/org/repository1 | github.com/org/repository2`. | | - Note this query could be simplified further using more advanced regexp matching if the two repos share part of their names, such as: `pattern repo:github.com/org/repository(1 | 2)`. | | -Sourcegraph also allows site admins to create pre-defined repository groupings, using [version contexts](/code-search/features#version-contexts-experimental). +Sourcegraph also allows users and site admins to create pre-defined repository groupings, using [search contexts](/code-search/working/search-contexts). ### Searching in non-master (unindexed) branches, tags, and commits @@ -53,8 +53,6 @@ Oracle OpenGrok provides three boolean operators — `AND`, `OR`, and `NOT` — Sourcegraph also provides [`AND`, `OR`, and `NOT` operators](/code-search/queries#boolean-operators). -> NOTE: Operators are available as of Sourcegraph 3.17 - ### Search filters Both Sourcegraph and OpenGrok allow users to add filters for scoping searches. Below is a mapping from OpenGrok syntax to Sourcegraph. diff --git a/docs/code-search/queries/index.mdx b/docs/code-search/queries/index.mdx index b8dfa9f3b..85adc06d1 100644 --- a/docs/code-search/queries/index.mdx +++ b/docs/code-search/queries/index.mdx @@ -94,11 +94,6 @@ The following filters can be used on all searches (using [RE2 syntax](https://go Multiple or combined **repo:** and **file:** filters are intersected. For example, `repo:foo repo:bar` limits your search to repositories whose path contains **both** `foo` and `bar` (such as `github.com/alice/foobar`). To include results from repositories whose path contains **either** `foo` or `bar`, use `repo:foo|bar`. - - The `rev:at.time(...)` filter is only supported for Sourcegraph versions 5.4 - or more. - - ## Boolean operators Use boolean operators to create more expressive searches. diff --git a/docs/code-search/queries/language.mdx b/docs/code-search/queries/language.mdx index 97813a0c7..f29c5a410 100644 --- a/docs/code-search/queries/language.mdx +++ b/docs/code-search/queries/language.mdx @@ -83,10 +83,6 @@ For example, ### Revision at time - - This feature is only supported for Sourcegraph versions 5.4 or more. - - Search a repository at a given time. Optionally, a second parameter can be used to specify a revision which will be used as the starting point of the search. For example, @@ -291,7 +287,7 @@ Set whether the pattern should run a [keyword search](/code-search/queries#keywo ### Repo has meta -Tagging repositories with key-value pairs is GA as of 5.1.0, but can be disabled by creating the feature flag `repository-metadata` and setting it to `false`. Add metadata by [following the instructions](/admin/repo/metadata). +Tagging repositories with key-value pairs is enabled by default, but can be disabled by creating the feature flag `repository-metadata` and setting it to `false`. Add metadata by [following the instructions](/admin/repo/metadata). ![repo-has-meta](https://storage.googleapis.com/sourcegraph-assets/Docs/CS-LANG/repo-has-meta.png) diff --git a/docs/code-search/working/search-contexts.mdx b/docs/code-search/working/search-contexts.mdx index 6e5bbc766..3406768c6 100644 --- a/docs/code-search/working/search-contexts.mdx +++ b/docs/code-search/working/search-contexts.mdx @@ -127,7 +127,7 @@ You will be returned to the list of search contexts. Your new search context wil ## Query-based search contexts -As of release 3.36, search contexts can be defined with a restricted search query as an alternative to a specific list of repositories and revisions. Allowed filters are: `repo`, `rev`, `file`, `lang`, `case`, `fork`, and `visibility`. `OR` and `AND` expressions are also allowed. +Search contexts can be defined with a restricted search query as an alternative to a specific list of repositories and revisions. Allowed filters are: `repo`, `rev`, `file`, `lang`, `case`, `fork`, and `visibility`. `OR` and `AND` expressions are also allowed. Currently, repo built in predicates for example `repo:has.file`, diff --git a/docs/cody/enterprise/completions-configuration.mdx b/docs/cody/enterprise/completions-configuration.mdx index 4e711ef77..76f6c919e 100644 --- a/docs/cody/enterprise/completions-configuration.mdx +++ b/docs/cody/enterprise/completions-configuration.mdx @@ -173,7 +173,7 @@ Once done, go to **Site admin > Site configuration** (`/site-admin/configuration For the access token, -- For Sourcegraph `v5.2.4` or more, the access token can be left empty, and it will rely on Environmental, Workload Identity, or Managed Identity credentials configured for the `frontend` and `worker` services +- The access token can be left empty, and it will rely on Environmental, Workload Identity, or Managed Identity credentials configured for the `frontend` and `worker` services - Set it to `` if directly configuring the credentials using the API key specified in the Azure portal ### Use StarCoder for autocomplete diff --git a/docs/cody/faq.mdx b/docs/cody/faq.mdx index 4c7b6cf5d..991c942f5 100644 --- a/docs/cody/faq.mdx +++ b/docs/cody/faq.mdx @@ -72,17 +72,6 @@ Cody Chat is optimized for coding related use cases and can be used primarily fo ## Embeddings -### Why were embeddings removed once my instance was upgraded to v5.3? - -Cody leverages **Sourcegraph Search** as a primary context provider, which comes with the following benefits: - -- **More secure**: No code being sent to a third-party embedding API -- **Easier to manage**: Less tech debt for embeddings setup and need for refreshes -- **More repos**: Sourcegraph Search scales to larger repos and a greater number. Users on Enterprise instances will now be able to select multiple repos as context sources from within the IDE -- **Equal, or better, quality**: Sourcegraph Search provides high-quality retrieval, as tested over the last ten years. When a customer sees degradation, we will be ready to respond quickly. - -We leverage multiple retrieval mechanisms to give Cody the right context and will be constantly iterating to improve Cody's quality. The most important aspect is getting the files from the codebase, not the specific algorithm used to find those files. - ### Why are embeddings no longer supported on Enterprise? Cody does not support embeddings on Cody Enterprise because we have replaced them with Sourcegraph Search. There are two driving factors: diff --git a/docs/cody/troubleshooting.mdx b/docs/cody/troubleshooting.mdx index 3baf0c456..127293278 100644 --- a/docs/cody/troubleshooting.mdx +++ b/docs/cody/troubleshooting.mdx @@ -139,7 +139,7 @@ Failed to execute 'setItem' on 'Storage': Setting the value of 'user-history:$us This error indicates that the chat history size surpasses the capacity of your browser's local storage. Cody stores comprehensive context data with each chat message, contributing to this limitation. -To fix this, navigate to https://sourcegraph.your-domain.com/cody/chat and click `Clear Chat History` if your instance is on v5.2.3+. For older versions, clear your browsing data or browser history. +To fix this, navigate to https://sourcegraph.your-domain.com/cody/chat and click `Clear Chat History`. ### Record performance traces for Cody diff --git a/docs/self-hosted/deploy/docker-compose/migrate.mdx b/docs/self-hosted/deploy/docker-compose/migrate.mdx index bdb1b8a4b..e79992170 100644 --- a/docs/self-hosted/deploy/docker-compose/migrate.mdx +++ b/docs/self-hosted/deploy/docker-compose/migrate.mdx @@ -4,7 +4,7 @@ > ⚠️ We recommend new users use our [Kubernetes Helm](/self-hosted/deploy/kubernetes) or [Docker Compose](/self-hosted/deploy/docker-compose) deployment methods. Note: [machine image](/self-hosted/deploy/machine-images/) and [script-install](/self-hosted/deploy/single-node/script) deployments are being sunset in [Sourcegraph 7.0.0](https://sourcegraph.com/changelog/releases/7.0). Existing customers can reach out to our Customer Engineering team support@sourcegraph.com for migration assistance. -Since Sourcegraph 3.13, deploying via Docker Compose is the recommended method for production deployments as it provides resource isolation between Sourcegraph services which makes it more scalable and stable. This page describes how to migrate from a single Docker image deployment to the Docker Compose deployment method. +Deploying via Docker Compose is the recommended method for production deployments as it provides resource isolation between Sourcegraph services which makes it more scalable and stable. This page describes how to migrate from a single Docker image deployment to the Docker Compose deployment method. Sourcegraph's core data (including user accounts, configuration, repository-metadata, etc.), can be migrated from the single Docker image (`sourcegraph/server`) to the Docker Compose deployment by dumping and restoring the Postgres database. @@ -12,7 +12,6 @@ Sourcegraph's core data (including user accounts, configuration, repository-meta ### Version requirements -- This migration can only be done with Sourcegraph v3.13.1+. If you are not currently on at least this version, please upgrade first. - Use the docker-compose version corresponding to your _current Sourcegraph version._ Do NOT attempt to upgrade at the same time as migrating to docker-compose. - For example, if the Sourcegraph instance `sourcegraph/server` image is version `v3.19.2` you must follow this guide using the Docker Compose deployment version `v3.19.2`. That means you must migrate to a new instance that is on _the same version you took the Database dump from._ diff --git a/docs/self-hosted/deploy/kubernetes/configure.mdx b/docs/self-hosted/deploy/kubernetes/configure.mdx index 40ddd61be..ef7bb470e 100644 --- a/docs/self-hosted/deploy/kubernetes/configure.mdx +++ b/docs/self-hosted/deploy/kubernetes/configure.mdx @@ -337,8 +337,6 @@ patches: ### Custom resources allocation -> WARNING: Only available in version 4.5.0 or above - In cases where adjusting resource allocation (e.g. replica count, resource limits, etc.) is necessary, it is important to follow the instructions provided below. > NOTE: The built-in [replica transformer](https://kubectl.docs.kubernetes.io/references/kustomize/kustomization/replicas/) is currently not supported unless being used as a component. diff --git a/docs/self-hosted/how-to/blobstore-debugging.mdx b/docs/self-hosted/how-to/blobstore-debugging.mdx index 802e49496..a7dc59821 100644 --- a/docs/self-hosted/how-to/blobstore-debugging.mdx +++ b/docs/self-hosted/how-to/blobstore-debugging.mdx @@ -1,7 +1,5 @@ # Blobstore debugging tips -If you recently updated to Sourcegraph v4.2.1+, please be sure to look at the [blobstore update notes](/self-hosted/how-to/blobstore-update-notes) - This page provides more tips on debugging why blobstore may not be working properly. **Please feel free to contact support@sourcegraph.com** if you are encountering any issues and we can help you work through debugging steps. diff --git a/docs/self-hosted/how-to/blobstore-update-notes.mdx b/docs/self-hosted/how-to/blobstore-update-notes.mdx deleted file mode 100644 index 6b100ce24..000000000 --- a/docs/self-hosted/how-to/blobstore-update-notes.mdx +++ /dev/null @@ -1,45 +0,0 @@ -# Sourcegraph 4.2.1+ blobstore update notes - -In Sourcegraph versions 4.2.1+ and 4.3+, `minio` object storage has been replaced with `sourcegraph/blobstore`. **No migration is required for most deployment types.** - -## About the change - -Sourcegraph is committed to only distributing open-source software that is permitted by other industry leaders, and prohibits the use of all software licenses [not allowed at Google](https://opensource.google/documentation/reference/thirdparty/licenses#banned). - -As a result, Sourcegraph v4.2.1+ and v4.3+ no longer use or distribute _any_ minio or AGPL-licensed software. - -If your Sourcegraph instance is already configured to use [external object storage](/self-hosted/external-services/object-storage), or you use `DISABLE_MINIO=true` in `sourcegraph/server` deployments, then this change should not affect you (there would already be no Minio software running as part of Sourcegraph). It is also safe to remove any minio specific env variables from your deployment. - -**If you are on running a proxy with the `NO_PROXY` env variable, you'll need to make sure that minio is removed from this list, and blobstore is added.** - -If you have any questions or concerns, please reach out to us via support@sourcegraph.com and we'd be happy to help. - -## If you use Kubernetes + Helm - -To update a Helm deployment, simply replace `minio` with `blobstore` in your Helm override YAML file (if present). For example: - -```diff --minio: -+blobstore: - enabled: false # Disable deployment of the built-in object storage -``` - -## If you use `sourcegraph/server` - -We are aware of an issue in `sourcegraph/server` which will be fixed in v4.3 (scheduled to be released Dec 15th.) - -You may initially encounter an error like: - -``` -failed to create bucket: operation error S3: CreateBucket, retry quota exceeded, 0 available, 5 requested -``` - -If you do encounter this, you may try simply running the container again (the 2nd time the file permissions are usually fixed.) - -To avoid this error during upgrade, please manually correct the permissions of the data directory. For example if you use the standard `--volume` commands like `--volume ~/.sourcegraph/config:/etc/sourcegraph`, then you may run: - -``` -mkdir -p ~/.sourcegraph/data/blobstore && sudo chown -R 100:101 ~/.sourcegraph/data/blobstore -``` - -After this the container should start without error. diff --git a/docs/self-hosted/how-to/clear-codeintel-data.mdx b/docs/self-hosted/how-to/clear-codeintel-data.mdx index 84cd76155..ff9ec8d5c 100644 --- a/docs/self-hosted/how-to/clear-codeintel-data.mdx +++ b/docs/self-hosted/how-to/clear-codeintel-data.mdx @@ -33,7 +33,7 @@ The following commands assume a connection to the `codeintel-db` database. Refer Truncate the following tables to clear all LSIF-encoded information from the database. This command can be run when clearing **all** data from the instance, in which case the associated records in the `frontend` database must also be cleared. -This command can also be run after a completed [migration from LSIF to SCIP](/admin/how-to/lsif-scip-migration), in which case these tables should be empty but may retain a number of blocks containing a large number of dead tuples. Truncating these _empty_ tables acts like a `VACUUM FULL` and releases the previously used disk space. +On instances that were upgraded from a version that stored LSIF-encoded data, these tables should be empty but may retain a number of blocks containing a large number of dead tuples. Truncating these _empty_ tables acts like a `VACUUM FULL` and releases the previously used disk space. ```sql BEGIN; diff --git a/docs/self-hosted/how-to/dirty-database-pre-3-37.mdx b/docs/self-hosted/how-to/dirty-database-pre-3-37.mdx deleted file mode 100644 index 5774629d3..000000000 --- a/docs/self-hosted/how-to/dirty-database-pre-3-37.mdx +++ /dev/null @@ -1,104 +0,0 @@ -# How to troubleshoot a dirty database - -> NOTE: This document refers to Sourcegraph instances with a version **strictly lower than** 3.37.0. For instructions on dealing with a dirty database for newer Sourcegraph instances, see [the updated documentation](/self-hosted/how-to/dirty-database). - -This document will take you through how to resolve a 'dirty database' error. During an upgrade, the `pgsql`, `codeintel-db`, and `codeinsights-db` databases must be migrated. If the upgrade was interrupted during the migration, this can result in a 'dirty database' error. - -The error will look something like this: - -```log -ERROR: Failed to migrate the DB. Please contact support@sourcegraph.com for further assistance: Dirty database version 1528395797. Fix and force version. -``` - -Resolving this error requires discovering which migration file failed to run, and manually attempting to run that migration. - -## Prerequisites - -- This document assumes that you are installing Sourcegraph or were attempting an upgrade when an error occurred. -- **NOTE: If you encountered this error during an upgrade, ensure you followed the [proper step upgrade process documented here.](/self-hosted/updates) If you skipped a minor version during an upgrade, you will need to revert back to the last minor version your instance was on before following the steps in this document.** - -The following procedure requires that you are able to execute commands from inside the database container. Learn more about shelling into [kubernetes](/self-hosted/deploy/kubernetes/operations#access-the-database) and [docker-compose](/self-hosted/deploy/docker-compose/operations#access-the-database) instances at these links. - -## TL;DR Steps to resolve - -_These steps pertain to the frontend database (pgsql) and are meant as a quick read for admins familiar with sql and database administration, for more explanation and details see the [detailed steps to resolution](#detailed-steps-to-resolve) below._ - -1. **Check the schema version in `psql` using the following query: `SELECT * FROM schema_migrations;`. If it's dirty, note the migration's version number.** -2. **Find the up migration with that migration's version number making sure to go to \** - - _Note: migrations in this directory are specific to the `pgsql` frontend database, learn about other databases in the [detailed steps to resolution](#detailed-steps-to-resolve)_ -3. **Run the code there explicitly.** -4. **Manually clear the dirty flag on the `schema_migrations` table.** -5. **Start up again and the remaining migrations should succeed, otherwise repeat.** - -## Detailed Steps to resolve - -### 1. Identify incomplete migration - -When migrations run, the `schema_migrations` table is updated to show the state of migrations. The `dirty` column, when set `t` (true), _indicates a migration was attempted but did not complete successfully_ (either did not yet complete or failed to complete), and the `version` column indicates the version of the migration the database is on (when not dirty), or attempted to migrate to (when dirty). On startup, the frontend will not start if the `schema_migrations` `dirty` column is set to `t`. - -**Check schema version, by querying the database version table:** `SELECT * FROM schema_migrations;` **If it's dirty, then note the version number for use in step 2.** - -Example: - -```sql -SELECT * FROM schema_migrations; -version | dirty -------------+------- -1528395539 | t -(1 row) -``` - -This indicates that migration `1528395539` was running, but has not yet completed. - -_Note: for codeintel the schema version table is called `codeintel_schema_migrations` and for codeinsights its called `codeinsights_schema_migrations`_ - -### 2. Run the sql queries to finish incomplete migrations - -Sourcegraph's migration files take for form of `sql` files following the snake case naming schema `_..sql` in subdirectories for the specific database. _Note frontend is the pgsql database_. - -1. **Find the up migration starting with the migration's version number identified in [step 1](#1-identify-incomplete-migration):** making sure to go to \ - -2. **Run the code from the identified migration _up_ file explicitly using the `psql` CLI:** - - It’s possible that one or more commands from the migration ran successfully already. In these cases you may need to run the sql transaction in pieces. For example if a migration file creates multiple indexes and one index already exists you'll need to manually run this transaction skipping that line or adding `IF NOT EXISTS` to the transaction. - - If you’re running into unique index creation errors because of duplicate values please let us know at support@sourcegraph.com or via your enterprise support channel. - - There may be other error cases that don't have an easy admin-only resolution, in these cases please let us know at support@sourcegraph.com or via your enterprise support channel. - -### 3. Verify database is clean and declare `dirty=false` - -1. **Ensure the migration applied, and manually clear the dirty flag on the `schema_migrations` table.** - - - example `psql` query: `UPDATE schema_migrations SET version=1528395918, dirty=false;` - - **Do not mark the migration table as clean if you have not verified that the migration was successfully completed.** - - Checking to see if a migration ran successfully requires looking at the migration’s `sql` file, and verifying that `sql` queries contained in the migration file have been applied to tables in the database. - - _Note: Many migrations do nothing but create tables and/or indexes or alter them._ - - You can get a description of a table and its associated indexes quickly using the `\d ` `psql` shell command (note lack of semicolon). Using this information, you can determine whether a table exists, what columns it contains, and what indexes on it exist. Use this information to determine if commands in a migration ran successfully before setting `dirty=false`. - -2. **Start Sourcegraph again and the remaining migrations should succeed, otherwise repeat this procedure again starting from the [Identify incomplete migration](#1-identify-incomplete-migration) step.** - -## Additional Information - -### `CREATE_INDEX_CONCURRENTLY` - -Some migrations utilize the `CREATE INDEX CONCURRENTLY` migration option which runs a query to create a table index as a background process ([learn more here](https://www.postgresql.org/docs/12/sql-createindex.html)). If one of these migrations fails to complete, the database will register that a table index has been created, however the index will be unusable. If you use `\d
` you will see the index for the table, but there will be nothing to tell you the indexing operation has failed. This database state can lead to poor search query performance, with searches attempting to utilize the incomplete table index. - -To resolve this, you will then need to run the migration that creates the relevant index again, replacing `CREATE INDEX CONCURRENTLY` with `REINDEX CONCURRENTLY`. You can also drop and recreate the index. - -To discover if such a damaged index exists by run the following query: - -```sql -SELECT - current_database() AS datname, - pc.relname AS relname, - 1 AS count -FROM pg_class pc -JOIN pg_index pi ON pi.indexrelid = pc.oid -WHERE - NOT indisvalid AND - NOT EXISTS (SELECT 1 FROM pg_stat_progress_create_index pci WHERE pci.index_relid = pi.indexrelid) -``` - -Additionally Grafana will alert you of an index is in this state. _The Grafana alert can be found under it's database's charts._ Ex: `Site Admin > Monitoring > Postgres > Invalid Indexes (unusable by query planner)` - -## Further resources - -- [Sourcegraph - Upgrading Sourcegraph to a new version](/self-hosted/updates) diff --git a/docs/self-hosted/how-to/dirty-database.mdx b/docs/self-hosted/how-to/dirty-database.mdx index c71f02939..34136735c 100644 --- a/docs/self-hosted/how-to/dirty-database.mdx +++ b/docs/self-hosted/how-to/dirty-database.mdx @@ -1,7 +1,5 @@ # How to troubleshoot a dirty database -> NOTE: If you are on a version **strictly lower than** Sourcegraph 3.37.0, see the [legacy dirty database documentation](/self-hosted/how-to/dirty-database-pre-3-37). The following documentation applies only to Sourcegraph instances version 3.37.0 and above. - This document will take you through how to resolve a 'dirty database' error. During instance startup, the `migrator` process will run any schema migrations necessary to bring the database up to the shape the code expects. If an error is encountered during this startup sequence or a multi-version upgrade, or if execution of either actions were interrupted, the schema will be marked as dirty and will require some form of user intervention. diff --git a/docs/self-hosted/how-to/index.mdx b/docs/self-hosted/how-to/index.mdx index a9b6256e0..63ada9327 100644 --- a/docs/self-hosted/how-to/index.mdx +++ b/docs/self-hosted/how-to/index.mdx @@ -9,15 +9,13 @@ - [How to troubleshoot an unfinished migration](/self-hosted/how-to/unfinished-migration) - [How to enable or disable an experimental feature](/admin/how-to/enable-experimental-feature) - [How to diagnose an `Unknown Error` during login to your Sourcegraph instance](/admin/how-to/unknown-error-login) -- [How to convert version contexts to search contexts](/admin/how-to/converting-version-contexts-to-search-contexts) - [How to troubleshoot pod evictions](/self-hosted/how-to/troubleshoot-pod-eviction) - [How to monitor your Sourcegraph instance](/self-hosted/how-to/monitoring-guide) - [How to troubleshoot a repository that is not being updated](/admin/how-to/repo-not-updated) - [How to configure submodules](/admin/how-to/submodule-configuration) - [How to remove users or edit users with the GraphQL API](/admin/how-to/mutate-user-api) - [How to setup HTTPS connection with Ingress controller on your Kubernetes instance](/self-hosted/how-to/setup-https) -- [How to rebuild corrupt Postgres indexes after upgrading to 3.30 or 3.30.1](/self-hosted/how-to/rebuild-corrupt-postgres-indexes) -- [How to determine cause for Precise-code-intel-worker in CrashLoopBackOff status](/self-hosted/how-to/precise-code-intel-worker-crashloopbackoff) +- [How to rebuild corrupt Postgres indexes](/self-hosted/how-to/rebuild-corrupt-postgres-indexes) - [How to troubleshoot a failure to update repositories when new repositories are added](/admin/how-to/update-repo-failure) - [How to run postgres queries in your Sourcegraph instance](/self-hosted/how-to/run-psql) - [How to purge deleted repository data from Sourcegraph](/admin/how-to/remove-repo#manually-purge-deleted-repository-data-from-disk) @@ -25,7 +23,6 @@ - [How to Set a password for Redis using a ConfigMap](/self-hosted/how-to/redis-configmap) - [How to import a set of internal repositories to Sourcegraph](/admin/how-to/internal-github-repos) - [How to identify and resolve index corruption in postgres 14](/self-hosted/how-to/postgres14-index-corruption) -- [Migrating code intelligence data from LSIF to SCIP (Sourcegraph 4.5 -> 4.6)](/admin/how-to/lsif-scip-migration) - [How to export search results](/admin/how-to/export-search-results) - [How to debug / confirm blobstore is healthy](/self-hosted/how-to/blobstore-debugging) - [How to handle postgresql 12 to 16 drift](/self-hosted/how-to/postgres-12-to-16-drift) 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 deleted file mode 100644 index 123e99458..000000000 --- a/docs/self-hosted/how-to/precise-code-intel-worker-crashloopbackoff.mdx +++ /dev/null @@ -1,29 +0,0 @@ -# How to determine why the precise-code-intel-worker is in CrashLoopBackOff status in Kubernetes deployment - -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`.](https://sourcegraph.com/changelog/self-hosted/kubernetes) - -## Symptoms - -When running `kubectl get pods` you notice that the `precise-code-intel-worker` is in this state, example: - -```bash -precise-code-intel-worker-9b69b5b59-jl6vd 0/1 CrashLoopBackOff 416 2d5h -precise-code-intel-worker-9b69b5b59-z7xx4 0/1 CrashLoopBackOff 415 2d5h -``` - -## Steps to resolve - -1. Check what version of Sourcegraph you are on. If it is 3.22 or later, you will need to deploy `MinIO` because the `precise-code-intel-worker` depends on MinIO to function. If 3.4.2+, then minio is no longer used and instead `sourcegraph/blobstore` is used. - -2. [Check what pods you have deployed and make sure MinIO is in the list.](/self-hosted/deploy/kubernetes/operations#list-pods-in-cluster) - - `kubectl get pods -o wide` - -3. If blobstore is not deployed, make sure you include the blobstore components in your Sourcegraph deployment. For modern Sourcegraph versions (3.4.2+), blobstore replaces MinIO. - -## Further resources - -- [Sourcegraph - Kubernetes Configuration](/self-hosted/deploy/kubernetes/configure) -- [Deploy Sourcegraph K8s - blobstore](https://github.com/sourcegraph/deploy-sourcegraph-k8s/tree/main/base/sourcegraph/blobstore) diff --git a/docs/self-hosted/how-to/rebuild-corrupt-postgres-indexes.mdx b/docs/self-hosted/how-to/rebuild-corrupt-postgres-indexes.mdx index 2742b4c1b..d89573dc3 100644 --- a/docs/self-hosted/how-to/rebuild-corrupt-postgres-indexes.mdx +++ b/docs/self-hosted/how-to/rebuild-corrupt-postgres-indexes.mdx @@ -120,7 +120,7 @@ commit; In case your database is large and `reindex (verbose) database sg` takes too long to re-run multiple times as you remove duplicates, you can instead run individual index rebuilding statements, and resume where you left of. -Here's a query that produces a list of such statements for all indexes that contain collatable key columns (we had corruption in these indexes in the 3.30 upgrade). This is a sub-set of the indexes that gets re-indexed by `reindex database sg`. +Here's a query that produces a list of such statements for all indexes that contain collatable key columns. This is a sub-set of the indexes that gets re-indexed by `reindex database sg`. ```sql select diff --git a/docs/self-hosted/how-to/rollback-database.mdx b/docs/self-hosted/how-to/rollback-database.mdx index 69793cdec..ea184231e 100644 --- a/docs/self-hosted/how-to/rollback-database.mdx +++ b/docs/self-hosted/how-to/rollback-database.mdx @@ -9,8 +9,6 @@ If a customer downgrades their instance to a previous version, they need to down ## Resolution -> NOTE: This process applies only to versions `3.37` and later. - > NOTE: A customer rollback is considered an **emergency operation**. Please contact support at `mailto:support@sourcegraph.com` for guidance on this operation. A database schema downgrade will not always be enough. If a newer version was running even for a small time, it could have migrated data in the background into a format that's no longer readable by the previous version of Sourcegraph. diff --git a/docs/self-hosted/index.mdx b/docs/self-hosted/index.mdx index 75878f207..368a30459 100644 --- a/docs/self-hosted/index.mdx +++ b/docs/self-hosted/index.mdx @@ -98,13 +98,10 @@ Get started running Sourcegraph on-prem. ## [How-to Guides](/self-hosted/how-to/) - [Blobstore debugging](/self-hosted/how-to/blobstore-debugging) -- [Blobstore update notes](/self-hosted/how-to/blobstore-update-notes) - [Clear code intelligence data](/self-hosted/how-to/clear-codeintel-data) -- [Dirty database (pre 3.37)](/self-hosted/how-to/dirty-database-pre-3-37) - [Dirty database](/self-hosted/how-to/dirty-database) - [PostgreSQL 12 to 16 drift](/self-hosted/how-to/postgres-12-to-16-drift) - [PostgreSQL 14 index corruption](/self-hosted/how-to/postgres14-index-corruption) -- [Precise code intel worker crashloopbackoff](/self-hosted/how-to/precise-code-intel-worker-crashloopbackoff) - [Privileged migrations](/self-hosted/how-to/privileged-migrations) - [Rebuild corrupt PostgreSQL indexes](/self-hosted/how-to/rebuild-corrupt-postgres-indexes) - [Redis ConfigMap](/self-hosted/how-to/redis-configmap) diff --git a/docs/self-hosted/observability/troubleshooting.mdx b/docs/self-hosted/observability/troubleshooting.mdx index 4b0fa957b..6922157d1 100644 --- a/docs/self-hosted/observability/troubleshooting.mdx +++ b/docs/self-hosted/observability/troubleshooting.mdx @@ -223,7 +223,7 @@ zoekt-webserver has a built in watchdog which ensures it can respond to search r By default the watchdog runs every 30s. If the watchdog fails 3 consecutive times (with a 30s sleep in-between) it will trigger the panic. This is usually indicative a server which is consistently overloaded. It is recommended to increase the CPU quota assigned to it or horizontally scale to more replicas. -From Sourcegraph 3.22 you can configure the watchdog via environment variables: +You can configure the watchdog via environment variables: - `ZOEKT_WATCHDOG_TICK` :: Duration of how often it runs. (default 30s) - `ZOEKT_WATCHDOG_ERRORS` :: Consecutive error count before exit. (default 3) diff --git a/docs/self-hosted/postgres12-end-of-life-notice.mdx b/docs/self-hosted/postgres12-end-of-life-notice.mdx index 20a55bdb5..a179c64ff 100644 --- a/docs/self-hosted/postgres12-end-of-life-notice.mdx +++ b/docs/self-hosted/postgres12-end-of-life-notice.mdx @@ -4,11 +4,11 @@ As of [Sourcegraph 7.0.0](https://sourcegraph.com/changelog/releases/7.0), the automatic PostgreSQL 12 to 16 upgrade entrypoint script has been fully removed from the database container images. Users still on PostgreSQL 12 must upgrade to a Sourcegraph 6.x release first to perform the automatic database upgrade before upgrading to 7.0.0 or later. -Sourcegraph's required minimum version of Postgres will be updated to Postgres 16 with upcoming releases, Sourcegraph 5.10. This change in required minimum version is a result of Postgres 12, the previous required minimum version, reaching end of life. Please review the below information and reach out if you have any questions or would like to review the impact this change will have on you! +Sourcegraph's required minimum version of Postgres was updated to Postgres 16 in Sourcegraph 5.10. This change in required minimum version is a result of Postgres 12, the previous required minimum version, reaching end of life. Please review the below information and reach out if you have any questions or would like to review the impact this change has on you. ## What -Currently, Sourcegraph's minimum required version of Postgres, the database management system used for all Sourcegraph instances, is Postgres 12. Postgres 12 is reaching end-of-life and will no longer be supported by Postgres. Because of this, Sourcegraph will be updating our minimum supported version to Postgres 16. +Prior to Sourcegraph 5.10, Sourcegraph's minimum required version of Postgres, the database management system used for all Sourcegraph instances, was Postgres 12. Postgres 12 has reached end-of-life and is no longer supported by Postgres. Because of this, Sourcegraph updated our minimum supported version to Postgres 16. ## Impact @@ -19,7 +19,7 @@ The impact to you depends on how you currently manage your Sourcegraph databases ### Built-in Databases -If you are using Sourcegraph's released Postgres images, these images will be updated to Postgres 16 as part of the Sourcegraph 5.10 release (expected for November 25th, 2024) and all near term subsequent releases. With this update, Sourcegraph will experience a longer-than-average downtime at the time of the upgrade to version 5.10 or beyond. This downtime is proportional to the amount of code indexed in your instance, and can range from approximately 15 minutes to a couple of hours. The downtime will only occur at the first upgrade to version 5.10 or beyond, and not during any subsequent upgrades. +If you are using Sourcegraph's released Postgres images, these images were updated to Postgres 16 as part of the Sourcegraph 5.10 release and all subsequent releases. With this update, Sourcegraph will experience a longer-than-average downtime at the time of the upgrade to version 5.10 or beyond. This downtime is proportional to the amount of code indexed in your instance, and can range from approximately 15 minutes to a couple of hours. The downtime will only occur at the first upgrade to version 5.10 or beyond, and not during any subsequent upgrades. We strongly recommend that you consider this downtime prior to upgrading to ensure minimal disruption to your users. We also strongly recommend creating a backup of your database before the upgrade process, as an interruption to the upgrade process could lead to database corruption. @@ -32,7 +32,7 @@ We strongly recommend that you consider this downtime prior to upgrading to ensu ### External Databases -If you are using externally managed databases for your Sourcegraph instance, you will need to manually upgrade the version of Postgres you are using to Postgres 16. For the Sourcegraph version that will be released on January 15, 2025 and subsequent versions, Sourcegraph will no longer run on any version of Postgres lower than Postgres 16, and you will not be able to upgrade your instance to any of those Sourcegraph versions unless that minimum required version of Postgres is met. +If you are using externally managed databases for your Sourcegraph instance, you will need to manually upgrade the version of Postgres you are using to Postgres 16. As of Sourcegraph 6.0.0, Sourcegraph will no longer run on any version of Postgres lower than Postgres 16, and you will not be able to upgrade your instance to any of those Sourcegraph versions unless that minimum required version of Postgres is met. The steps for upgrading your version of Postgres will be dependent on your organizational practices and the database management service you are using. @@ -44,7 +44,7 @@ The steps for upgrading your version of Postgres will be dependent on your organ ## Frequently Asked Questions -### Will I be required to upgrade to the latest version of Sourcegraph by November 25, 2024 or January 15, 2025? +### Am I required to upgrade to the latest version of Sourcegraph? No, you will not be required to upgrade to the latest version of Sourcegraph. However, as always, we do recommend you are updating your instance regularly to continue getting the latest and greatest features and fixes. diff --git a/docs/technical-changelog.mdx b/docs/technical-changelog.mdx index 9169574f3..fd5dfbaa6 100644 --- a/docs/technical-changelog.mdx +++ b/docs/technical-changelog.mdx @@ -12315,7 +12315,7 @@ The following PRs were merged onto the previous release branch but could not be - Endpoint environment variables (`SEARCHER_URL`, `SYMBOLS_URL`, `INDEXED_SEARCH_SERVERS`, `SRC_GIT_SERVERS`) now can be set to replica count values in Kubernetes, Kustomize, Helm and Docker Compose environments. This avoids the need to use service discovery or generating the respective list of addresses in those environments. [#45862](https://github.com/sourcegraph/sourcegraph-public-snapshot/pull/45862) - The default author and email for changesets will now be pulled from user account details when possible. [#46385](https://github.com/sourcegraph/sourcegraph-public-snapshot/pull/46385) - Code Insights has a new display option: "Max number of series points to display". This setting controls the number of data points you see per series on an insight. [#46653](https://github.com/sourcegraph/sourcegraph-public-snapshot/pull/46653) -- Added out-of-band migration that will migrate all existing data from LSIF to SCIP (see additional [migration documenta[tion](/admin/how-to/lsif-scip-migration)). [#45106](https://github.com/sourcegraph/sourcegraph-public-snapshot/pull/45106)) +- Added out-of-band migration that will migrate all existing data from LSIF to SCIP. [#45106](https://github.com/sourcegraph/sourcegraph-public-snapshot/pull/45106)) - Code Insights has a new search-powered repositories field that allows you to select repositories with Sourcegraph search syntax. [#45687](https://github.com/sourcegraph/sourcegraph-public-snapshot/pull/45687) - You can now export all data for a Code Insight from the card menu or the standalone page. [#46795](https://github.com/sourcegraph/sourcegraph-public-snapshot/pull/46795), [#46694](https://github.com/sourcegraph/sourcegraph-public-snapshot/pull/46694) - Added Gerrit as an officially supported code host with permissions syncing. [#46763](https://github.com/sourcegraph/sourcegraph-public-snapshot/pull/46763) @@ -12489,7 +12489,7 @@ The following PRs were merged onto the previous release branch but could not be # v4.2.1 -- `minio` has been replaced with `blobstore`. Please see the update notes [here](/self-hosted/how-to/blobstore-update-notes) +- `minio` has been replaced with `blobstore`. # v4.2.0 diff --git a/src/data/redirects.ts b/src/data/redirects.ts index e480a4195..9d4a00ebf 100644 --- a/src/data/redirects.ts +++ b/src/data/redirects.ts @@ -5056,8 +5056,7 @@ const redirectsData = [ }, { source: '/admin/how-to/precise-code-intel-worker-crashloopbackoff', - destination: - '/self-hosted/how-to/precise-code-intel-worker-crashloopbackoff' + destination: '/code-navigation/troubleshooting' }, { source: '/admin/how-to/privileged_migrations', @@ -5368,7 +5367,7 @@ const redirectsData = [ }, { source: '/admin/how-to/lsif_scip_migration', - destination: '/admin/how-to/lsif-scip-migration' + destination: '/self-hosted/how-to/clear-codeintel-data' }, { source: '/admin/how-to/update_repo_failure', @@ -5749,7 +5748,7 @@ const redirectsData = [ }, { source: '/self-hosted/how-to/blobstore_update_notes', - destination: '/self-hosted/how-to/blobstore-update-notes' + destination: '/self-hosted/how-to/blobstore-debugging' }, { source: '/self-hosted/how-to/clear_codeintel_data', @@ -5761,7 +5760,7 @@ const redirectsData = [ }, { source: '/self-hosted/how-to/dirty_database_pre_3_37', - destination: '/self-hosted/how-to/dirty-database-pre-3-37' + destination: '/self-hosted/how-to/dirty-database' }, { source: '/self-hosted/how-to/postgres_12_to_16_drift', @@ -5894,6 +5893,26 @@ const redirectsData = [ source: '/code-search/how-to/create-search-context-graphql', destination: '/api' }, + { + source: '/self-hosted/how-to/blobstore-update-notes', + destination: '/self-hosted/how-to/blobstore-debugging' + }, + { + source: '/self-hosted/how-to/precise-code-intel-worker-crashloopbackoff', + destination: '/code-navigation/troubleshooting' + }, + { + source: '/self-hosted/how-to/dirty-database-pre-3-37', + destination: '/self-hosted/how-to/dirty-database' + }, + { + source: '/admin/how-to/lsif-scip-migration', + destination: '/self-hosted/how-to/clear-codeintel-data' + }, + { + source: '/admin/how-to/converting-version-contexts-to-search-contexts', + destination: '/code-search/working/search-contexts' + }, ]; const updatedRedirectsData = redirectsData.map(redirect => {