diff options
author | GitLab Bot <gitlab-bot@gitlab.com> | 2022-04-07 18:08:29 +0000 |
---|---|---|
committer | GitLab Bot <gitlab-bot@gitlab.com> | 2022-04-07 18:08:29 +0000 |
commit | c2bdb9d02768a61bee7560113f4d4c83dc91338e (patch) | |
tree | e242f8d39df80ec39a59eb73ad96ee389c8a4d41 /doc | |
parent | fe4751154c331e35c0e6575a3aedc02b210a1c63 (diff) | |
download | gitlab-ce-c2bdb9d02768a61bee7560113f4d4c83dc91338e.tar.gz |
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc')
-rw-r--r-- | doc/administration/package_information/postgresql_versions.md | 4 | ||||
-rw-r--r-- | doc/administration/package_information/supported_os.md | 6 | ||||
-rw-r--r-- | doc/api/runners.md | 4 | ||||
-rw-r--r-- | doc/ci/runners/runners_scope.md | 25 | ||||
-rw-r--r-- | doc/development/documentation/feature_flags.md | 47 | ||||
-rw-r--r-- | doc/development/service_ping/implement.md | 2 | ||||
-rw-r--r-- | doc/update/deprecations.md | 32 | ||||
-rw-r--r-- | doc/user/admin_area/settings/continuous_integration.md | 22 | ||||
-rw-r--r-- | doc/user/admin_area/settings/img/continuous_integration_shared_runner_details_input_v14_10.png | bin | 0 -> 10770 bytes | |||
-rw-r--r-- | doc/user/admin_area/settings/img/continuous_integration_shared_runner_details_v14_0.png | bin | 80106 -> 0 bytes | |||
-rw-r--r-- | doc/user/admin_area/settings/img/continuous_integration_shared_runner_details_v14_10.png | bin | 0 -> 9849 bytes | |||
-rw-r--r-- | doc/user/group/iterations/index.md | 6 | ||||
-rw-r--r-- | doc/user/markdown.md | 1 | ||||
-rw-r--r-- | doc/user/project/settings/import_export.md | 2 | ||||
-rw-r--r-- | doc/user/shortcuts.md | 6 |
15 files changed, 110 insertions, 47 deletions
diff --git a/doc/administration/package_information/postgresql_versions.md b/doc/administration/package_information/postgresql_versions.md index e707cb70187..c80437221c4 100644 --- a/doc/administration/package_information/postgresql_versions.md +++ b/doc/administration/package_information/postgresql_versions.md @@ -26,8 +26,8 @@ Read more about update policies and warnings in the PostgreSQL | GitLab version | PostgreSQL versions | Default version for fresh installs | Default version for upgrades | Notes | | -------------- | --------------------- | ---------------------------------- | ---------------------------- | ----- | -| 14.1 | 12.6, 13.3 | 12.6 | 12.6 | PostgreSQL 13 available for fresh installations if not using [Geo](../geo/index.md#requirements-for-running-geo) or [Patroni](../postgresql/index.md#postgresql-replication-and-failover-with-omnibus-gitlab). -| 14.0 | 12.6 | 12.6 | 12.6 | HA installations with repmgr are no longer supported and will be prevented from upgrading to Omnibus GitLab 14.0 | +| 14.1 | 12.7, 13.3 | 12.7 | 12.7 | PostgreSQL 13 available for fresh installations if not using [Geo](../geo/index.md#requirements-for-running-geo) or [Patroni](../postgresql/index.md#postgresql-replication-and-failover-with-omnibus-gitlab). +| 14.0 | 12.7 | 12.7 | 12.7 | HA installations with repmgr are no longer supported and will be prevented from upgrading to Omnibus GitLab 14.0 | | 13.8 | 11.9, 12.4 | 12.4 | 12.4 | Package upgrades automatically performed PostgreSQL upgrade for nodes that are not part of a Geo or HA cluster.). | | 13.7 | 11.9, 12.4 | 12.4 | 11.9 | For upgrades users can manually upgrade to 12.4 following the [upgrade docs](https://docs.gitlab.com/omnibus/settings/database.html#gitlab-133-and-later). | | 13.4 | 11.9, 12.4 | 11.9 | 11.9 | Package upgrades aborted if users not running PostgreSQL 11 already | diff --git a/doc/administration/package_information/supported_os.md b/doc/administration/package_information/supported_os.md index cda5f5a5928..16038b9ebf5 100644 --- a/doc/administration/package_information/supported_os.md +++ b/doc/administration/package_information/supported_os.md @@ -28,10 +28,10 @@ The following lists the currently supported OSs and their possible EOL dates. | Ubuntu 18.04 | GitLab CE / GitLab EE 10.7.0 | amd64 | April 2023 | <https://wiki.ubuntu.com/Releases> | | Ubuntu 20.04 | GitLab CE / GitLab EE 13.2.0 | amd64, arm64 | April 2025 | <https://wiki.ubuntu.com/Releases> | | Amazon Linux 2 | GitLab CE / GitLab EE 14.9.0 | amd64, arm64 | June 2023 | <https://aws.amazon.com/amazon-linux-2/faqs/> | -| Raspbian Buster | GitLab CE 12.2.0 | armhf | 2022 | <https://wiki.debian.org/DebianReleases#Production_Releases> | +| Raspberry Pi OS (Buster) (formerly known as Raspbian Buster) | GitLab CE 12.2.0 | armhf | 2024 | <https://www.raspberrypi.com/news/new-old-functionality-with-raspberry-pi-os-legacy/> | NOTE: -CentOS 8 will be EOL on December 31, 2021. In GitLab 14.5 and later, +CentOS 8 was EOL on December 31, 2021. In GitLab 14.5 and later, [CentOS builds work in AlmaLinux](https://gitlab.com/gitlab-org/distribution/team-tasks/-/issues/954#note_730198505). We will officially support all distributions that are binary compatible with Red Hat Enterprise Linux. This gives users a path forward for their CentOS 8 builds at its end of life. @@ -78,7 +78,7 @@ release for them can be found below: | Ubuntu 14.04 | [April 2019](https://ubuntu.com/info/release-end-of-life) | [GitLab CE](https://packages.gitlab.com/app/gitlab/gitlab-ce/search?q=gitlab-ce_11.10&dist=ubuntu%2Ftrusty) / [GitLab EE](https://packages.gitlab.com/app/gitlab/gitlab-ee/search?q=gitlab-ee_11.10&dist=ubuntu%2Ftrusty) 11.10 | | OpenSUSE 42.3 | [July 2019](https://en.opensuse.org/Lifetime#Discontinued_distributions) | [GitLab CE](https://packages.gitlab.com/app/gitlab/gitlab-ce/search?q=gitlab-ce-12.1&dist=opensuse%2F42.3) / [GitLab EE](https://packages.gitlab.com/app/gitlab/gitlab-ee/search?q=gitlab-ee-12.1&dist=opensuse%2F42.3) 12.1 | | OpenSUSE 15.0 | [December 2019](https://en.opensuse.org/Lifetime#Discontinued_distributions) | [GitLab CE](https://packages.gitlab.com/app/gitlab/gitlab-ce/search?q=gitlab-ce-12.5&dist=opensuse%2F15.0) / [GitLab EE](https://packages.gitlab.com/app/gitlab/gitlab-ee/search?q=gitlab-ee-12.5&dist=opensuse%2F15.0) 12.5 | -| Raspbian Stretch | [June 2020](https://downloads.raspberrypi.org/raspbian/images/raspbian-2019-04-09/) | [GitLab CE](https://packages.gitlab.com/app/gitlab/raspberry-pi2/search?q=gitlab-ce_13.2&dist=raspbian%2Fstretch) 13.3 | +| Raspbian Stretch | [June 2020](https://downloads.raspberrypi.org/raspbian/images/raspbian-2019-04-09/) | [GitLab CE](https://packages.gitlab.com/app/gitlab/raspberry-pi2/search?q=gitlab-ce_13.3&dist=raspbian%2Fstretch) 13.3 | | Debian Jessie | [June 2020](https://www.debian.org/News/2020/20200709) | [GitLab CE](https://packages.gitlab.com/app/gitlab/gitlab-ce/search?q=gitlab-ce_13.2&dist=debian%2Fjessie) / [GitLab EE](https://packages.gitlab.com/app/gitlab/gitlab-ee/search?q=gitlab-ee_13.2&dist=debian%2Fjessie) 13.3 | | CentOS 6 | [November 2020](https://wiki.centos.org/About/Product) | [GitLab CE](https://packages.gitlab.com/app/gitlab/gitlab-ce/search?q=13.6&filter=all&filter=all&dist=el%2F6) / [GitLab EE](https://packages.gitlab.com/app/gitlab/gitlab-ee/search?q=13.6&filter=all&filter=all&dist=el%2F6) 13.6 | | OpenSUSE 15.1 | [November 2020](https://en.opensuse.org/Lifetime#Discontinued_distributions) | [GitLab CE](https://packages.gitlab.com/app/gitlab/gitlab-ce/search?q=gitlab-ce-13.12&dist=opensuse%2F15.1) / [GitLab EE](https://packages.gitlab.com/app/gitlab/gitlab-ee/search?q=gitlab-ee-13.12&dist=opensuse%2F15.1) 13.12 | diff --git a/doc/api/runners.md b/doc/api/runners.md index c450efe8c3f..304f2494f70 100644 --- a/doc/api/runners.md +++ b/doc/api/runners.md @@ -448,7 +448,7 @@ Example response: ## List project's runners -List all runners available in the project, including from ancestor groups and [any allowed shared runners](../ci/runners/runners_scope.md#enable-shared-runners). +List all runners available in the project, including from ancestor groups and [any allowed shared runners](../ci/runners/runners_scope.md#enable-shared-runners-for-a-project). ```plaintext GET /projects/:id/runners @@ -566,7 +566,7 @@ curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" "https://git ## List group's runners -List all runners available in the group as well as its ancestor groups, including [any allowed shared runners](../ci/runners/runners_scope.md#enable-shared-runners). +List all runners available in the group as well as its ancestor groups, including [any allowed shared runners](../ci/runners/runners_scope.md#enable-shared-runners-for-a-group). ```plaintext GET /groups/:id/runners diff --git a/doc/ci/runners/runners_scope.md b/doc/ci/runners/runners_scope.md index fb5395076b0..6082a17d001 100644 --- a/doc/ci/runners/runners_scope.md +++ b/doc/ci/runners/runners_scope.md @@ -37,22 +37,31 @@ If you are using GitLab.com: - The shared runners consume the [CI/CD minutes](../pipelines/cicd_minutes.md) included with your account. -### Enable shared runners +### Enable shared runners for a project On GitLab.com, [shared runners](index.md) are enabled in all projects by default. -On self-managed instances of GitLab, an administrator must [install](https://docs.gitlab.com/runner/install/index.html) -and [register](https://docs.gitlab.com/runner/register/index.html) them. +On self-managed instances of GitLab, an administrator can +[enable them for all new projects](../../user/admin_area/settings/continuous_integration.md#enable-shared-runners-for-new-projects). -You can also enable shared runners for individual projects. +For existing projects, an administrator must +[install](https://docs.gitlab.com/runner/install/index.html) and +[register](https://docs.gitlab.com/runner/register/index.html) them. -To enable shared runners: +To enable shared runners for a project: 1. Go to the project's **Settings > CI/CD** and expand the **Runners** section. 1. Select **Enable shared runners for this project**. -### Disable shared runners +### Enable shared runners for a group + +To enable shared runners for a group: + +1. Go to the group's **Settings > CI/CD** and expand the **Runners** section. +1. Select **Enable shared runners for this group**. + +### Disable shared runners for a project You can disable shared runners for individual projects or for groups. You must have the Owner role for the project @@ -68,6 +77,8 @@ Shared runners are automatically disabled for a project: - If the shared runners setting for the parent group is disabled, and - If overriding this setting is not permitted at the project level. +### Disable shared runners for a group + To disable shared runners for a group: 1. Go to the group's **Settings > CI/CD** and expand the **Runners** section. @@ -78,7 +89,7 @@ To disable shared runners for a group: NOTE: To re-enable the shared runners for a group, turn on the **Enable shared runners for this group** toggle. -Then, an owner or maintainer must explicitly change this setting +Then, a user with the Owner or Maintainer role must explicitly change this setting for each project subgroup or project. ### How shared runners pick jobs diff --git a/doc/development/documentation/feature_flags.md b/doc/development/documentation/feature_flags.md index 1e4698ff867..fb58851e93f 100644 --- a/doc/development/documentation/feature_flags.md +++ b/doc/development/documentation/feature_flags.md @@ -19,8 +19,29 @@ must be documented. For context, see the When you document feature flags, you must: -- [Add a note at the start of the topic](#use-a-note-to-describe-the-state-of-the-feature-flag). - [Add version history text](#add-version-history-text). +- [Add a note at the start of the topic](#use-a-note-to-describe-the-state-of-the-feature-flag). + +## Add version history text + +When the state of a flag changes (for example, disabled by default to enabled by default), add the change to the version history. + +Possible version history entries are: + +```markdown +> - [Introduced](issue-link) in GitLab X.X [with a flag](../../administration/feature_flags.md) named <flag name>. Disabled by default. +> - [Enabled on GitLab.com](issue-link) in GitLab X.X. +> - [Enabled on GitLab.com](issue-link) in GitLab X.X. Available to GitLab.com administrators only. +> - [Enabled on self-managed](issue-link) in GitLab X.X. +> - [Generally available](issue-link) in GitLab X.Y. [Feature flag <flag name>](issue-link) removed. +``` + +You can combine entries if they happened in the same release: + +```markdown +> - Introduced in GitLab 14.2 [with a flag](../../administration/feature_flags.md) named `ci_include_rules`. Disabled by default. +> - [Enabled on GitLab.com and self-managed](https://gitlab.com/gitlab-org/gitlab/-/issues/337507) in GitLab 14.3. +``` ## Use a note to describe the state of the feature flag @@ -30,7 +51,8 @@ The note has three parts, and follows this structure: ```markdown FLAG: -<Self-managed GitLab availability information.> <GitLab.com availability information.> +<Self-managed GitLab availability information.> +<GitLab.com availability information.> <This feature is not ready for production use.> ``` @@ -61,27 +83,6 @@ If needed, you can add this sentence: `The feature is not ready for production use.` -## Add version history text - -When the state of a flag changes (for example, disabled by default to enabled by default), add the change to the version history. - -Possible version history entries are: - -```markdown -> - [Introduced](issue-link) in GitLab X.X [with a flag](../../administration/feature_flags.md) named <flag name>. Disabled by default. -> - [Enabled on GitLab.com](issue-link) in GitLab X.X. -> - [Enabled on GitLab.com](issue-link) in GitLab X.X. Available to GitLab.com administrators only. -> - [Enabled on self-managed](issue-link) in GitLab X.X. -> - [Generally available](issue-link) in GitLab X.Y. [Feature flag <flag name>](issue-link) removed. -``` - -You can combine entries if they happened in the same release: - -```markdown -> - Introduced in GitLab 14.2 [with a flag](../../administration/feature_flags.md) named `ci_include_rules`. Disabled by default. -> - [Enabled on GitLab.com and self-managed](https://gitlab.com/gitlab-org/gitlab/-/issues/337507) in GitLab 14.3. -``` - ## Feature flag documentation examples The following examples show the progression of a feature flag. diff --git a/doc/development/service_ping/implement.md b/doc/development/service_ping/implement.md index 25e841e113b..ca4a0158051 100644 --- a/doc/development/service_ping/implement.md +++ b/doc/development/service_ping/implement.md @@ -760,7 +760,7 @@ To set up Service Ping locally, you must: 1. Clone and start [Versions Application](https://gitlab.com/gitlab-services/version-gitlab-com). Make sure you run `docker-compose up` to start a PostgreSQL and Redis instance. 1. Point GitLab to the Versions Application endpoint instead of the default endpoint: - 1. Open [service_ping/submit_service.rb](https://gitlab.com/gitlab-org/gitlab/-/blob/master/app/services/service_ping/submit_service.rb#L5) in your local and modified `PRODUCTION_URL`. + 1. Open [service_ping/submit_service.rb](https://gitlab.com/gitlab-org/gitlab/-/blob/master/app/services/service_ping/submit_service.rb#L5) locally and modify `STAGING_BASE_URL`. 1. Set it to the local Versions Application URL: `http://localhost:3000/usage_data`. ### Test local setup diff --git a/doc/update/deprecations.md b/doc/update/deprecations.md index 752e05a8cd4..0bbaf677a75 100644 --- a/doc/update/deprecations.md +++ b/doc/update/deprecations.md @@ -42,6 +42,38 @@ Each deprecation has a **planned removal milestone** and indicates whether it is Most of the deprecations are **planned for removal in 15.0**, and many of them are **breaking changes**. +## 14.10 + +### Manual iteration management + +WARNING: +This feature will be changed or removed in 16.0 +as a [breaking change](https://docs.gitlab.com/ee/development/contributing/#breaking-changes). +Before updating GitLab, review the details carefully to determine if you need to make any +changes to your code, settings, or workflow. + +Manual iteration management is deprecated and only automatic iteration cadences will be supported in the future. + +Creating and deleting iterations will be fully removed in 16.0. Updating all iteration fields except for +`description` will also be removed. + +On the GraphQL API the following mutations will be removed: + + 1. `iterationCreate` + 1. `iterationDelete` + +The update `updateIteration` mutation will only allow updating the iteration's `description`. The following +arguments will be removed: + + 1. `title` + 1. `dueDate` + 1. `startDate` + +For more information about iteration cadences, you can refer to +[the documentation of the feature](https://docs.gitlab.com/ee/user/group/iterations/#iteration-cadences). + +**Planned removal milestone: 16.0 (2023-04-22)** + ## 14.9 ### Background upload for object storage diff --git a/doc/user/admin_area/settings/continuous_integration.md b/doc/user/admin_area/settings/continuous_integration.md index 0330d89aedc..7d968ff5e86 100644 --- a/doc/user/admin_area/settings/continuous_integration.md +++ b/doc/user/admin_area/settings/continuous_integration.md @@ -28,7 +28,18 @@ From now on, every existing project and newly created ones that don't have a If you want to disable it for a specific project, you can do so in [its settings](../../../topics/autodevops/index.md#enable-or-disable-auto-devops). -## Shared runner details +## Enable shared runners for new projects + +You can set all new projects to have the instance's shared runners available by default. + +1. On the top bar, select **Menu > Admin**. +1. On the left sidebar, select **Settings > CI/CD**. +1. Expand **Continuous Integration and Deployment**. +1. Select the **Enable shared runners for new projects** checkbox. + +Any time a new project is created, the shared runners are available. + +## Add a message for shared runners To display details about the instance's shared runners in all projects' runner settings: @@ -36,16 +47,17 @@ runner settings: 1. On the top bar, select **Menu > Admin**. 1. On the left sidebar, select **Settings > CI/CD**. 1. Expand **Continuous Integration and Deployment**. -1. Enter your shared runner details in the **Shared runner details** field. +1. Enter text, including Markdown if you want, in the **Shared runner details** field. For example: + + ![Shared runner details input](img/continuous_integration_shared_runner_details_input_v14_10.png) -You can use [Markdown](../../markdown.md) for improved formatting. To see the rendered -details: +To view the rendered details: 1. On the top bar, select **Menu > Project** and select any group or project. 1. On the left sidebar, select **Settings > CI/CD**. 1. Expand **Runners**. -![Shared runner details example](img/continuous_integration_shared_runner_details_v14_0.png) +![Shared runner details example](img/continuous_integration_shared_runner_details_v14_10.png) ## Maximum artifacts size diff --git a/doc/user/admin_area/settings/img/continuous_integration_shared_runner_details_input_v14_10.png b/doc/user/admin_area/settings/img/continuous_integration_shared_runner_details_input_v14_10.png Binary files differnew file mode 100644 index 00000000000..08451f36962 --- /dev/null +++ b/doc/user/admin_area/settings/img/continuous_integration_shared_runner_details_input_v14_10.png diff --git a/doc/user/admin_area/settings/img/continuous_integration_shared_runner_details_v14_0.png b/doc/user/admin_area/settings/img/continuous_integration_shared_runner_details_v14_0.png Binary files differdeleted file mode 100644 index d8bc3deccd4..00000000000 --- a/doc/user/admin_area/settings/img/continuous_integration_shared_runner_details_v14_0.png +++ /dev/null diff --git a/doc/user/admin_area/settings/img/continuous_integration_shared_runner_details_v14_10.png b/doc/user/admin_area/settings/img/continuous_integration_shared_runner_details_v14_10.png Binary files differnew file mode 100644 index 00000000000..64bd9cf6911 --- /dev/null +++ b/doc/user/admin_area/settings/img/continuous_integration_shared_runner_details_v14_10.png diff --git a/doc/user/group/iterations/index.md b/doc/user/group/iterations/index.md index 999d4b15cb0..8453c5cf4bd 100644 --- a/doc/user/group/iterations/index.md +++ b/doc/user/group/iterations/index.md @@ -45,7 +45,7 @@ From there you can create a new iteration or select an iteration to get a more d WARNING: Manual iteration management is in its end-of-life process. Creating an iteration is [deprecated](https://gitlab.com/gitlab-org/gitlab/-/issues/356069) -for use in GitLab 14.10, and is planned for removal in GitLab 15.6. +for use in GitLab 14.10, and is planned for removal in GitLab 16.0. Prerequisites: @@ -66,7 +66,7 @@ To create an iteration: WARNING: Editing all attributes, with the exception of `description` is [deprecated](https://gitlab.com/gitlab-org/gitlab/-/issues/356069) -for use in GitLab 14.10, and is planned for removal in GitLab 15.6. +for use in GitLab 14.10, and is planned for removal in GitLab 16.0. In the future only editing an iteration's `description` will be allowed. Prerequisites: @@ -82,7 +82,7 @@ To edit an iteration, select the three-dot menu (**{ellipsis_v}**) > **Edit**. WARNING: Manual iteration management is in its end-of-life process. Deleting an iteration is [deprecated](https://gitlab.com/gitlab-org/gitlab/-/issues/356069) -for use in GitLab 14.10, and is planned for removal in GitLab 15.6. +for use in GitLab 14.10, and is planned for removal in GitLab 16.0. Prerequisites: diff --git a/doc/user/markdown.md b/doc/user/markdown.md index 5d7c480143a..a98a032078d 100644 --- a/doc/user/markdown.md +++ b/doc/user/markdown.md @@ -525,6 +525,7 @@ GitLab Flavored Markdown recognizes the following: | merge request | `!123` | `namespace/project!123` | `project!123` | | snippet | `$123` | `namespace/project$123` | `project$123` | | [epic](group/epics/index.md) | `&123` | `group1/subgroup&123` | | +| [iteration](group/iterations/index.md) | `*iteration:"iteration title"`| | | | [vulnerability](application_security/vulnerabilities/index.md) <sup>1</sup> | `[vulnerability:123]` | `[vulnerability:namespace/project/123]` | `[vulnerability:project/123]` | | feature flag | `[feature_flag:123]` | `[feature_flag:namespace/project/123]` | `[feature_flag:project/123]` | | label by ID | `~123` | `namespace/project~123` | `project~123` | diff --git a/doc/user/project/settings/import_export.md b/doc/user/project/settings/import_export.md index 4fe12320f77..30261ed5082 100644 --- a/doc/user/project/settings/import_export.md +++ b/doc/user/project/settings/import_export.md @@ -238,7 +238,7 @@ and the exports between them are compatible. ### Project fails to import due to mismatch -If the [shared runners enablement](../../../ci/runners/runners_scope.md#enable-shared-runners) +If the [shared runners enablement](../../../ci/runners/runners_scope.md#enable-shared-runners-for-a-project) does not match between the exported project, and the project import, the project fails to import. Review [issue 276930](https://gitlab.com/gitlab-org/gitlab/-/issues/276930), and either: diff --git a/doc/user/shortcuts.md b/doc/user/shortcuts.md index e807f251da1..e5285d63cf4 100644 --- a/doc/user/shortcuts.md +++ b/doc/user/shortcuts.md @@ -101,6 +101,12 @@ These shortcuts are available when viewing issues and [merge requests](project/m | <kbd>b</kbd> | Copy source branch name (merge requests only). | | <kbd>.</kbd> | Open the [Web IDE](project/web_ide/index.md). | +Merge requests additionally support the following shortcuts: + +| macOS shortcut | Windows shortcut | Description | +|---------------------------------|---------------------|-------------| +| <kbd>Command</kbd> + <kbd>p</kbd> | <kbd>Control</kbd> + <kbd>p</kbd> | Search for, and then jump to a file for review. | + ### Project files These shortcuts are available when browsing the files in a project (go to |