diff --git a/.gitlab/ci/package-and-test/main.gitlab-ci.yml b/.gitlab/ci/package-and-test/main.gitlab-ci.yml index 88056092bf3..23c40f30013 100644 --- a/.gitlab/ci/package-and-test/main.gitlab-ci.yml +++ b/.gitlab/ci/package-and-test/main.gitlab-ci.yml @@ -567,7 +567,7 @@ importers: - if: $QA_SUITES =~ /Test::Integration::Import/ - !reference [.rules:test:manual, rules] -ai-gateway-sync-seat-link: +ai-gateway: extends: - .qa - .failure-videos @@ -578,11 +578,6 @@ ai-gateway-sync-seat-link: - if: $QA_SUITES =~ /Test::Integration::AiGateway/ - !reference [.rules:test:manual, rules] -ai-gateway-sync-service-token: - extends: ai-gateway-sync-seat-link - variables: - QA_USE_SYNC_SERVICE_TOKEN_WORKER: "true" - # ------------------------------------------ # Update jobs # ------------------------------------------ diff --git a/app/assets/javascripts/ci/catalog/components/list/ci_resources_list_item.vue b/app/assets/javascripts/ci/catalog/components/list/ci_resources_list_item.vue index 42f8cea8727..355b4f71d99 100644 --- a/app/assets/javascripts/ci/catalog/components/list/ci_resources_list_item.vue +++ b/app/assets/javascripts/ci/catalog/components/list/ci_resources_list_item.vue @@ -8,6 +8,7 @@ import { CI_RESOURCE_DETAILS_PAGE_NAME } from '../../router/constants'; export default { i18n: { + components: s__('CiCatalog|Components:'), unreleased: s__('CiCatalog|Unreleased'), releasedMessage: s__('CiCatalog|Released %{timeAgo} by %{author}'), }, @@ -34,8 +35,12 @@ export default { authorProfileUrl() { return this.latestVersion.author.webUrl; }, - resourceId() { - return cleanLeadingSeparator(this.resource.webPath); + componentNames() { + const components = this.resource.latestVersion?.components?.nodes; + return components?.map((component) => component.name).join(', ') || null; + }, + detailsPageHref() { + return decodeURIComponent(this.detailsPageResolved.href); }, detailsPageResolved() { return this.$router.resolve({ @@ -43,33 +48,36 @@ export default { params: { id: this.resourceId }, }); }, - detailsPageHref() { - return decodeURIComponent(this.detailsPageResolved.href); - }, entityId() { return getIdFromGraphQLId(this.resource.id); }, + formattedDate() { + return formatDate(this.latestVersion?.releasedAt); + }, + hasComponents() { + return Boolean(this.componentNames); + }, + hasReleasedVersion() { + return Boolean(this.latestVersion?.releasedAt); + }, + latestVersion() { + return this.resource?.latestVersion || {}; + }, + name() { + return this.latestVersion?.name || this.$options.i18n.unreleased; + }, + releasedAt() { + return getTimeago().format(this.latestVersion?.releasedAt); + }, + resourceId() { + return cleanLeadingSeparator(this.resource.webPath); + }, starCount() { return this.resource?.starCount || 0; }, starCountText() { return n__('Star', 'Stars', this.starCount); }, - hasReleasedVersion() { - return Boolean(this.latestVersion?.releasedAt); - }, - formattedDate() { - return formatDate(this.latestVersion?.releasedAt); - }, - latestVersion() { - return this.resource?.latestVersion || {}; - }, - releasedAt() { - return getTimeago().format(this.latestVersion?.releasedAt); - }, - name() { - return this.latestVersion?.name || this.$options.i18n.unreleased; - }, webPath() { return cleanLeadingSeparator(this.resource?.webPath); }, @@ -152,6 +160,14 @@ export default { +
+ • {{ $options.i18n.components }} + {{ componentNames }} +
diff --git a/app/assets/javascripts/ci/catalog/graphql/fragments/catalog_resource.fragment.graphql b/app/assets/javascripts/ci/catalog/graphql/fragments/catalog_resource.fragment.graphql index 316308e96d7..252bd6a5743 100644 --- a/app/assets/javascripts/ci/catalog/graphql/fragments/catalog_resource.fragment.graphql +++ b/app/assets/javascripts/ci/catalog/graphql/fragments/catalog_resource.fragment.graphql @@ -7,6 +7,12 @@ fragment CatalogResourceFields on CiCatalogResource { starCount latestVersion { id + components { + nodes { + id + name + } + } name path releasedAt diff --git a/app/models/concerns/pg_full_text_searchable.rb b/app/models/concerns/pg_full_text_searchable.rb index d32c4c9baf1..b8bf92f1f17 100644 --- a/app/models/concerns/pg_full_text_searchable.rb +++ b/app/models/concerns/pg_full_text_searchable.rb @@ -58,7 +58,7 @@ module PgFullTextSearchable column_text = self[column].gsub(LONG_WORDS_REGEX, ' ') column_text = column_text[0..(TSVECTOR_MAX_LENGTH - 1)] - column_text = ActiveSupport::Inflector.transliterate(column_text) + column_text = Gitlab::I18n.with_default_locale { ActiveSupport::Inflector.transliterate(column_text) } column_text = column_text.gsub(XML_TAG_REGEX, ' \1 ') Arel::Nodes::NamedFunction.new( @@ -136,7 +136,7 @@ module PgFullTextSearchable # URLs get broken up into separate words when : is removed below, so we just remove the whole scheme. query = remove_url_scheme(query) # Remove accents from search term to match indexed data - query = ActiveSupport::Inflector.transliterate(query) + query = Gitlab::I18n.with_default_locale { ActiveSupport::Inflector.transliterate(query) } # Prevent users from using tsquery operators that can cause syntax errors. query = filter_allowed_characters(query) diff --git a/config/feature_flags/experiment/stop_precalling_binary_for_blobs.yml b/config/feature_flags/experiment/stop_precalling_binary_for_blobs.yml new file mode 100644 index 00000000000..da81f318b2d --- /dev/null +++ b/config/feature_flags/experiment/stop_precalling_binary_for_blobs.yml @@ -0,0 +1,9 @@ +--- +name: stop_precalling_binary_for_blobs +feature_issue_url: https://gitlab.com/gitlab-org/gitlab/-/issues/424140 +introduced_by_url: https://gitlab.com/gitlab-org/gitlab/-/merge_requests/142418 +rollout_issue_url: https://gitlab.com/gitlab-com/gl-infra/production/-/issues/17440 +milestone: '16.9' +group: group::code review +type: experiment +default_enabled: false diff --git a/data/deprecations/16-9-deprecate-license-scanning-ci-templates.yml b/data/deprecations/16-9-deprecate-license-scanning-ci-templates.yml new file mode 100644 index 00000000000..33b628aff57 --- /dev/null +++ b/data/deprecations/16-9-deprecate-license-scanning-ci-templates.yml @@ -0,0 +1,17 @@ +- title: "Deprecate License Scanning CI templates" + removal_milestone: "17.0" + announcement_milestone: "16.9" + breaking_change: true + reporter: thiagocsf + stage: secure + issue_url: https://gitlab.com/gitlab-org/gitlab/-/issues/439157 + body: | # (required) Don't change this line. + GitLab 17.0 removes the License Scanning CI templates: + + - [`Jobs/License-Scanning.gitlab-ci.yml`](https://gitlab.com/gitlab-org/gitlab/-/blob/6d9956863d3cd066edc50a29767c2cd4a939c6fd/lib/gitlab/ci/templates/Jobs/License-Scanning.gitlab-ci.yml) + - [`Jobs/License-Scanning.latest.gitlab-ci.yml`](https://gitlab.com/gitlab-org/gitlab/-/blob/6d9956863d3cd066edc50a29767c2cd4a939c6fd/lib/gitlab/ci/templates/Jobs/License-Scanning.latest.gitlab-ci.yml) + - [`Security/License-Scanning.gitlab-ci.yml`](https://gitlab.com/gitlab-org/gitlab/-/blob/6d9956863d3cd066edc50a29767c2cd4a939c6fd/lib/gitlab/ci/templates/Security/License-Scanning.gitlab-ci.yml) + + CI configurations including any of the templates above will stop working in GitLab 17.0. + + Users are advised to use [License scanning of CycloneDX files](https://docs.gitlab.com/ee/user/compliance/license_scanning_of_cyclonedx_files/) instead. diff --git a/db/docs/batched_background_migrations/backfill_catalog_resource_versions_released_at.yml b/db/docs/batched_background_migrations/backfill_catalog_resource_versions_released_at.yml new file mode 100644 index 00000000000..6aba2294645 --- /dev/null +++ b/db/docs/batched_background_migrations/backfill_catalog_resource_versions_released_at.yml @@ -0,0 +1,8 @@ +--- +migration_job_name: BackfillCatalogResourceVersionsReleasedAt +description: Backfills catalog_resource_versions.released_at with data from releases.released_at. +feature_category: pipeline_composition +introduced_by_url: https://gitlab.com/gitlab-org/gitlab/-/merge_requests/142255 +milestone: '16.9' +queued_migration_version: 20240118225727 +finalize_after: '2024-01-22' diff --git a/db/post_migrate/20240118225727_queue_backfill_catalog_resource_versions_released_at.rb b/db/post_migrate/20240118225727_queue_backfill_catalog_resource_versions_released_at.rb new file mode 100644 index 00000000000..cfd7578d4a9 --- /dev/null +++ b/db/post_migrate/20240118225727_queue_backfill_catalog_resource_versions_released_at.rb @@ -0,0 +1,27 @@ +# frozen_string_literal: true + +class QueueBackfillCatalogResourceVersionsReleasedAt < Gitlab::Database::Migration[2.2] + milestone '16.9' + + restrict_gitlab_migration gitlab_schema: :gitlab_main + + MIGRATION = 'BackfillCatalogResourceVersionsReleasedAt' + DELAY_INTERVAL = 2.minutes + BATCH_SIZE = 500 + SUB_BATCH_SIZE = 100 + + def up + queue_batched_background_migration( + MIGRATION, + :catalog_resource_versions, + :id, + job_interval: DELAY_INTERVAL, + batch_size: BATCH_SIZE, + sub_batch_size: SUB_BATCH_SIZE + ) + end + + def down + delete_batched_background_migration(MIGRATION, :catalog_resource_versions, :id, []) + end +end diff --git a/db/schema_migrations/20240118225727 b/db/schema_migrations/20240118225727 new file mode 100644 index 00000000000..b197fb842d0 --- /dev/null +++ b/db/schema_migrations/20240118225727 @@ -0,0 +1 @@ +cdcbcde66af020836f20d076ba4ef757edc09b5659a681e2eeb2008ffc6cdf94 \ No newline at end of file diff --git a/doc/administration/admin_area.md b/doc/administration/admin_area.md index efb3cdf22a8..6f827513c77 100644 --- a/doc/administration/admin_area.md +++ b/doc/administration/admin_area.md @@ -4,7 +4,11 @@ group: unassigned info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# GitLab Admin Area **(FREE SELF)** +# GitLab Admin Area + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed The Admin Area provides a web UI to manage and configure features of GitLab self-managed instances. If you are an administrator, to access the Admin Area: @@ -143,7 +147,11 @@ When using authentication providers, administrators can see the identities for a This list shows the user's identities, including SCIM identities. Administrators can use this information to troubleshoot SCIM-related issues and confirm the identities being used for an account. -### User Permission Export **(PREMIUM SELF)** +### User Permission Export + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** Self-managed > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/1772) in GitLab 13.8. > - [Feature flag removed](https://gitlab.com/gitlab-org/gitlab/-/issues/292436) in GitLab 13.9. @@ -326,7 +334,7 @@ For each Gitaly server, the following details are listed: ### Administering runners -> [Moved](https://gitlab.com/gitlab-org/gitlab/-/issues/340859) from **Overview > Runners** to **CI/CD > Runners** in GitLab 15.8. +> - [Moved](https://gitlab.com/gitlab-org/gitlab/-/issues/340859) from **Overview > Runners** to **CI/CD > Runners** in GitLab 15.8. You can administer all runners in the GitLab instance from the Admin Area's **Runners** page. See [GitLab Runner](https://docs.gitlab.com/runner/) for more information. @@ -383,7 +391,7 @@ You can also edit, pause, or remove each runner. ### Administering Jobs -> [Moved](https://gitlab.com/gitlab-org/gitlab/-/issues/386311) from **Overview > Jobs** to **CI/CD > Jobs** in GitLab 15.8. +> - [Moved](https://gitlab.com/gitlab-org/gitlab/-/issues/386311) from **Overview > Jobs** to **CI/CD > Jobs** in GitLab 15.8. You can administer all jobs in the GitLab instance from the Admin Area's Jobs page. @@ -467,7 +475,11 @@ For details of these log files and their contents, see [Log system](logs/index.m The content of each log file is listed in chronological order. To minimize performance issues, a maximum 2000 lines of each log file are shown. -### Audit Events **(PREMIUM SELF)** +### Audit Events + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** Self-managed The **Audit Events** page lists changes made within the GitLab server. With this information you can control, analyze, and track every change. diff --git a/doc/administration/analytics/dev_ops_reports.md b/doc/administration/analytics/dev_ops_reports.md index 313e99c1e57..8fc2c4961b4 100644 --- a/doc/administration/analytics/dev_ops_reports.md +++ b/doc/administration/analytics/dev_ops_reports.md @@ -4,7 +4,11 @@ group: Optimize info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# DevOps Reports **(FREE SELF)** +# DevOps Reports + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed DevOps Reports give you an overview of your entire instance's adoption of [DevOps](https://about.gitlab.com/topics/devops/) @@ -37,7 +41,11 @@ information is **not sent** to any other GitLab instances. If you have just started using GitLab, it might take a few weeks for data to be collected before this feature is available. -## DevOps Adoption **(ULTIMATE SELF)** +## DevOps Adoption + +DETAILS: +**Tier:** Ultimate +**Offering:** Self-managed > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/247112) in GitLab 13.7 as a [Beta feature](../../policy/experiment-beta-support.md#beta). > - The Overview tab [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/330401) in GitLab 14.1. diff --git a/doc/administration/analytics/index.md b/doc/administration/analytics/index.md index c5431efaf9b..44204796444 100644 --- a/doc/administration/analytics/index.md +++ b/doc/administration/analytics/index.md @@ -4,9 +4,13 @@ group: Optimize info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Instance-level analytics **(FREE SELF)** +# Instance-level analytics -> [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/issues/41416) in GitLab 11.2. +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/issues/41416) in GitLab 11.2. Instance-level analytics provide insights into the feature and data usage of your entire instance. diff --git a/doc/administration/analytics/usage_trends.md b/doc/administration/analytics/usage_trends.md index 52ea20a2954..55330e26824 100644 --- a/doc/administration/analytics/usage_trends.md +++ b/doc/administration/analytics/usage_trends.md @@ -4,7 +4,11 @@ group: Optimize info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Usage Trends **(FREE SELF)** +# Usage Trends + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/235754) in GitLab 13.5 behind a feature flag, disabled by default. > - [Became enabled by default](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/46962) in GitLab 13.6. diff --git a/doc/administration/appearance.md b/doc/administration/appearance.md index 9ebc9a37407..928c5aaab47 100644 --- a/doc/administration/appearance.md +++ b/doc/administration/appearance.md @@ -4,7 +4,11 @@ group: unassigned info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# GitLab Appearance **(FREE SELF)** +# GitLab Appearance + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed You can update your settings to change the look and feel of your GitLab self-managed instance. @@ -92,7 +96,7 @@ You can add also add a [customized help message](settings/help_page.md) below th ## Customize the Progressive Web App -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/375708) in GitLab 15.9. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/375708) in GitLab 15.9. Customize the icon, display name, short name, and description for your Progessive Web App (PWA). For more information, see [Progressive Web App](https://developer.mozilla.org/en-US/docs/Web/Progressive_web_apps). diff --git a/doc/administration/application_settings_cache.md b/doc/administration/application_settings_cache.md index 91392b2f0d9..3dc2fa5ad9b 100644 --- a/doc/administration/application_settings_cache.md +++ b/doc/administration/application_settings_cache.md @@ -4,7 +4,11 @@ group: Cloud Connector info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Application cache interval **(FREE SELF)** +# Application cache interval + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed By default, GitLab caches application settings for 60 seconds. Occasionally, you may need to increase that interval to have more delay between application diff --git a/doc/administration/audit_event_streaming/examples.md b/doc/administration/audit_event_streaming/examples.md index ed7c0d5d97d..f1c2992d2f8 100644 --- a/doc/administration/audit_event_streaming/examples.md +++ b/doc/administration/audit_event_streaming/examples.md @@ -108,7 +108,7 @@ Push: ### Example payloads for Git over SSH events with Deploy Key -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/363876) in GitLab 15.3. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/363876) in GitLab 15.3. Fetch: @@ -275,7 +275,7 @@ Fetch: ## Audit event streaming on merge request approval actions -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/271162) in GitLab 14.9. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/271162) in GitLab 14.9. Stream audit events that relate to merge approval actions performed in a project. @@ -321,7 +321,7 @@ X-Gitlab-Audit-Event-Type: audit_operation ## Audit event streaming on merge request create actions -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/90911) in GitLab 15.2. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/90911) in GitLab 15.2. Stream audit events that relate to merge request create actions using the `/logs` endpoint. @@ -370,7 +370,7 @@ X-Gitlab-Event-Streaming-Token: ## Audit event streaming on project fork actions -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/90916) in GitLab 15.2. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/90916) in GitLab 15.2. Stream audit events that relate to project fork actions using the `/logs` endpoint. @@ -419,7 +419,7 @@ X-Gitlab-Event-Streaming-Token: ## Audit event streaming on project group link actions -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/90955) in GitLab 15.2. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/90955) in GitLab 15.2. Stream audit events that relate to project group link creation, updates, and deletion using the `/logs` endpoint. @@ -533,7 +533,7 @@ X-Gitlab-Event-Streaming-Token: ## Audit event streaming on invalid merge request approver state -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/374566) in GitLab 15.5. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/374566) in GitLab 15.5. Stream audit events that relate to invalid merge request approver states in a project. diff --git a/doc/administration/audit_event_streaming/graphql_api.md b/doc/administration/audit_event_streaming/graphql_api.md index 06cae34b7ef..57ec2735a0b 100644 --- a/doc/administration/audit_event_streaming/graphql_api.md +++ b/doc/administration/audit_event_streaming/graphql_api.md @@ -4,7 +4,11 @@ group: Compliance info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Audit event streaming GraphQL API **(ULTIMATE ALL)** +# Audit event streaming GraphQL API + +DETAILS: +**Tier:** Ultimate +**Offering:** SaaS, self-managed > - API [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/332747) in GitLab 14.5 [with a flag](../feature_flags.md) named `ff_external_audit_events_namespace`. Disabled by default. > - API [enabled on GitLab.com and by default on self-managed](https://gitlab.com/gitlab-org/gitlab/-/issues/338939) in GitLab 14.7. @@ -335,7 +339,7 @@ Event type filters are removed if: ### Google Cloud Logging destinations -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/409422) in GitLab 16.1. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/409422) in GitLab 16.1. Manage Google Cloud Logging destinations for top-level groups. @@ -467,7 +471,11 @@ Streaming configuration is deleted if: - The returned `errors` object is empty. - The API responds with `200 OK`. -## Instance streaming destinations **(ULTIMATE SELF)** +## Instance streaming destinations + +DETAILS: +**Tier:** Ultimate +**Offering:** Self-managed > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/335175) in GitLab 16.0 [with a flag](../feature_flags.md) named `ff_external_audit_events`. Disabled by default. > - [Feature flag `ff_external_audit_events`](https://gitlab.com/gitlab-org/gitlab/-/issues/393772) enabled by default in GitLab 16.2. @@ -743,7 +751,7 @@ Event type filters are removed if: ### Google Cloud Logging destinations -> [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/11303) in GitLab 16.5. +> - [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/11303) in GitLab 16.5. Manage Google Cloud Logging destinations for an entire instance. diff --git a/doc/administration/audit_event_streaming/index.md b/doc/administration/audit_event_streaming/index.md index 2cfe71cd4a5..f45892829db 100644 --- a/doc/administration/audit_event_streaming/index.md +++ b/doc/administration/audit_event_streaming/index.md @@ -4,7 +4,11 @@ group: Compliance info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Audit event streaming **(ULTIMATE ALL)** +# Audit event streaming + +DETAILS: +**Tier:** Ultimate +**Offering:** SaaS, self-managed > - UI [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/336411) in GitLab 14.9. > - [Subgroup events recording](https://gitlab.com/gitlab-org/gitlab/-/issues/366878) fixed in GitLab 15.2. @@ -130,7 +134,7 @@ To delete only the custom HTTP headers for a streaming destination: #### Verify event authenticity -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/360814) in GitLab 15.2. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/360814) in GitLab 15.2. Each streaming destination has a unique verification token (`verificationToken`) that can be used to verify the authenticity of the event. This token is either specified by the Owner or generated automatically when the event destination is created and cannot be changed. @@ -200,7 +204,7 @@ To override the `content-type` header default value for a top-level group stream ### Google Cloud Logging destinations -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/124384) in GitLab 16.2. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/124384) in GitLab 16.2. Manage Google Cloud Logging destinations for top-level groups. @@ -354,7 +358,11 @@ To delete AWS S3 streaming destinations to a top-level group: 1. Select **Delete destination**. 1. Confirm by selecting **Delete destination** in the dialog. -## Instance streaming destinations **(ULTIMATE SELF)** +## Instance streaming destinations + +DETAILS: +**Tier:** Ultimate +**Offering:** Self-managed > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/398107) in GitLab 16.1 [with a flag](../feature_flags.md) named `ff_external_audit_events`. Disabled by default. > - [Feature flag `ff_external_audit_events`](https://gitlab.com/gitlab-org/gitlab/-/issues/393772) enabled by default in GitLab 16.2. @@ -511,7 +519,7 @@ To override the `content-type` header default value for an instance streaming de ### Google Cloud Logging destinations -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/131851) in GitLab 16.5. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/131851) in GitLab 16.5. Manage Google Cloud Logging destinations for an entire instance. diff --git a/doc/administration/audit_events.md b/doc/administration/audit_events.md index 6b3428d0ad6..1908cab402e 100644 --- a/doc/administration/audit_events.md +++ b/doc/administration/audit_events.md @@ -4,7 +4,11 @@ group: Compliance info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Audit events **(PREMIUM ALL)** +# Audit events + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed A security audit is a in-depth analysis and review of your infrastructure, which is used to display areas of concern and potentially hazardous practices. To assist with the audit process, GitLab provides @@ -50,7 +54,11 @@ Group audit events can also be accessed using the [Group Audit Events API](../ap Project audit events can also be accessed using the [Project Audit Events API](../api/audit_events.md#project-audit-events). Project audit event queries are limited to a maximum of 30 days. -### Instance audit events **(PREMIUM SELF)** +### Instance audit events + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** Self-managed You can view audit events from user actions across an entire GitLab instance. To view instance audit events: @@ -69,7 +77,11 @@ exist for this action. The [`group_saml_provider_create` and `group_saml_provider_update` audit event types](audit_event_streaming/audit_event_types.md#compliance-management) generate audit events for group-level configuration of SAML. -### Sign-in audit events **(FREE ALL)** +### Sign-in audit events + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed Successful sign-in events are the only audit events available at all tiers. To see successful sign-in events: @@ -137,7 +149,7 @@ When a user is [impersonated](../administration/admin_area.md#user-impersonation ## Time zones -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/242014) in GitLab 15.7, GitLab UI shows dates and times in the user's local time zone instead of UTC. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/242014) in GitLab 15.7, GitLab UI shows dates and times in the user's local time zone instead of UTC. The time zone used for audit events depends on where you view them: diff --git a/doc/administration/audit_reports.md b/doc/administration/audit_reports.md index bfd061eb760..ddc221a2727 100644 --- a/doc/administration/audit_reports.md +++ b/doc/administration/audit_reports.md @@ -5,7 +5,11 @@ info: To determine the technical writer assigned to the Stage/Group associated w description: 'Learn how to create evidence artifacts typically requested by a 3rd party auditor.' --- -# Audit reports **(FREE ALL)** +# Audit reports + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed GitLab can help owners and administrators respond to auditors by generating comprehensive reports. These audit reports vary in scope, depending on the diff --git a/doc/administration/auditor_users.md b/doc/administration/auditor_users.md index 45475ab7b16..df125858769 100644 --- a/doc/administration/auditor_users.md +++ b/doc/administration/auditor_users.md @@ -4,7 +4,11 @@ group: Authentication info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Auditor users **(PREMIUM SELF)** +# Auditor users + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** Self-managed Users with auditor access have read-only access to all groups, projects, and other resources except: @@ -62,6 +66,6 @@ If you are signed in with auditor access, you: ## Maintain auditor users using API -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/366404) in GitLab 15.3. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/366404) in GitLab 15.3. Administrators can use the GitLab API to [create](../api/users.md#user-creation) and [modify](../api/users.md#user-modification) auditor users. diff --git a/doc/administration/auth/atlassian.md b/doc/administration/auth/atlassian.md index 36331799fec..7c330934607 100644 --- a/doc/administration/auth/atlassian.md +++ b/doc/administration/auth/atlassian.md @@ -4,7 +4,11 @@ group: Authentication info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Use Atlassian as an OAuth 2.0 authentication provider **(FREE SELF)** +# Use Atlassian as an OAuth 2.0 authentication provider + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed To enable the Atlassian OmniAuth provider for passwordless authentication you must register an application with Atlassian. diff --git a/doc/administration/auth/cognito.md b/doc/administration/auth/cognito.md index 096243419c1..122031f4a9f 100644 --- a/doc/administration/auth/cognito.md +++ b/doc/administration/auth/cognito.md @@ -4,7 +4,11 @@ group: Authentication info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Use AWS Cognito as an OAuth 2.0 authentication provider **(FREE SELF)** +# Use AWS Cognito as an OAuth 2.0 authentication provider + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed Amazon Web Services (AWS) Cognito lets you add user sign-up, sign-in, and access control to your GitLab instance. The following documentation enables AWS Cognito as an OAuth 2.0 provider. diff --git a/doc/administration/auth/crowd.md b/doc/administration/auth/crowd.md index ae9a46650f6..4d615ee4905 100644 --- a/doc/administration/auth/crowd.md +++ b/doc/administration/auth/crowd.md @@ -4,7 +4,11 @@ group: Authentication info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Use Atlassian Crowd as an authentication provider (deprecated) **(FREE SELF)** +# Use Atlassian Crowd as an authentication provider (deprecated) + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed WARNING: This feature was [deprecated](https://gitlab.com/gitlab-org/gitlab/-/issues/369117) in GitLab 15.3 and is planned for diff --git a/doc/administration/auth/index.md b/doc/administration/auth/index.md index dd7f9cec77e..ea8b420c26b 100644 --- a/doc/administration/auth/index.md +++ b/doc/administration/auth/index.md @@ -5,7 +5,11 @@ description: Third-party authentication providers. info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# GitLab authentication and authorization **(FREE SELF)** +# GitLab authentication and authorization + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed GitLab integrates with a number of [OmniAuth providers](../../integration/omniauth.md#supported-providers), and the following external authentication and authorization providers: @@ -13,8 +17,8 @@ and the following external authentication and authorization providers: - [LDAP](ldap/index.md): Includes Active Directory, Apple Open Directory, Open LDAP, and 389 Server. - [Google Secure LDAP](ldap/google_secure_ldap.md) -- [SAML for GitLab.com groups](../../user/group/saml_sso/index.md) **(PREMIUM SAAS)** -- [Smartcard](smartcard.md) **(PREMIUM SELF)** +- [SAML for GitLab.com groups](../../user/group/saml_sso/index.md) +- [Smartcard](smartcard.md) NOTE: UltraAuth has removed their software which supports OmniAuth integration. We have therefore removed all references to UltraAuth integration. diff --git a/doc/administration/auth/jwt.md b/doc/administration/auth/jwt.md index 4e000576652..a567e3b735b 100644 --- a/doc/administration/auth/jwt.md +++ b/doc/administration/auth/jwt.md @@ -4,7 +4,11 @@ group: Authentication info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Use JWT as an authentication provider **(FREE SELF)** +# Use JWT as an authentication provider + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed To enable the JWT OmniAuth provider, you must register your application with JWT. JWT provides you with a secret key for you to use. diff --git a/doc/administration/auth/ldap/google_secure_ldap.md b/doc/administration/auth/ldap/google_secure_ldap.md index 8338760ecb5..d62652eee7c 100644 --- a/doc/administration/auth/ldap/google_secure_ldap.md +++ b/doc/administration/auth/ldap/google_secure_ldap.md @@ -4,9 +4,13 @@ group: Authentication info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Google Secure LDAP **(FREE SELF)** +# Google Secure LDAP -> [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/issues/46391) in GitLab 11.9. +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/issues/46391) in GitLab 11.9. [Google Cloud Identity](https://cloud.google.com/identity/) provides a Secure LDAP service that can be configured with GitLab for authentication and group sync. diff --git a/doc/administration/auth/ldap/index.md b/doc/administration/auth/ldap/index.md index 49841b5e1be..1aa5c3464ee 100644 --- a/doc/administration/auth/ldap/index.md +++ b/doc/administration/auth/ldap/index.md @@ -4,7 +4,11 @@ group: Authentication info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Integrate LDAP with GitLab **(FREE SELF)** +# Integrate LDAP with GitLab + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed GitLab integrates with [LDAP - Lightweight Directory Access Protocol](https://en.wikipedia.org/wiki/Lightweight_Directory_Access_Protocol) to support user authentication. @@ -441,7 +445,11 @@ You must define the following attributes in an `attributes` hash. | `first_name` | LDAP attribute for user first name. Used when the attribute configured for `name` does not exist. | **{dotted-circle}** No | `'givenName'` | | `last_name` | LDAP attribute for user last name. Used when the attribute configured for `name` does not exist. | **{dotted-circle}** No | `'sn'` | -### LDAP sync configuration settings **(PREMIUM SELF)** +### LDAP sync configuration settings + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** Self-managed These LDAP sync configuration settings are available: @@ -452,7 +460,11 @@ These LDAP sync configuration settings are available: | `external_groups` | An array of CNs of groups containing users that should be considered external. Not `cn=interns` or the full DN. | **{dotted-circle}** No | `['interns', 'contractors']` | | `sync_ssh_keys` | The LDAP attribute containing a user's public SSH key. | **{dotted-circle}** No | `'sshPublicKey'` or false if not set | -### Use multiple LDAP servers **(PREMIUM SELF)** +### Use multiple LDAP servers + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** Self-managed If you have users on multiple LDAP servers, you can configure GitLab to use them. To add additional LDAP servers: @@ -1197,7 +1209,7 @@ You can find more details on the expected behavior of user updates in our [LDAP ## Google Secure LDAP -> Introduced in GitLab 11.9. +> - Introduced in GitLab 11.9. [Google Cloud Identity](https://cloud.google.com/identity/) provides a Secure LDAP service that can be configured with GitLab for authentication and group sync. diff --git a/doc/administration/auth/ldap/ldap-troubleshooting.md b/doc/administration/auth/ldap/ldap-troubleshooting.md index 39546345355..42bf2d2679a 100644 --- a/doc/administration/auth/ldap/ldap-troubleshooting.md +++ b/doc/administration/auth/ldap/ldap-troubleshooting.md @@ -4,7 +4,11 @@ group: Authentication info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Troubleshooting LDAP **(FREE SELF)** +# Troubleshooting LDAP + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed If you are an administrator, use the following information to troubleshoot LDAP. @@ -53,7 +57,11 @@ main: # 'main' is the GitLab 'provider ID' of this LDAP server admin_group: 'my_admin_group' ``` -#### Query LDAP **(PREMIUM SELF)** +#### Query LDAP + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** Self-managed The following allows you to perform a search in LDAP using the rails console. Depending on what you're trying to do, it may make more sense to query [a user](#query-a-user-in-ldap) @@ -248,7 +256,11 @@ ldapsearch -H ldaps://$host:$port -D "$bind_dn" -y bind_dn_password.txt -b "$ba port. - We are assuming the password for the `bind_dn` user is in `bind_dn_password.txt`. -#### Sync all users **(PREMIUM SELF)** +#### Sync all users + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** Self-managed The output from a manual [user sync](ldap_synchronization.md#user-sync) can show you what happens when GitLab tries to sync its users against LDAP. Enter the [rails console](#rails-console) @@ -262,7 +274,11 @@ LdapSyncWorker.new.perform Next, [learn how to read the output](#example-console-output-after-a-user-sync). -##### Example console output after a user sync **(PREMIUM SELF)** +##### Example console output after a user sync + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** Self-managed The output from a [manual user sync](#sync-all-users) is very verbose, and a single user's successful sync can look like this: @@ -353,7 +369,11 @@ adapter = Gitlab::Auth::Ldap::Adapter.new('ldapmain') # If `main` is the LDAP pr Gitlab::Auth::Ldap::Person.find_by_uid('', adapter) ``` -### Group memberships **(PREMIUM SELF)** +### Group memberships + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** Self-managed #### Memberships not granted @@ -660,7 +680,7 @@ emails.each do |username, email| end ``` -You can then [run a UserSync](#sync-all-users) **(PREMIUM SELF)** to sync the latest DN +You can then [run a UserSync](#sync-all-users) to sync the latest DN for each of these users. ## Could not authenticate from AzureActivedirectoryV2 because "Invalid grant" diff --git a/doc/administration/auth/ldap/ldap_synchronization.md b/doc/administration/auth/ldap/ldap_synchronization.md index 75c257c1009..bb38e115cb3 100644 --- a/doc/administration/auth/ldap/ldap_synchronization.md +++ b/doc/administration/auth/ldap/ldap_synchronization.md @@ -4,7 +4,11 @@ group: Authentication info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# LDAP synchronization **(PREMIUM SELF)** +# LDAP synchronization + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** Self-managed If you have [configured LDAP to work with GitLab](index.md), GitLab can automatically synchronize users and groups. @@ -485,7 +489,7 @@ group, GitLab revokes their `admin` role when syncing. ### Global group memberships lock -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/4354) in GitLab 12.0. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/4354) in GitLab 12.0. GitLab administrators can prevent group members from inviting new members to subgroups that have their membership synchronized with LDAP. diff --git a/doc/administration/auth/oidc.md b/doc/administration/auth/oidc.md index 80c3a21d953..eaa175e3763 100644 --- a/doc/administration/auth/oidc.md +++ b/doc/administration/auth/oidc.md @@ -4,7 +4,11 @@ group: Authentication info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Use OpenID Connect as an authentication provider **(FREE SELF)** +# Use OpenID Connect as an authentication provider + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed You can use GitLab as a client application with [OpenID Connect](https://openid.net/specs/openid-connect-core-1_0.html) as an OmniAuth provider. @@ -459,7 +463,7 @@ gitlab_rails['omniauth_providers'] = [ #### Configure Keycloak with a symmetric key algorithm -> Introduced in GitLab 14.2. +> - Introduced in GitLab 14.2. WARNING: The following instructions are included for completeness, but only use symmetric key @@ -749,9 +753,13 @@ def sync_missing_provider(self, user: User, extern_uid: str) For more information, see the [GitLab API user method documentation](https://python-gitlab.readthedocs.io/en/stable/gl_objects/users.html#examples). -## Configure users based on OIDC group membership **(PREMIUM ALL)** +## Configure users based on OIDC group membership -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/209898) in GitLab 15.10. +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/209898) in GitLab 15.10. You can configure OIDC group membership to: @@ -928,7 +936,11 @@ based on group membership, configure GitLab to identify: ::EndTabs -### Auditor groups **(PREMIUM SELF)** +### Auditor groups + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** Self-managed Your IdP must pass group information to GitLab in the OIDC response. To use this response to assign users as auditors based on group membership, configure GitLab to identify: diff --git a/doc/administration/auth/smartcard.md b/doc/administration/auth/smartcard.md index 1d4ca87bcc0..7bf28758fa6 100644 --- a/doc/administration/auth/smartcard.md +++ b/doc/administration/auth/smartcard.md @@ -4,13 +4,17 @@ group: Authentication info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Smartcard authentication **(PREMIUM SELF)** +# Smartcard authentication + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** Self-managed GitLab supports authentication using smartcards. ## Existing password authentication -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/33669) in GitLab 12.6. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/33669) in GitLab 12.6. By default, existing users can continue to sign in with a username and password when smartcard authentication is enabled. @@ -27,7 +31,7 @@ GitLab supports two authentication methods: ### Authentication against a local database with X.509 certificates -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/726) in GitLab 11.6 as an experimental feature. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/726) in GitLab 11.6 as an experimental feature. WARNING: Smartcard authentication against local databases may change or be removed completely in future @@ -54,7 +58,7 @@ Certificate: ### Authentication against a local database with X.509 certificates and SAN extension -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/8605) in GitLab 12.3. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/8605) in GitLab 12.3. Smartcards with X.509 certificates using SAN extensions can be used to authenticate with GitLab. @@ -97,7 +101,7 @@ Certificate: ### Authentication against an LDAP server -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/7693) in GitLab 11.8 as an experimental feature. Smartcard authentication against an LDAP server may change or be removed completely in the future. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/7693) in GitLab 11.8 as an experimental feature. Smartcard authentication against an LDAP server may change or be removed completely in the future. GitLab implements a standard way of certificate matching following [RFC4523](https://www.rfc-editor.org/rfc/rfc4523). It uses the diff --git a/doc/administration/auth/test_oidc_oauth.md b/doc/administration/auth/test_oidc_oauth.md index 1f30da50dfa..e2fbf234037 100644 --- a/doc/administration/auth/test_oidc_oauth.md +++ b/doc/administration/auth/test_oidc_oauth.md @@ -4,7 +4,11 @@ group: Authentication info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Test OIDC/OAuth in GitLab **(FREE SELF)** +# Test OIDC/OAuth in GitLab + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed To test OIDC/OAuth in GitLab, you must: diff --git a/doc/administration/backup_restore/backup_gitlab.md b/doc/administration/backup_restore/backup_gitlab.md index 973157f8e83..252a4de6aa8 100644 --- a/doc/administration/backup_restore/backup_gitlab.md +++ b/doc/administration/backup_restore/backup_gitlab.md @@ -4,7 +4,11 @@ group: Geo info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Back up GitLab **(FREE SELF)** +# Back up GitLab + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed The exact procedure for backing up GitLab depends on many factors. Your particular deployment's usage and configuration determine what kind of data exists, where it is located, and how much there is. These factors influence your options for how to perform a back up, how to store it, and how to restore it. @@ -649,7 +653,7 @@ sudo gitlab-backup create INCREMENTAL=yes SKIP=tar #### Back up specific repository storages -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/86896) in GitLab 15.0. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/86896) in GitLab 15.0. When using [multiple repository storages](../repository_storage_paths.md), repositories from specific repository storages can be backed up separately @@ -743,7 +747,7 @@ For Linux package (Omnibus): ##### S3 Encrypted Buckets -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/64765) in GitLab 14.3. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/64765) in GitLab 14.3. AWS supports these [modes for server side encryption](https://docs.aws.amazon.com/AmazonS3/latest/userguide/serv-side-encryption.html): @@ -985,7 +989,7 @@ For self-compiled installations: ##### Using Azure Blob storage -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/25877) in GitLab 13.4. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/25877) in GitLab 13.4. ::Tabs diff --git a/doc/administration/backup_restore/backup_large_reference_architectures.md b/doc/administration/backup_restore/backup_large_reference_architectures.md index 64d7b2168f5..16c36c5d5d2 100644 --- a/doc/administration/backup_restore/backup_large_reference_architectures.md +++ b/doc/administration/backup_restore/backup_large_reference_architectures.md @@ -4,7 +4,11 @@ group: Geo info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Back up and restore large reference architectures **(FREE SELF)** +# Back up and restore large reference architectures + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed This document describes how to: diff --git a/doc/administration/backup_restore/index.md b/doc/administration/backup_restore/index.md index d6e67ad4229..d2b9a0c5944 100644 --- a/doc/administration/backup_restore/index.md +++ b/doc/administration/backup_restore/index.md @@ -4,7 +4,11 @@ group: Geo info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Back up and restore GitLab **(FREE SELF)** +# Back up and restore GitLab + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed Your software or organization depends on the data in your GitLab instance. You need to ensure this data is protected from adverse events such as: diff --git a/doc/administration/backup_restore/restore_gitlab.md b/doc/administration/backup_restore/restore_gitlab.md index c779c81c169..bd1e87b532c 100644 --- a/doc/administration/backup_restore/restore_gitlab.md +++ b/doc/administration/backup_restore/restore_gitlab.md @@ -4,7 +4,11 @@ group: Geo info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Restore GitLab **(FREE SELF)** +# Restore GitLab + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed GitLab provides a command-line interface to restore your entire installation, and is flexible enough to fit your needs. @@ -330,7 +334,7 @@ The `force=yes` environment variable also disables these prompts. ### Excluding tasks on restore -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/19347) in GitLab 14.10. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/19347) in GitLab 14.10. You can exclude specific tasks on restore by adding the environment variable `SKIP`, whose values are a comma-separated list of the following options: @@ -361,7 +365,7 @@ To exclude specific tasks: ### Restore specific repository storages -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/86896) in GitLab 15.0. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/86896) in GitLab 15.0. When using [multiple repository storages](../repository_storage_paths.md), repositories from specific repository storages can be restored separately @@ -384,7 +388,7 @@ For example: ### Restore specific repositories -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/88094) in GitLab 15.1. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/88094) in GitLab 15.1. You can restore specific repositories using the `REPOSITORIES_PATHS` and the `SKIP_REPOSITORIES_PATHS` options. Both options accept a comma-separated list of project and group paths. If you diff --git a/doc/administration/broadcast_messages.md b/doc/administration/broadcast_messages.md index 5a1cb88e876..72291c6f84c 100644 --- a/doc/administration/broadcast_messages.md +++ b/doc/administration/broadcast_messages.md @@ -4,7 +4,11 @@ group: Acquisition info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Broadcast messages **(FREE SELF)** +# Broadcast messages + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed > - Target roles [introduced](https://gitlab.com/gitlab-org/growth/team-tasks/-/issues/461) in GitLab 14.8 [with a flag](../administration/feature_flags.md) named `role_targeted_broadcast_messages`. Disabled by default. > - Theme [introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/83251) and background color removed in GitLab 14.10. diff --git a/doc/administration/cicd.md b/doc/administration/cicd.md index 4fd11041e91..040fe843355 100644 --- a/doc/administration/cicd.md +++ b/doc/administration/cicd.md @@ -4,7 +4,11 @@ group: Pipeline Execution info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# GitLab CI/CD instance configuration **(FREE SELF)** +# GitLab CI/CD instance configuration + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed GitLab administrators can manage the GitLab CI/CD configuration for their instance. @@ -57,7 +61,11 @@ For Linux package installations: sudo gitlab-ctl reconfigure ``` -## Set the `needs` job limit **(FREE SELF)** +## Set the `needs` job limit + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed The maximum number of jobs that can be defined in `needs` defaults to 50. diff --git a/doc/administration/clusters/kas.md b/doc/administration/clusters/kas.md index 9c87576aa80..462fb0be3fb 100644 --- a/doc/administration/clusters/kas.md +++ b/doc/administration/clusters/kas.md @@ -4,7 +4,11 @@ group: Environments info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Install the GitLab agent server for Kubernetes (KAS) **(FREE SELF)** +# Install the GitLab agent server for Kubernetes (KAS) + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed > - [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/3834) in GitLab 13.10, the GitLab agent server (KAS) became available on GitLab.com at `wss://kas.gitlab.com`. > - [Moved](https://gitlab.com/groups/gitlab-org/-/epics/6290) from GitLab Premium to GitLab Free in 14.5. diff --git a/doc/administration/compliance.md b/doc/administration/compliance.md index 67b9e8d06a9..567156a99bb 100644 --- a/doc/administration/compliance.md +++ b/doc/administration/compliance.md @@ -4,7 +4,11 @@ group: Compliance info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Compliance features **(FREE SELF)** +# Compliance features + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed GitLab compliance features ensure your GitLab instance meets common compliance standards, and are available at various pricing tiers. For more information about compliance management, see the compliance management [solutions page](https://about.gitlab.com/solutions/compliance/). diff --git a/doc/administration/configure.md b/doc/administration/configure.md index 7ae088cd783..7ea3b19ea33 100644 --- a/doc/administration/configure.md +++ b/doc/administration/configure.md @@ -5,7 +5,11 @@ description: Installation settings. info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Configure your GitLab installation **(FREE SELF)** +# Configure your GitLab installation + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed Customize and configure your self-managed GitLab installation. diff --git a/doc/administration/consul.md b/doc/administration/consul.md index 0740c27dc7c..252eb2b98ea 100644 --- a/doc/administration/consul.md +++ b/doc/administration/consul.md @@ -4,7 +4,11 @@ group: Distribution info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# How to set up Consul **(PREMIUM SELF)** +# How to set up Consul + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** Self-managed A Consul cluster consists of both [server and client agents](https://developer.hashicorp.com/consul/docs/agent). diff --git a/doc/administration/credentials_inventory.md b/doc/administration/credentials_inventory.md index 1bd4ce75891..b0fd268c64e 100644 --- a/doc/administration/credentials_inventory.md +++ b/doc/administration/credentials_inventory.md @@ -4,7 +4,11 @@ group: Authentication info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Credentials inventory **(ULTIMATE SELF)** +# Credentials inventory + +DETAILS: +**Tier:** Ultimate +**Offering:** Self-managed > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/20912) in GitLab 12.6. > - [Bot-created access tokens not displayed in personal access token list](https://gitlab.com/gitlab-org/gitlab/-/issues/351759) in GitLab 14.9. @@ -32,7 +36,7 @@ You can also [revoke](#revoke-a-users-personal-access-token), [delete](#delete-a ## Revoke a user's personal access token -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/214811) in GitLab 13.4. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/214811) in GitLab 13.4. You can revoke a user's personal access token. @@ -54,7 +58,7 @@ When a PAT is revoked from the credentials inventory, the instance notifies the ## Revoke a user's project access token -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/243833) in GitLab 14.8. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/243833) in GitLab 14.8. 1. On the left sidebar, at the bottom, select **Admin Area**. 1. Select **Credentials**. @@ -67,7 +71,7 @@ The project access token is revoked and a background worker is queued to delete ## Delete a user's SSH key -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/225248) in GitLab 13.5. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/225248) in GitLab 13.5. 1. On the left sidebar, at the bottom, select **Admin Area**. 1. Select **Credentials**. diff --git a/doc/administration/custom_project_templates.md b/doc/administration/custom_project_templates.md index 3c3319c80f9..7745d4500c2 100644 --- a/doc/administration/custom_project_templates.md +++ b/doc/administration/custom_project_templates.md @@ -4,7 +4,11 @@ group: Source Code info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Custom instance-level project templates **(PREMIUM SELF)** +# Custom instance-level project templates + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** Self-managed As an administrator, you can configure a group that contains projects available for use as the source of project templates on your instance. You can then diff --git a/doc/administration/dedicated/index.md b/doc/administration/dedicated/index.md index 64a0d80fdcc..6483e13d4fe 100644 --- a/doc/administration/dedicated/index.md +++ b/doc/administration/dedicated/index.md @@ -5,7 +5,10 @@ description: IP allowlists, SAML, maintenance. info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Configure GitLab Dedicated **(ULTIMATE)** +# Configure GitLab Dedicated + +DETAILS: +**Offering:** Dedicated GitLab Dedicated is a single-tenant SaaS solution, fully managed and hosted by GitLab. For more information about this offering, see the [subscription page](../../subscriptions/gitlab_dedicated/index.md). diff --git a/doc/administration/diff_limits.md b/doc/administration/diff_limits.md index 66a1e86b025..a1a66d54798 100644 --- a/doc/administration/diff_limits.md +++ b/doc/administration/diff_limits.md @@ -4,7 +4,11 @@ group: Source Code info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Diff limits administration **(FREE SELF)** +# Diff limits administration + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed You can set a maximum size for display of diff files (patches). diff --git a/doc/administration/docs_self_host.md b/doc/administration/docs_self_host.md index 30ec21ef660..2c65023918c 100644 --- a/doc/administration/docs_self_host.md +++ b/doc/administration/docs_self_host.md @@ -4,7 +4,11 @@ group: Distribution info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Host the GitLab product documentation **(FREE SELF)** +# Host the GitLab product documentation + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed If you are not able to access the GitLab product documentation at `docs.gitlab.com`, you can host the documentation yourself instead. diff --git a/doc/administration/email_from_gitlab.md b/doc/administration/email_from_gitlab.md index 0fe07c63169..e3ad383d1a7 100644 --- a/doc/administration/email_from_gitlab.md +++ b/doc/administration/email_from_gitlab.md @@ -4,7 +4,11 @@ group: unassigned info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Email from GitLab **(PREMIUM SELF)** +# Email from GitLab + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** Self-managed Administrators can email all users, or users of a chosen group or project. Users receive the email at their primary email address. diff --git a/doc/administration/encrypted_configuration.md b/doc/administration/encrypted_configuration.md index 1346786446c..f373f1ffcc7 100644 --- a/doc/administration/encrypted_configuration.md +++ b/doc/administration/encrypted_configuration.md @@ -4,9 +4,13 @@ group: Distribution info: "To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments" --- -# Encrypted Configuration **(FREE SELF)** +# Encrypted Configuration -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/45712) in GitLab 13.7. +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/45712) in GitLab 13.7. GitLab can read settings for certain features from encrypted settings files. The supported features are: diff --git a/doc/administration/environment_variables.md b/doc/administration/environment_variables.md index c3bc4b0bc1f..cf976dc2349 100644 --- a/doc/administration/environment_variables.md +++ b/doc/administration/environment_variables.md @@ -4,7 +4,11 @@ group: Distribution info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Environment variables **(FREE SELF)** +# Environment variables + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed GitLab exposes certain environment variables which can be used to override their defaults values. diff --git a/doc/administration/external_pipeline_validation.md b/doc/administration/external_pipeline_validation.md index 5442bc74125..7f7a9f2f30e 100644 --- a/doc/administration/external_pipeline_validation.md +++ b/doc/administration/external_pipeline_validation.md @@ -4,7 +4,11 @@ group: Pipeline Execution info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# External pipeline validation **(FREE SELF)** +# External pipeline validation + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed You can use an external service to validate a pipeline before it's created. diff --git a/doc/administration/external_users.md b/doc/administration/external_users.md index b6744e56f4f..d35e11ef18b 100644 --- a/doc/administration/external_users.md +++ b/doc/administration/external_users.md @@ -4,7 +4,11 @@ group: Authentication info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# External users **(FREE SELF)** +# External users + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed In cases where it is desired that a user has access only to some internal or private projects, there is the option of creating **External Users**. This diff --git a/doc/administration/feature_flags.md b/doc/administration/feature_flags.md index b40334fe507..74f27f5f4c2 100644 --- a/doc/administration/feature_flags.md +++ b/doc/administration/feature_flags.md @@ -5,7 +5,11 @@ info: To determine the technical writer assigned to the Stage/Group associated w description: "GitLab administrator: enable and disable GitLab features deployed behind feature flags" --- -# Enable and disable GitLab features deployed behind feature flags **(FREE SELF)** +# Enable and disable GitLab features deployed behind feature flags + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed GitLab adopted [feature flags strategies](../development/feature_flags/index.md) to deploy features in an early stage of development so that they can be diff --git a/doc/administration/file_hooks.md b/doc/administration/file_hooks.md index a16e1c2fde9..eb7ab7bcca8 100644 --- a/doc/administration/file_hooks.md +++ b/doc/administration/file_hooks.md @@ -4,7 +4,11 @@ group: Import and Integrate info: "To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments" --- -# File hooks **(FREE SELF)** +# File hooks + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed Use custom file hooks (not to be confused with [server hooks](server_hooks.md) or [system hooks](system_hooks.md)), to introduce custom integrations without modifying the GitLab source code. diff --git a/doc/administration/geo/disaster_recovery/background_verification.md b/doc/administration/geo/disaster_recovery/background_verification.md index c9bc957d41f..a0821344cab 100644 --- a/doc/administration/geo/disaster_recovery/background_verification.md +++ b/doc/administration/geo/disaster_recovery/background_verification.md @@ -4,7 +4,11 @@ group: Geo info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Automatic background verification **(PREMIUM SELF)** +# Automatic background verification + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** Self-managed Automatic background verification ensures that the transferred data matches a calculated checksum. If the checksum of the data on the **primary** site matches checksum of the diff --git a/doc/administration/geo/disaster_recovery/bring_primary_back.md b/doc/administration/geo/disaster_recovery/bring_primary_back.md index 7e4a5cc01af..068e4d70e64 100644 --- a/doc/administration/geo/disaster_recovery/bring_primary_back.md +++ b/doc/administration/geo/disaster_recovery/bring_primary_back.md @@ -4,7 +4,11 @@ group: Geo info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Bring a demoted primary site back online **(PREMIUM SELF)** +# Bring a demoted primary site back online + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** Self-managed After a failover, it is possible to fail back to the demoted **primary** site to restore your original configuration. This process consists of two steps: @@ -95,7 +99,7 @@ This behavior is useful when: ### Skipping re-transfer of blobs or files -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/352530) in GitLab 16.8 [with a flag](../../feature_flags.md) named `geo_skip_download_if_exists`. Disabled by default. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/352530) in GitLab 16.8 [with a flag](../../feature_flags.md) named `geo_skip_download_if_exists`. Disabled by default. FLAG: On self-managed GitLab, by default this feature is not available. To make it available, an administrator can [enable the feature flag](../../feature_flags.md) named `geo_skip_download_if_exists`. diff --git a/doc/administration/geo/disaster_recovery/index.md b/doc/administration/geo/disaster_recovery/index.md index 7949bd498a7..a0352f4248c 100644 --- a/doc/administration/geo/disaster_recovery/index.md +++ b/doc/administration/geo/disaster_recovery/index.md @@ -4,7 +4,11 @@ group: Geo info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Disaster Recovery (Geo) **(PREMIUM SELF)** +# Disaster Recovery (Geo) + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** Self-managed Geo replicates your database, your Git repositories, and few other assets, but there are some [limitations](../index.md#limitations). diff --git a/doc/administration/geo/disaster_recovery/planned_failover.md b/doc/administration/geo/disaster_recovery/planned_failover.md index a2baed1a92e..8261b7751da 100644 --- a/doc/administration/geo/disaster_recovery/planned_failover.md +++ b/doc/administration/geo/disaster_recovery/planned_failover.md @@ -4,7 +4,11 @@ group: Geo info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Disaster recovery for planned failover **(PREMIUM SELF)** +# Disaster recovery for planned failover + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** Self-managed The primary use-case of Disaster Recovery is to ensure business continuity in the event of unplanned outage, but it can be used in conjunction with a planned diff --git a/doc/administration/geo/disaster_recovery/runbooks/planned_failover_multi_node.md b/doc/administration/geo/disaster_recovery/runbooks/planned_failover_multi_node.md index f24d2bba2a3..1394ec2572a 100644 --- a/doc/administration/geo/disaster_recovery/runbooks/planned_failover_multi_node.md +++ b/doc/administration/geo/disaster_recovery/runbooks/planned_failover_multi_node.md @@ -8,7 +8,11 @@ WARNING: This runbook is an [Experiment](../../../../policy/experiment-beta-support.md#experiment). For complete, production-ready documentation, see the [disaster recovery documentation](../index.md). -# Disaster Recovery (Geo) promotion runbooks **(PREMIUM SELF)** +# Disaster Recovery (Geo) promotion runbooks + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** Self-managed ## Geo planned failover for a multi-node configuration diff --git a/doc/administration/geo/disaster_recovery/runbooks/planned_failover_single_node.md b/doc/administration/geo/disaster_recovery/runbooks/planned_failover_single_node.md index 0afd669e797..96ab4a44a33 100644 --- a/doc/administration/geo/disaster_recovery/runbooks/planned_failover_single_node.md +++ b/doc/administration/geo/disaster_recovery/runbooks/planned_failover_single_node.md @@ -8,7 +8,11 @@ WARNING: This runbook is an [Experiment](../../../../policy/experiment-beta-support.md#experiment). For complete, production-ready documentation, see the [disaster recovery documentation](../index.md). -# Disaster Recovery (Geo) promotion runbooks **(PREMIUM SELF)** +# Disaster Recovery (Geo) promotion runbooks + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** Self-managed ## Geo planned failover for a single-node configuration diff --git a/doc/administration/geo/glossary.md b/doc/administration/geo/glossary.md index 138bf6c444c..39e8f9e5919 100644 --- a/doc/administration/geo/glossary.md +++ b/doc/administration/geo/glossary.md @@ -5,7 +5,11 @@ info: To determine the technical writer assigned to the Stage/Group associated w --- -# Geo Glossary **(PREMIUM SELF)** +# Geo Glossary + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** Self-managed NOTE: We are updating the Geo documentation, user interface and commands to reflect these changes. Not all pages comply with diff --git a/doc/administration/geo/index.md b/doc/administration/geo/index.md index 83a52bb6107..83204e8ee43 100644 --- a/doc/administration/geo/index.md +++ b/doc/administration/geo/index.md @@ -4,7 +4,11 @@ group: Geo info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Geo **(PREMIUM SELF)** +# Geo + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** Self-managed Geo is the solution for widely distributed development teams and for providing a warm-standby as part of a disaster recovery strategy. @@ -230,7 +234,7 @@ For information on how to update your Geo sites to the latest GitLab version, se ### Pausing and resuming replication -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/35913) in GitLab 13.2. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/35913) in GitLab 13.2. WARNING: In GitLab 13.2 and 13.3, promoting a secondary site to a primary while the diff --git a/doc/administration/geo/replication/configuration.md b/doc/administration/geo/replication/configuration.md index b50f86dcf47..bd84bf48af7 100644 --- a/doc/administration/geo/replication/configuration.md +++ b/doc/administration/geo/replication/configuration.md @@ -4,7 +4,11 @@ group: Geo info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Geo configuration **(PREMIUM SELF)** +# Geo configuration + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** Self-managed ## Configuring a new **secondary** site @@ -401,7 +405,7 @@ Selective synchronization: ### Git operations on unreplicated repositories -> [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/2562) in GitLab 12.10 for HTTP(S) and in GitLab 13.0 for SSH. +> - [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/2562) in GitLab 12.10 for HTTP(S) and in GitLab 13.0 for SSH. Git clone, pull, and push operations over HTTP(S) and SSH are supported for repositories that exist on the **primary** site but not on **secondary** sites. This situation can occur diff --git a/doc/administration/geo/replication/container_registry.md b/doc/administration/geo/replication/container_registry.md index 107260ce2f4..7a307372943 100644 --- a/doc/administration/geo/replication/container_registry.md +++ b/doc/administration/geo/replication/container_registry.md @@ -4,7 +4,11 @@ group: Geo info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Container registry for a secondary site **(PREMIUM SELF)** +# Container registry for a secondary site + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** Self-managed You can set up a container registry on your **secondary** Geo site that mirrors the one on the **primary** Geo site. diff --git a/doc/administration/geo/replication/datatypes.md b/doc/administration/geo/replication/datatypes.md index 634a524e6f0..99d42d33a2a 100644 --- a/doc/administration/geo/replication/datatypes.md +++ b/doc/administration/geo/replication/datatypes.md @@ -4,7 +4,11 @@ group: Geo info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Supported Geo data types **(PREMIUM SELF)** +# Supported Geo data types + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** Self-managed A Geo data type is a specific class of data that is required by one or more GitLab features to store relevant information. @@ -160,7 +164,7 @@ The replication for some data types is behind a corresponding feature flag: > - They're enabled on GitLab.com. > - They can't be enabled or disabled per-project. > - They are recommended for production use. -> - For GitLab self-managed instances, GitLab administrators can opt to [disable them](#enable-or-disable-replication-for-some-data-types). **(FREE SELF)** +> - For GitLab self-managed instances, GitLab administrators can opt to [disable them](#enable-or-disable-replication-for-some-data-types). #### Enable or disable replication (for some data types) @@ -208,7 +212,7 @@ successfully, you must replicate their data using some other means. |[Versioned snippets](../../../user/snippets.md#versioned-snippets) | [**Yes** (13.7)](https://gitlab.com/groups/gitlab-org/-/epics/2809) | [**Yes** (14.2)](https://gitlab.com/groups/gitlab-org/-/epics/2810) | Not applicable | Not applicable | Verification was implemented behind the feature flag `geo_snippet_repository_verification` in 13.11, and the feature flag was removed in 14.2. | |[GitLab Pages](../../pages/index.md) | [**Yes** (14.3)](https://gitlab.com/groups/gitlab-org/-/epics/589) | **Yes** (14.6) | [**Yes** (15.1)](https://gitlab.com/groups/gitlab-org/-/epics/5551) | [**Yes** (16.4)](object_storage.md) | Behind feature flag `geo_pages_deployment_replication`, enabled by default. Verification was behind the feature flag `geo_pages_deployment_verification`, removed in 14.7. | |[Project-level Secure files](../../../ci/secure_files/index.md) | **Yes** (15.3) | **Yes** (15.3) | **Yes** (15.3) | [**Yes** (16.4)](object_storage.md) | | -| [Incident Metric Images](../../../operations/incident_management/incidents.md#metrics) | **Yes** (15.5) | **Yes**(15.5) | **Yes** (15.5) | [**Yes** (16.4)](object_storage.md) | Replication/Verification is handled via the Uploads data type. | | +| [Incident Metric Images](../../../operations/incident_management/incidents.md#metrics) | **Yes** (15.5) | **Yes** (15.5) | **Yes** (15.5) | [**Yes** (16.4)](object_storage.md) | Replication/Verification is handled via the Uploads data type. | | |[Alert Metric Images](../../../operations/incident_management/alerts.md#metrics-tab) | **Yes** (15.5) | **Yes** (15.5) | **Yes** (15.5) | [**Yes** (16.4)](object_storage.md) | Replication/Verification is handled via the Uploads data type. | |[Server-side Git hooks](../../server_hooks.md) | [Not planned](https://gitlab.com/groups/gitlab-org/-/epics/1867) | No | Not applicable | Not applicable | Not planned because of current implementation complexity, low customer interest, and availability of alternatives to hooks. | |[Elasticsearch integration](../../../integration/advanced_search/elasticsearch.md) | [Not planned](https://gitlab.com/gitlab-org/gitlab/-/issues/1186) | No | No | No | Not planned because further product discovery is required and Elasticsearch (ES) clusters can be rebuilt. Secondaries use the same ES cluster as the primary. | diff --git a/doc/administration/geo/replication/disable_geo.md b/doc/administration/geo/replication/disable_geo.md index 597bb08c188..e8e9b588a7b 100644 --- a/doc/administration/geo/replication/disable_geo.md +++ b/doc/administration/geo/replication/disable_geo.md @@ -4,7 +4,11 @@ group: Geo info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Disabling Geo **(PREMIUM SELF)** +# Disabling Geo + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** Self-managed If you want to revert to a regular Linux package installation setup after a test, or you have encountered a Disaster Recovery situation and you want to disable Geo momentarily, you can use these instructions to disable your diff --git a/doc/administration/geo/replication/faq.md b/doc/administration/geo/replication/faq.md index c5ac25ba152..0c5d78d6f98 100644 --- a/doc/administration/geo/replication/faq.md +++ b/doc/administration/geo/replication/faq.md @@ -4,7 +4,11 @@ group: Geo info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Geo Frequently Asked Questions **(PREMIUM SELF)** +# Geo Frequently Asked Questions + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** Self-managed ## What are the minimum requirements to run Geo? diff --git a/doc/administration/geo/replication/geo_validation_tests.md b/doc/administration/geo/replication/geo_validation_tests.md index b4f4374fd9b..9f0aaebc8fe 100644 --- a/doc/administration/geo/replication/geo_validation_tests.md +++ b/doc/administration/geo/replication/geo_validation_tests.md @@ -4,7 +4,11 @@ group: Geo info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Geo validation tests **(PREMIUM SELF)** +# Geo validation tests + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** Self-managed The Geo team performs manual testing and validation on common deployment configurations to ensure that Geo works when upgrading between minor GitLab versions and major PostgreSQL database versions. diff --git a/doc/administration/geo/replication/location_aware_git_url.md b/doc/administration/geo/replication/location_aware_git_url.md index 2491b7c8bc8..65df56d315e 100644 --- a/doc/administration/geo/replication/location_aware_git_url.md +++ b/doc/administration/geo/replication/location_aware_git_url.md @@ -4,7 +4,11 @@ group: Geo info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Location-aware Git remote URL with AWS Route53 **(PREMIUM SELF)** +# Location-aware Git remote URL with AWS Route53 + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** Self-managed NOTE: Since GitLab 14.6, diff --git a/doc/administration/geo/replication/multiple_servers.md b/doc/administration/geo/replication/multiple_servers.md index 9298281561f..edec46e45d2 100644 --- a/doc/administration/geo/replication/multiple_servers.md +++ b/doc/administration/geo/replication/multiple_servers.md @@ -4,7 +4,11 @@ group: Geo info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Geo for multiple nodes **(PREMIUM SELF)** +# Geo for multiple nodes + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** Self-managed This document describes a minimal reference architecture for running Geo in a multi-node configuration. If your multi-node setup differs from the one diff --git a/doc/administration/geo/replication/object_storage.md b/doc/administration/geo/replication/object_storage.md index 9d1cb4387a0..eaedb09e4b5 100644 --- a/doc/administration/geo/replication/object_storage.md +++ b/doc/administration/geo/replication/object_storage.md @@ -4,7 +4,11 @@ group: Geo info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Geo with Object storage **(PREMIUM SELF)** +# Geo with Object storage + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** Self-managed > Verification of files stored in object storage was [introduced](https://gitlab.com/groups/gitlab-org/-/epics/8056) in GitLab 16.4 [with a flag](../../feature_flags.md) named `geo_object_storage_verification`. Enabled by default. diff --git a/doc/administration/geo/replication/remove_geo_site.md b/doc/administration/geo/replication/remove_geo_site.md index 4787b949e2e..d6bd634412d 100644 --- a/doc/administration/geo/replication/remove_geo_site.md +++ b/doc/administration/geo/replication/remove_geo_site.md @@ -4,7 +4,11 @@ group: Geo info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Removing secondary Geo sites **(PREMIUM SELF)** +# Removing secondary Geo sites + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** Self-managed **Secondary** sites can be removed from the Geo cluster using the Geo administration page of the **primary** site. To remove a **secondary** site: diff --git a/doc/administration/geo/replication/security_review.md b/doc/administration/geo/replication/security_review.md index 8d563b7e609..8fc0f219b74 100644 --- a/doc/administration/geo/replication/security_review.md +++ b/doc/administration/geo/replication/security_review.md @@ -4,7 +4,11 @@ group: Geo info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Geo security review (Q&A) **(PREMIUM SELF)** +# Geo security review (Q&A) + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** Self-managed The following security review of the Geo feature set focuses on security aspects of the feature as they apply to customers running their own GitLab instances. The review diff --git a/doc/administration/geo/replication/single_sign_on.md b/doc/administration/geo/replication/single_sign_on.md index f8ca6209524..305cb4d8725 100644 --- a/doc/administration/geo/replication/single_sign_on.md +++ b/doc/administration/geo/replication/single_sign_on.md @@ -4,7 +4,11 @@ group: Geo info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Geo with Single Sign On (SSO) **(PREMIUM SELF)** +# Geo with Single Sign On (SSO) + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** Self-managed This documentation only discusses Geo-specific SSO considerations and configuration. For more information on general authentication, see [GitLab authentication and authorization](../../auth/index.md). diff --git a/doc/administration/geo/replication/troubleshooting.md b/doc/administration/geo/replication/troubleshooting.md index 39fa04103db..7406326c37e 100644 --- a/doc/administration/geo/replication/troubleshooting.md +++ b/doc/administration/geo/replication/troubleshooting.md @@ -4,7 +4,11 @@ group: Geo info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Troubleshooting Geo **(PREMIUM SELF)** +# Troubleshooting Geo + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** Self-managed Setting up Geo requires careful attention to details, and sometimes it's easy to miss a step. diff --git a/doc/administration/geo/replication/tuning.md b/doc/administration/geo/replication/tuning.md index c02571e21a8..6f5491292b8 100644 --- a/doc/administration/geo/replication/tuning.md +++ b/doc/administration/geo/replication/tuning.md @@ -4,7 +4,11 @@ group: Geo info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Tuning Geo **(PREMIUM SELF)** +# Tuning Geo + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** Self-managed You can limit the number of concurrent operations the sites can run in the background. diff --git a/doc/administration/geo/replication/upgrading_the_geo_sites.md b/doc/administration/geo/replication/upgrading_the_geo_sites.md index 4a72dcf0145..20d140d4da8 100644 --- a/doc/administration/geo/replication/upgrading_the_geo_sites.md +++ b/doc/administration/geo/replication/upgrading_the_geo_sites.md @@ -4,7 +4,11 @@ group: Geo info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Upgrading the Geo sites **(PREMIUM SELF)** +# Upgrading the Geo sites + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** Self-managed WARNING: Read these sections carefully before updating your Geo sites. Not following diff --git a/doc/administration/geo/replication/usage.md b/doc/administration/geo/replication/usage.md index d05fb75af11..4e62c87bf06 100644 --- a/doc/administration/geo/replication/usage.md +++ b/doc/administration/geo/replication/usage.md @@ -6,7 +6,11 @@ info: To determine the technical writer assigned to the Stage/Group associated w -# Using a Geo Site **(PREMIUM SELF)** +# Using a Geo Site + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** Self-managed After you set up the [database replication and configure the Geo nodes](../index.md#setup-instructions), use your closest GitLab site as you would do with the primary one. diff --git a/doc/administration/geo/secondary_proxy/index.md b/doc/administration/geo/secondary_proxy/index.md index 376f3f3958e..cbe41d3da2a 100644 --- a/doc/administration/geo/secondary_proxy/index.md +++ b/doc/administration/geo/secondary_proxy/index.md @@ -4,7 +4,11 @@ group: Geo info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Geo proxying for secondary sites **(PREMIUM SELF)** +# Geo proxying for secondary sites + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** Self-managed > - [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/5914) in GitLab 14.4 [with a flag](../../feature_flags.md) named `geo_secondary_proxy`. Disabled by default. > - [Enabled by default for unified URLs](https://gitlab.com/gitlab-org/gitlab/-/issues/325732) in GitLab 14.6. diff --git a/doc/administration/geo/secondary_proxy/location_aware_external_url.md b/doc/administration/geo/secondary_proxy/location_aware_external_url.md index 2f55aa27dff..5865498210d 100644 --- a/doc/administration/geo/secondary_proxy/location_aware_external_url.md +++ b/doc/administration/geo/secondary_proxy/location_aware_external_url.md @@ -4,7 +4,11 @@ group: Geo info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Location-aware public URL **(PREMIUM SELF)** +# Location-aware public URL + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** Self-managed With [Geo proxying for secondary sites](index.md), you can provide GitLab users with a single URL that automatically uses the Geo site closest to them. diff --git a/doc/administration/geo/secondary_proxy/runners.md b/doc/administration/geo/secondary_proxy/runners.md index 6dfd61778e7..befb880e8de 100644 --- a/doc/administration/geo/secondary_proxy/runners.md +++ b/doc/administration/geo/secondary_proxy/runners.md @@ -4,9 +4,14 @@ group: Geo info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Secondary runners **(PREMIUM SELF EXPERIMENT)** +# Secondary runners -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/415179) in GitLab 16.7 [with a flag](../../feature_flags.md) named `geo_proxy_check_pipeline_refs`. Disabled by default. +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** Self-managed +**Status:** Experiment + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/415179) in GitLab 16.7 [with a flag](../../feature_flags.md) named `geo_proxy_check_pipeline_refs`. Disabled by default. FLAG: On self-managed GitLab, by default this feature is not available. diff --git a/doc/administration/geo/setup/database.md b/doc/administration/geo/setup/database.md index a9238a4142a..d5336b13c31 100644 --- a/doc/administration/geo/setup/database.md +++ b/doc/administration/geo/setup/database.md @@ -4,7 +4,11 @@ group: Geo info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Geo database replication **(PREMIUM SELF)** +# Geo database replication + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** Self-managed This document describes the minimal required steps to replicate your primary GitLab database to a secondary site's database. You may have to change some diff --git a/doc/administration/geo/setup/external_database.md b/doc/administration/geo/setup/external_database.md index a17c09c85e8..fc7273b9477 100644 --- a/doc/administration/geo/setup/external_database.md +++ b/doc/administration/geo/setup/external_database.md @@ -4,7 +4,11 @@ group: Geo info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Geo with external PostgreSQL instances **(PREMIUM SELF)** +# Geo with external PostgreSQL instances + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** Self-managed This document is relevant if you are using a PostgreSQL instance that is not managed by the Linux package. This includes diff --git a/doc/administration/geo/setup/index.md b/doc/administration/geo/setup/index.md index 1868902cfcf..4b69ac4df93 100644 --- a/doc/administration/geo/setup/index.md +++ b/doc/administration/geo/setup/index.md @@ -4,7 +4,11 @@ group: Geo info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Setting up Geo **(PREMIUM SELF)** +# Setting up Geo + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** Self-managed ## Prerequisites diff --git a/doc/administration/geo/setup/two_single_node_external_services.md b/doc/administration/geo/setup/two_single_node_external_services.md index a77bacb0587..f166df04e6a 100644 --- a/doc/administration/geo/setup/two_single_node_external_services.md +++ b/doc/administration/geo/setup/two_single_node_external_services.md @@ -4,7 +4,11 @@ group: Geo info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Set up Geo for two single-node sites (with external PostgreSQL services) **(PREMIUM SELF)** +# Set up Geo for two single-node sites (with external PostgreSQL services) + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** Self-managed The following guide provides concise instructions on how to deploy GitLab Geo for a two single-node site installation using two Linux package instances and external PostgreSQL databases like RDS, Azure Database, or Google Cloud SQL. diff --git a/doc/administration/geo/setup/two_single_node_sites.md b/doc/administration/geo/setup/two_single_node_sites.md index edcb2f467ff..7a34147428b 100644 --- a/doc/administration/geo/setup/two_single_node_sites.md +++ b/doc/administration/geo/setup/two_single_node_sites.md @@ -4,7 +4,11 @@ group: Geo info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Set up Geo for two single-node sites **(PREMIUM SELF)** +# Set up Geo for two single-node sites + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** Self-managed The following guide provides concise instructions on how to deploy GitLab Geo for a two single-node site installation using two Linux package instances with no external services set up. diff --git a/doc/administration/geo_sites.md b/doc/administration/geo_sites.md index fa650bade47..61002872fbd 100644 --- a/doc/administration/geo_sites.md +++ b/doc/administration/geo_sites.md @@ -4,7 +4,11 @@ group: Geo info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Geo sites Admin Area **(PREMIUM SELF)** +# Geo sites Admin Area + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** Self-managed You can configure various settings for GitLab Geo sites. For more information, see [Geo documentation](../administration/geo/index.md). diff --git a/doc/administration/get_started.md b/doc/administration/get_started.md index 41783d55377..e83cdb10fe9 100644 --- a/doc/administration/get_started.md +++ b/doc/administration/get_started.md @@ -5,7 +5,11 @@ description: Administration overview. info: For assistance with this tutorial, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments-to-other-projects-and-subjects. --- -# Get started administering GitLab **(FREE SELF)** +# Get started administering GitLab + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed Get started with GitLab administration. Configure your organization and its authentication, then secure, monitor, and back up GitLab. @@ -181,7 +185,11 @@ The EC2 instance meets the requirements for an application data backup by taking In general, if you're running GitLab on a virtualized server, you can create VM snapshots of the entire GitLab server. It is common for a VM snapshot to require you to power down the server. -#### Option 2: GitLab Geo **(PREMIUM SELF)** +#### Option 2: GitLab Geo + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** Self-managed Geo provides local, read-only instances of your GitLab instances. diff --git a/doc/administration/git_protocol.md b/doc/administration/git_protocol.md index 7ff676e3512..7f4da906df8 100644 --- a/doc/administration/git_protocol.md +++ b/doc/administration/git_protocol.md @@ -5,7 +5,11 @@ info: To determine the technical writer assigned to the Stage/Group associated w description: "Set and configure Git protocol v2" --- -# Configuring Git Protocol v2 **(FREE SELF)** +# Configuring Git Protocol v2 + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed > [Re-enabled](https://gitlab.com/gitlab-org/gitlab/-/issues/27828) in GitLab 12.8. diff --git a/doc/administration/gitaly/concurrency_limiting.md b/doc/administration/gitaly/concurrency_limiting.md index 2b1a2bbef64..488b5d2d0b1 100644 --- a/doc/administration/gitaly/concurrency_limiting.md +++ b/doc/administration/gitaly/concurrency_limiting.md @@ -125,7 +125,7 @@ You can observe the behavior of this queue using Gitaly logs and Prometheus. For ## Adaptive concurrency limiting -> [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/10734) in GitLab 16.6. +> - [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/10734) in GitLab 16.6. Gitaly supports two concurrency limits: diff --git a/doc/administration/gitaly/configure_gitaly.md b/doc/administration/gitaly/configure_gitaly.md index d492d3d32b3..3cdc89d500c 100644 --- a/doc/administration/gitaly/configure_gitaly.md +++ b/doc/administration/gitaly/configure_gitaly.md @@ -4,7 +4,11 @@ group: Gitaly info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Configure Gitaly **(FREE SELF)** +# Configure Gitaly + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed Configure Gitaly in one of two ways: @@ -878,7 +882,11 @@ result as you did at the start. For example: `enforced="true"` means that authentication is being enforced. -## Pack-objects cache **(FREE SELF)** +## Pack-objects cache + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed [Gitaly](index.md), the service that provides storage for Git repositories, can be configured to cache a short rolling window of Git @@ -1008,7 +1016,7 @@ the deleted file have closed it. #### Minimum key occurrences `min_occurrences` -> [Introduced](https://gitlab.com/gitlab-com/gl-infra/scalability/-/issues/2222) in GitLab 15.11. +> - [Introduced](https://gitlab.com/gitlab-com/gl-infra/scalability/-/issues/2222) in GitLab 15.11. The `min_occurrences` setting controls how often an identical request must occur before we create a new cache entry. The default value is `1`, @@ -1356,7 +1364,7 @@ Configure Gitaly to sign commits made with the GitLab UI in one of two ways: ## Generate configuration using an external command -> [Introduced](https://gitlab.com/gitlab-org/gitaly/-/issues/4828) in GitLab 15.11. +> - [Introduced](https://gitlab.com/gitlab-org/gitaly/-/issues/4828) in GitLab 15.11. You can generate parts of the Gitaly configuration using an external command. You might do this: diff --git a/doc/administration/gitaly/index.md b/doc/administration/gitaly/index.md index 7826b98a663..2f096f5283e 100644 --- a/doc/administration/gitaly/index.md +++ b/doc/administration/gitaly/index.md @@ -4,7 +4,11 @@ group: Gitaly info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Gitaly and Gitaly Cluster **(FREE SELF)** +# Gitaly and Gitaly Cluster + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed [Gitaly](https://gitlab.com/gitlab-org/gitaly) provides high-level RPC access to Git repositories. It is used by GitLab to read and write Git data. @@ -490,7 +494,7 @@ You can [monitor distribution of reads](monitoring.md#monitor-gitaly-cluster) us #### Strong consistency -> In GitLab 14.0, strong consistency is the primary replication method. +> - In GitLab 14.0, strong consistency is the primary replication method. Gitaly Cluster provides strong consistency by writing changes synchronously to all healthy, up-to-date replicas. If a replica is outdated or unhealthy at the time of the transaction, the write is asynchronously replicated to it. diff --git a/doc/administration/gitaly/monitoring.md b/doc/administration/gitaly/monitoring.md index 83d843971d7..01aff7b205e 100644 --- a/doc/administration/gitaly/monitoring.md +++ b/doc/administration/gitaly/monitoring.md @@ -92,7 +92,7 @@ In Prometheus, look for the following metrics: ## Monitor Gitaly adaptive concurrency limiting -> [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/10734) in GitLab 16.6. +> - [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/10734) in GitLab 16.6. You can observe specific behavior of [adaptive concurrency limiting](concurrency_limiting.md#adaptive-concurrency-limiting) using Gitaly logs and Prometheus. @@ -178,7 +178,7 @@ gitaly_streamcache_index_entries{dir="/var/opt/gitlab/git-data/repositories/+git ## Monitor Gitaly server-side backups -> [Introduced](https://gitlab.com/gitlab-org/gitaly/-/issues/5358) in GitLab 16.7. +> - [Introduced](https://gitlab.com/gitlab-org/gitaly/-/issues/5358) in GitLab 16.7. Monitor [server-side repository backups](configure_gitaly.md#configure-server-side-backups) with the following metrics: @@ -288,7 +288,7 @@ You can also monitor the [Praefect logs](../logs/index.md#praefect-logs). ### Database metrics `/db_metrics` endpoint -> [Introduced](https://gitlab.com/gitlab-org/gitaly/-/issues/3286) in GitLab 14.5. +> - [Introduced](https://gitlab.com/gitlab-org/gitaly/-/issues/3286) in GitLab 14.5. The following metrics are available from the `/db_metrics` endpoint: diff --git a/doc/administration/gitaly/praefect.md b/doc/administration/gitaly/praefect.md index 6440092bde0..73455c17ad4 100644 --- a/doc/administration/gitaly/praefect.md +++ b/doc/administration/gitaly/praefect.md @@ -4,7 +4,11 @@ group: Gitaly info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Configure Gitaly Cluster **(FREE SELF)** +# Configure Gitaly Cluster + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed Configure Gitaly Cluster using either: @@ -491,7 +495,7 @@ praefect['configuration'] = { ### Praefect -> [Introduced](https://gitlab.com/gitlab-org/gitaly/-/issues/2634) in GitLab 13.4, Praefect nodes can no longer be designated as `primary`. +> - [Introduced](https://gitlab.com/gitlab-org/gitaly/-/issues/2634) in GitLab 13.4, Praefect nodes can no longer be designated as `primary`. If there are multiple Praefect nodes: @@ -870,7 +874,7 @@ For self-compiled installations: #### Service discovery -> [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/8971) in GitLab 15.10. +> - [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/8971) in GitLab 15.10. Prerequisites: @@ -1526,7 +1530,7 @@ For a replication factor: ## Repository verification -> [Introduced](https://gitlab.com/gitlab-org/gitaly/-/issues/4080) in GitLab 15.0. +> - [Introduced](https://gitlab.com/gitlab-org/gitaly/-/issues/4080) in GitLab 15.0. Praefect stores metadata about the repositories in a database. If the repositories are modified on disk without going through Praefect, the metadata can become inaccurate. For example if a Gitaly node is diff --git a/doc/administration/gitaly/recovery.md b/doc/administration/gitaly/recovery.md index 78e7cc6995d..d1324cd7819 100644 --- a/doc/administration/gitaly/recovery.md +++ b/doc/administration/gitaly/recovery.md @@ -180,7 +180,7 @@ Virtual storage: default #### Unavailable replicas of available repositories -> Introduced in GitLab 14.0, flag renamed from `-partially-replicated` and behavior changed. +> - Introduced in GitLab 14.0, flag renamed from `-partially-replicated` and behavior changed. To also list information of repositories which are available but are unavailable from some of the assigned nodes, use the `-partially-unavailable` flag. @@ -273,7 +273,7 @@ These tools reconcile the outdated repositories to bring them fully up to date a ### Automatic reconciliation -> [Introduced](https://gitlab.com/gitlab-org/gitaly/-/issues/2717) in GitLab 13.4. +> - [Introduced](https://gitlab.com/gitlab-org/gitaly/-/issues/2717) in GitLab 13.4. Praefect automatically reconciles repositories that are not up to date. By default, this is done every five minutes. For each outdated repository on a healthy Gitaly node, Praefect picks a @@ -498,7 +498,7 @@ This command fails if: ### Manually add many repositories to the tracking database -> [Introduced](https://gitlab.com/gitlab-org/omnibus-gitlab/-/merge_requests/6319) in GitLab 15.4. +> - [Introduced](https://gitlab.com/gitlab-org/omnibus-gitlab/-/merge_requests/6319) in GitLab 15.4. WARNING: Because of a [known issue](https://gitlab.com/gitlab-org/gitaly/-/issues/5402), you can't add repositories to the @@ -543,7 +543,7 @@ If any entry fails these checks, the command aborts prior to attempting to track ### List virtual storage details -> [Introduced](https://gitlab.com/gitlab-org/gitaly/-/merge_requests/4609) in GitLab 15.1. +> - [Introduced](https://gitlab.com/gitlab-org/gitaly/-/merge_requests/4609) in GitLab 15.1. The `list-storages` Praefect sub-command lists virtual storages and their associated storage nodes. If a virtual storage is: diff --git a/doc/administration/gitaly/reference.md b/doc/administration/gitaly/reference.md index 169b6e00813..0a2943fff35 100644 --- a/doc/administration/gitaly/reference.md +++ b/doc/administration/gitaly/reference.md @@ -4,7 +4,11 @@ group: Gitaly info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Example configuration files **(FREE SELF)** +# Example configuration files + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed Gitaly and Gitaly Cluster are configured by using configuration files. The default location of the configuration files depends on the type of installation you have: diff --git a/doc/administration/gitaly/troubleshooting.md b/doc/administration/gitaly/troubleshooting.md index 28e117c9dab..4590682e4e4 100644 --- a/doc/administration/gitaly/troubleshooting.md +++ b/doc/administration/gitaly/troubleshooting.md @@ -4,7 +4,11 @@ group: Gitaly info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Troubleshooting Gitaly **(FREE SELF)** +# Troubleshooting Gitaly + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed Refer to the information below when troubleshooting Gitaly. For information on troubleshooting Gitaly Cluster (Praefect), see [Troubleshooting Gitaly Cluster](troubleshooting_gitaly_cluster.md). diff --git a/doc/administration/gitaly/troubleshooting_gitaly_cluster.md b/doc/administration/gitaly/troubleshooting_gitaly_cluster.md index 9f1ae36b742..1f0b75602bb 100644 --- a/doc/administration/gitaly/troubleshooting_gitaly_cluster.md +++ b/doc/administration/gitaly/troubleshooting_gitaly_cluster.md @@ -4,14 +4,18 @@ group: Gitaly info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Troubleshooting Gitaly Cluster **(FREE SELF)** +# Troubleshooting Gitaly Cluster + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed Refer to the information below when troubleshooting Gitaly Cluster (Praefect). For information on troubleshooting Gitaly, see [Troubleshooting Gitaly](troubleshooting.md). ## Check cluster health -> [Introduced](https://gitlab.com/gitlab-org/omnibus-gitlab/-/merge_requests/5688) in GitLab 14.5. +> - [Introduced](https://gitlab.com/gitlab-org/omnibus-gitlab/-/merge_requests/5688) in GitLab 14.5. The `check` Praefect sub-command runs a series of checks to determine the health of the Gitaly Cluster. @@ -74,7 +78,7 @@ If this check fails: ### Check clock synchronization -> [Introduced](https://gitlab.com/gitlab-org/gitaly/-/merge_requests/4225) in GitLab 14.8. +> - [Introduced](https://gitlab.com/gitlab-org/gitaly/-/merge_requests/4225) in GitLab 14.8. Authentication between Praefect and the Gitaly servers requires the server times to be in sync so the token check succeeds. @@ -145,7 +149,7 @@ To determine the primary node of a repository: ## View repository metadata -> [Introduced](https://gitlab.com/gitlab-org/gitaly/-/issues/3481) in GitLab 14.6. +> - [Introduced](https://gitlab.com/gitlab-org/gitaly/-/issues/3481) in GitLab 14.6. Gitaly Cluster maintains a [metadata database](index.md#components) about the repositories stored on the cluster. Use the `praefect metadata` subcommand to inspect the metadata for troubleshooting. diff --git a/doc/administration/housekeeping.md b/doc/administration/housekeeping.md index 7ee29035de4..bbd154e3efc 100644 --- a/doc/administration/housekeeping.md +++ b/doc/administration/housekeeping.md @@ -4,7 +4,11 @@ group: Gitaly info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Housekeeping **(FREE SELF)** +# Housekeeping + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed GitLab supports and automates housekeeping tasks in Git repositories to ensure that they can be served as efficiently as possible. Housekeeping tasks include: diff --git a/doc/administration/inactive_project_deletion.md b/doc/administration/inactive_project_deletion.md index 3c340448cee..b1e779b314b 100644 --- a/doc/administration/inactive_project_deletion.md +++ b/doc/administration/inactive_project_deletion.md @@ -4,7 +4,11 @@ group: Compliance info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Inactive project deletion **(FREE SELF)** +# Inactive project deletion + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/85689) in GitLab 15.0 [with a flag](../administration/feature_flags.md) named `inactive_projects_deletion`. Disabled by default. > - [Feature flag `inactive_projects_deletion`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/96803) removed in GitLab 15.4. diff --git a/doc/administration/incoming_email.md b/doc/administration/incoming_email.md index 2d2d9d34019..6fd587fdde0 100644 --- a/doc/administration/incoming_email.md +++ b/doc/administration/incoming_email.md @@ -4,7 +4,11 @@ group: Project Management info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Incoming email **(FREE SELF)** +# Incoming email + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed GitLab has several features based on receiving incoming email messages: @@ -795,7 +799,7 @@ incoming_email: #### Microsoft Graph -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/214900) in GitLab 13.11. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/214900) in GitLab 13.11. GitLab can read incoming email using the Microsoft Graph API instead of IMAP. Because [Microsoft is deprecating IMAP usage with Basic Authentication](https://techcommunity.microsoft.com/t5/exchange-team-blog/announcing-oauth-2-0-support-for-imap-and-smtp-auth-protocols-in/ba-p/1330432), the Microsoft Graph API is be required for new Microsoft Exchange Online mailboxes. @@ -870,7 +874,7 @@ The Microsoft Graph API is not yet supported in self-compiled installations. See ### Use encrypted credentials -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/108279) in GitLab 15.9. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/108279) in GitLab 15.9. Instead of having the incoming email credentials stored in plaintext in the configuration files, you can optionally use an encrypted file for the incoming email credentials. diff --git a/doc/administration/index.md b/doc/administration/index.md index 4b98999fb6d..fb3dcf76947 100644 --- a/doc/administration/index.md +++ b/doc/administration/index.md @@ -5,7 +5,11 @@ info: "To determine the technical writer assigned to the Stage/Group associated description: 'Learn how to install, configure, update, and maintain your GitLab instance.' --- -# Administer GitLab **(FREE SELF)** +# Administer GitLab + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed Learn how to administer a self-managed GitLab instance. diff --git a/doc/administration/instance_limits.md b/doc/administration/instance_limits.md index 5638b2d76ac..4d7f0bea7cb 100644 --- a/doc/administration/instance_limits.md +++ b/doc/administration/instance_limits.md @@ -4,7 +4,11 @@ group: Distribution info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# GitLab application limits **(FREE SELF)** +# GitLab application limits + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed GitLab, like most large applications, enforces limits in certain features to maintain a minimum quality of performance. Allowing some features to be limitless could affect security, @@ -96,7 +100,7 @@ This setting limits the request rate on the Packages API per user or IP. For mor ### Git LFS -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/68642) in GitLab 14.3. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/68642) in GitLab 14.3. This setting limits the request rate on the [Git LFS](../topics/git/lfs/index.md) requests per user. For more information, read @@ -116,7 +120,7 @@ This setting limits the request rate on the Packages API per user or IP address. ### Deprecated API endpoints -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/68645) in GitLab 14.4. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/68645) in GitLab 14.4. This setting limits the request rate on deprecated API endpoints per user or IP address. For more information, read [Deprecated API rate limits](settings/deprecated_api_rate_limits.md). @@ -191,7 +195,7 @@ This endpoint has been requested too many times. Try again later. ### Pipeline creation rate limit -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/362475) in GitLab 15.0. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/362475) in GitLab 15.0. This setting limits the request rate to the pipeline creation endpoints. @@ -327,7 +331,7 @@ See also [webhook limits for GitLab.com](../user/gitlab_com/index.md#other-limit ### Recursive webhooks -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/329743) in GitLab 14.8. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/329743) in GitLab 14.8. GitLab detects and blocks webhooks that are recursive or that exceed the limit of webhooks that can be triggered from other webhooks. This enables GitLab to @@ -484,7 +488,7 @@ Set the limit to `0` to disable it. ### Limit the number of pipeline triggers -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/33696) in GitLab 14.6. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/33696) in GitLab 14.6. You can set a limit on the maximum number of pipeline triggers per project. This limit is checked every time a new trigger is created. @@ -526,7 +530,7 @@ Plan.default.actual_limits.update!(ci_pipeline_schedules: 100) ### Limit the number of pipelines created by a pipeline schedule per day -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/323066) in GitLab 14.0. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/323066) in GitLab 14.0. You can limit the number of pipelines that pipeline schedules can trigger per day. @@ -552,7 +556,7 @@ This limit is [enabled on GitLab.com](../user/gitlab_com/index.md#gitlab-cicd). ### Limit the number of schedule rules defined for security policy project -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/335659) in GitLab 15.1. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/335659) in GitLab 15.1. You can limit the total number of schedule rules per security policy project. This limit is checked each time policies with schedule rules are updated. If a new schedule rule would @@ -588,7 +592,7 @@ Plan.default.actual_limits.update!(ci_instance_level_variables: 30) ### Number of group level variables -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/362227) in GitLab 15.7. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/362227) in GitLab 15.7. The total number of group level CI/CD variables is limited at the instance level. This limit is checked each time a new group level variable is created. If a new variable @@ -606,7 +610,7 @@ Plan.default.actual_limits.update!(group_ci_variables: 40000) ### Number of project level variables -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/362227) in GitLab 15.7. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/362227) in GitLab 15.7. The total number of project level CI/CD variables is limited at the instance level. This limit is checked each time a new project level variable is created. If a new variable @@ -754,7 +758,7 @@ continue to run, but the log is truncated when it hits the limit. ### Maximum number of active DAST profile schedules per project -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/68551) in GitLab 14.3. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/68551) in GitLab 14.3. Limit the number of active DAST profile schedules per project. A DAST profile schedule can be active or inactive. @@ -809,7 +813,7 @@ ApplicationSetting.update(ci_max_total_yaml_size_bytes: 20.megabytes) ### Limit dotenv variables -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/321552) in GitLab 14.5. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/321552) in GitLab 14.5. You can set a limit on the maximum number of variables inside of a dotenv artifact. This limit is checked every time a dotenv file is exported as an artifact. @@ -827,7 +831,7 @@ This limit is [enabled on GitLab.com](../user/gitlab_com/index.md#gitlab-cicd). ### Limit dotenv file size -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/321552) in GitLab 14.5. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/321552) in GitLab 14.5. You can set a limit on the maximum size of a dotenv artifact. This limit is checked every time a dotenv file is exported as an artifact. @@ -843,7 +847,7 @@ Plan.default.actual_limits.update!(dotenv_size: 5.kilobytes) ### Limit CI/CD job annotations -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/38337) in GitLab 16.3. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/38337) in GitLab 16.3. You can set a limit on the maximum number of [annotations](../ci/yaml/artifacts_reports.md#artifactsreportsannotations) per CI/CD job. @@ -859,7 +863,7 @@ Plan.default.actual_limits.update!(ci_job_annotations_num: 100) ### Limit CI/CD job annotations file size -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/38337) in GitLab 16.3. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/38337) in GitLab 16.3. You can set a limit on the maximum size of a CI/CD job [annotation](../ci/yaml/artifacts_reports.md#artifactsreportsannotations). @@ -918,7 +922,11 @@ panel_groups: label: Legend Label ``` -## Environment Dashboard limits **(PREMIUM ALL)** +## Environment Dashboard limits + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed See [Environment Dashboard](../ci/environments/environments_dashboard.md#adding-a-project-to-the-dashboard) for the maximum number of displayed projects. @@ -1109,7 +1117,7 @@ When asking for versions of a given NuGet package name, the GitLab package regis ## Dependency Proxy Limits -> [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/6396) in GitLab 14.5. +> - [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/6396) in GitLab 14.5. The maximum file size for an image cached in the [Dependency Proxy](../user/packages/dependency_proxy/index.md) @@ -1138,7 +1146,7 @@ Container repository tags are in the container registry and, as such, each tag d ## Project-level Secure Files API limits -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/78227) in GitLab 14.8. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/78227) in GitLab 14.8. The [secure files API](../api/secure_files.md) enforces the following limits: diff --git a/doc/administration/instance_review.md b/doc/administration/instance_review.md index a33bf0f70b1..cd67ee34a12 100644 --- a/doc/administration/instance_review.md +++ b/doc/administration/instance_review.md @@ -4,7 +4,11 @@ group: Acquisition info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Instance review **(FREE SELF)** +# Instance review + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed If you run a self-managed instance with 50 or more users on the Free tier ([either Community Edition or unlicensed Enterprise Edition](https://about.gitlab.com/install/ce-or-ee/)), diff --git a/doc/administration/integration/diagrams_net.md b/doc/administration/integration/diagrams_net.md index 42286428bb1..9fb9e3eb1d1 100644 --- a/doc/administration/integration/diagrams_net.md +++ b/doc/administration/integration/diagrams_net.md @@ -4,7 +4,11 @@ group: Source Code info: "To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments" --- -# Diagrams.net **(FREE SELF)** +# Diagrams.net + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/86206) in GitLab 15.10. > - Offline environment support [introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/116281) in GitLab 16.1. diff --git a/doc/administration/integration/kroki.md b/doc/administration/integration/kroki.md index b3c55e6f772..bbd1027e802 100644 --- a/doc/administration/integration/kroki.md +++ b/doc/administration/integration/kroki.md @@ -4,7 +4,11 @@ group: Project Management info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Kroki **(FREE SELF)** +# Kroki + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/241744) in GitLab 13.7. > - Support for reStructuredText and Textile documents [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/324766) in GitLab 13.12. diff --git a/doc/administration/integration/mailgun.md b/doc/administration/integration/mailgun.md index a4e8c826ef7..35ece000dc2 100644 --- a/doc/administration/integration/mailgun.md +++ b/doc/administration/integration/mailgun.md @@ -4,7 +4,11 @@ group: Project Management info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Mailgun **(FREE SELF)** +# Mailgun + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed When you use Mailgun to send emails for your GitLab instance and [Mailgun](https://www.mailgun.com/) integration is enabled and configured in GitLab, you can receive their webhook for diff --git a/doc/administration/integration/plantuml.md b/doc/administration/integration/plantuml.md index 9e8bd323f5a..f6e4cedd1ee 100644 --- a/doc/administration/integration/plantuml.md +++ b/doc/administration/integration/plantuml.md @@ -4,7 +4,11 @@ group: Source Code info: "To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments" --- -# PlantUML **(FREE SELF)** +# PlantUML + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed With the [PlantUML](https://plantuml.com) integration, you can create diagrams in snippets, wikis, and repositories. This integration is enabled on GitLab.com for all SaaS users and does not require any additional configuration. diff --git a/doc/administration/integration/terminal.md b/doc/administration/integration/terminal.md index cb7d51f882a..bd0b589f9b8 100644 --- a/doc/administration/integration/terminal.md +++ b/doc/administration/integration/terminal.md @@ -4,7 +4,11 @@ group: Environments info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Web terminals (deprecated) **(FREE SELF)** +# Web terminals (deprecated) + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed > - [Deprecated](https://gitlab.com/groups/gitlab-org/configure/-/epics/8) in GitLab 14.5. > - [Disabled on self-managed](https://gitlab.com/gitlab-org/gitlab/-/issues/353410) in GitLab 15.0. diff --git a/doc/administration/invalidate_markdown_cache.md b/doc/administration/invalidate_markdown_cache.md index e58d56b2aed..4832bfec198 100644 --- a/doc/administration/invalidate_markdown_cache.md +++ b/doc/administration/invalidate_markdown_cache.md @@ -4,7 +4,11 @@ group: Project Management info: "To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments" --- -# Markdown cache **(FREE SELF)** +# Markdown cache + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed For performance reasons, GitLab caches the HTML version of Markdown text in fields such as: diff --git a/doc/administration/issue_closing_pattern.md b/doc/administration/issue_closing_pattern.md index cf61b930800..16d50c79313 100644 --- a/doc/administration/issue_closing_pattern.md +++ b/doc/administration/issue_closing_pattern.md @@ -4,7 +4,11 @@ group: Code Review info: "To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments" --- -# Issue closing pattern **(FREE SELF)** +# Issue closing pattern + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed NOTE: This page explains how an administrator can configure issue closing patterns. diff --git a/doc/administration/job_artifacts.md b/doc/administration/job_artifacts.md index 0658af2360b..e5ba05a6bc3 100644 --- a/doc/administration/job_artifacts.md +++ b/doc/administration/job_artifacts.md @@ -4,7 +4,11 @@ group: Pipeline Security info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Jobs artifacts administration **(FREE SELF)** +# Jobs artifacts administration + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed This is the administration documentation. To learn how to use job artifacts in your GitLab CI/CD pipeline, see the [job artifacts configuration documentation](../ci/jobs/job_artifacts.md). diff --git a/doc/administration/job_artifacts_troubleshooting.md b/doc/administration/job_artifacts_troubleshooting.md index 1dc16d8347c..74d68c8646e 100644 --- a/doc/administration/job_artifacts_troubleshooting.md +++ b/doc/administration/job_artifacts_troubleshooting.md @@ -446,7 +446,7 @@ For more information, [see the investigation details](https://gitlab.com/gitlab- ## Usage quota shows incorrect artifact storage usage -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/238536) in GitLab 14.10. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/238536) in GitLab 14.10. Sometimes the [artifacts storage usage](../user/usage_quotas.md) displays an incorrect value for the total storage space used by artifacts. To recalculate the artifact diff --git a/doc/administration/job_logs.md b/doc/administration/job_logs.md index 364927b4726..8fe09c8405e 100644 --- a/doc/administration/job_logs.md +++ b/doc/administration/job_logs.md @@ -4,7 +4,11 @@ group: Runner info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Job logs **(FREE SELF)** +# Job logs + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed Job logs are sent by a runner while it's processing a job. You can see logs in job pages, pipelines, email notifications, and so on. diff --git a/doc/administration/labels.md b/doc/administration/labels.md index dcecbb84c3d..66bd59b8f3b 100644 --- a/doc/administration/labels.md +++ b/doc/administration/labels.md @@ -4,7 +4,11 @@ group: Project Management info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Labels administration **(FREE SELF)** +# Labels administration + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed To manage labels for the GitLab instance: diff --git a/doc/administration/lfs/index.md b/doc/administration/lfs/index.md index 5eccbf9e951..64fffd572fd 100644 --- a/doc/administration/lfs/index.md +++ b/doc/administration/lfs/index.md @@ -4,7 +4,11 @@ group: Source Code info: "To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments" --- -# GitLab Git Large File Storage (LFS) Administration **(FREE SELF)** +# GitLab Git Large File Storage (LFS) Administration + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed This page contains information about configuring Git LFS in self-managed GitLab instances. For user documentation about Git LFS, see [Git Large File Storage](../../topics/git/lfs/index.md). diff --git a/doc/administration/libravatar.md b/doc/administration/libravatar.md index d91f286c633..ab5b0160af8 100644 --- a/doc/administration/libravatar.md +++ b/doc/administration/libravatar.md @@ -4,7 +4,11 @@ group: Distribution info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Using the Libravatar service with GitLab **(FREE SELF)** +# Using the Libravatar service with GitLab + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed GitLab by default supports the [Gravatar](https://gravatar.com) avatar service. diff --git a/doc/administration/license.md b/doc/administration/license.md index 9b95af28eed..f8e978e23c0 100644 --- a/doc/administration/license.md +++ b/doc/administration/license.md @@ -4,7 +4,11 @@ group: Provision info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Activate GitLab Enterprise Edition (EE) **(PREMIUM SELF)** +# Activate GitLab Enterprise Edition (EE) + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** Self-managed When you install a new GitLab instance without a license, only Free features are enabled. To enable more features in GitLab Enterprise Edition (EE), activate diff --git a/doc/administration/license_file.md b/doc/administration/license_file.md index 26656271217..ce6058f3e54 100644 --- a/doc/administration/license_file.md +++ b/doc/administration/license_file.md @@ -30,7 +30,7 @@ In GitLab 14.1.x to 14.7, if you have already activated your subscription with a ## Activate subscription during installation -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/114572) in GitLab 16.0. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/114572) in GitLab 16.0. To activate your subscription during installation, set the `GITLAB_ACTIVATION_CODE` environment variable with the activation code: diff --git a/doc/administration/load_balancer.md b/doc/administration/load_balancer.md index d58b70865df..c941734e5ff 100644 --- a/doc/administration/load_balancer.md +++ b/doc/administration/load_balancer.md @@ -4,7 +4,11 @@ group: Distribution info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Load Balancer for multi-node GitLab **(FREE SELF)** +# Load Balancer for multi-node GitLab + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed In a multi-node GitLab configuration, you need a load balancer to route traffic to the application servers. The specifics on which load balancer to use diff --git a/doc/administration/logs/index.md b/doc/administration/logs/index.md index f5b83f27183..633f0f84f69 100644 --- a/doc/administration/logs/index.md +++ b/doc/administration/logs/index.md @@ -4,7 +4,11 @@ group: Respond info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Log system **(FREE SELF)** +# Log system + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed GitLab has an advanced log system where everything is logged, so you can analyze your instance using various system log files. The log system is similar to [audit events](../audit_events.md). @@ -353,7 +357,7 @@ process on Redis or external HTTP, not only the serialization process. ## `application.log` (deprecated) -> [Deprecated](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/111046) in GitLab 15.10. +> - [Deprecated](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/111046) in GitLab 15.10. This file is located at: @@ -373,7 +377,7 @@ October 07, 2014 11:25: Project "project133" was removed ## `application_json.log` -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/22812) in GitLab 12.7. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/22812) in GitLab 12.7. This file is located at: @@ -433,7 +437,7 @@ like this example: ## `kubernetes.log` (deprecated) -> [Deprecated](https://gitlab.com/groups/gitlab-org/configure/-/epics/8) in GitLab 14.5. +> - [Deprecated](https://gitlab.com/groups/gitlab-org/configure/-/epics/8) in GitLab 14.5. This file is located at: @@ -467,7 +471,11 @@ only. For example: } ``` -## `audit_json.log` **(FREE ALL)** +## `audit_json.log` + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed NOTE: GitLab Free tracks a small number of different audit events. @@ -573,7 +581,7 @@ For self-compiled installations, edit the `gitlab.yml` and set the Sidekiq ### `sidekiq_client.log` -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/26586) in GitLab 12.9. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/26586) in GitLab 12.9. This file is located at: @@ -701,7 +709,7 @@ This file logs the progress of [project imports and migrations](../../user/proje ## `exporter.log` -> Introduced in GitLab 13.1. +> - Introduced in GitLab 13.1. This file is located at: @@ -712,7 +720,7 @@ It logs the progress of the export process. ## `features_json.log` -> [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/issues/59587) in GitLab 13.7. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/issues/59587) in GitLab 13.7. This file is located at: @@ -737,7 +745,7 @@ are recorded in this file. For example: ## `ci_resource_groups_json.log` -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/384180) in GitLab 15.9. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/384180) in GitLab 15.9. This file is located at: @@ -755,7 +763,7 @@ The examples show the `resource_group_id`, `processable_id`, `message`, and `suc ## `auth.log` -> Introduced in GitLab 12.0. +> - Introduced in GitLab 12.0. This file is located at: @@ -793,7 +801,7 @@ This file contains the JSON version of the logs in `auth.log`, for example: ## `graphql_json.log` -> [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/issues/59587) in GitLab 12.0. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/issues/59587) in GitLab 12.0. This file is located at: @@ -808,14 +816,14 @@ GraphQL queries are recorded in the file. For example: ## `clickhouse.log` -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/133371) in GitLab 16.5. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/133371) in GitLab 16.5. The `clickhouse.log` file logs information related to the [ClickHouse database client](../../integration/clickhouse.md) in GitLab. ## `migrations.log` -> Introduced in GitLab 12.3. +> - Introduced in GitLab 12.3. This file is located at: @@ -826,7 +834,7 @@ This file logs the progress of [database migrations](../raketasks/maintenance.md ## `mail_room_json.log` (default) -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/19186) in GitLab 12.6. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/19186) in GitLab 12.6. This file is located at: @@ -838,7 +846,7 @@ Its name and path are configurable, so the name and path may not match the above ## `web_hooks.log` -> Introduced in GitLab 16.3. +> - Introduced in GitLab 16.3. This file is located at: @@ -884,9 +892,13 @@ are generated in a location based on your installation method: - `/var/log/gitlab/gitlab-rails/web_exporter.log` on Linux package installations. - `/home/git/gitlab/log/web_exporter.log` on self-compiled installations. -## `database_load_balancing.log` **(PREMIUM SELF)** +## `database_load_balancing.log` -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/15442) in GitLab 12.3. +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** Self-managed + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/15442) in GitLab 12.3. Contains details of GitLab [Database Load Balancing](../postgresql/database_load_balancing.md). This file is located at: @@ -894,9 +906,13 @@ This file is located at: - `/var/log/gitlab/gitlab-rails/database_load_balancing.log` on Linux package installations. - `/home/git/gitlab/log/database_load_balancing.log` on self-compiled installations. -## `zoekt.log` **(PREMIUM SELF)** +## `zoekt.log` -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/110980) in GitLab 15.9. +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** Self-managed + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/110980) in GitLab 15.9. This file logs information related to the [Exact code search](../../user/search/exact_code_search.md) feature which is @@ -907,9 +923,13 @@ This file is located at: - `/var/log/gitlab/gitlab-rails/zoekt.log` on Linux package installations. - `/home/git/gitlab/log/zoekt.log` on self-compiled installations. -## `elasticsearch.log` **(PREMIUM SELF)** +## `elasticsearch.log` -> Introduced in GitLab 12.6. +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** Self-managed + +> - Introduced in GitLab 12.6. This file logs information related to the Elasticsearch Integration, including errors during indexing or searching Elasticsearch. This file is located at: @@ -936,7 +956,7 @@ Line breaks have been added to the following example line for clarity: ## `exceptions_json.log` -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/17819) in GitLab 12.6. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/17819) in GitLab 12.6. This file logs the information about exceptions being tracked by `Gitlab::ErrorTracking`, which provides a standard and consistent way of @@ -967,7 +987,7 @@ Each line contains JSON that can be ingested by Elasticsearch. For example: ## `service_measurement.log` -> Introduced in GitLab 13.0. +> - Introduced in GitLab 13.0. This file is located at: @@ -983,7 +1003,11 @@ For example: { "severity":"INFO", "time":"2020-04-22T16:04:50.691Z","correlation_id":"04f1366e-57a1-45b8-88c1-b00b23dc3616","class":"Projects::ImportExport::ExportService","current_user":"John Doe","project_full_path":"group1/test-export","file_path":"/path/to/archive","gc_stats":{"count":{"before":127,"after":127,"diff":0},"heap_allocated_pages":{"before":10369,"after":10369,"diff":0},"heap_sorted_length":{"before":10369,"after":10369,"diff":0},"heap_allocatable_pages":{"before":0,"after":0,"diff":0},"heap_available_slots":{"before":4226409,"after":4226409,"diff":0},"heap_live_slots":{"before":2542709,"after":2641420,"diff":98711},"heap_free_slots":{"before":1683700,"after":1584989,"diff":-98711},"heap_final_slots":{"before":0,"after":0,"diff":0},"heap_marked_slots":{"before":2542704,"after":2542704,"diff":0},"heap_eden_pages":{"before":10369,"after":10369,"diff":0},"heap_tomb_pages":{"before":0,"after":0,"diff":0},"total_allocated_pages":{"before":10369,"after":10369,"diff":0},"total_freed_pages":{"before":0,"after":0,"diff":0},"total_allocated_objects":{"before":24896308,"after":24995019,"diff":98711},"total_freed_objects":{"before":22353599,"after":22353599,"diff":0},"malloc_increase_bytes":{"before":140032,"after":6650240,"diff":6510208},"malloc_increase_bytes_limit":{"before":25804104,"after":25804104,"diff":0},"minor_gc_count":{"before":94,"after":94,"diff":0},"major_gc_count":{"before":33,"after":33,"diff":0},"remembered_wb_unprotected_objects":{"before":34284,"after":34284,"diff":0},"remembered_wb_unprotected_objects_limit":{"before":68568,"after":68568,"diff":0},"old_objects":{"before":2404725,"after":2404725,"diff":0},"old_objects_limit":{"before":4809450,"after":4809450,"diff":0},"oldmalloc_increase_bytes":{"before":140032,"after":6650240,"diff":6510208},"oldmalloc_increase_bytes_limit":{"before":68537556,"after":68537556,"diff":0}},"time_to_finish":0.12298400001600385,"number_of_sql_calls":70,"memory_usage":"0.0 MiB","label":"process_48616"} ``` -## `geo.log` **(PREMIUM SELF)** +## `geo.log` + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** Self-managed Geo stores structured log messages in a `geo.log` file. For Linux package installations, this file is at `/var/log/gitlab/gitlab-rails/geo.log`. @@ -1030,9 +1054,13 @@ can be used. } ``` -## `llm.log` **(ULTIMATE SAAS)** +## `llm.log` -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/120506) in GitLab 16.0. +DETAILS: +**Tier:** Ultimate +**Offering:** SaaS + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/120506) in GitLab 16.0. The `llm.log` file logs information related to [AI features](../../user/ai_features.md). @@ -1170,7 +1198,7 @@ GitLab also tracks [Prometheus metrics for Praefect](../gitaly/monitoring.md#mon ## Backup log -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/63832) in GitLab 14.1. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/63832) in GitLab 14.1. For Linux package installations, the backup log is located at `/var/log/gitlab/gitlab-rails/backup_json.log`. @@ -1178,7 +1206,7 @@ This log is populated when a [GitLab backup is created](../../administration/bac ## Performance bar stats -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/48149) in GitLab 13.7. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/48149) in GitLab 13.7. This file is located at: diff --git a/doc/administration/logs/log_parsing.md b/doc/administration/logs/log_parsing.md index 3ac24fbb9ab..58c8f8b5007 100644 --- a/doc/administration/logs/log_parsing.md +++ b/doc/administration/logs/log_parsing.md @@ -4,7 +4,11 @@ group: Distribution info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Parsing GitLab logs with `jq` **(FREE SELF)** +# Parsing GitLab logs with `jq` + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed We recommend using log aggregation and search tools like Kibana and Splunk whenever possible, but if they are not available you can still quickly parse diff --git a/doc/administration/logs/tracing_correlation_id.md b/doc/administration/logs/tracing_correlation_id.md index a5f6b103d1f..33e37f3f1b9 100644 --- a/doc/administration/logs/tracing_correlation_id.md +++ b/doc/administration/logs/tracing_correlation_id.md @@ -4,7 +4,11 @@ group: Distribution info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Find relevant log entries with a correlation ID **(FREE SELF)** +# Find relevant log entries with a correlation ID + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed GitLab instances log a unique request tracking ID (known as the "correlation ID") for most requests. Each individual request to GitLab gets diff --git a/doc/administration/maintenance_mode/index.md b/doc/administration/maintenance_mode/index.md index f4823ce9af1..f3e20c88d5c 100644 --- a/doc/administration/maintenance_mode/index.md +++ b/doc/administration/maintenance_mode/index.md @@ -4,9 +4,13 @@ group: Geo info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# GitLab Maintenance Mode **(PREMIUM SELF)** +# GitLab Maintenance Mode -> [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/2149) in GitLab 13.9. +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** Self-managed + +> - [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/2149) in GitLab 13.9. Maintenance Mode allows administrators to reduce write operations to a minimum while maintenance tasks are performed. The main goal is to block all external actions that change the internal state. The internal state includes the PostgreSQL database, but especially files, Git repositories, and Container repositories. diff --git a/doc/administration/merge_request_diffs.md b/doc/administration/merge_request_diffs.md index a3874091f34..51297916efb 100644 --- a/doc/administration/merge_request_diffs.md +++ b/doc/administration/merge_request_diffs.md @@ -4,7 +4,11 @@ group: Source Code info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Merge request diffs storage **(FREE SELF)** +# Merge request diffs storage + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed Merge request diffs are size-limited copies of diffs associated with merge requests. When viewing a merge request, diffs are sourced from these copies diff --git a/doc/administration/merge_requests_approvals.md b/doc/administration/merge_requests_approvals.md index 9e766633d56..4035f472924 100644 --- a/doc/administration/merge_requests_approvals.md +++ b/doc/administration/merge_requests_approvals.md @@ -4,9 +4,13 @@ group: Source Code info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Merge request approvals **(PREMIUM SELF)** +# Merge request approvals -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/39060) in GitLab 12.8. +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** Self-managed + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/39060) in GitLab 12.8. Merge request approval rules prevent users from overriding certain settings on the project level. When enabled at the instance level, these settings [cascade](../user/project/merge_requests/approvals/settings.md#settings-cascading) diff --git a/doc/administration/moderate_users.md b/doc/administration/moderate_users.md index c2c3491b6fc..4077bf0b836 100644 --- a/doc/administration/moderate_users.md +++ b/doc/administration/moderate_users.md @@ -4,7 +4,11 @@ group: Authentication info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Moderate users (administration) **(FREE SELF)** +# Moderate users (administration) + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed This is the administration documentation. For information about moderating users at the group level, see the [group-level documentation](../user/group/moderate_users.md). @@ -133,7 +137,7 @@ When you deactivate a user, their projects, groups, and history remain. ### Deactivate a user -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/22257) in GitLab 12.4. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/22257) in GitLab 12.4. Prerequisites: @@ -179,7 +183,11 @@ A maximum of 100,000 users can be deactivated per day. NOTE: GitLab generated bots are excluded from the automatic deactivation of dormant users. -### Automatically delete unconfirmed users **(PREMIUM SELF)** +### Automatically delete unconfirmed users + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** Self-managed > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/352514) in GitLab 16.1 [with a flag](../administration/feature_flags.md) named `delete_unconfirmed_users_setting`. Disabled by default. > - [Enabled by default](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/124982) in GitLab 16.2. @@ -209,7 +217,7 @@ A maximum of 240,000 users can be deleted per day. ### Activate a user -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/22257) in GitLab 12.4. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/22257) in GitLab 12.4. A deactivated user can be activated from the Admin Area. @@ -291,7 +299,7 @@ Before 15.1, additionally groups of which deleted user were the only owner among ## Trust and untrust users -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/132402) in GitLab 16.5. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/132402) in GitLab 16.5. You can trust and untrust users from the Admin Area. diff --git a/doc/administration/monitoring/github_imports.md b/doc/administration/monitoring/github_imports.md index 28dbc3d8209..d4c075db6c3 100644 --- a/doc/administration/monitoring/github_imports.md +++ b/doc/administration/monitoring/github_imports.md @@ -4,7 +4,11 @@ group: Import and Integrate info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Monitoring GitHub imports **(FREE SELF)** +# Monitoring GitHub imports + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed The GitHub importer exposes various Prometheus metrics that you can use to monitor the health and progress of the importer. diff --git a/doc/administration/monitoring/health_check.md b/doc/administration/monitoring/health_check.md index b688387ded6..665d9b86191 100644 --- a/doc/administration/monitoring/health_check.md +++ b/doc/administration/monitoring/health_check.md @@ -4,7 +4,11 @@ group: Respond info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Health Check **(FREE SELF)** +# Health Check + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed GitLab provides liveness and readiness probes to indicate service health and reachability to required services. These probes report on the status of the diff --git a/doc/administration/monitoring/index.md b/doc/administration/monitoring/index.md index 10fe1486484..d58e63eb04f 100644 --- a/doc/administration/monitoring/index.md +++ b/doc/administration/monitoring/index.md @@ -4,7 +4,11 @@ group: Respond info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Monitoring GitLab **(FREE SELF)** +# Monitoring GitLab + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed Explore our features to monitor your GitLab instance: diff --git a/doc/administration/monitoring/ip_allowlist.md b/doc/administration/monitoring/ip_allowlist.md index d861a24ba2d..59942be6a3e 100644 --- a/doc/administration/monitoring/ip_allowlist.md +++ b/doc/administration/monitoring/ip_allowlist.md @@ -4,7 +4,11 @@ group: Cloud Connector info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# IP allowlist **(FREE SELF)** +# IP allowlist + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed GitLab provides some [monitoring endpoints](health_check.md) that provide health check information when probed. diff --git a/doc/administration/monitoring/performance/gitlab_configuration.md b/doc/administration/monitoring/performance/gitlab_configuration.md index 7dc4f34e514..458d586c803 100644 --- a/doc/administration/monitoring/performance/gitlab_configuration.md +++ b/doc/administration/monitoring/performance/gitlab_configuration.md @@ -4,7 +4,11 @@ group: Respond info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# GitLab Configuration **(FREE SELF)** +# GitLab Configuration + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed GitLab Performance Monitoring is disabled by default. To enable it and change any of its settings: diff --git a/doc/administration/monitoring/performance/grafana_configuration.md b/doc/administration/monitoring/performance/grafana_configuration.md index 0d264972073..dc4c3749b23 100644 --- a/doc/administration/monitoring/performance/grafana_configuration.md +++ b/doc/administration/monitoring/performance/grafana_configuration.md @@ -4,7 +4,11 @@ group: Respond info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Configure Grafana **(FREE SELF)** +# Configure Grafana + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed > - Grafana bundled with GitLab was [deprecated](https://gitlab.com/gitlab-org/omnibus-gitlab/-/issues/7772) in GitLab 16.0. > - Grafana bundled with GitLab was [removed](https://gitlab.com/gitlab-org/omnibus-gitlab/-/issues/7772) in GitLab 16.3. @@ -29,7 +33,7 @@ see the [GitLab Grafana dashboards](https://gitlab.com/gitlab-org/grafana-dashbo ## Integrate with GitLab UI -> [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/issues/61005) in GitLab 12.1. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/issues/61005) in GitLab 12.1. After setting up Grafana, you can enable a link to access it from the GitLab sidebar: @@ -45,7 +49,7 @@ GitLab displays your link in the Admin Area under **Monitoring > Metrics Dashboa ## Required Scopes -> [Introduced](https://gitlab.com/gitlab-org/omnibus-gitlab/-/issues/5822) in GitLab 13.10. +> - [Introduced](https://gitlab.com/gitlab-org/omnibus-gitlab/-/issues/5822) in GitLab 13.10. When setting up Grafana through the process above, no scope shows in the screen in the Admin Area under **Applications > GitLab Grafana**. However, the `read_user` scope is diff --git a/doc/administration/monitoring/performance/index.md b/doc/administration/monitoring/performance/index.md index 88faf071cfe..3b734003a2c 100644 --- a/doc/administration/monitoring/performance/index.md +++ b/doc/administration/monitoring/performance/index.md @@ -4,7 +4,11 @@ group: Cloud Connector info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# GitLab Performance Monitoring **(FREE SELF)** +# GitLab Performance Monitoring + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed GitLab comes with its own application performance measuring system as of GitLab 8.4, called "GitLab Performance Monitoring". GitLab Performance Monitoring is available in both the diff --git a/doc/administration/monitoring/performance/performance_bar.md b/doc/administration/monitoring/performance/performance_bar.md index a8bf39761ed..373c21949c5 100644 --- a/doc/administration/monitoring/performance/performance_bar.md +++ b/doc/administration/monitoring/performance/performance_bar.md @@ -4,7 +4,11 @@ group: Cloud Connector info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Performance bar **(FREE SELF)** +# Performance bar + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed > - The **Stats** field [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/271551) in GitLab 13.9. > - The **Memory** field [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/330736) in GitLab 14.0. diff --git a/doc/administration/monitoring/prometheus/gitlab_exporter.md b/doc/administration/monitoring/prometheus/gitlab_exporter.md index 96f666db0ed..50c6be133f6 100644 --- a/doc/administration/monitoring/prometheus/gitlab_exporter.md +++ b/doc/administration/monitoring/prometheus/gitlab_exporter.md @@ -4,7 +4,11 @@ group: Cloud Connector info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# GitLab exporter **(FREE SELF)** +# GitLab exporter + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed > Renamed from `GitLab monitor exporter` to `GitLab exporter` in [GitLab 12.3](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/16511). diff --git a/doc/administration/monitoring/prometheus/gitlab_metrics.md b/doc/administration/monitoring/prometheus/gitlab_metrics.md index d46c1b71768..7fee19de38d 100644 --- a/doc/administration/monitoring/prometheus/gitlab_metrics.md +++ b/doc/administration/monitoring/prometheus/gitlab_metrics.md @@ -4,7 +4,11 @@ group: Shared responsibility based on functional area info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# GitLab Prometheus metrics **(FREE SELF)** +# GitLab Prometheus metrics + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed To enable the GitLab Prometheus metrics: @@ -104,8 +108,8 @@ The following metrics are available: | `gitlab_transaction_db__cached_count_total` | Counter | 13.1 | Counter for total number of cached SQL calls, grouped by database roles (primary/replica) | `controller`, `action`, `endpoint_id` | | `gitlab_transaction_db__wal_count_total` | Counter | 14.0 | Counter for total number of WAL (write ahead log location) queries, grouped by database roles (primary/replica) | `controller`, `action`, `endpoint_id` | | `gitlab_transaction_db__wal_cached_count_total` | Counter | 14.1 | Counter for total number of cached WAL (write ahead log location) queries, grouped by database roles (primary/replica)| `controller`, `action`, `endpoint_id` | -| `http_elasticsearch_requests_duration_seconds` **(PREMIUM ALL)** | Histogram | 13.1 | Elasticsearch requests duration during web transactions | `controller`, `action`, `endpoint_id` | -| `http_elasticsearch_requests_total` **(PREMIUM ALL)** | Counter | 13.1 | Elasticsearch requests count during web transactions | `controller`, `action`, `endpoint_id` | +| `http_elasticsearch_requests_duration_seconds` | Histogram | 13.1 | Elasticsearch requests duration during web transactions. Premium and Ultimate only. | `controller`, `action`, `endpoint_id` | +| `http_elasticsearch_requests_total` | Counter | 13.1 | Elasticsearch requests count during web transactions. Premium and Ultimate only. | `controller`, `action`, `endpoint_id` | | `pipelines_created_total` | Counter | 9.4 | Counter of pipelines created | | | `rack_uncaught_errors_total` | Counter | 9.4 | Rack connections handling uncaught errors count | | | `user_session_logins_total` | Counter | 9.4 | Counter of how many users have logged in since GitLab was started or restarted | | @@ -408,7 +412,11 @@ configuration option in `gitlab.yml`. These metrics are served from the | `geo_design_management_repositories_verification_failed` | Gauge | 16.1 | Number of design repositories verifications failed on secondary | `url` | | `gitlab_ci_queue_active_runners_total` | Histogram | 16.3 | The number of active runners that can process the CI/CD queue in a project | -## Database load balancing metrics **(PREMIUM SELF)** +## Database load balancing metrics + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** Self-managed The following metrics are available: @@ -418,7 +426,11 @@ The following metrics are available: | `sidekiq_load_balancing_count` | Counter | 13.11 | Sidekiq jobs using load balancing with data consistency set to :sticky or :delayed | `queue`, `boundary`, `external_dependencies`, `feature_category`, `job_status`, `urgency`, `data_consistency`, `load_balancing_strategy` | | `gitlab_transaction_caught_up_replica_pick_count_total` | Counter | 14.1 | Number of search attempts for caught up replica | `result` | -## Database partitioning metrics **(PREMIUM SELF)** +## Database partitioning metrics + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** Self-managed The following metrics are available: diff --git a/doc/administration/monitoring/prometheus/index.md b/doc/administration/monitoring/prometheus/index.md index 1fe05ed7538..4b06c49d55b 100644 --- a/doc/administration/monitoring/prometheus/index.md +++ b/doc/administration/monitoring/prometheus/index.md @@ -4,7 +4,11 @@ group: Distribution info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Monitoring GitLab with Prometheus **(FREE SELF)** +# Monitoring GitLab with Prometheus + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed [Prometheus](https://prometheus.io) is a powerful time-series monitoring service, providing a flexible platform for monitoring GitLab and other software products. diff --git a/doc/administration/monitoring/prometheus/node_exporter.md b/doc/administration/monitoring/prometheus/node_exporter.md index 6b395f77ce2..6acb3737bc7 100644 --- a/doc/administration/monitoring/prometheus/node_exporter.md +++ b/doc/administration/monitoring/prometheus/node_exporter.md @@ -4,7 +4,11 @@ group: Shared responsibility based on functional area info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Node exporter **(FREE SELF)** +# Node exporter + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed The [node exporter](https://github.com/prometheus/node_exporter) enables you to measure various machine resources such as memory, disk and CPU utilization. diff --git a/doc/administration/monitoring/prometheus/pgbouncer_exporter.md b/doc/administration/monitoring/prometheus/pgbouncer_exporter.md index e1773301047..26f85f7173d 100644 --- a/doc/administration/monitoring/prometheus/pgbouncer_exporter.md +++ b/doc/administration/monitoring/prometheus/pgbouncer_exporter.md @@ -4,7 +4,11 @@ group: Database info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# PgBouncer exporter **(FREE SELF)** +# PgBouncer exporter + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed The [PgBouncer exporter](https://github.com/prometheus-community/pgbouncer_exporter) enables you to measure various [PgBouncer](https://www.pgbouncer.org/) metrics. diff --git a/doc/administration/monitoring/prometheus/postgres_exporter.md b/doc/administration/monitoring/prometheus/postgres_exporter.md index fe04ae3f797..a10c06ff8a9 100644 --- a/doc/administration/monitoring/prometheus/postgres_exporter.md +++ b/doc/administration/monitoring/prometheus/postgres_exporter.md @@ -4,7 +4,11 @@ group: Database info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# PostgreSQL Server Exporter **(FREE SELF)** +# PostgreSQL Server Exporter + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed The [PostgreSQL Server Exporter](https://github.com/prometheus-community/postgres_exporter) allows you to export various PostgreSQL metrics. diff --git a/doc/administration/monitoring/prometheus/redis_exporter.md b/doc/administration/monitoring/prometheus/redis_exporter.md index fde07c68c0a..dabcaa629af 100644 --- a/doc/administration/monitoring/prometheus/redis_exporter.md +++ b/doc/administration/monitoring/prometheus/redis_exporter.md @@ -4,7 +4,11 @@ group: Shared responsibility based on functional area info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Redis exporter **(FREE SELF)** +# Redis exporter + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed The [Redis exporter](https://github.com/oliver006/redis_exporter) enables you to measure various [Redis](https://redis.io) metrics. For more information on what is exported, diff --git a/doc/administration/monitoring/prometheus/registry_exporter.md b/doc/administration/monitoring/prometheus/registry_exporter.md index 8dde7086d79..70624e76de2 100644 --- a/doc/administration/monitoring/prometheus/registry_exporter.md +++ b/doc/administration/monitoring/prometheus/registry_exporter.md @@ -4,7 +4,11 @@ group: Package Registry info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Registry exporter **(FREE SELF)** +# Registry exporter + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed The Registry exporter allows you to measure various Registry metrics. To enable it: diff --git a/doc/administration/monitoring/prometheus/web_exporter.md b/doc/administration/monitoring/prometheus/web_exporter.md index 2831ca17c81..7d5862f4c78 100644 --- a/doc/administration/monitoring/prometheus/web_exporter.md +++ b/doc/administration/monitoring/prometheus/web_exporter.md @@ -4,7 +4,11 @@ group: Cloud Connector info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Web exporter (dedicated metrics server) **(FREE SELF)** +# Web exporter (dedicated metrics server) + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed When [monitoring GitLab with Prometheus](index.md), GitLab runs various collectors that sample the application for data related to usage, load and performance. GitLab can then make @@ -54,7 +58,7 @@ Metrics can now be served and scraped from `localhost:8083/metrics`. ## Enable HTTPS -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/364771) in GitLab 15.2. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/364771) in GitLab 15.2. To serve metrics via HTTPS instead of HTTP, enable TLS in the exporter settings: diff --git a/doc/administration/nfs.md b/doc/administration/nfs.md index 5f12c141540..e9971c332dc 100644 --- a/doc/administration/nfs.md +++ b/doc/administration/nfs.md @@ -4,7 +4,11 @@ group: Distribution info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Using NFS with GitLab **(FREE SELF)** +# Using NFS with GitLab + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed NFS can be used as an alternative for object storage but this isn't typically recommended for performance reasons. diff --git a/doc/administration/object_storage.md b/doc/administration/object_storage.md index d4c3cdae8bb..fd5a45fd75a 100644 --- a/doc/administration/object_storage.md +++ b/doc/administration/object_storage.md @@ -4,7 +4,11 @@ group: Distribution info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Object storage **(FREE SELF)** +# Object storage + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed GitLab supports using an object storage service for holding numerous types of data. It's recommended over NFS and @@ -45,7 +49,7 @@ Specifically, GitLab has been tested by vendors and customers on a number of obj ## Configure a single storage connection for all object types (consolidated form) -> [Introduced](https://gitlab.com/gitlab-org/omnibus-gitlab/-/merge_requests/4368) in GitLab 13.2. +> - [Introduced](https://gitlab.com/gitlab-org/omnibus-gitlab/-/merge_requests/4368) in GitLab 13.2. Most types of objects, such as CI artifacts, LFS files, and upload attachments can be saved in object storage by specifying a single credential for object @@ -254,7 +258,7 @@ AWS KMS keys and SSE-C encryption are #### Server-side encryption headers -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/38240) in GitLab 13.3. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/38240) in GitLab 13.3. Setting a default encryption on an S3 bucket is the easiest way to enable encryption, but you may want to @@ -328,7 +332,7 @@ gitlab_rails['object_store']['connection'] = { #### GCS example with ADC -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/275979) in GitLab 13.6. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/275979) in GitLab 13.6. Google Cloud Application Default Credentials (ADC) are typically used with GitLab to use the default service account. This eliminates the @@ -355,7 +359,7 @@ If you use ADC, be sure that: ### Azure Blob storage -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/25877) in GitLab 13.4. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/25877) in GitLab 13.4. Although Azure uses the word `container` to denote a collection of blobs, GitLab standardizes on the term `bucket`. Be sure to configure diff --git a/doc/administration/operations/fast_ssh_key_lookup.md b/doc/administration/operations/fast_ssh_key_lookup.md index 2170abf8700..7bdd99ab4e7 100644 --- a/doc/administration/operations/fast_ssh_key_lookup.md +++ b/doc/administration/operations/fast_ssh_key_lookup.md @@ -4,7 +4,11 @@ group: Source Code info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Fast lookup of authorized SSH keys in the database **(FREE SELF)** +# Fast lookup of authorized SSH keys in the database + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed NOTE: This document describes a drop-in replacement for the @@ -25,7 +29,11 @@ GitLab Shell solves this by providing a way to authorize SSH users via a fast, indexed lookup in the GitLab database. This page describes how to enable the fast lookup of authorized SSH keys. -## Fast lookup is required for Geo **(PREMIUM ALL)** +## Fast lookup is required for Geo + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed Unlike [Cloud Native GitLab](https://docs.gitlab.com/charts/), by default Linux package installations manage an `authorized_keys` file that is located in the diff --git a/doc/administration/operations/filesystem_benchmarking.md b/doc/administration/operations/filesystem_benchmarking.md index 7b0bb012624..16f20efe3c1 100644 --- a/doc/administration/operations/filesystem_benchmarking.md +++ b/doc/administration/operations/filesystem_benchmarking.md @@ -4,7 +4,11 @@ group: Distribution info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# File system performance benchmarking **(FREE SELF)** +# File system performance benchmarking + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed File system performance has a big impact on overall GitLab performance, especially for actions that read or write to Git repositories. This information diff --git a/doc/administration/operations/gitlab_sshd.md b/doc/administration/operations/gitlab_sshd.md index a14f556af84..7ba4d20aa7c 100644 --- a/doc/administration/operations/gitlab_sshd.md +++ b/doc/administration/operations/gitlab_sshd.md @@ -4,7 +4,11 @@ group: Source Code info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# `gitlab-sshd` **(FREE SELF)** +# `gitlab-sshd` + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/299109) in GitLab 14.5 as an Experiment for self-managed customers. > - Ready for production use with [Cloud Native GitLab in GitLab 15.1](https://gitlab.com/gitlab-org/charts/gitlab/-/issues/2540) and [Linux packages in GitLab 15.9](https://gitlab.com/gitlab-org/omnibus-gitlab/-/issues/5937). diff --git a/doc/administration/operations/index.md b/doc/administration/operations/index.md index d1ec818a2a5..145263374bf 100644 --- a/doc/administration/operations/index.md +++ b/doc/administration/operations/index.md @@ -5,7 +5,11 @@ description: Backup and restore, move repos, maintenance tasks. info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Maintain your GitLab installation **(FREE SELF)** +# Maintain your GitLab installation + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed Keep your GitLab instance up and running. diff --git a/doc/administration/operations/moving_repositories.md b/doc/administration/operations/moving_repositories.md index 24d53d71517..a38f4301ce5 100644 --- a/doc/administration/operations/moving_repositories.md +++ b/doc/administration/operations/moving_repositories.md @@ -4,7 +4,11 @@ group: Gitaly info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Moving repositories managed by GitLab **(FREE SELF)** +# Moving repositories managed by GitLab + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed You can move all repositories managed by GitLab to another file system or another server. @@ -25,7 +29,7 @@ For more information, see: - [The API documentation](../../api/snippet_repository_storage_moves.md) details the endpoints for querying and scheduling snippet repository moves. - [The API documentation](../../api/group_repository_storage_moves.md) details the endpoints for - querying and scheduling group repository moves **(PREMIUM SELF)**. + querying and scheduling group repository moves. - [Migrate to Gitaly Cluster](../gitaly/index.md#migrate-to-gitaly-cluster). ### Moving Repositories @@ -64,7 +68,7 @@ To move repositories: - [All snippets](#move-all-snippets) or [individual snippets](../../api/snippet_repository_storage_moves.md#schedule-a-repository-storage-move-for-a-snippet). - [All groups](#move-all-groups) or - [individual groups](../../api/group_repository_storage_moves.md#schedule-a-repository-storage-move-for-a-group). **(PREMIUM SELF)** + [individual groups](../../api/group_repository_storage_moves.md#schedule-a-repository-storage-move-for-a-group). 1. If [Geo](../geo/index.md) is enabled, [resync all repositories](../geo/replication/troubleshooting.md#queue-up-all-repositories-for-resync). @@ -134,7 +138,11 @@ To move all snippets by using the API: 1. Repeat for each storage as required. -#### Move all groups **(PREMIUM SELF)** +#### Move all groups + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** Self-managed To move all groups by using the API: diff --git a/doc/administration/operations/puma.md b/doc/administration/operations/puma.md index ec236f52c5b..0b353981fb4 100644 --- a/doc/administration/operations/puma.md +++ b/doc/administration/operations/puma.md @@ -4,7 +4,11 @@ group: Distribution info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Configure the bundled Puma instance of the GitLab package **(FREE SELF)** +# Configure the bundled Puma instance of the GitLab package + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed Puma is a fast, multi-threaded, and highly concurrent HTTP 1.1 server for Ruby applications. It runs the core Rails application that provides the user-facing @@ -182,7 +186,7 @@ losing Prometheus metrics. ### Using an encrypted SSL key -> [Introduced](https://gitlab.com/gitlab-org/omnibus-gitlab/-/issues/7799) in GitLab 16.1. +> - [Introduced](https://gitlab.com/gitlab-org/omnibus-gitlab/-/issues/7799) in GitLab 16.1. Puma supports the use of an encrypted private SSL key, which can be decrypted at runtime. The following instructions illustrate how to diff --git a/doc/administration/operations/rails_console.md b/doc/administration/operations/rails_console.md index f15fdd32c90..8e5122d3cb4 100644 --- a/doc/administration/operations/rails_console.md +++ b/doc/administration/operations/rails_console.md @@ -4,7 +4,11 @@ group: Distribution info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Rails console **(FREE SELF)** +# Rails console + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed At the heart of GitLab is a web application [built using the Ruby on Rails framework](https://about.gitlab.com/blog/2018/10/29/why-we-use-rails-to-build-gitlab/). diff --git a/doc/administration/operations/ssh_certificates.md b/doc/administration/operations/ssh_certificates.md index ca24b2e0721..ddc64153d9d 100644 --- a/doc/administration/operations/ssh_certificates.md +++ b/doc/administration/operations/ssh_certificates.md @@ -4,9 +4,13 @@ group: Distribution info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# User lookup via OpenSSH's AuthorizedPrincipalsCommand **(FREE SELF)** +# User lookup via OpenSSH's AuthorizedPrincipalsCommand -> [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/19911) in GitLab 11.2. +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/19911) in GitLab 11.2. The default SSH authentication for GitLab requires users to upload their SSH public keys before they can use the SSH transport. diff --git a/doc/administration/package_information/defaults.md b/doc/administration/package_information/defaults.md index 93f01d71879..d8d0cb1a9d7 100644 --- a/doc/administration/package_information/defaults.md +++ b/doc/administration/package_information/defaults.md @@ -4,7 +4,11 @@ group: Distribution info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Package defaults **(FREE SELF)** +# Package defaults + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed Unless configuration is specified in the `/etc/gitlab/gitlab.rb` file, the package assumes the defaults as noted below. diff --git a/doc/administration/package_information/deprecation_policy.md b/doc/administration/package_information/deprecation_policy.md index 7cc589990db..02bd8ae45d1 100644 --- a/doc/administration/package_information/deprecation_policy.md +++ b/doc/administration/package_information/deprecation_policy.md @@ -4,7 +4,11 @@ group: Distribution info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Linux package deprecation policy **(FREE SELF)** +# Linux package deprecation policy + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed The Linux packages come with number of different libraries and services which offers users plethora of configuration options. diff --git a/doc/administration/package_information/index.md b/doc/administration/package_information/index.md index 59086579965..cae621ebd5b 100644 --- a/doc/administration/package_information/index.md +++ b/doc/administration/package_information/index.md @@ -4,7 +4,11 @@ group: Distribution info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Package information **(FREE SELF)** +# Package information + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed The Linux package is bundled with all dependencies required for GitLab to function correctly. More details can be found diff --git a/doc/administration/package_information/licensing.md b/doc/administration/package_information/licensing.md index 2f907ba9df3..ea15a069246 100644 --- a/doc/administration/package_information/licensing.md +++ b/doc/administration/package_information/licensing.md @@ -4,7 +4,11 @@ group: Distribution info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Package Licensing **(FREE SELF)** +# Package Licensing + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed ## License diff --git a/doc/administration/package_information/omnibus_packages.md b/doc/administration/package_information/omnibus_packages.md index 12f7f6861ad..a026d6c16a7 100644 --- a/doc/administration/package_information/omnibus_packages.md +++ b/doc/administration/package_information/omnibus_packages.md @@ -4,7 +4,11 @@ group: Distribution info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Packages and images from the Linux package **(FREE SELF)** +# Packages and images from the Linux package + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed Below you can find some basic information on why GitLab provides packages and a Docker image that come with bundled dependencies. diff --git a/doc/administration/package_information/postgresql_versions.md b/doc/administration/package_information/postgresql_versions.md index 5140d795892..ea08241d472 100644 --- a/doc/administration/package_information/postgresql_versions.md +++ b/doc/administration/package_information/postgresql_versions.md @@ -4,7 +4,11 @@ group: Distribution info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# PostgreSQL versions shipped with the Linux package **(FREE SELF)** +# PostgreSQL versions shipped with the Linux package + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed NOTE: This table lists only GitLab versions where a significant change happened in the diff --git a/doc/administration/package_information/signed_packages.md b/doc/administration/package_information/signed_packages.md index 22ac472c590..a2fbcc8362d 100644 --- a/doc/administration/package_information/signed_packages.md +++ b/doc/administration/package_information/signed_packages.md @@ -4,7 +4,11 @@ group: Distribution info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Package Signatures **(FREE SELF)** +# Package Signatures + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed Linux packages produced by GitLab are created using [Omnibus](https://github.com/chef/omnibus), for which GitLab has added DEB signing using `debsigs` in [our own fork](https://gitlab.com/gitlab-org/omnibus). diff --git a/doc/administration/package_information/supported_os.md b/doc/administration/package_information/supported_os.md index b85d6b8dd07..600e9b8f8ea 100644 --- a/doc/administration/package_information/supported_os.md +++ b/doc/administration/package_information/supported_os.md @@ -4,7 +4,11 @@ group: Distribution info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Supported operating systems **(FREE SELF)** +# Supported operating systems + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed GitLab officially supports LTS versions of operating systems. While OSs like Ubuntu have a clear distinction between LTS and non-LTS versions, there are @@ -73,7 +77,7 @@ To upgrade both the operating system (OS) and GitLab: ## Packages for ARM64 -> [Introduced](https://gitlab.com/gitlab-org/gitlab-omnibus-builder/-/issues/27) in GitLab 13.4. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab-omnibus-builder/-/issues/27) in GitLab 13.4. GitLab provides arm64/aarch64 packages for some supported operating systems. You can see if your operating system architecture is supported in the table diff --git a/doc/administration/packages/container_registry.md b/doc/administration/packages/container_registry.md index 281e2f275ec..33d66989b18 100644 --- a/doc/administration/packages/container_registry.md +++ b/doc/administration/packages/container_registry.md @@ -4,7 +4,11 @@ group: Container Registry info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# GitLab container registry administration **(FREE SELF)** +# GitLab container registry administration + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed With the GitLab container registry, every project can have its own space to store Docker images. @@ -1069,7 +1073,12 @@ end You can also [run cleanup on a schedule](../../user/packages/container_registry/reduce_container_registry_storage.md#cleanup-policy). -## Container registry metadata database **(FREE SELF BETA)** +## Container registry metadata database + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed +**Status:** Beta The metadata database enables many new registry features, including online garbage collection, and increases the efficiency of many registry operations. @@ -1263,7 +1272,10 @@ itself on the system so that the `gitlab-ctl` command can bring the registry ser Also, there's no way to save progress or results during the mark phase of the process. Only once blobs start being deleted is anything permanent done. -### Continuous Zero Downtime Garbage Collection **(BETA)** +### Continuous Zero Downtime Garbage Collection + +DETAILS: +**Status:** Beta You can run garbage collection in the background without the need to schedule it or require read-only mode, if you migrate to the [metadata database (beta)](container_registry_metadata_database.md). diff --git a/doc/administration/packages/container_registry_metadata_database.md b/doc/administration/packages/container_registry_metadata_database.md index e9477c74914..2cbc457abca 100644 --- a/doc/administration/packages/container_registry_metadata_database.md +++ b/doc/administration/packages/container_registry_metadata_database.md @@ -4,9 +4,14 @@ group: Container Registry info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Container registry metadata database **(FREE SELF BETA)** +# Container registry metadata database -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/423459) in GitLab 16.4 as a [Beta feature](../../policy/experiment-beta-support.md) for self-managed GitLab instances. +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed +**Status:** Beta + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/423459) in GitLab 16.4 as a [Beta feature](../../policy/experiment-beta-support.md) for self-managed GitLab instances. WARNING: The metadata database is a [beta feature](../../policy/experiment-beta-support.md#beta). diff --git a/doc/administration/packages/dependency_proxy.md b/doc/administration/packages/dependency_proxy.md index e34153e01e0..44e343fc113 100644 --- a/doc/administration/packages/dependency_proxy.md +++ b/doc/administration/packages/dependency_proxy.md @@ -4,7 +4,11 @@ group: Container Registry info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# GitLab Dependency Proxy administration **(FREE SELF)** +# GitLab Dependency Proxy administration + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/7934) in [GitLab Premium](https://about.gitlab.com/pricing/) 11.11. > - [Moved](https://gitlab.com/gitlab-org/gitlab/-/issues/273655) from GitLab Premium to GitLab Free in 13.6. @@ -198,7 +202,7 @@ This section describes the earlier configuration format. [Migration steps still #### Migrate local Dependency Proxy blobs and manifests to object storage -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/79663) in GitLab 14.8. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/79663) in GitLab 14.8. After [configuring object storage](#using-object-storage), use the following task to migrate existing Dependency Proxy blobs and manifests from local storage diff --git a/doc/administration/packages/index.md b/doc/administration/packages/index.md index 51641bf06ea..136a45cb09d 100644 --- a/doc/administration/packages/index.md +++ b/doc/administration/packages/index.md @@ -4,7 +4,11 @@ group: Package Registry info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# GitLab package registry administration **(FREE SELF)** +# GitLab package registry administration + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed To use GitLab as a private repository for a variety of common package managers, use the package registry. You can build and publish diff --git a/doc/administration/pages/index.md b/doc/administration/pages/index.md index 150e0115eb7..1fc582905fa 100644 --- a/doc/administration/pages/index.md +++ b/doc/administration/pages/index.md @@ -4,7 +4,11 @@ group: Knowledge info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# GitLab Pages administration **(FREE SELF)** +# GitLab Pages administration + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed GitLab Pages allows for hosting of static sites. It must be configured by an administrator. Separate [user documentation](../../user/project/pages/index.md) is available. @@ -93,9 +97,12 @@ Where `example.io` is the domain GitLab Pages is served from, `192.0.2.1` is the IPv4 address of your GitLab instance, and `2001:db8::1` is the IPv6 address. If you don't have IPv6, you can omit the `AAAA` record. -#### For namespace in URL path, without wildcard DNS **(EXPERIMENT)** +#### For namespace in URL path, without wildcard DNS -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/17584) in GitLab 16.7. This feature is an [Experiment](../../policy/experiment-beta-support.md). +DETAILS: +**Status:** Experiment + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/17584) in GitLab 16.7. This feature is an [Experiment](../../policy/experiment-beta-support.md). FLAG: On self-managed GitLab, by default this feature is available. @@ -184,9 +191,12 @@ The Pages daemon doesn't listen to the outside world. Watch the [video tutorial](https://youtu.be/dD8c7WNcc6s) for this configuration. -### Pages domain without wildcard DNS **(EXPERIMENT)** +### Pages domain without wildcard DNS -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/17584) in GitLab 16.7. This feature is an [Experiment](../../policy/experiment-beta-support.md). +DETAILS: +**Status:** Experiment + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/17584) in GitLab 16.7. This feature is an [Experiment](../../policy/experiment-beta-support.md). FLAG: On self-managed GitLab, by default this feature is available. @@ -270,9 +280,12 @@ Before you reconfigure, remove the `gitlab_pages` section from `/etc/gitlab/gitl then run `gitlab-ctl reconfigure`. For more information, read [GitLab Pages does not regenerate OAuth](https://gitlab.com/gitlab-org/omnibus-gitlab/-/issues/3947). -### Pages domain with TLS support, without wildcard DNS **(EXPERIMENT)** +### Pages domain with TLS support, without wildcard DNS -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/17584) in GitLab 16.7. This feature is an [Experiment](../../policy/experiment-beta-support.md). +DETAILS: +**Status:** Experiment + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/17584) in GitLab 16.7. This feature is an [Experiment](../../policy/experiment-beta-support.md). FLAG: On self-managed GitLab, by default this feature is available. @@ -553,7 +566,7 @@ verification requirement: ### Let's Encrypt integration -> [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/issues/28996) in GitLab 12.1. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/issues/28996) in GitLab 12.1. [GitLab Pages' Let's Encrypt integration](../../user/project/pages/custom_domains_ssl_tls_certification/lets_encrypt_integration.md) allows users to add Let's Encrypt SSL certificates for GitLab Pages @@ -601,7 +614,7 @@ all the App nodes and Sidekiq nodes. #### Using Pages with reduced authentication scope -> [Introduced](https://gitlab.com/gitlab-org/gitlab-pages/-/merge_requests/423) in GitLab 13.10. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab-pages/-/merge_requests/423) in GitLab 13.10. By default, the Pages daemon uses the `api` scope to authenticate. You can configure this. For example, this reduces the scope to `read_api` in `/etc/gitlab/gitlab.rb`: @@ -624,7 +637,7 @@ this: #### Disable public access to all Pages sites -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/32095) in GitLab 12.7. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/32095) in GitLab 12.7. You can enforce [Access Control](#access-control) for all GitLab Pages websites hosted on your GitLab instance. By doing so, only authenticated users have access to them. @@ -672,7 +685,7 @@ Authority (CA) in the system certificate store. ### ZIP serving and cache configuration -> [Introduced](https://gitlab.com/gitlab-org/gitlab-pages/-/merge_requests/392) in GitLab 13.7. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab-pages/-/merge_requests/392) in GitLab 13.7. WARNING: These instructions deal with some advanced settings of your GitLab instance. The recommended default values are set inside GitLab Pages. You should @@ -717,7 +730,7 @@ gitlab_pages['headers'] = ['Strict-Transport-Security: max-age=63072000'] ### Pages project redirects limits -> [Introduced](https://gitlab.com/gitlab-org/gitlab-pages/-/merge_requests/778) in GitLab 15.2. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab-pages/-/merge_requests/778) in GitLab 15.2. GitLab Pages comes with a set of default limits for the [`_redirects` file](../../user/project/pages/redirects.md) to minimize the impact on performance. You can configure these limits if you'd like to increase or decrease the limits. @@ -765,7 +778,7 @@ Follow the steps below to configure verbose logging of GitLab Pages daemon. ## Propagating the correlation ID -> [Introduced](https://gitlab.com/gitlab-org/gitlab-pages/-/merge_requests/438) in GitLab 13.10. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab-pages/-/merge_requests/438) in GitLab 13.10. Setting the `propagate_correlation_id` to true allows installations behind a reverse proxy to generate and set a correlation ID to requests sent to GitLab Pages. When a reverse proxy sets the header value `X-Request-ID`, @@ -819,7 +832,11 @@ Follow the steps below to configure the proxy listener of GitLab Pages. 1. [Reconfigure GitLab](../restart_gitlab.md#reconfigure-a-linux-package-installation). -## Set global maximum size of each GitLab Pages site **(FREE SELF)** +## Set global maximum size of each GitLab Pages site + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed Prerequisites: @@ -833,7 +850,11 @@ To set the global maximum pages size for a project: 1. In **Maximum size of pages**, enter a value. The default is `100`. 1. Select **Save changes**. -## Set maximum size of each GitLab Pages site in a group **(PREMIUM SELF)** +## Set maximum size of each GitLab Pages site in a group + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** Self-managed Prerequisites: @@ -847,7 +868,11 @@ To set the maximum size of each GitLab Pages site in a group, overriding the inh 1. Enter a value under **Maximum size** in MB. 1. Select **Save changes**. -## Set maximum size of GitLab Pages site in a project **(PREMIUM SELF)** +## Set maximum size of GitLab Pages site in a project + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** Self-managed Prerequisites: @@ -995,7 +1020,7 @@ For more details see this [blog post](https://about.gitlab.com/blog/2020/08/03/h ### GitLab API cache configuration -> [Introduced](https://gitlab.com/gitlab-org/gitlab-pages/-/issues/520) in GitLab 13.10. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab-pages/-/issues/520) in GitLab 13.10. API-based configuration uses a caching mechanism to improve performance and reliability of serving Pages. The cache behavior can be modified by changing the cache settings, however, the recommended values are set for you and should only be modified if needed. @@ -1150,7 +1175,7 @@ sudo gitlab-rake gitlab:pages:deployments:migrate_to_local ### Disable Pages local storage -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/301159) in GitLab 13.11. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/301159) in GitLab 13.11. If you use [object storage](#object-storage-settings), you can disable local storage to avoid unnecessary disk usage/writes: @@ -1211,7 +1236,7 @@ An IPv6 address receives a large prefix in the 128-bit address space. The prefix #### Enable HTTP requests rate limits by source-IP -> [Introduced](https://gitlab.com/gitlab-org/gitlab-pages/-/issues/631) in GitLab 14.5. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab-pages/-/issues/631) in GitLab 14.5. 1. Set rate limits in `/etc/gitlab/gitlab.rb`: @@ -1224,7 +1249,7 @@ An IPv6 address receives a large prefix in the 128-bit address space. The prefix #### Enable HTTP requests rate limits by domain -> [Introduced](https://gitlab.com/gitlab-org/gitlab-pages/-/issues/630) in GitLab 14.7. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab-pages/-/issues/630) in GitLab 14.7. 1. Set rate limits in `/etc/gitlab/gitlab.rb`: @@ -1237,7 +1262,7 @@ An IPv6 address receives a large prefix in the 128-bit address space. The prefix #### Enable TLS connections rate limits by source-IP -> [Introduced](https://gitlab.com/gitlab-org/gitlab-pages/-/issues/632) in GitLab 14.9. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab-pages/-/issues/632) in GitLab 14.9. 1. Set rate limits in `/etc/gitlab/gitlab.rb`: @@ -1250,7 +1275,7 @@ An IPv6 address receives a large prefix in the 128-bit address space. The prefix #### Enable TLS connections rate limits by domain -> [Introduced](https://gitlab.com/gitlab-org/gitlab-pages/-/issues/632) in GitLab 14.9. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab-pages/-/issues/632) in GitLab 14.9. 1. Set rate limits in `/etc/gitlab/gitlab.rb`: diff --git a/doc/administration/pages/source.md b/doc/administration/pages/source.md index 4e88d4aa4f3..6e2ae56ec5c 100644 --- a/doc/administration/pages/source.md +++ b/doc/administration/pages/source.md @@ -4,7 +4,11 @@ group: Knowledge info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# GitLab Pages administration for self-compiled installations **(FREE SELF)** +# GitLab Pages administration for self-compiled installations + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed NOTE: Before attempting to enable GitLab Pages, first make sure you have diff --git a/doc/administration/pages/troubleshooting.md b/doc/administration/pages/troubleshooting.md index 7a93c8a0f76..60bf8af4fa0 100644 --- a/doc/administration/pages/troubleshooting.md +++ b/doc/administration/pages/troubleshooting.md @@ -4,7 +4,11 @@ group: Knowledge info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Troubleshooting GitLab Pages administration **(FREE SELF)** +# Troubleshooting GitLab Pages administration + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed This page contains a list of issues you might encounter when administering GitLab Pages. diff --git a/doc/administration/polling.md b/doc/administration/polling.md index 5edba91165f..3826ca29067 100644 --- a/doc/administration/polling.md +++ b/doc/administration/polling.md @@ -4,7 +4,11 @@ group: Distribution info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Polling interval multiplier **(FREE SELF)** +# Polling interval multiplier + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed The GitLab UI polls for updates for different resources (such as issue notes, issue titles, and pipeline statuses) on a schedule appropriate to the resource. diff --git a/doc/administration/postgresql/database_load_balancing.md b/doc/administration/postgresql/database_load_balancing.md index 7ef4e2cbcd2..b879d19b622 100644 --- a/doc/administration/postgresql/database_load_balancing.md +++ b/doc/administration/postgresql/database_load_balancing.md @@ -4,7 +4,11 @@ group: Database info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Database Load Balancing **(FREE SELF)** +# Database Load Balancing + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/1283) in [GitLab Premium](https://about.gitlab.com/pricing/) 9.0. > - [Moved](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/60894) from GitLab Premium to GitLab Free in 14.0. @@ -104,7 +108,7 @@ The primary will be used for write queries whether or not it is present in this ### Service Discovery -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/5883) in GitLab 11.0. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/5883) in GitLab 11.0. Service discovery allows GitLab to automatically retrieve a list of PostgreSQL hosts to use. It periodically @@ -161,7 +165,7 @@ upper limit on the time it takes to terminate all old database connections. ### Handling stale reads -> [Moved](https://gitlab.com/gitlab-org/gitlab/-/issues/327902) from GitLab Premium to GitLab Free in 14.0. +> - [Moved](https://gitlab.com/gitlab-org/gitlab/-/issues/327902) from GitLab Premium to GitLab Free in 14.0. To prevent reading from an outdated secondary the load balancer checks if it is in sync with the primary. If the data is recent enough, the diff --git a/doc/administration/postgresql/external.md b/doc/administration/postgresql/external.md index 5b425075b9e..ff6ba1c6f5f 100644 --- a/doc/administration/postgresql/external.md +++ b/doc/administration/postgresql/external.md @@ -4,7 +4,11 @@ group: Database info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Configure GitLab using an external PostgreSQL service **(FREE SELF)** +# Configure GitLab using an external PostgreSQL service + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed If you're hosting GitLab on a cloud provider, you can optionally use a managed service for PostgreSQL. For example, AWS offers a managed Relational diff --git a/doc/administration/postgresql/index.md b/doc/administration/postgresql/index.md index 07de9bcdcf1..f913579e941 100644 --- a/doc/administration/postgresql/index.md +++ b/doc/administration/postgresql/index.md @@ -4,7 +4,11 @@ group: Database info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Configuring PostgreSQL for scaling **(FREE SELF)** +# Configuring PostgreSQL for scaling + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed In this section, you are guided through configuring a PostgreSQL database to be used with GitLab in one of our [reference architectures](../reference_architectures/index.md). @@ -34,7 +38,11 @@ When setting up an external database there are some metrics that are useful for When setting up an external database there are monitoring and logging settings required for troubleshooting various database related issues. Read more about [monitoring and logging setup for external Databases](external_metrics.md). -### PostgreSQL replication and failover for Linux package installations **(PREMIUM SELF)** +### PostgreSQL replication and failover for Linux package installations + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** Self-managed This setup is for when you have installed GitLab using the [Linux **Enterprise Edition** (EE) package](https://about.gitlab.com/install/?version=ee). diff --git a/doc/administration/postgresql/moving.md b/doc/administration/postgresql/moving.md index f1d6ffb29f6..21184480541 100644 --- a/doc/administration/postgresql/moving.md +++ b/doc/administration/postgresql/moving.md @@ -4,7 +4,11 @@ group: Database info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Moving GitLab databases to a different PostgreSQL instance **(FREE SELF)** +# Moving GitLab databases to a different PostgreSQL instance + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed Sometimes it is necessary to move your databases from one PostgreSQL instance to another. For example, if you are using AWS Aurora and are preparing to diff --git a/doc/administration/postgresql/multiple_databases.md b/doc/administration/postgresql/multiple_databases.md index b91b0e573f0..dd0cc765ba0 100644 --- a/doc/administration/postgresql/multiple_databases.md +++ b/doc/administration/postgresql/multiple_databases.md @@ -5,9 +5,13 @@ group: Tenant Scale info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Multiple Databases **(FREE SELF)** +# Multiple Databases -> [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/6168) in GitLab 15.7. +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed + +> - [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/6168) in GitLab 15.7. WARNING: This feature is not ready for production use diff --git a/doc/administration/postgresql/pgbouncer.md b/doc/administration/postgresql/pgbouncer.md index 6bda0522b54..78906daaa0f 100644 --- a/doc/administration/postgresql/pgbouncer.md +++ b/doc/administration/postgresql/pgbouncer.md @@ -4,7 +4,11 @@ group: Database info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Working with the bundled PgBouncer service **(FREE SELF)** +# Working with the bundled PgBouncer service + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed NOTE: PgBouncer is bundled in the `gitlab-ee` package, but is free to use. @@ -91,7 +95,7 @@ Do not backup or restore GitLab through a PgBouncer connection: it causes a GitL ## Enable Monitoring -> [Introduced](https://gitlab.com/gitlab-org/omnibus-gitlab/-/issues/3786) in GitLab 12.0. +> - [Introduced](https://gitlab.com/gitlab-org/omnibus-gitlab/-/issues/3786) in GitLab 12.0. If you enable Monitoring, it must be enabled on **all** PgBouncer servers. diff --git a/doc/administration/postgresql/replication_and_failover.md b/doc/administration/postgresql/replication_and_failover.md index 007762c3c00..5810103eb7f 100644 --- a/doc/administration/postgresql/replication_and_failover.md +++ b/doc/administration/postgresql/replication_and_failover.md @@ -4,7 +4,11 @@ group: Database info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# PostgreSQL replication and failover for Linux package installations **(PREMIUM SELF)** +# PostgreSQL replication and failover for Linux package installations + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** Self-managed If you're a Free user of GitLab self-managed, consider using a cloud-hosted solution. This document doesn't cover self-compiled installations. @@ -336,7 +340,7 @@ If you choose an arbitrary order, you do not have any predetermined leader. #### Enable Monitoring -> [Introduced](https://gitlab.com/gitlab-org/omnibus-gitlab/-/issues/3786) in GitLab 12.0. +> - [Introduced](https://gitlab.com/gitlab-org/omnibus-gitlab/-/issues/3786) in GitLab 12.0. If you enable Monitoring, it must be enabled on **all** database servers. @@ -1090,7 +1094,10 @@ Reverting the PostgreSQL upgrade with `gitlab-ctl revert-pg-upgrade` has the sam `gitlab-ctl pg-upgrade`. You should follow the same procedure by first stopping the replicas, then reverting the leader, and finally reverting the replicas. -### Near zero downtime upgrade of PostgreSQL in a Patroni cluster **(EXPERIMENT)** +### Near zero downtime upgrade of PostgreSQL in a Patroni cluster + +DETAILS: +**Status:** Experiment Patroni enables you to run a major PostgreSQL upgrade without shutting down the cluster. However, this requires additional resources to host the new Patroni nodes with the upgraded PostgreSQL. In practice, with this diff --git a/doc/administration/postgresql/replication_and_failover_troubleshooting.md b/doc/administration/postgresql/replication_and_failover_troubleshooting.md index 1b5aa5fc3b5..7a4e70e0809 100644 --- a/doc/administration/postgresql/replication_and_failover_troubleshooting.md +++ b/doc/administration/postgresql/replication_and_failover_troubleshooting.md @@ -4,7 +4,11 @@ group: Database info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Troubleshooting PostgreSQL replication and failover for Linux package installations **(PREMIUM SELF)** +# Troubleshooting PostgreSQL replication and failover for Linux package installations + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** Self-managed When working with PostgreSQL replication and failover, you might encounter the following issues. diff --git a/doc/administration/postgresql/standalone.md b/doc/administration/postgresql/standalone.md index b609400e91d..b1404a91928 100644 --- a/doc/administration/postgresql/standalone.md +++ b/doc/administration/postgresql/standalone.md @@ -4,7 +4,11 @@ group: Database info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Standalone PostgreSQL for Linux package installations **(FREE SELF)** +# Standalone PostgreSQL for Linux package installations + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed If you wish to have your database service hosted separately from your GitLab application servers, you can do this using the PostgreSQL binaries packaged diff --git a/doc/administration/raketasks/check.md b/doc/administration/raketasks/check.md index 39d7cae5dde..1c0ed96a7e5 100644 --- a/doc/administration/raketasks/check.md +++ b/doc/administration/raketasks/check.md @@ -4,7 +4,11 @@ group: Distribution info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Integrity check Rake task **(FREE SELF)** +# Integrity check Rake task + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed GitLab provides Rake tasks to check the integrity of various components. See also the [check GitLab configuration Rake task](maintenance.md#check-gitlab-configuration). @@ -207,7 +211,7 @@ See [LDAP Rake Tasks - LDAP Check](ldap.md#check) for details. ## Verify database values can be decrypted using the current secrets -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/20069) in GitLab 13.1. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/20069) in GitLab 13.1. This task runs through all possible encrypted values in the database, verifying that they are decryptable using the current @@ -285,7 +289,7 @@ I, [2020-06-11T17:18:15.575711 #27148] INFO -- : Done! ## Reset encrypted tokens when they can't be recovered -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/131893) in GitLab 16.6. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/131893) in GitLab 16.6. WARNING: This operation is dangerous and can result in data-loss. Proceed with extreme caution. diff --git a/doc/administration/raketasks/geo.md b/doc/administration/raketasks/geo.md index f0cbd66c719..6f703c4b887 100644 --- a/doc/administration/raketasks/geo.md +++ b/doc/administration/raketasks/geo.md @@ -6,7 +6,11 @@ remove_date: '2024-02-06' redirect_to: '../../update/deprecations.md#geo-housekeeping-rake-tasks' --- -# Geo Rake tasks (removed) **(PREMIUM SELF)** +# Geo Rake tasks (removed) + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** Self-managed The Geo housekeeping Rake tasks were [deprecated](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/125927) in diff --git a/doc/administration/raketasks/github_import.md b/doc/administration/raketasks/github_import.md index 3b9b7bdfa7a..69b8912fcd5 100644 --- a/doc/administration/raketasks/github_import.md +++ b/doc/administration/raketasks/github_import.md @@ -4,7 +4,11 @@ group: Distribution info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# GitHub import Rake task (deprecated) **(FREE SELF)** +# GitHub import Rake task (deprecated) + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/390690) in GitLab 15.9, Rake task no longer automatically creates namespaces or groups that don't exist. > - Requirement for Maintainer role instead of Developer role introduced in GitLab 16.0 and backported to GitLab 15.11.1 and GitLab 15.10.5. diff --git a/doc/administration/raketasks/incoming_email.md b/doc/administration/raketasks/incoming_email.md index abd5f0e0a4d..0f8a0592c16 100644 --- a/doc/administration/raketasks/incoming_email.md +++ b/doc/administration/raketasks/incoming_email.md @@ -4,9 +4,13 @@ group: Distribution info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Incoming email Rake tasks **(FREE SELF)** +# Incoming email Rake tasks -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/108279) in GitLab 15.9. +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/108279) in GitLab 15.9. The following are Incoming email-related Rake tasks. diff --git a/doc/administration/raketasks/ldap.md b/doc/administration/raketasks/ldap.md index 0db18ca6460..e3473b9b897 100644 --- a/doc/administration/raketasks/ldap.md +++ b/doc/administration/raketasks/ldap.md @@ -4,7 +4,11 @@ group: Authentication info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# LDAP Rake tasks **(FREE SELF)** +# LDAP Rake tasks + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed The following are LDAP-related Rake tasks. @@ -34,9 +38,13 @@ limit by passing a number to the check task: rake gitlab:ldap:check[50] ``` -## Run a group sync **(PREMIUM SELF)** +## Run a group sync -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/14735) in GitLab 12.2. +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** Self-managed + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/14735) in GitLab 12.2. The following task runs a [group sync](../auth/ldap/ldap_synchronization.md#group-sync) immediately. This is valuable when you'd like to update all configured group memberships against LDAP without diff --git a/doc/administration/raketasks/maintenance.md b/doc/administration/raketasks/maintenance.md index 21a7ba258c1..7910420bb8a 100644 --- a/doc/administration/raketasks/maintenance.md +++ b/doc/administration/raketasks/maintenance.md @@ -4,7 +4,11 @@ group: Distribution info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Maintenance Rake tasks **(FREE SELF)** +# Maintenance Rake tasks + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed GitLab provides Rake tasks for general maintenance. @@ -73,7 +77,11 @@ Gitaly - gitaly Git Version: 2.37.1.gl1 ``` -## Show GitLab license information **(PREMIUM SELF)** +## Show GitLab license information + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** Self-managed > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/20501) in GitLab 12.6. > - Moved to GitLab Premium in 13.9. @@ -361,7 +369,10 @@ status in the output of the `sudo gitlab-rake db:migrate:status` command. sudo gitlab-ctl restart sidekiq ``` -## Rebuild database indexes **(EXPERIMENT)** +## Rebuild database indexes + +DETAILS: +**Status:** Experiment WARNING: This feature is experimental, and isn't enabled by default. Use caution when diff --git a/doc/administration/raketasks/praefect.md b/doc/administration/raketasks/praefect.md index 95db4544f43..85d673e9828 100644 --- a/doc/administration/raketasks/praefect.md +++ b/doc/administration/raketasks/praefect.md @@ -4,9 +4,13 @@ group: Gitaly info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Praefect Rake tasks **(FREE SELF)** +# Praefect Rake tasks -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/28369) in GitLab 12.10. +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/28369) in GitLab 12.10. Rake tasks are available for projects that have been created on Praefect storage. See the [Praefect documentation](../gitaly/praefect.md) for information on configuring Praefect. diff --git a/doc/administration/raketasks/project_import_export.md b/doc/administration/raketasks/project_import_export.md index 001d8ec6f1d..521c1bcb699 100644 --- a/doc/administration/raketasks/project_import_export.md +++ b/doc/administration/raketasks/project_import_export.md @@ -4,7 +4,11 @@ group: Distribution info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Project import and export Rake tasks **(FREE SELF)** +# Project import and export Rake tasks + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed GitLab provides Rake tasks for [project import and export](../../user/project/settings/import_export.md). @@ -41,7 +45,7 @@ gitlab-rake "gitlab:import_export:import[root, group/subgroup, testingprojectimp ## Export large projects -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/25598) in GitLab 12.9. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/25598) in GitLab 12.9. You can use a Rake task to export large project. diff --git a/doc/administration/raketasks/service_desk_email.md b/doc/administration/raketasks/service_desk_email.md index 9e18d2fe6c8..266bfa37e79 100644 --- a/doc/administration/raketasks/service_desk_email.md +++ b/doc/administration/raketasks/service_desk_email.md @@ -4,9 +4,13 @@ group: Distribution info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Service Desk email Rake tasks **(FREE SELF)** +# Service Desk email Rake tasks -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/108279) in GitLab 15.9. +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/108279) in GitLab 15.9. The following are Service Desk email-related Rake tasks. diff --git a/doc/administration/raketasks/smtp.md b/doc/administration/raketasks/smtp.md index 46df6b7a720..cf99d40b02b 100644 --- a/doc/administration/raketasks/smtp.md +++ b/doc/administration/raketasks/smtp.md @@ -4,9 +4,13 @@ group: Distribution info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# SMTP Rake tasks **(FREE SELF)** +# SMTP Rake tasks -[Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/67802) in GitLab 14.2. +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/67802) in GitLab 14.2. The following are SMTP-related Rake tasks. diff --git a/doc/administration/raketasks/uploads/migrate.md b/doc/administration/raketasks/uploads/migrate.md index d5f998e35db..e61e83c4912 100644 --- a/doc/administration/raketasks/uploads/migrate.md +++ b/doc/administration/raketasks/uploads/migrate.md @@ -4,7 +4,11 @@ group: Distribution info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Uploads migrate Rake tasks **(FREE SELF)** +# Uploads migrate Rake tasks + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed There is a Rake task for migrating uploads between different storage types. diff --git a/doc/administration/raketasks/uploads/sanitize.md b/doc/administration/raketasks/uploads/sanitize.md index 225e65fae76..05273a29b65 100644 --- a/doc/administration/raketasks/uploads/sanitize.md +++ b/doc/administration/raketasks/uploads/sanitize.md @@ -4,7 +4,11 @@ group: Distribution info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Uploads sanitize Rake tasks **(FREE SELF)** +# Uploads sanitize Rake tasks + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed In GitLab 11.9 and later, EXIF data is automatically stripped from JPG or TIFF image uploads. diff --git a/doc/administration/read_only_gitlab.md b/doc/administration/read_only_gitlab.md index f70e1379958..422484daa58 100644 --- a/doc/administration/read_only_gitlab.md +++ b/doc/administration/read_only_gitlab.md @@ -4,7 +4,11 @@ group: Distribution info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Place GitLab into a read-only state **(FREE SELF)** +# Place GitLab into a read-only state + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed NOTE: In GitLab 13.9 and later, the recommended method to diff --git a/doc/administration/redis/index.md b/doc/administration/redis/index.md index 1ba51c588fe..dce42b912a0 100644 --- a/doc/administration/redis/index.md +++ b/doc/administration/redis/index.md @@ -4,7 +4,11 @@ group: Distribution info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Configuring Redis for scaling **(FREE SELF)** +# Configuring Redis for scaling + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed Based on your infrastructure setup and how you have installed GitLab, there are multiple ways to configure Redis. diff --git a/doc/administration/redis/replication_and_failover.md b/doc/administration/redis/replication_and_failover.md index b33db6ce957..dfe4162d5c8 100644 --- a/doc/administration/redis/replication_and_failover.md +++ b/doc/administration/redis/replication_and_failover.md @@ -4,7 +4,11 @@ group: Distribution info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Redis replication and failover with the Linux package **(PREMIUM SELF)** +# Redis replication and failover with the Linux package + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** Self-managed This documentation is for the Linux package. To use your own non-bundled Redis, see [Redis replication and failover providing your own instance](replication_and_failover_external.md). @@ -494,7 +498,7 @@ which ideally should not have Redis or Sentinels on it for a HA setup. ### Step 5. Enable Monitoring -> [Introduced](https://gitlab.com/gitlab-org/omnibus-gitlab/-/issues/3786) in GitLab 12.0. +> - [Introduced](https://gitlab.com/gitlab-org/omnibus-gitlab/-/issues/3786) in GitLab 12.0. If you enable Monitoring, it must be enabled on **all** Redis servers. @@ -781,7 +785,7 @@ You can find the relevant attributes defined in [`gitlab_rails.rb`](https://gitl ### Control startup behavior -> [Introduced](https://gitlab.com/gitlab-org/omnibus-gitlab/-/merge_requests/6646) in GitLab 15.10. +> - [Introduced](https://gitlab.com/gitlab-org/omnibus-gitlab/-/merge_requests/6646) in GitLab 15.10. To prevent the bundled Redis service from starting at boot or restarting after changing its configuration: @@ -804,7 +808,7 @@ to ensure the node starts and restarts as expected during operation. ### Control replica configuration -> [Introduced](https://gitlab.com/gitlab-org/omnibus-gitlab/-/merge_requests/6646) in GitLab 15.10. +> - [Introduced](https://gitlab.com/gitlab-org/omnibus-gitlab/-/merge_requests/6646) in GitLab 15.10. To prevent the `replicaof` line from rendering in the Redis configuration file: diff --git a/doc/administration/redis/replication_and_failover_external.md b/doc/administration/redis/replication_and_failover_external.md index 48a5fa8e20f..d26bfd5b3f7 100644 --- a/doc/administration/redis/replication_and_failover_external.md +++ b/doc/administration/redis/replication_and_failover_external.md @@ -4,7 +4,11 @@ group: Distribution info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Redis replication and failover providing your own instance **(FREE SELF)** +# Redis replication and failover providing your own instance + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed If you're hosting GitLab on a cloud provider, you can optionally use a managed service for Redis. For example, AWS offers ElastiCache that runs Redis. diff --git a/doc/administration/redis/standalone.md b/doc/administration/redis/standalone.md index 9b66d3a81af..c49d9ecec4c 100644 --- a/doc/administration/redis/standalone.md +++ b/doc/administration/redis/standalone.md @@ -4,7 +4,11 @@ group: Distribution info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Standalone Redis using the Linux package **(FREE SELF)** +# Standalone Redis using the Linux package + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed The Linux package can be used to configure a standalone Redis server. In this configuration, Redis is not scaled, and represents a single diff --git a/doc/administration/redis/troubleshooting.md b/doc/administration/redis/troubleshooting.md index 6cfbce0443f..aebb3004223 100644 --- a/doc/administration/redis/troubleshooting.md +++ b/doc/administration/redis/troubleshooting.md @@ -4,7 +4,11 @@ group: Distribution info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Troubleshooting Redis **(FREE SELF)** +# Troubleshooting Redis + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed There are a lot of moving parts that must be taken care carefully in order for the HA setup to work as expected. diff --git a/doc/administration/reference_architectures/10k_users.md b/doc/administration/reference_architectures/10k_users.md index e31dc4f2130..7bfc11c639d 100644 --- a/doc/administration/reference_architectures/10k_users.md +++ b/doc/administration/reference_architectures/10k_users.md @@ -4,7 +4,11 @@ group: Distribution info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Reference architecture: up to 10,000 users **(PREMIUM SELF)** +# Reference architecture: up to 10,000 users + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** Self-managed This page describes the GitLab reference architecture designed for the load of up to 10,000 users with notable headroom. diff --git a/doc/administration/reference_architectures/1k_users.md b/doc/administration/reference_architectures/1k_users.md index 1296111a974..5499166ded7 100644 --- a/doc/administration/reference_architectures/1k_users.md +++ b/doc/administration/reference_architectures/1k_users.md @@ -4,7 +4,11 @@ group: Distribution info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Reference architecture: up to 1,000 users **(FREE SELF)** +# Reference architecture: up to 1,000 users + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed This page describes the GitLab reference architecture designed for the load of up to 1,000 users with notable headroom (non-HA standalone). @@ -97,7 +101,11 @@ You can also optionally configure GitLab to use an [external PostgreSQL service] or an [external object storage service](../object_storage.md) for added performance and reliability at an increased complexity cost. -## Configure advanced search **(PREMIUM SELF)** +## Configure advanced search + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** Self-managed You can leverage Elasticsearch and [enable advanced search](../../integration/advanced_search/elasticsearch.md) for faster, more advanced code search across your entire GitLab instance. diff --git a/doc/administration/reference_architectures/25k_users.md b/doc/administration/reference_architectures/25k_users.md index d4f4fca9efa..3f385cef20d 100644 --- a/doc/administration/reference_architectures/25k_users.md +++ b/doc/administration/reference_architectures/25k_users.md @@ -4,7 +4,11 @@ group: Distribution info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Reference architecture: up to 25,000 users **(PREMIUM SELF)** +# Reference architecture: up to 25,000 users + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** Self-managed This page describes the GitLab reference architecture designed for the load of up to 25,000 users with notable headroom. diff --git a/doc/administration/reference_architectures/2k_users.md b/doc/administration/reference_architectures/2k_users.md index dd71190b76d..f0d978ffba2 100644 --- a/doc/administration/reference_architectures/2k_users.md +++ b/doc/administration/reference_architectures/2k_users.md @@ -4,7 +4,11 @@ group: Distribution info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Reference architecture: up to 2,000 users **(FREE SELF)** +# Reference architecture: up to 2,000 users + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed This page describes the GitLab reference architecture designed for the load of up to 2,000 users with notable headroom (non-HA). @@ -1057,7 +1061,11 @@ GitLab Runner returns job logs in chunks which the Linux package caches temporar While sharing the job logs through NFS is supported, it's recommended to avoid the need to use NFS by enabling [incremental logging](../job_logs.md#incremental-logging-architecture) (required when no NFS node has been deployed). Incremental logging uses Redis instead of disk space for temporary caching of job logs. -## Configure advanced search **(PREMIUM SELF)** +## Configure advanced search + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** Self-managed You can leverage Elasticsearch and [enable advanced search](../../integration/advanced_search/elasticsearch.md) for faster, more advanced code search across your entire GitLab instance. diff --git a/doc/administration/reference_architectures/3k_users.md b/doc/administration/reference_architectures/3k_users.md index 6d39ab36f5c..310c4568af5 100644 --- a/doc/administration/reference_architectures/3k_users.md +++ b/doc/administration/reference_architectures/3k_users.md @@ -4,7 +4,11 @@ group: Distribution info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Reference architecture: up to 3,000 users **(PREMIUM SELF)** +# Reference architecture: up to 3,000 users + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** Self-managed This page describes the GitLab reference architecture designed for the load of up to 3,000 users with notable headroom. @@ -1709,7 +1713,7 @@ The following IPs will be used as an example: - `10.6.0.71`: Sidekiq 1 - `10.6.0.72`: Sidekiq 2 -To configure the Sidekiq nodes, one each one: +To configure the Sidekiq nodes, on each one: 1. SSH in to the Sidekiq server. 1. [Download and install](https://about.gitlab.com/install/) the Linux diff --git a/doc/administration/reference_architectures/50k_users.md b/doc/administration/reference_architectures/50k_users.md index f68cc8e578f..5d6e4b44f72 100644 --- a/doc/administration/reference_architectures/50k_users.md +++ b/doc/administration/reference_architectures/50k_users.md @@ -4,7 +4,11 @@ group: Distribution info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Reference architecture: up to 50,000 users **(PREMIUM SELF)** +# Reference architecture: up to 50,000 users + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** Self-managed This page describes the GitLab reference architecture designed for the load of up to 50,000 users with notable headroom. diff --git a/doc/administration/reference_architectures/5k_users.md b/doc/administration/reference_architectures/5k_users.md index 0e867f54c0a..422717590b1 100644 --- a/doc/administration/reference_architectures/5k_users.md +++ b/doc/administration/reference_architectures/5k_users.md @@ -4,7 +4,11 @@ group: Distribution info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Reference architecture: up to 5,000 users **(PREMIUM SELF)** +# Reference architecture: up to 5,000 users + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** Self-managed This page describes the GitLab reference architecture designed for the load of up to 5,000 users with notable headroom. diff --git a/doc/administration/reference_architectures/index.md b/doc/administration/reference_architectures/index.md index 2abcc045dab..c9dc8d14ecd 100644 --- a/doc/administration/reference_architectures/index.md +++ b/doc/administration/reference_architectures/index.md @@ -5,7 +5,11 @@ description: Recommended deployments at scale. info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Reference architectures **(FREE SELF)** +# Reference architectures + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed The GitLab Reference Architectures have been designed and tested by the GitLab Quality Engineering and Support teams to provide recommended deployments at scale. diff --git a/doc/administration/reply_by_email.md b/doc/administration/reply_by_email.md index d6c1f74fda8..e91bee9e886 100644 --- a/doc/administration/reply_by_email.md +++ b/doc/administration/reply_by_email.md @@ -4,7 +4,11 @@ group: Respond info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Reply by email **(FREE SELF)** +# Reply by email + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed GitLab can be set up to allow users to comment on issues and merge requests by replying to notification emails. diff --git a/doc/administration/reply_by_email_postfix_setup.md b/doc/administration/reply_by_email_postfix_setup.md index 90d1bf30182..5425b71491f 100644 --- a/doc/administration/reply_by_email_postfix_setup.md +++ b/doc/administration/reply_by_email_postfix_setup.md @@ -4,7 +4,11 @@ group: Distribution info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Set up Postfix for incoming email **(FREE SELF)** +# Set up Postfix for incoming email + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed This document takes you through the steps of setting up a basic Postfix mail server with IMAP authentication on Ubuntu, to be used with [incoming email](incoming_email.md). diff --git a/doc/administration/reporting/git_abuse_rate_limit.md b/doc/administration/reporting/git_abuse_rate_limit.md index 19818a818ac..3a742c894d1 100644 --- a/doc/administration/reporting/git_abuse_rate_limit.md +++ b/doc/administration/reporting/git_abuse_rate_limit.md @@ -4,7 +4,11 @@ group: Anti-Abuse info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Git abuse rate limit (administration) **(ULTIMATE SELF)** +# Git abuse rate limit (administration) + +DETAILS: +**Tier:** Ultimate +**Offering:** Self-managed > - [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/8066) in GitLab 15.2 [with a flag](../../administration/feature_flags.md) named `git_abuse_rate_limit_feature_flag`. Disabled by default. > - [Generally available](https://gitlab.com/gitlab-org/gitlab/-/issues/394996) in GitLab 15.11. Feature flag `git_abuse_rate_limit_feature_flag` removed. diff --git a/doc/administration/reporting/ip_addr_restrictions.md b/doc/administration/reporting/ip_addr_restrictions.md index 434052344d8..e178e8d66b2 100644 --- a/doc/administration/reporting/ip_addr_restrictions.md +++ b/doc/administration/reporting/ip_addr_restrictions.md @@ -4,7 +4,11 @@ group: Anti-Abuse info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# IP address restrictions **(FREE SELF)** +# IP address restrictions + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed IP address restrictions help prevent malicious users hiding their activities behind multiple IP addresses. diff --git a/doc/administration/reporting/spamcheck.md b/doc/administration/reporting/spamcheck.md index 4ba36e33abb..c92d55299bd 100644 --- a/doc/administration/reporting/spamcheck.md +++ b/doc/administration/reporting/spamcheck.md @@ -4,9 +4,13 @@ group: Distribution info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Spamcheck anti-spam service **(FREE SELF)** +# Spamcheck anti-spam service -> [Introduced](https://gitlab.com/gitlab-org/omnibus-gitlab/-/issues/6259) in GitLab 14.8. +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed + +> - [Introduced](https://gitlab.com/gitlab-org/omnibus-gitlab/-/issues/6259) in GitLab 14.8. WARNING: Spamcheck is available to all tiers, but only on instances using GitLab Enterprise Edition (EE). For [licensing reasons](https://gitlab.com/gitlab-org/omnibus-gitlab/-/issues/6259#note_726605397), it is not included in the GitLab Community Edition (CE) package. You can [migrate from CE to EE](../../update/package/convert_to_ee.md). diff --git a/doc/administration/repository_checks.md b/doc/administration/repository_checks.md index 85a74199022..a6094f8fd27 100644 --- a/doc/administration/repository_checks.md +++ b/doc/administration/repository_checks.md @@ -4,7 +4,11 @@ group: Gitaly info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Repository checks **(FREE SELF)** +# Repository checks + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed You can use [`git fsck`](https://git-scm.com/docs/git-fsck) to verify the integrity of all data committed to a repository. GitLab administrators can: diff --git a/doc/administration/repository_storage_paths.md b/doc/administration/repository_storage_paths.md index efa719d103b..9c2767ac310 100644 --- a/doc/administration/repository_storage_paths.md +++ b/doc/administration/repository_storage_paths.md @@ -4,7 +4,11 @@ group: Gitaly info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Repository storage **(FREE SELF)** +# Repository storage + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed GitLab stores [repositories](../user/project/repository/index.md) on repository storage. Repository storage is either: diff --git a/doc/administration/restart_gitlab.md b/doc/administration/restart_gitlab.md index 6cd9af0731a..dea9ce624fa 100644 --- a/doc/administration/restart_gitlab.md +++ b/doc/administration/restart_gitlab.md @@ -4,7 +4,11 @@ group: Distribution info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# How to restart GitLab **(FREE SELF)** +# How to restart GitLab + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed Depending on how you installed GitLab, there are different methods to restart its services. diff --git a/doc/administration/review_abuse_reports.md b/doc/administration/review_abuse_reports.md index 86953f6d984..05f25c3d53c 100644 --- a/doc/administration/review_abuse_reports.md +++ b/doc/administration/review_abuse_reports.md @@ -4,7 +4,11 @@ group: Anti-Abuse info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Review abuse reports **(FREE SELF)** +# Review abuse reports + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed View and resolve abuse reports from GitLab users. diff --git a/doc/administration/review_spam_logs.md b/doc/administration/review_spam_logs.md index 67f6080b3bc..e0aff7f720a 100644 --- a/doc/administration/review_spam_logs.md +++ b/doc/administration/review_spam_logs.md @@ -4,7 +4,11 @@ group: Anti-Abuse info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Review spam logs **(FREE SELF)** +# Review spam logs + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed GitLab tracks user activity and flags certain behavior for potential spam. diff --git a/doc/administration/secure_files.md b/doc/administration/secure_files.md index d3dfe4fdf4c..f311f40d9df 100644 --- a/doc/administration/secure_files.md +++ b/doc/administration/secure_files.md @@ -4,7 +4,11 @@ group: Mobile DevOps info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Secure Files administration **(FREE SELF)** +# Secure Files administration + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/78227) in GitLab 14.8 [with a flag](feature_flags.md) named `ci_secure_files`. Disabled by default. > - [Generally available](https://gitlab.com/gitlab-org/gitlab/-/issues/350748) in GitLab 15.7. Feature flag `ci_secure_files` removed. @@ -85,7 +89,11 @@ are stored locally, follow the steps below. 1. Save the file and [restart GitLab](restart_gitlab.md#self-compiled-installations) for the changes to take effect. -## Using object storage **(FREE SELF)** +## Using object storage + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed Instead of storing Secure Files on disk, you should use [one of the supported object storage options](object_storage.md#supported-object-storage-providers). This configuration relies on valid credentials to be configured already. @@ -165,7 +173,7 @@ See [the available connection settings for different providers](object_storage.m ### Migrate to object storage -> [Introduced](https://gitlab.com/gitlab-org/incubation-engineering/mobile-devops/readme/-/issues/125) in GitLab 16.1. +> - [Introduced](https://gitlab.com/gitlab-org/incubation-engineering/mobile-devops/readme/-/issues/125) in GitLab 16.1. WARNING: It's not possible to migrate Secure Files from object storage back to local storage, diff --git a/doc/administration/server_hooks.md b/doc/administration/server_hooks.md index 406964a117e..8ba88ea75f4 100644 --- a/doc/administration/server_hooks.md +++ b/doc/administration/server_hooks.md @@ -4,7 +4,11 @@ group: Gitaly info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Git server hooks **(FREE SELF)** +# Git server hooks + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/196051) in GitLab 12.8 replacing Custom Hooks. > - [Renamed](https://gitlab.com/gitlab-org/gitlab/-/issues/372991) from server hooks to Git server hooks in GitLab 15.6. @@ -38,7 +42,7 @@ If you don't have access to the `gitaly` command, alternatives to server hooks i :::TabTitle GitLab 15.11 and later -> [Introduced](https://gitlab.com/gitlab-org/gitaly/-/issues/4629) in GitLab 15.11, `hooks set` command replaces direct file system access. Existing Git hooks don't need migrating for the `hooks set` command. +> - [Introduced](https://gitlab.com/gitlab-org/gitaly/-/issues/4629) in GitLab 15.11, `hooks set` command replaces direct file system access. Existing Git hooks don't need migrating for the `hooks set` command. Prerequisites: @@ -169,7 +173,7 @@ subdirectories. :::TabTitle GitLab 15.11 and later -> [Introduced](https://gitlab.com/gitlab-org/gitaly/-/issues/4629) in GitLab 15.11, `hooks set` command replaces direct file system access. +> - [Introduced](https://gitlab.com/gitlab-org/gitaly/-/issues/4629) in GitLab 15.11, `hooks set` command replaces direct file system access. Prerequisites: diff --git a/doc/administration/settings/account_and_limit_settings.md b/doc/administration/settings/account_and_limit_settings.md index d8e2ca38627..9342afb5830 100644 --- a/doc/administration/settings/account_and_limit_settings.md +++ b/doc/administration/settings/account_and_limit_settings.md @@ -4,7 +4,11 @@ group: Source Code info: "To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments" --- -# Account and limit settings **(FREE SELF)** +# Account and limit settings + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed ## Default projects limit @@ -36,7 +40,7 @@ can create in their personal namespace: ## Max attachment size -> [Changed](https://gitlab.com/gitlab-org/gitlab/-/issues/20061) from 10 MB to 100 MB in GitLab 15.7. +> - [Changed](https://gitlab.com/gitlab-org/gitlab/-/issues/20061) from 10 MB to 100 MB in GitLab 15.7. The maximum file size for attachments in GitLab comments and replies is 100 MB. To change the maximum attachment size: @@ -96,7 +100,11 @@ To change the default global prefix: You can also configure the prefix by using the [settings API](../../api/settings.md). -## Repository size limit **(PREMIUM SELF)** +## Repository size limit + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** Self-managed Repositories in your GitLab instance can grow quickly, especially if you are using LFS. Their size can grow exponentially, rapidly consuming available storage. @@ -174,7 +182,11 @@ Users can select the **Remember me** checkbox on sign-in, and their session will 1. Expand **Account and limit**. 1. Select or clear the **Remember me** checkbox to turn this setting on or off. -### Customize session duration for Git Operations when 2FA is enabled **(PREMIUM SELF)** +### Customize session duration for Git Operations when 2FA is enabled + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** Self-managed > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/296669) in GitLab 13.9. > - It's deployed behind a feature flag, disabled by default. @@ -192,7 +204,11 @@ To set a limit on how long these sessions are valid: 1. Fill in the **Session duration for Git operations when 2FA is enabled (minutes)** field. 1. Select **Save changes**. -## Limit the lifetime of SSH keys **(ULTIMATE SELF)** +## Limit the lifetime of SSH keys + +DETAILS: +**Tier:** Ultimate +**Offering:** Self-managed > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/1007) in GitLab 14.6 [with a flag](../../administration/feature_flags.md) named `ff_limit_ssh_key_lifetime`. Disabled by default. > - [Enabled on self-managed](https://gitlab.com/gitlab-org/gitlab/-/issues/346753) in GitLab 14.6. @@ -229,9 +245,13 @@ Once a lifetime for SSH keys is set, GitLab: NOTE: When a user's SSH key becomes invalid they can delete and re-add the same key again. -## Limit the lifetime of access tokens **(ULTIMATE SELF)** +## Limit the lifetime of access tokens -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/3649) in GitLab 12.6. +DETAILS: +**Tier:** Ultimate +**Offering:** Self-managed + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/3649) in GitLab 12.6. Users can optionally specify a maximum lifetime in days for access tokens, this includes [personal](../../user/profile/personal_access_tokens.md), @@ -263,9 +283,13 @@ Once a lifetime for access tokens is set, GitLab: allowed lifetime. Three hours is given to allow administrators to change the allowed lifetime, or remove it, before revocation takes place. -## Disable user profile name changes **(PREMIUM SELF)** +## Disable user profile name changes -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/24605) in GitLab 12.7. +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** Self-managed + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/24605) in GitLab 12.7. To maintain integrity of user details in [Audit Events](../../administration/audit_events.md), GitLab administrators can choose to disable a user's ability to change their profile name. @@ -281,9 +305,12 @@ When this ability is disabled, GitLab administrators can still use the [Admin Area](../../administration/admin_area.md#administering-users) or the [API](../../api/users.md#user-modification) to update usernames. -## Prevent users from creating organizations **(EXPERIMENT)** +## Prevent users from creating organizations -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/423302) in GitLab 16.7 [with a flag](../feature_flags.md) named `ui_for_organizations`. Disabled by default. +DETAILS: +**Status:** Experiment + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/423302) in GitLab 16.7 [with a flag](../feature_flags.md) named `ui_for_organizations`. Disabled by default. FLAG: On self-managed GitLab, by default this feature is not available. To make it available, an administrator can [enable the feature flag](../feature_flags.md) named `ui_for_organizations`. On GitLab.com, this feature is not available. This feature is not ready for production use. @@ -297,7 +324,7 @@ By default, users can create organizations. GitLab administrators can prevent us ## Prevent new users from creating top-level groups -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/367754) in GitLab 15.5. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/367754) in GitLab 15.5. By default, new users can create top-level groups. GitLab administrators can prevent new users from creating top-level groups: @@ -313,7 +340,7 @@ By default, new users can create top-level groups. GitLab administrators can pre ## Set profiles of new users to private by default -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/231301) in GitLab 15.8. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/231301) in GitLab 15.8. By default, newly created users have a public profile. GitLab administrators can set new users to have a private profile by default: @@ -322,9 +349,13 @@ By default, newly created users have a public profile. GitLab administrators can 1. Expand **Account and limit**. 1. Select the **Make new users' profiles private by default** checkbox. -## Prevent users from deleting their accounts **(PREMIUM SELF)** +## Prevent users from deleting their accounts -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/26053) in GitLab 16.1 [with a flag](../../administration/feature_flags.md) named `deleting_account_disabled_for_users`. Enabled by default. +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** Self-managed + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/26053) in GitLab 16.1 [with a flag](../../administration/feature_flags.md) named `deleting_account_disabled_for_users`. Enabled by default. By default, users can delete their own accounts. GitLab administrators can prevent users from deleting their own accounts: diff --git a/doc/administration/settings/continuous_integration.md b/doc/administration/settings/continuous_integration.md index 8164c63b9b9..dfa0c499edb 100644 --- a/doc/administration/settings/continuous_integration.md +++ b/doc/administration/settings/continuous_integration.md @@ -4,7 +4,11 @@ group: Pipeline Execution info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Continuous Integration and Deployment Admin Area settings **(FREE SELF)** +# Continuous Integration and Deployment Admin Area settings + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed The [Admin Area](index.md) has the instance settings for Auto DevOps, runners, and job artifacts. @@ -133,7 +137,7 @@ artifacts, as described in the [troubleshooting documentation](../../administrat ## Keep the latest artifacts for all jobs in the latest successful pipelines -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/50889) in GitLab 13.9. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/50889) in GitLab 13.9. When enabled (default), the artifacts of the most recent pipeline for each Git ref ([branches and tags](https://git-scm.com/book/en/v2/Git-Internals-Git-References)) @@ -193,7 +197,7 @@ To set all new [CI/CD variables](../../ci/variables/index.md) as ## Maximum includes -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/207270) in GitLab 16.0. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/207270) in GitLab 16.0. The maximum number of [includes](../../ci/yaml/includes.md) per pipeline can be set at the instance level. The default is `150`. @@ -205,7 +209,7 @@ The default is `150`. ## Default CI/CD configuration file -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/18073) in GitLab 12.5. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/18073) in GitLab 12.5. The default CI/CD configuration file and path for new projects can be set in the Admin Area of your GitLab instance (`.gitlab-ci.yml` if not set): @@ -267,7 +271,11 @@ so you can view job artifact pages directly: 1. Expand **Continuous Integration and Deployment**. 1. Deselect **Enable the external redirect page for job artifacts**. -## Required pipeline configuration **(ULTIMATE SELF)** +## Required pipeline configuration + +DETAILS: +**Tier:** Ultimate +**Offering:** Self-managed > - [Moved](https://gitlab.com/gitlab-org/gitlab/-/issues/352316) from GitLab Premium to GitLab Ultimate in 15.0. > - [Deprecated](https://gitlab.com/gitlab-org/gitlab/-/issues/389467) in GitLab 15.9. @@ -306,7 +314,11 @@ To select a CI/CD template for the required pipeline configuration: ## Package registry configuration -### Maven Forwarding **(PREMIUM SELF)** +### Maven Forwarding + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** Self-managed GitLab administrators can disable the forwarding of Maven requests to [Maven Central](https://search.maven.org/). @@ -318,7 +330,11 @@ To disable forwarding Maven requests: 1. Clear the checkbox **Forward Maven package requests to the Maven Registry if the packages are not found in the GitLab Package Registry**. 1. Select **Save changes**. -### npm Forwarding **(PREMIUM SELF)** +### npm Forwarding + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** Self-managed GitLab administrators can disable the forwarding of npm requests to [npmjs.com](https://www.npmjs.com/). @@ -330,7 +346,11 @@ To disable it: 1. Clear the checkbox **Forward npm package requests to the npm Registry if the packages are not found in the GitLab Package Registry**. 1. Select **Save changes**. -### PyPI Forwarding **(PREMIUM SELF)** +### PyPI Forwarding + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** Self-managed GitLab administrators can disable the forwarding of PyPI requests to [pypi.org](https://pypi.org/). @@ -398,7 +418,7 @@ To restrict runner registration by members in a specific group: ## Disable runner version management -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/114041) in GitLab 15.10. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/114041) in GitLab 15.10. By default, GitLab instances periodically fetch official runner version data from GitLab.com to [determine whether the runners need upgrades](../../ci/runners/runners_scope.md#determine-which-runners-need-to-be-upgraded). diff --git a/doc/administration/settings/deprecated_api_rate_limits.md b/doc/administration/settings/deprecated_api_rate_limits.md index 2ef4d49ff0a..a4a1e2979b3 100644 --- a/doc/administration/settings/deprecated_api_rate_limits.md +++ b/doc/administration/settings/deprecated_api_rate_limits.md @@ -4,9 +4,13 @@ group: Source Code info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Deprecated API rate limits **(FREE SELF)** +# Deprecated API rate limits -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/68645) in GitLab 14.4. +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/68645) in GitLab 14.4. Deprecated API endpoints are those which have been replaced with alternative functionality, but cannot be removed without breaking backward compatibility. diff --git a/doc/administration/settings/email.md b/doc/administration/settings/email.md index a010a855ba1..80c8123e8b5 100644 --- a/doc/administration/settings/email.md +++ b/doc/administration/settings/email.md @@ -4,7 +4,11 @@ group: Project Management info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Email **(FREE SELF)** +# Email + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed You can customize some of the content in emails sent from your GitLab instance. @@ -12,7 +16,11 @@ You can customize some of the content in emails sent from your GitLab instance. The logo in the header of some emails can be customized, see the [logo customization section](../../administration/appearance.md#customize-your-homepage-button). -## Include author name in email notification email body **(PREMIUM SELF)** +## Include author name in email notification email body + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** Self-managed By default, GitLab overrides the email address in notification emails with the email address of the issue, merge request, or comment author. Enable this setting to include the author's email @@ -26,7 +34,11 @@ To include the author's email address in the email body: 1. Select the **Include author name in email notification email body** checkbox. 1. Select **Save changes**. -## Enable multipart email **(PREMIUM SELF)** +## Enable multipart email + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** Self-managed GitLab can send email in multipart format (HTML and plain text) or plain text only. @@ -38,9 +50,13 @@ To enable multipart email: 1. Select **Enable multipart email**. 1. Select **Save changes**. -## Custom hostname for private commit emails **(PREMIUM SELF)** +## Custom hostname for private commit emails -> [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/22560) in GitLab 11.5. +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** Self-managed + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/22560) in GitLab 11.5. This configuration option sets the email hostname for [private commit emails](../../user/profile/index.md#use-an-automatically-generated-private-commit-email). By default it is set to `users.noreply.YOUR_CONFIGURED_HOSTNAME`. @@ -58,7 +74,11 @@ After the hostname is configured, every private commit email using the previous recognized by GitLab. This can directly conflict with certain [Push rules](../../user/project/repository/push_rules.md) such as `Check whether author is a GitLab user` and `Check whether committer is the current authenticated user`. -## Custom additional text **(PREMIUM SELF)** +## Custom additional text + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** Self-managed You can add additional text at the bottom of any email that GitLab sends. This additional text can be used for legal, auditing, or compliance reasons, for example. @@ -83,7 +103,11 @@ To disable these notifications: 1. Clear the **Enable user deactivation emails** checkbox. 1. Select **Save changes**. -### Custom additional text in deactivation emails **(FREE SELF)** +### Custom additional text in deactivation emails + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/355964) in GitLab 15.9 [with a flag](../../administration/feature_flags.md) named `deactivation_email_additional_text`. Disabled by default. > - [Enabled on self-managed and GitLab.com](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/111882) in GitLab 15.9. diff --git a/doc/administration/settings/external_authorization.md b/doc/administration/settings/external_authorization.md index 95ce7963bb7..76d991caab4 100644 --- a/doc/administration/settings/external_authorization.md +++ b/doc/administration/settings/external_authorization.md @@ -4,9 +4,13 @@ group: Authentication info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# External authorization control **(FREE SELF)** +# External authorization control -> [Moved](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/27056) from GitLab Premium to GitLab Free in 11.10. +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed + +> - [Moved](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/27056) from GitLab Premium to GitLab Free in 11.10. In highly controlled environments, it may be necessary for access policy to be controlled by an external service that permits access based on project diff --git a/doc/administration/settings/files_api_rate_limits.md b/doc/administration/settings/files_api_rate_limits.md index 4764341b932..b4b0e37fd67 100644 --- a/doc/administration/settings/files_api_rate_limits.md +++ b/doc/administration/settings/files_api_rate_limits.md @@ -4,7 +4,11 @@ group: Source Code info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Rate limits on Repository files API **(FREE SELF)** +# Rate limits on Repository files API + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/68561) in GitLab 14.3. > - [Generally available](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/75918) in GitLab 14.6. [Feature flag `files_api_throttling`](https://gitlab.com/gitlab-org/gitlab/-/issues/338903) removed. diff --git a/doc/administration/settings/floc.md b/doc/administration/settings/floc.md index 499b1d9c82f..d76eefee4e5 100644 --- a/doc/administration/settings/floc.md +++ b/doc/administration/settings/floc.md @@ -4,9 +4,13 @@ group: unassigned info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Federated Learning of Cohorts (FLoC) **(FREE SELF)** +# Federated Learning of Cohorts (FLoC) -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/60933) in GitLab 13.12. +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/60933) in GitLab 13.12. Federated Learning of Cohorts (FLoC) is a new feature of the Chrome browser. It works by categorizing users into different cohorts, so that diff --git a/doc/administration/settings/git_lfs_rate_limits.md b/doc/administration/settings/git_lfs_rate_limits.md index 4e096e52f41..91d67b3c19f 100644 --- a/doc/administration/settings/git_lfs_rate_limits.md +++ b/doc/administration/settings/git_lfs_rate_limits.md @@ -4,7 +4,11 @@ group: Source Code info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Rate limits on Git LFS **(FREE SELF)** +# Rate limits on Git LFS + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed [Git LFS (Large File Storage)](../../topics/git/lfs/index.md) is a Git extension for handling large files. If you use Git LFS in your repository, common Git operations diff --git a/doc/administration/settings/gitaly_timeouts.md b/doc/administration/settings/gitaly_timeouts.md index b35ee32a3e9..51bed3a072b 100644 --- a/doc/administration/settings/gitaly_timeouts.md +++ b/doc/administration/settings/gitaly_timeouts.md @@ -4,7 +4,11 @@ group: Gitaly info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Gitaly timeouts **(FREE SELF)** +# Gitaly timeouts + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed [Gitaly](../gitaly/index.md) provides two types of configurable timeouts: @@ -33,7 +37,7 @@ Different call timeouts are available for different Gitaly operations. ## Configure the negotiation timeouts -> [Introduced](https://gitlab.com/gitlab-org/gitaly/-/issues/5574) in GitLab 16.5. +> - [Introduced](https://gitlab.com/gitlab-org/gitaly/-/issues/5574) in GitLab 16.5. You might need to increase the negotiation timeout: diff --git a/doc/administration/settings/help_page.md b/doc/administration/settings/help_page.md index bb7f214a106..81e52c38af4 100644 --- a/doc/administration/settings/help_page.md +++ b/doc/administration/settings/help_page.md @@ -4,7 +4,11 @@ group: unassigned info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Customize the Help and sign-in page messages **(FREE SELF)** +# Customize the Help and sign-in page messages + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed In large organizations, it is useful to have information about who to contact or where to go for help. You can customize and display this information on the GitLab `/help` page and on diff --git a/doc/administration/settings/import_and_export_settings.md b/doc/administration/settings/import_and_export_settings.md index 54995cdc686..a6030d35b57 100644 --- a/doc/administration/settings/import_and_export_settings.md +++ b/doc/administration/settings/import_and_export_settings.md @@ -4,7 +4,11 @@ group: Import and Integrate info: "To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments" --- -# Import and export settings **(FREE SELF)** +# Import and export settings + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed Settings for import- and export-related features. @@ -33,9 +37,12 @@ To enable the export of 1. Select the **Enabled** checkbox. 1. Select **Save changes**. -## Enable migration of groups and projects by direct transfer **(BETA)** +## Enable migration of groups and projects by direct transfer -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/383268) in GitLab 15.8. +DETAILS: +**Status:** Beta + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/383268) in GitLab 15.8. WARNING: In GitLab 16.1 and earlier, you should **not** use direct transfer with [scheduled scan execution policies](../../user/application_security/policies/scan-execution-policies.md). If using direct transfer, first upgrade to GitLab 16.2 and ensure security policy bots are enabled in the projects you are enforcing. @@ -61,7 +68,7 @@ The same setting ## Max export size -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/86124) in GitLab 15.0. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/86124) in GitLab 15.0. To modify the maximum file size for exports in GitLab: @@ -71,7 +78,7 @@ To modify the maximum file size for exports in GitLab: ## Max import size -> [Changed](https://gitlab.com/gitlab-org/gitlab/-/issues/251106) from 50 MiB to unlimited in GitLab 13.8. +> - [Changed](https://gitlab.com/gitlab-org/gitlab/-/issues/251106) from 50 MiB to unlimited in GitLab 13.8. To modify the maximum file size for imports in GitLab: @@ -91,7 +98,7 @@ For GitLab.com repository size limits, read [accounts and limit settings](../../ ## Maximum remote file size for imports -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/384976) in GitLab 16.3. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/384976) in GitLab 16.3. By default, the maximum remote file size for imports from external object storages (for example, AWS) is 10 GiB. @@ -104,7 +111,7 @@ To modify this setting: ## Maximum download file size for imports by direct transfer -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/384976) in GitLab 16.3. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/384976) in GitLab 16.3. By default, the maximum download file size for imports by direct transfer is 5 GiB. @@ -140,7 +147,7 @@ To modify this setting: ## Timeout for decompressing archived files -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/128218) in GitLab 16.4. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/128218) in GitLab 16.4. When you [import a project](../../user/project/settings/import_export.md), you can specify the maximum time out for decompressing imported archives. The default value is 210 seconds. diff --git a/doc/administration/settings/import_export_rate_limits.md b/doc/administration/settings/import_export_rate_limits.md index b261efd751b..785870e93ae 100644 --- a/doc/administration/settings/import_export_rate_limits.md +++ b/doc/administration/settings/import_export_rate_limits.md @@ -4,9 +4,13 @@ group: Import and Integrate info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Rate limits for imports and exports of project and groups **(FREE SELF)** +# Rate limits for imports and exports of project and groups -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/35728) in GitLab 13.2. +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/35728) in GitLab 13.2. You can configure the rate limits for imports and exports of projects and groups: diff --git a/doc/administration/settings/incident_management_rate_limits.md b/doc/administration/settings/incident_management_rate_limits.md index 57005682f15..629fbc13f1f 100644 --- a/doc/administration/settings/incident_management_rate_limits.md +++ b/doc/administration/settings/incident_management_rate_limits.md @@ -4,9 +4,13 @@ group: Respond info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Incident management rate limits **(ULTIMATE SELF)** +# Incident management rate limits -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/17859) in GitLab 12.5. +DETAILS: +**Tier:** Ultimate +**Offering:** Self-managed + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/17859) in GitLab 12.5. You can limit the number of inbound alerts for [incidents](../../operations/incident_management/incidents.md) that can be created in a period of time. The inbound [incident management](../../operations/incident_management/index.md) diff --git a/doc/administration/settings/index.md b/doc/administration/settings/index.md index 2df9d1cd52d..8b8dc8750aa 100644 --- a/doc/administration/settings/index.md +++ b/doc/administration/settings/index.md @@ -5,7 +5,11 @@ description: Product settings. info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Update your Admin Area settings **(FREE SELF)** +# Update your Admin Area settings + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed As an administrator of a GitLab self-managed instance, you can manage the behavior of your deployment. diff --git a/doc/administration/settings/instance_template_repository.md b/doc/administration/settings/instance_template_repository.md index 3d95172ae24..3d3bdb516d9 100644 --- a/doc/administration/settings/instance_template_repository.md +++ b/doc/administration/settings/instance_template_repository.md @@ -4,7 +4,11 @@ group: Source Code info: "To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments" --- -# Instance template repository **(PREMIUM SELF)** +# Instance template repository + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** Self-managed > - [Improved](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/52360) to behave like group-level templates in GitLab 13.9. > - [Feature flag removed](https://gitlab.com/gitlab-org/gitlab/-/issues/321247) in GitLab 14.0. diff --git a/doc/administration/settings/jira_cloud_app.md b/doc/administration/settings/jira_cloud_app.md index 62a8b85e79b..1eb3e15b081 100644 --- a/doc/administration/settings/jira_cloud_app.md +++ b/doc/administration/settings/jira_cloud_app.md @@ -4,7 +4,11 @@ group: Import and Integrate info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# GitLab for Jira Cloud app administration **(FREE SELF)** +# GitLab for Jira Cloud app administration + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed NOTE: This page contains administrator documentation for the GitLab for Jira Cloud app. For user documentation, see [GitLab for Jira Cloud app](../../integration/jira/connect-app.md). @@ -75,7 +79,7 @@ If necessary: ## Connect the GitLab for Jira Cloud app -> Introduced in GitLab 15.7. +> - Introduced in GitLab 15.7. You can link your self-managed instance after you install the GitLab for Jira Cloud app from the marketplace. Jira apps can only link to one URL per marketplace listing. The official listing links to GitLab.com. diff --git a/doc/administration/settings/jira_cloud_app_troubleshooting.md b/doc/administration/settings/jira_cloud_app_troubleshooting.md index 93d85625463..9791d6f121d 100644 --- a/doc/administration/settings/jira_cloud_app_troubleshooting.md +++ b/doc/administration/settings/jira_cloud_app_troubleshooting.md @@ -4,7 +4,11 @@ group: Import and Integrate info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Troubleshooting GitLab for Jira Cloud app administration **(FREE SELF)** +# Troubleshooting GitLab for Jira Cloud app administration + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed When administering the GitLab for Jira Cloud app, you might encounter the following issues. diff --git a/doc/administration/settings/localization.md b/doc/administration/settings/localization.md index 71ceaa3c9bf..e48ac74c1b8 100644 --- a/doc/administration/settings/localization.md +++ b/doc/administration/settings/localization.md @@ -4,7 +4,11 @@ group: unassigned info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Localization **(FREE SELF)** +# Localization + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed As an administrator of a GitLab self-managed instance, you can manage the behavior of your deployment. diff --git a/doc/administration/settings/package_registry_rate_limits.md b/doc/administration/settings/package_registry_rate_limits.md index db3170a625b..70a7e09c7f4 100644 --- a/doc/administration/settings/package_registry_rate_limits.md +++ b/doc/administration/settings/package_registry_rate_limits.md @@ -4,7 +4,11 @@ group: Package Registry info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Package registry rate limits **(FREE SELF)** +# Package registry rate limits + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed With the [GitLab package registry](../../user/packages/package_registry/index.md), you can use GitLab as a private or public registry for a variety of common package managers. You can diff --git a/doc/administration/settings/project_integration_management.md b/doc/administration/settings/project_integration_management.md index 435a8d07c0b..45805d82db9 100644 --- a/doc/administration/settings/project_integration_management.md +++ b/doc/administration/settings/project_integration_management.md @@ -4,7 +4,11 @@ group: Import and Integrate info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Project integration administration **(FREE SELF)** +# Project integration administration + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed NOTE: This page contains administrator documentation for project integrations. For user documentation, see [Project integrations](../../user/project/integrations/index.md). @@ -79,7 +83,7 @@ Resetting an instance-level default setting removes the integration from all pro ### View projects that use custom settings -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/218252) in GitLab 14.2. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/218252) in GitLab 14.2. Prerequisites: diff --git a/doc/administration/settings/protected_paths.md b/doc/administration/settings/protected_paths.md index 9eae34c8c64..f775bfbeb31 100644 --- a/doc/administration/settings/protected_paths.md +++ b/doc/administration/settings/protected_paths.md @@ -4,7 +4,11 @@ group: unassigned info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Protected paths **(FREE SELF)** +# Protected paths + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed Rate limiting is a technique that improves the security and durability of a web application. For more details, see [Rate limits](../../security/rate_limits.md). @@ -28,7 +32,7 @@ See also: ## Configure protected paths -> [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/31246) in GitLab 12.4. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/31246) in GitLab 12.4. Throttling of protected paths is enabled by default and can be disabled or customized. diff --git a/doc/administration/settings/push_event_activities_limit.md b/doc/administration/settings/push_event_activities_limit.md index edf64100eb7..0e61c205d96 100644 --- a/doc/administration/settings/push_event_activities_limit.md +++ b/doc/administration/settings/push_event_activities_limit.md @@ -4,9 +4,13 @@ group: Source Code info: "To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments" --- -# Push event activities limit and bulk push events **(FREE SELF)** +# Push event activities limit and bulk push events -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/31007) in GitLab 12.4. +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/31007) in GitLab 12.4. Set the number of branches or tags to limit the number of single push events allowed at once. If the number of events is greater than this, GitLab creates diff --git a/doc/administration/settings/rate_limit_on_issues_creation.md b/doc/administration/settings/rate_limit_on_issues_creation.md index 36e242b4ac4..22a0e905e85 100644 --- a/doc/administration/settings/rate_limit_on_issues_creation.md +++ b/doc/administration/settings/rate_limit_on_issues_creation.md @@ -4,9 +4,13 @@ group: Project Management info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Rate limits on issue and epic creation **(FREE SELF)** +# Rate limits on issue and epic creation -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/28129) in GitLab 12.10. +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/28129) in GitLab 12.10. Rate limits control the pace at which new epics and issues can be created. For example, if you set the limit to `300`, the diff --git a/doc/administration/settings/rate_limit_on_members_api.md b/doc/administration/settings/rate_limit_on_members_api.md index 3e8868adc91..5a6911d2bca 100644 --- a/doc/administration/settings/rate_limit_on_members_api.md +++ b/doc/administration/settings/rate_limit_on_members_api.md @@ -4,9 +4,13 @@ group: Tenant Scale info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Rate limit on Members API **(FREE SELF)** +# Rate limit on Members API -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/140633) in GitLab 16.9. +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/140633) in GitLab 16.9. You can configure the rate limit per group (or project) per user to the [delete members API](../../api/members.md#remove-a-member-from-a-group-or-project). diff --git a/doc/administration/settings/rate_limit_on_notes_creation.md b/doc/administration/settings/rate_limit_on_notes_creation.md index 59ec47afaa9..94d09576bbf 100644 --- a/doc/administration/settings/rate_limit_on_notes_creation.md +++ b/doc/administration/settings/rate_limit_on_notes_creation.md @@ -4,9 +4,13 @@ group: Project Management info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Rate limits on note creation **(FREE SELF)** +# Rate limits on note creation -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/53637) in GitLab 13.9. +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/53637) in GitLab 13.9. You can configure the per-user rate limit for requests to the note creation endpoint. diff --git a/doc/administration/settings/rate_limit_on_pipelines_creation.md b/doc/administration/settings/rate_limit_on_pipelines_creation.md index e99d6e65993..0137f1f72ea 100644 --- a/doc/administration/settings/rate_limit_on_pipelines_creation.md +++ b/doc/administration/settings/rate_limit_on_pipelines_creation.md @@ -4,9 +4,13 @@ group: Pipeline Execution info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Rate limits on pipeline creation **(FREE SELF)** +# Rate limits on pipeline creation -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/362475) in GitLab 15.0. +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/362475) in GitLab 15.0. You can set a limit so that users and processes can't request more than a certain number of pipelines each minute. This limit can help save resources and improve stability. diff --git a/doc/administration/settings/rate_limit_on_projects_api.md b/doc/administration/settings/rate_limit_on_projects_api.md index f2797b37171..6a6fea8ed2b 100644 --- a/doc/administration/settings/rate_limit_on_projects_api.md +++ b/doc/administration/settings/rate_limit_on_projects_api.md @@ -4,7 +4,11 @@ group: Tenant Scale info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Rate limit on Projects API **(FREE SELF)** +# Rate limit on Projects API + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/112283) in GitLab 15.10 with a [flag](../feature_flags.md) named `rate_limit_for_unauthenticated_projects_api_access`. Disabled by default. > - [Enabled on GitLab.com](https://gitlab.com/gitlab-org/gitlab/-/issues/391922) on May 08, 2023. diff --git a/doc/administration/settings/rate_limit_on_users_api.md b/doc/administration/settings/rate_limit_on_users_api.md index fcac30c9105..cad09a8e2ca 100644 --- a/doc/administration/settings/rate_limit_on_users_api.md +++ b/doc/administration/settings/rate_limit_on_users_api.md @@ -4,9 +4,13 @@ group: Authentication info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Rate limits on Users API **(FREE SELF)** +# Rate limits on Users API -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/78364) in GitLab 14.8. +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/78364) in GitLab 14.8. You can configure the per user rate limit for requests to [Users API](../../api/users.md). diff --git a/doc/administration/settings/rate_limits_on_git_ssh_operations.md b/doc/administration/settings/rate_limits_on_git_ssh_operations.md index dea939c7fe9..87ada453eff 100644 --- a/doc/administration/settings/rate_limits_on_git_ssh_operations.md +++ b/doc/administration/settings/rate_limits_on_git_ssh_operations.md @@ -4,9 +4,13 @@ group: Source Code info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Rate limits on Git SSH operations **(FREE SELF)** +# Rate limits on Git SSH operations -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/78373) in GitLab 14.7 [with a flag](../feature_flags.md) named `rate_limit_gitlab_shell`. Available by default without a feature flag from 15.8. +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/78373) in GitLab 14.7 [with a flag](../feature_flags.md) named `rate_limit_gitlab_shell`. Available by default without a feature flag from 15.8. GitLab applies rate limits to Git operations that use SSH by user account and project. When the rate limit is exceeded, GitLab rejects further connection requests from that user for the project. @@ -21,7 +25,7 @@ Because the same commands are shared by `git-upload-pack`, `git pull`, and `git ## Configure GitLab Shell operation limit -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/123761) in GitLab 16.2. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/123761) in GitLab 16.2. `Git operations using SSH` is enabled by default. Defaults to 600 per user per minute. diff --git a/doc/administration/settings/rate_limits_on_raw_endpoints.md b/doc/administration/settings/rate_limits_on_raw_endpoints.md index 9ff5637028d..0dfb5d4080b 100644 --- a/doc/administration/settings/rate_limits_on_raw_endpoints.md +++ b/doc/administration/settings/rate_limits_on_raw_endpoints.md @@ -4,9 +4,13 @@ group: unassigned info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Rate limits on raw endpoints **(FREE SELF)** +# Rate limits on raw endpoints -> [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/30635) in GitLab 12.2. +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/30635) in GitLab 12.2. This setting defaults to `300` requests per minute, and allows you to rate limit the requests to raw endpoints: diff --git a/doc/administration/settings/scim_setup.md b/doc/administration/settings/scim_setup.md index 2e1b40d58b8..a044cf60556 100644 --- a/doc/administration/settings/scim_setup.md +++ b/doc/administration/settings/scim_setup.md @@ -4,9 +4,13 @@ group: Authentication info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Configure SCIM for self-managed GitLab instances **(PREMIUM SELF)** +# Configure SCIM for self-managed GitLab instances -> [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/8902) in GitLab 15.8. +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** Self-managed + +> - [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/8902) in GitLab 15.8. You can use the open standard System for Cross-domain Identity Management (SCIM) to automatically: diff --git a/doc/administration/settings/security_and_compliance.md b/doc/administration/settings/security_and_compliance.md index d0d9ed3256b..6e0c6020fd4 100644 --- a/doc/administration/settings/security_and_compliance.md +++ b/doc/administration/settings/security_and_compliance.md @@ -4,7 +4,11 @@ group: Composition Analysis info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Security and Compliance Admin Area settings **(ULTIMATE SELF)** +# Security and Compliance Admin Area settings + +DETAILS: +**Tier:** Ultimate +**Offering:** Self-managed The settings for package metadata synchronization are located in the [Admin Area](index.md). diff --git a/doc/administration/settings/security_contact_information.md b/doc/administration/settings/security_contact_information.md index e4d2cf62bdc..753169cfe35 100644 --- a/doc/administration/settings/security_contact_information.md +++ b/doc/administration/settings/security_contact_information.md @@ -4,9 +4,13 @@ group: Compliance info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Provide public security contact information **(FREE SELF)** +# Provide public security contact information -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/433210) in GitLab 16.7. +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/433210) in GitLab 16.7. Organizations can facilitate the responsible disclosure of security issues by providing public contact information. GitLab supports using a diff --git a/doc/administration/settings/sidekiq_job_limits.md b/doc/administration/settings/sidekiq_job_limits.md index bf89678d4d2..a0c6ece333e 100644 --- a/doc/administration/settings/sidekiq_job_limits.md +++ b/doc/administration/settings/sidekiq_job_limits.md @@ -4,9 +4,13 @@ group: unassigned info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Sidekiq job size limits **(FREE SELF)** +# Sidekiq job size limits -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/68982) in GitLab 14.3. +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/68982) in GitLab 14.3. [Sidekiq](../sidekiq/index.md) jobs get stored in Redis. To avoid excessive memory for Redis, we: diff --git a/doc/administration/settings/sign_in_restrictions.md b/doc/administration/settings/sign_in_restrictions.md index 6888994580c..d0cb7ed2acc 100644 --- a/doc/administration/settings/sign_in_restrictions.md +++ b/doc/administration/settings/sign_in_restrictions.md @@ -4,7 +4,11 @@ group: unassigned info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Sign-in restrictions **(FREE SELF)** +# Sign-in restrictions + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed You can use **Sign-in restrictions** to customize authentication restrictions for web interfaces as well as Git over HTTP(S). @@ -30,7 +34,7 @@ In the event of an external authentication provider outage, use the [GitLab Rail ## Admin Mode -> [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/2158) in GitLab 13.10. +> - [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/2158) in GitLab 13.10. If you're an administrator, you might want to work in GitLab without administrator access. You could either create a separate user account that does not have @@ -155,7 +159,7 @@ period in hours. ## Email notification for unknown sign-ins -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/218457) in GitLab 13.2. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/218457) in GitLab 13.2. When enabled, GitLab notifies users of sign-ins from unknown IP addresses or devices. For more information, see [Email notification for unknown sign-ins](../../user/profile/notifications.md#notifications-for-unknown-sign-ins). diff --git a/doc/administration/settings/sign_up_restrictions.md b/doc/administration/settings/sign_up_restrictions.md index 23aa3ee68de..c9b4cea0023 100644 --- a/doc/administration/settings/sign_up_restrictions.md +++ b/doc/administration/settings/sign_up_restrictions.md @@ -4,7 +4,11 @@ group: unassigned info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Sign-up restrictions **(FREE SELF)** +# Sign-up restrictions + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed You can enforce the following restrictions on sign ups: @@ -132,14 +136,18 @@ To remove the user cap: ## Minimum password length limit -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/20661) in GitLab 12.6 +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/20661) in GitLab 12.6 You can [change](../../security/password_length_limits.md#modify-minimum-password-length) the minimum number of characters a user must have in their password using the GitLab UI. -### Password complexity requirements **(PREMIUM SELF)** +### Password complexity requirements -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/354965) in GitLab 15.2. +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** Self-managed + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/354965) in GitLab 15.2. By default, the only requirement for user passwords is [minimum password length](#minimum-password-length-limit). You can add additional complexity requirements. Changes to password complexity requirements apply to new passwords: diff --git a/doc/administration/settings/slack_app.md b/doc/administration/settings/slack_app.md index 5421d80d2ba..d27677776f8 100644 --- a/doc/administration/settings/slack_app.md +++ b/doc/administration/settings/slack_app.md @@ -4,9 +4,13 @@ group: Import and Integrate info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# GitLab for Slack app administration **(FREE SELF)** +# GitLab for Slack app administration -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/358872) for self-managed in GitLab 16.2. +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/358872) for self-managed in GitLab 16.2. NOTE: This page contains administrator documentation for the GitLab for Slack app. For user documentation, see [GitLab for Slack app](../../user/project/integrations/gitlab_slack_application.md). diff --git a/doc/administration/settings/terms.md b/doc/administration/settings/terms.md index dc12784ad82..026d7fe2855 100644 --- a/doc/administration/settings/terms.md +++ b/doc/administration/settings/terms.md @@ -4,7 +4,11 @@ group: unassigned info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Terms of Service and Privacy Policy **(FREE SELF)** +# Terms of Service and Privacy Policy + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed An administrator can enforce acceptance of a terms of service and privacy policy. When this option is enabled, new and existing users must accept the terms. diff --git a/doc/administration/settings/terraform_limits.md b/doc/administration/settings/terraform_limits.md index 9650b2fdda1..a621d18d478 100644 --- a/doc/administration/settings/terraform_limits.md +++ b/doc/administration/settings/terraform_limits.md @@ -4,9 +4,13 @@ group: Environments info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Terraform limits **(FREE SELF)** +# Terraform limits -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/352951) in GitLab 15.7. +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/352951) in GitLab 15.7. You can limit the total storage of [Terraform state files](../terraform_state.md). The limit applies to each individual diff --git a/doc/administration/settings/third_party_offers.md b/doc/administration/settings/third_party_offers.md index 861859e3639..1ff49b4b02e 100644 --- a/doc/administration/settings/third_party_offers.md +++ b/doc/administration/settings/third_party_offers.md @@ -4,9 +4,13 @@ group: Tenant Scale info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Customer experience improvement and third-party offers **(FREE SELF)** +# Customer experience improvement and third-party offers -> [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/20379) in GitLab 11.1. +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/20379) in GitLab 11.1. Within GitLab, we inform users of available third-party offers they might find valuable in order to enhance the development of their projects. An example is the Google Cloud Platform free credit diff --git a/doc/administration/settings/usage_statistics.md b/doc/administration/settings/usage_statistics.md index 4c6af23849d..cf26c78d9a1 100644 --- a/doc/administration/settings/usage_statistics.md +++ b/doc/administration/settings/usage_statistics.md @@ -4,7 +4,11 @@ group: Analytics Instrumentation info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Usage statistics **(FREE SELF)** +# Usage statistics + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed GitLab Inc. periodically collects information about your instance in order to perform various actions. diff --git a/doc/administration/settings/user_and_ip_rate_limits.md b/doc/administration/settings/user_and_ip_rate_limits.md index 1f6cb1af814..8f25c89f8f6 100644 --- a/doc/administration/settings/user_and_ip_rate_limits.md +++ b/doc/administration/settings/user_and_ip_rate_limits.md @@ -4,7 +4,11 @@ group: unassigned info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# User and IP rate limits **(FREE SELF)** +# User and IP rate limits + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed Rate limiting is a common technique used to improve the security and durability of a web application. For more details, see @@ -84,7 +88,7 @@ To enable the unauthenticated request rate limit: ## Use a custom rate limit response -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/50693) in GitLab 13.8. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/50693) in GitLab 13.8. A request that exceeds a rate limit returns a `429` response code and a plain-text body, which by default is `Retry later`. @@ -99,7 +103,7 @@ To use a custom response: ## Maximum authenticated requests to `project/:id/jobs` per minute -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/129319) in GitLab 16.5. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/129319) in GitLab 16.5. To reduce timeouts, the `project/:id/jobs` endpoint has a default [rate limit](../../security/rate_limits.md#project-jobs-api-endpoint) of 600 calls per authenticated user. @@ -112,7 +116,7 @@ To modify the maximum number of requests: ## Response headers -> [Introduced](https://gitlab.com/gitlab-com/gl-infra/scalability/-/issues/731) in GitLab 13.8, the `RateLimit` headers. `Retry-After` was introduced in an earlier version. +> - [Introduced](https://gitlab.com/gitlab-com/gl-infra/scalability/-/issues/731) in GitLab 13.8, the `RateLimit` headers. `Retry-After` was introduced in an earlier version. When a client exceeds the associated rate limit, the following requests are blocked. The server may respond with rate-limiting information allowing the @@ -131,7 +135,7 @@ attached into the response headers. ## Use an HTTP header to bypass rate limiting -> [Introduced](https://gitlab.com/gitlab-com/gl-infra/scalability/-/issues/622) in GitLab 13.6. +> - [Introduced](https://gitlab.com/gitlab-com/gl-infra/scalability/-/issues/622) in GitLab 13.6. Depending on the needs of your organization, you may want to enable rate limiting but have some requests bypass the rate limiter. @@ -168,7 +172,7 @@ To disable the bypass mechanism, make sure the environment variable ## Allow specific users to bypass authenticated request rate limiting -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/49127) in GitLab 13.7. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/49127) in GitLab 13.7. Similarly to the bypass header described above, it is possible to allow a certain set of users to bypass the rate limiter. This only applies @@ -193,7 +197,7 @@ At application startup, the allowlist is logged in [`auth.log`](../logs/index.md ## Try out throttling settings before enforcing them -> [Introduced](https://gitlab.com/gitlab-com/gl-infra/scalability/-/issues/629) in GitLab 13.6. +> - [Introduced](https://gitlab.com/gitlab-com/gl-infra/scalability/-/issues/629) in GitLab 13.6. You can try out throttling settings by setting the `GITLAB_THROTTLE_DRY_RUN` environment variable to a comma-separated list of throttle names. diff --git a/doc/administration/settings/visibility_and_access_controls.md b/doc/administration/settings/visibility_and_access_controls.md index 671d0a70bd9..e2f63a91cdc 100644 --- a/doc/administration/settings/visibility_and_access_controls.md +++ b/doc/administration/settings/visibility_and_access_controls.md @@ -4,7 +4,11 @@ group: Source Code info: "To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments" --- -# Control access and visibility **(FREE SELF)** +# Control access and visibility + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed GitLab enables users with administrator access to enforce specific controls on branches, projects, snippets, groups, and more. @@ -32,9 +36,13 @@ on the instance. To alter which roles have permission to create projects: - Developers and Maintainers. 1. Select **Save changes**. -## Restrict project deletion to administrators **(PREMIUM SELF)** +## Restrict project deletion to administrators -> User interface [changed](https://gitlab.com/gitlab-org/gitlab/-/issues/352960) in GitLab 15.1. +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** Self-managed + +> - User interface [changed](https://gitlab.com/gitlab-org/gitlab/-/issues/352960) in GitLab 15.1. By default both administrators and anyone with the **Owner** role can delete a project. To restrict project deletion to only administrators: @@ -47,7 +55,11 @@ By default both administrators and anyone with the **Owner** role can delete a p - (GitLab 15.0 and earlier) **Default project deletion protection** and select **Only admins can delete project**. 1. Select **Save changes**. -## Deletion protection **(PREMIUM SELF)** +## Deletion protection + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** Self-managed > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/255449) in GitLab 14.2 for groups created after August 12, 2021. > - [Renamed](https://gitlab.com/gitlab-org/gitlab/-/issues/352960) from default delayed project deletion in GitLab 15.1. @@ -60,7 +72,7 @@ Instance-level protection against accidental deletion of groups and projects. ### Retention period -> [Changed](https://gitlab.com/gitlab-org/gitlab/-/issues/352960) in GitLab 15.1. +> - [Changed](https://gitlab.com/gitlab-org/gitlab/-/issues/352960) in GitLab 15.1. Groups and projects remain restorable within a defined retention period. By default this is 7 days but it can be changed. Setting the retention period to `0` means that groups and project are removed immediately and cannot be restored. @@ -231,7 +243,7 @@ from CI/CD jobs, even if you select **Only SSH**. ## Customize Git clone URL for HTTP(S) -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/18422) in GitLab 12.4. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/18422) in GitLab 12.4. You can customize project Git clone URLs for HTTP(S), which affects the clone panel: diff --git a/doc/administration/sidekiq/extra_sidekiq_processes.md b/doc/administration/sidekiq/extra_sidekiq_processes.md index bde60d17f0c..9f4c3cffb75 100644 --- a/doc/administration/sidekiq/extra_sidekiq_processes.md +++ b/doc/administration/sidekiq/extra_sidekiq_processes.md @@ -4,7 +4,11 @@ group: Distribution info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Run multiple Sidekiq processes **(FREE SELF)** +# Run multiple Sidekiq processes + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed GitLab allows you to start multiple Sidekiq processes to process background jobs at a higher rate on a single instance. By default, Sidekiq starts one worker diff --git a/doc/administration/sidekiq/index.md b/doc/administration/sidekiq/index.md index 6a6412a9944..73a6cf5cecf 100644 --- a/doc/administration/sidekiq/index.md +++ b/doc/administration/sidekiq/index.md @@ -4,7 +4,11 @@ group: Distribution info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Configure an external Sidekiq instance **(FREE SELF)** +# Configure an external Sidekiq instance + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed You can configure an external Sidekiq instance by using the Sidekiq that's bundled in the GitLab package. Sidekiq requires connection to the Redis, PostgreSQL, and Gitaly instances. @@ -246,7 +250,7 @@ To configure the metrics server: ### Enable HTTPS -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/364771) in GitLab 15.2. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/364771) in GitLab 15.2. To serve metrics via HTTPS instead of HTTP, enable TLS in the exporter settings: diff --git a/doc/administration/sidekiq/processing_specific_job_classes.md b/doc/administration/sidekiq/processing_specific_job_classes.md index 26f3445f62c..59dc041e903 100644 --- a/doc/administration/sidekiq/processing_specific_job_classes.md +++ b/doc/administration/sidekiq/processing_specific_job_classes.md @@ -312,7 +312,7 @@ query syntax is employed by both [routing rules](#routing-rules) and ### Available attributes -> [Introduced](https://gitlab.com/gitlab-com/gl-infra/scalability/-/issues/261) in GitLab 13.1 (`tags`). +> - [Introduced](https://gitlab.com/gitlab-com/gl-infra/scalability/-/issues/261) in GitLab 13.1 (`tags`). Queue matching query works upon the worker attributes, described in [Sidekiq style guide](../../development/sidekiq/index.md). We support querying diff --git a/doc/administration/sidekiq/sidekiq_health_check.md b/doc/administration/sidekiq/sidekiq_health_check.md index 9da4a59dc42..4c164e6eee7 100644 --- a/doc/administration/sidekiq/sidekiq_health_check.md +++ b/doc/administration/sidekiq/sidekiq_health_check.md @@ -4,7 +4,11 @@ group: Distribution info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Sidekiq Health Check **(FREE SELF)** +# Sidekiq Health Check + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed GitLab provides liveness and readiness probes to indicate service health and reachability to the Sidekiq cluster. These endpoints diff --git a/doc/administration/sidekiq/sidekiq_job_migration.md b/doc/administration/sidekiq/sidekiq_job_migration.md index ef79ed8eded..a455ceae4ef 100644 --- a/doc/administration/sidekiq/sidekiq_job_migration.md +++ b/doc/administration/sidekiq/sidekiq_job_migration.md @@ -4,7 +4,11 @@ group: unassigned info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Sidekiq job migration Rake tasks **(FREE SELF)** +# Sidekiq job migration Rake tasks + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed WARNING: This operation should be very uncommon. We do not recommend it for the vast majority of GitLab instances. diff --git a/doc/administration/sidekiq/sidekiq_troubleshooting.md b/doc/administration/sidekiq/sidekiq_troubleshooting.md index 591d1e5f64d..be33ccf4358 100644 --- a/doc/administration/sidekiq/sidekiq_troubleshooting.md +++ b/doc/administration/sidekiq/sidekiq_troubleshooting.md @@ -4,7 +4,11 @@ group: Distribution info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Troubleshooting Sidekiq **(FREE SELF)** +# Troubleshooting Sidekiq + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed Sidekiq is the background job processor GitLab uses to asynchronously run tasks. When things go wrong it can be difficult to troubleshoot. These @@ -474,7 +478,7 @@ end ## Canceling running jobs (destructive) -> Introduced in GitLab 12.3. +> - Introduced in GitLab 12.3. This is highly risky operation and use it as last resort. Doing that might result in data corruption, as the job diff --git a/doc/administration/silent_mode/index.md b/doc/administration/silent_mode/index.md index f72b715ac5e..1edbef835b1 100644 --- a/doc/administration/silent_mode/index.md +++ b/doc/administration/silent_mode/index.md @@ -4,7 +4,11 @@ group: Geo info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# GitLab Silent Mode **(FREE SELF)** +# GitLab Silent Mode + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed > - [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/9826) in GitLab 15.11. This feature was an [Experiment](../../policy/experiment-beta-support.md#experiment). > - Enabling and disabling Silent Mode through the web UI was [introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/131090) in GitLab 16.4. diff --git a/doc/administration/smime_signing_email.md b/doc/administration/smime_signing_email.md index 5e303fc79a8..bc2e2f19558 100644 --- a/doc/administration/smime_signing_email.md +++ b/doc/administration/smime_signing_email.md @@ -4,7 +4,11 @@ group: Distribution info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Signing outgoing email with S/MIME **(FREE SELF)** +# Signing outgoing email with S/MIME + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed Notification emails sent by GitLab can be signed with S/MIME for improved security. diff --git a/doc/administration/snippets/index.md b/doc/administration/snippets/index.md index 6b53c2b1d10..5344f6e2e7b 100644 --- a/doc/administration/snippets/index.md +++ b/doc/administration/snippets/index.md @@ -4,7 +4,11 @@ group: Source Code info: "To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments" --- -# Snippets **(FREE SELF)** +# Snippets + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed You can configure a maximum size for a snippet to prevent abuse. The default limit is 52428800 bytes (50 MB). diff --git a/doc/administration/static_objects_external_storage.md b/doc/administration/static_objects_external_storage.md index 258af6b045b..8bccb865a4c 100644 --- a/doc/administration/static_objects_external_storage.md +++ b/doc/administration/static_objects_external_storage.md @@ -4,9 +4,13 @@ group: IDE info: "To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments" --- -# External storage for static objects **(FREE SELF)** +# External storage for static objects -> [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/31025) in GitLab 12.3. +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/31025) in GitLab 12.3. Configure GitLab to serve repository static objects (such as archives or raw blobs) from external storage such as a content delivery network (CDN). diff --git a/doc/administration/system_hooks.md b/doc/administration/system_hooks.md index 57a23a25a08..56d6c6c58f1 100644 --- a/doc/administration/system_hooks.md +++ b/doc/administration/system_hooks.md @@ -4,7 +4,11 @@ group: Import and Integrate info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# System hooks **(FREE SELF)** +# System hooks + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed System hooks (not to be confused with [server hooks](server_hooks.md) or [file hooks](file_hooks.md)) perform HTTP POST requests and are triggered on the following events: diff --git a/doc/administration/terraform_state.md b/doc/administration/terraform_state.md index 0a993542847..9cafd453797 100644 --- a/doc/administration/terraform_state.md +++ b/doc/administration/terraform_state.md @@ -4,9 +4,13 @@ group: Environments info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Terraform state administration **(FREE SELF)** +# Terraform state administration -> [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/2673) in GitLab 12.10. +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed + +> - [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/2673) in GitLab 12.10. GitLab can be used as a backend for [Terraform](../user/infrastructure/index.md) state files. The files are encrypted before being stored. This feature is enabled by default. @@ -90,7 +94,11 @@ For self-compiled installations: 1. Save the file and [restart GitLab](restart_gitlab.md#self-compiled-installations) for the changes to take effect. -## Using object storage **(FREE SELF)** +## Using object storage + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed Instead of storing Terraform state files on disk, we recommend the use of [one of the supported object storage options](object_storage.md#supported-object-storage-providers). @@ -113,7 +121,7 @@ The following settings are: ### Migrate to object storage -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/247042) in GitLab 13.9. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/247042) in GitLab 13.9. WARNING: It's not possible to migrate Terraform state files from object storage back to local storage, diff --git a/doc/administration/timezone.md b/doc/administration/timezone.md index c5f4fed4ef8..e0ee4a8aeea 100644 --- a/doc/administration/timezone.md +++ b/doc/administration/timezone.md @@ -4,7 +4,11 @@ group: Distribution info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Changing your time zone **(FREE SELF)** +# Changing your time zone + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed The global time zone configuration parameter can be changed in `config/gitlab.yml`: diff --git a/doc/administration/troubleshooting/diagnostics_tools.md b/doc/administration/troubleshooting/diagnostics_tools.md index b9e77e72c65..4a30e0a9295 100644 --- a/doc/administration/troubleshooting/diagnostics_tools.md +++ b/doc/administration/troubleshooting/diagnostics_tools.md @@ -4,7 +4,11 @@ group: Distribution info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Diagnostics tools **(FREE SELF)** +# Diagnostics tools + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed These are some of the diagnostics tools the GitLab Support team uses during troubleshooting. They are listed here for transparency, and for users with experience diff --git a/doc/administration/troubleshooting/gitlab_rails_cheat_sheet.md b/doc/administration/troubleshooting/gitlab_rails_cheat_sheet.md index 57b2df000b1..253e493ad49 100644 --- a/doc/administration/troubleshooting/gitlab_rails_cheat_sheet.md +++ b/doc/administration/troubleshooting/gitlab_rails_cheat_sheet.md @@ -4,7 +4,11 @@ group: Distribution info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# GitLab Rails Console Cheat Sheet **(FREE SELF)** +# GitLab Rails Console Cheat Sheet + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed This was the GitLab Support Team's collection of information regarding the GitLab Rails console, for use while troubleshooting. It is listed here for posterity, diff --git a/doc/administration/troubleshooting/index.md b/doc/administration/troubleshooting/index.md index a59429f1aee..5284831604c 100644 --- a/doc/administration/troubleshooting/index.md +++ b/doc/administration/troubleshooting/index.md @@ -4,7 +4,11 @@ group: Distribution info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Troubleshooting a GitLab installation **(FREE SELF)** +# Troubleshooting a GitLab installation + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed This page documents a collection of resources to help you troubleshoot a GitLab installation. diff --git a/doc/administration/troubleshooting/linux_cheat_sheet.md b/doc/administration/troubleshooting/linux_cheat_sheet.md index 6255cae3a30..8b8de470401 100644 --- a/doc/administration/troubleshooting/linux_cheat_sheet.md +++ b/doc/administration/troubleshooting/linux_cheat_sheet.md @@ -4,7 +4,11 @@ group: Distribution info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Linux cheat sheet **(FREE SELF)** +# Linux cheat sheet + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed This is the GitLab Support Team's collection of information regarding Linux, that they sometimes use while troubleshooting. It is listed here for transparency, diff --git a/doc/administration/troubleshooting/postgresql.md b/doc/administration/troubleshooting/postgresql.md index 75fd807643c..0c033eea347 100644 --- a/doc/administration/troubleshooting/postgresql.md +++ b/doc/administration/troubleshooting/postgresql.md @@ -4,7 +4,11 @@ group: Database info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# PostgreSQL **(FREE SELF)** +# PostgreSQL + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed This page contains information about PostgreSQL the GitLab Support team uses when troubleshooting. GitLab makes this information public, so that anyone can diff --git a/doc/administration/troubleshooting/test_environments.md b/doc/administration/troubleshooting/test_environments.md index 1d148a654b8..d7f265c1185 100644 --- a/doc/administration/troubleshooting/test_environments.md +++ b/doc/administration/troubleshooting/test_environments.md @@ -4,7 +4,11 @@ group: Distribution info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Apps for a testing environment **(FREE SELF)** +# Apps for a testing environment + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed This is the GitLab Support Team's collection of information regarding testing environments, for use while troubleshooting. It is listed here for transparency, and it may be useful diff --git a/doc/administration/uploads.md b/doc/administration/uploads.md index 95454ef629c..f213c373ac1 100644 --- a/doc/administration/uploads.md +++ b/doc/administration/uploads.md @@ -4,7 +4,11 @@ group: Distribution info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Uploads administration **(FREE SELF)** +# Uploads administration + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed Uploads represent all user data that may be sent to GitLab as a single file. For example, avatars and note attachments are uploads. Uploads are integral to GitLab functionality and therefore cannot be disabled. @@ -54,7 +58,11 @@ _The uploads are stored by default in 1. Save the file and [restart GitLab](restart_gitlab.md#self-compiled-installations) for the changes to take effect. -## Using object storage **(FREE SELF)** +## Using object storage + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed If you don't want to use the local disk where GitLab is installed to store the uploads, you can use an object storage provider like AWS S3 instead. diff --git a/doc/administration/user_cohorts.md b/doc/administration/user_cohorts.md index fb9adc67dc0..f11d46cd8d4 100644 --- a/doc/administration/user_cohorts.md +++ b/doc/administration/user_cohorts.md @@ -4,7 +4,11 @@ group: unassigned info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Cohorts **(FREE SELF)** +# Cohorts + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed You can analyze your users' GitLab activities over time. diff --git a/doc/administration/user_settings.md b/doc/administration/user_settings.md index ec6dab525ac..8e425cb87bd 100644 --- a/doc/administration/user_settings.md +++ b/doc/administration/user_settings.md @@ -4,7 +4,11 @@ group: Authentication info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Modify global user settings **(FREE SELF)** +# Modify global user settings + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed GitLab administrators can modify user settings for the entire GitLab instance. diff --git a/doc/administration/whats-new.md b/doc/administration/whats-new.md index 8af9387f821..fee10037f8b 100644 --- a/doc/administration/whats-new.md +++ b/doc/administration/whats-new.md @@ -4,7 +4,11 @@ group: unassigned info: For assistance with this What's new page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments-to-other-projects-and-subjects. --- -# What's new **(FREE ALL)** +# What's new + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed You can view some of the highlights from the last 10 GitLab versions in the **What's new** feature. It lists new features available in different diff --git a/doc/administration/wikis/index.md b/doc/administration/wikis/index.md index abbb968e35d..5719f876db2 100644 --- a/doc/administration/wikis/index.md +++ b/doc/administration/wikis/index.md @@ -4,13 +4,17 @@ group: Knowledge info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Wiki settings **(FREE SELF)** +# Wiki settings + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed Adjust the wiki settings of your GitLab instance. ## Wiki page content size limit -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/31176) in GitLab 13.2. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/31176) in GitLab 13.2. You can set a maximum content size limit for wiki pages. This limit can prevent abuse of the feature. The default value is **52428800 Bytes** (50 MB). @@ -83,7 +87,7 @@ read the documentation on [reducing repository size](../../user/project/reposito ## Allow URI includes for AsciiDoc -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/348687) in GitLab 16.1. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/348687) in GitLab 16.1. Include directives import content from separate pages or external URLs, and display them as part of the content of the current document. To enable diff --git a/doc/api/access_requests.md b/doc/api/access_requests.md index 3d3bddb3970..d1edee93c67 100644 --- a/doc/api/access_requests.md +++ b/doc/api/access_requests.md @@ -4,7 +4,11 @@ group: Authentication info: "To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments" --- -# Group and project access requests API **(FREE ALL)** +# Group and project access requests API + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed ## Valid access levels diff --git a/doc/api/admin_sidekiq_queues.md b/doc/api/admin_sidekiq_queues.md index 6240063e401..fbb5bfa5e62 100644 --- a/doc/api/admin_sidekiq_queues.md +++ b/doc/api/admin_sidekiq_queues.md @@ -4,9 +4,13 @@ group: Distribution info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Sidekiq queues administration API **(FREE SELF)** +# Sidekiq queues administration API -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/25998) in GitLab 12.9 +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/25998) in GitLab 12.9 Delete jobs from a Sidekiq queue that match the given [metadata](../development/logging.md#logging-context-metadata-through-rails-or-grape-requests). diff --git a/doc/api/alert_management_alerts.md b/doc/api/alert_management_alerts.md index 1b213640f6c..7a5271ce4ea 100644 --- a/doc/api/alert_management_alerts.md +++ b/doc/api/alert_management_alerts.md @@ -4,7 +4,11 @@ group: Respond info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Alert Management alerts API **(FREE ALL)** +# Alert Management alerts API + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed The Alert Management alerts API is limited to metric images. For more API endpoints, see the [GraphQL API](graphql/reference/index.md#alertmanagementalert). diff --git a/doc/api/api_resources.md b/doc/api/api_resources.md index cf08c34655b..7081fe26007 100644 --- a/doc/api/api_resources.md +++ b/doc/api/api_resources.md @@ -4,7 +4,11 @@ group: Import and Integrate info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# REST API resources **(FREE ALL)** +# REST API resources + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed Available resources for the [GitLab REST API](index.md) can be grouped in the following contexts: diff --git a/doc/api/appearance.md b/doc/api/appearance.md index bf08581639b..8503df20711 100644 --- a/doc/api/appearance.md +++ b/doc/api/appearance.md @@ -4,9 +4,13 @@ group: Authentication info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Appearance API **(FREE SELF)** +# Appearance API -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/16647) in GitLab 12.7. +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/16647) in GitLab 12.7. The appearance API allows you to maintain the appearance of GitLab as if you're using the GitLab UI at `/admin/appearance`. The API requires diff --git a/doc/api/applications.md b/doc/api/applications.md index be526aec8f8..234cd63ccee 100644 --- a/doc/api/applications.md +++ b/doc/api/applications.md @@ -4,9 +4,13 @@ group: Authentication info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Applications API **(FREE ALL)** +# Applications API -> [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/8160) in GitLab 10.5. +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/8160) in GitLab 10.5. The Applications API operates on instance-wide OAuth applications for: diff --git a/doc/api/audit_events.md b/doc/api/audit_events.md index 2676a343a15..c6a7b67a58e 100644 --- a/doc/api/audit_events.md +++ b/doc/api/audit_events.md @@ -4,12 +4,20 @@ group: Compliance info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Audit Events API **(PREMIUM ALL)** +# Audit Events API + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/121) in GitLab 12.4. > - [Author Email added to the response body](https://gitlab.com/gitlab-org/gitlab/-/issues/386322) in GitLab 15.9. -## Instance Audit Events **(PREMIUM SELF)** +## Instance Audit Events + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** Self-managed Use this API to retrieve instance audit events. @@ -279,7 +287,7 @@ Example response: ## Project Audit Events -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/219238) in GitLab 13.1. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/219238) in GitLab 13.1. Use this API to retrieve project audit events. diff --git a/doc/api/avatar.md b/doc/api/avatar.md index fe6ad8f589f..0203440b077 100644 --- a/doc/api/avatar.md +++ b/doc/api/avatar.md @@ -4,9 +4,13 @@ group: Authentication info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Avatar API **(FREE ALL)** +# Avatar API -> [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/19121) in GitLab 11.0. +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/19121) in GitLab 11.0. ## Get a single avatar URL diff --git a/doc/api/boards.md b/doc/api/boards.md index 0562e59bcb6..5b927916a19 100644 --- a/doc/api/boards.md +++ b/doc/api/boards.md @@ -4,7 +4,11 @@ group: Project Management info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Project issue boards API **(FREE ALL)** +# Project issue boards API + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed Every API call to [issue boards](../user/project/issue_board.md) must be authenticated. @@ -215,7 +219,7 @@ Example response: ## Update an issue board -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/5954) in GitLab 11.1. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/5954) in GitLab 11.1. Updates a project issue board. diff --git a/doc/api/branches.md b/doc/api/branches.md index f5fe7d0526c..ee1633361da 100644 --- a/doc/api/branches.md +++ b/doc/api/branches.md @@ -4,7 +4,11 @@ group: Source Code info: "To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments" --- -# Branches API **(FREE ALL)** +# Branches API + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed This API operates on [repository branches](../user/project/repository/branches/index.md). diff --git a/doc/api/broadcast_messages.md b/doc/api/broadcast_messages.md index 7ee8ed3eed9..4866b3e2867 100644 --- a/doc/api/broadcast_messages.md +++ b/doc/api/broadcast_messages.md @@ -4,7 +4,11 @@ group: Acquisition info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Broadcast Messages API **(FREE SELF)** +# Broadcast Messages API + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed > - `target_access_levels` [introduced](https://gitlab.com/gitlab-org/growth/team-tasks/-/issues/461) in GitLab 14.8 [with a flag](../administration/feature_flags.md) named `role_targeted_broadcast_messages`. Disabled by default. > - `color` parameter [removed](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/95829) in GitLab 15.6. @@ -16,7 +20,11 @@ As of GitLab 12.8, GET requests do not require authentication. All other broadca - Guests result in `401 Unauthorized`. - Regular users result in `403 Forbidden`. -## Get all broadcast messages **(FREE ALL)** +## Get all broadcast messages + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed List all broadcast messages. @@ -49,7 +57,11 @@ Example response: ] ``` -## Get a specific broadcast message **(FREE ALL)** +## Get a specific broadcast message + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed Get a specific broadcast message. diff --git a/doc/api/bulk_imports.md b/doc/api/bulk_imports.md index 6419c56ce34..040409a7ae9 100644 --- a/doc/api/bulk_imports.md +++ b/doc/api/bulk_imports.md @@ -4,7 +4,11 @@ group: Import and Integrate info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Group and project migration by direct transfer API **(FREE ALL)** +# Group and project migration by direct transfer API + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/64335) in GitLab 14.1. > - Project migration [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/390515) in GitLab 15.11. @@ -284,7 +288,7 @@ curl --request GET --header "PRIVATE-TOKEN: " "https://gitlab ## Get list of failed import records for group or project migration entity -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/428016) in GitLab 16.6. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/428016) in GitLab 16.6. ```plaintext GET /bulk_imports/:id/entities/:entity_id/failures diff --git a/doc/api/cluster_agents.md b/doc/api/cluster_agents.md index e1241eb572c..6016008f618 100644 --- a/doc/api/cluster_agents.md +++ b/doc/api/cluster_agents.md @@ -4,7 +4,11 @@ group: Environments info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Agents API **(FREE ALL)** +# Agents API + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/83270) in GitLab 14.10. > - Agent Tokens API [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/347046) in GitLab 15.0. @@ -240,7 +244,7 @@ curl --request DELETE --header "Private-Token: " "https://git ## List tokens for an agent -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/347046) in GitLab 15.0. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/347046) in GitLab 15.0. Returns a list of active tokens for an agent. @@ -307,7 +311,7 @@ The `last_used_at` field for a token is only returned when getting a single agen ## Get a single agent token -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/347046) in GitLab 15.0. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/347046) in GitLab 15.0. Gets a single agent token. @@ -433,7 +437,7 @@ Example response: ## Revoke an agent token -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/347046) in GitLab 15.0. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/347046) in GitLab 15.0. Revokes an agent token. diff --git a/doc/api/code_suggestions.md b/doc/api/code_suggestions.md index 307dc112028..fa56f71c095 100644 --- a/doc/api/code_suggestions.md +++ b/doc/api/code_suggestions.md @@ -10,7 +10,7 @@ Use the Code Suggestions API to access the Code Suggestions feature. ## Create an access token -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/404427) in GitLab 16.1. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/404427) in GitLab 16.1. Creates an access token to access Code Suggestions. @@ -34,7 +34,10 @@ Example response: } ``` -## Generate code completions **(EXPERIMENT)** +## Generate code completions + +DETAILS: +**Status:** Experiment > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/415581) in GitLab 16.2 [with a flag](../administration/feature_flags.md) named `code_suggestions_completion_api`. Disabled by default. This feature is an Experiment. > - Requirement to generate a JWT before calling this endpoint was [removed](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/127863) in GitLab 16.3. diff --git a/doc/api/commits.md b/doc/api/commits.md index 43d59129366..280e1bde9cf 100644 --- a/doc/api/commits.md +++ b/doc/api/commits.md @@ -4,7 +4,11 @@ group: Source Code info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Commits API **(FREE ALL)** +# Commits API + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed This API operates on [repository commits](https://git-scm.com/book/en/v2/Git-Basics-Recording-Changes-to-the-Repository). Read more about [GitLab-specific information](../user/project/repository/index.md#commit-changes-to-a-repository) for commits. diff --git a/doc/api/container_registry.md b/doc/api/container_registry.md index 9ad52fa3c3a..bfac48a4f10 100644 --- a/doc/api/container_registry.md +++ b/doc/api/container_registry.md @@ -4,7 +4,11 @@ group: Container Registry info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Container registry API **(FREE ALL)** +# Container registry API + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed > - The ability to authenticate with a CI/CD job token [introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/49750) in GitLab 13.12 [with a flag](../administration/feature_flags.md) named `ci_job_token_scope`. Disabled by default. > - CI/CD job token authentication [generally available](https://gitlab.com/gitlab-org/gitlab/-/issues/300821) in GitLab 16.8. Feature flag `ci_job_token_scope` removed. @@ -17,7 +21,7 @@ of the project that created the pipeline. ## Change the visibility of the container registry -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/18792) in GitLab 14.2. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/18792) in GitLab 14.2. This controls who can view the container registry. @@ -162,7 +166,7 @@ Example response: ## Get details of a single repository -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/209916) in GitLab 13.6. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/209916) in GitLab 13.6. Get details of a registry repository. diff --git a/doc/api/custom_attributes.md b/doc/api/custom_attributes.md index 735c4ebb239..e99e1d823a4 100644 --- a/doc/api/custom_attributes.md +++ b/doc/api/custom_attributes.md @@ -4,7 +4,11 @@ group: Project Management info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Custom Attributes API **(FREE SELF)** +# Custom Attributes API + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed Every API call to custom attributes must be authenticated as administrator. diff --git a/doc/api/database_migrations.md b/doc/api/database_migrations.md index 0786e801b9c..ca29d6a16c2 100644 --- a/doc/api/database_migrations.md +++ b/doc/api/database_migrations.md @@ -4,9 +4,13 @@ group: Database info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Database migrations API **(FREE SELF)** +# Database migrations API -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/123408) in GitLab 16.2. +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/123408) in GitLab 16.2. This API is for managing database migrations used in the development of GitLab. diff --git a/doc/api/dependencies.md b/doc/api/dependencies.md index 5b0b92467c0..98f0ecdd757 100644 --- a/doc/api/dependencies.md +++ b/doc/api/dependencies.md @@ -4,7 +4,11 @@ group: Composition Analysis info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Dependencies API **(ULTIMATE ALL)** +# Dependencies API + +DETAILS: +**Tier:** Ultimate +**Offering:** SaaS, self-managed WARNING: This API is in an [Experiment](../policy/experiment-beta-support.md#experiment) and considered unstable. diff --git a/doc/api/dependency_list_export.md b/doc/api/dependency_list_export.md index d53f997a363..4b8c4449ac3 100644 --- a/doc/api/dependency_list_export.md +++ b/doc/api/dependency_list_export.md @@ -4,7 +4,11 @@ group: Threat Insights info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Dependency list export API **(ULTIMATE ALL)** +# Dependency list export API + +DETAILS: +**Tier:** Ultimate +**Offering:** SaaS, self-managed Every call to this endpoint requires authentication. diff --git a/doc/api/dependency_proxy.md b/doc/api/dependency_proxy.md index b187a939236..964c1c508bc 100644 --- a/doc/api/dependency_proxy.md +++ b/doc/api/dependency_proxy.md @@ -4,7 +4,11 @@ group: Container Registry info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Dependency Proxy API **(FREE ALL)** +# Dependency Proxy API + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed ## Purge the dependency proxy for a group diff --git a/doc/api/deploy_keys.md b/doc/api/deploy_keys.md index d4b31991af4..c5505585987 100644 --- a/doc/api/deploy_keys.md +++ b/doc/api/deploy_keys.md @@ -4,14 +4,22 @@ group: Environments info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Deploy keys API **(FREE ALL)** +# Deploy keys API + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed The deploy keys API can return in responses fingerprints of the public key in the following fields: - `fingerprint` (MD5 hash). Not available on FIPS-enabled systems. - `fingerprint_sha256` (SHA256 hash). [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/91302) in GitLab 15.2. -## List all deploy keys **(FREE SELF)** +## List all deploy keys + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed > `projects_with_readonly_access` [introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/119147) in GitLab 16.0. @@ -137,7 +145,7 @@ Example response: ## List project deploy keys for user -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/88917) in GitLab 15.1. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/88917) in GitLab 15.1. Get a list of a specified user (requestee) and the authenticated user's (requester) common [project deploy keys](../user/project/deploy_keys/index.md#scope). It lists only the **enabled project keys from the common projects of requester and requestee**. diff --git a/doc/api/deploy_tokens.md b/doc/api/deploy_tokens.md index aa8460872fc..0c0d8ed4dcb 100644 --- a/doc/api/deploy_tokens.md +++ b/doc/api/deploy_tokens.md @@ -4,11 +4,19 @@ group: Environments info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Deploy Tokens API **(FREE ALL)** +# Deploy Tokens API -## List all deploy tokens **(FREE SELF)** +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/21811) in GitLab 12.9. +## List all deploy tokens + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/21811) in GitLab 12.9. Get a list of all deploy tokens across the GitLab instance. This endpoint requires administrator access. @@ -54,7 +62,7 @@ for the project. ### List project deploy tokens -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/21811) in GitLab 12.9. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/21811) in GitLab 12.9. Get a list of a project's deploy tokens. @@ -96,7 +104,7 @@ Example response: ### Get a project deploy token -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/82467) in GitLab 14.9. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/82467) in GitLab 14.9. Get a single project's deploy token by ID. @@ -136,7 +144,7 @@ Example response: ### Create a project deploy token -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/21811) in GitLab 12.9. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/21811) in GitLab 12.9. Creates a new deploy token for a project. @@ -181,7 +189,7 @@ Example response: ### Delete a project deploy token -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/21811) in GitLab 12.9. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/21811) in GitLab 12.9. Removes a deploy token from the project. @@ -210,7 +218,7 @@ tokens. Only group Owners can create and delete group deploy tokens. ### List group deploy tokens -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/21811) in GitLab 12.9. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/21811) in GitLab 12.9. Get a list of a group's deploy tokens @@ -252,7 +260,7 @@ Example response: ### Get a group deploy token -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/82467) in GitLab 14.9. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/82467) in GitLab 14.9. Get a single group's deploy token by ID. @@ -292,7 +300,7 @@ Example response: ### Create a group deploy token -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/21811) in GitLab 12.9. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/21811) in GitLab 12.9. Creates a new deploy token for a group. @@ -337,7 +345,7 @@ Example response: ### Delete a group deploy token -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/21811) in GitLab 12.9. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/21811) in GitLab 12.9. Removes a deploy token from the group. diff --git a/doc/api/deployments.md b/doc/api/deployments.md index ca2f5f78e38..2d234d20e4a 100644 --- a/doc/api/deployments.md +++ b/doc/api/deployments.md @@ -4,7 +4,11 @@ group: Environments info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Deployments API **(FREE ALL)** +# Deployments API + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed > Support for [GitLab CI/CD job token](../ci/jobs/ci_job_token.md) authentication [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/414549) in GitLab 16.2. @@ -510,7 +514,7 @@ Example responses: ## List of merge requests associated with a deployment -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/35739) in GitLab 12.7. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/35739) in GitLab 12.7. NOTE: Not all deployments can be associated with merge requests. See @@ -529,7 +533,11 @@ It supports the same parameters as the [Merge Requests API](merge_requests.md#li curl --header "PRIVATE-TOKEN: " "https://gitlab.example.com/api/v4/projects/1/deployments/42/merge_requests" ``` -## Approve or reject a blocked deployment **(PREMIUM ALL)** +## Approve or reject a blocked deployment + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/343864) in GitLab 14.7 [with a flag](../administration/feature_flags.md) named `deployment_approvals`. Disabled by default. > - [Feature flag removed](https://gitlab.com/gitlab-org/gitlab/-/issues/347342) in GitLab 14.8. diff --git a/doc/api/discussions.md b/doc/api/discussions.md index b12131e4746..23fb1e8bfa9 100644 --- a/doc/api/discussions.md +++ b/doc/api/discussions.md @@ -4,7 +4,11 @@ group: Source Code info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Discussions API **(FREE ALL)** +# Discussions API + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed Discussions are a set of related notes on: @@ -457,7 +461,11 @@ curl --request DELETE --header "PRIVATE-TOKEN: " \ "https://gitlab.example.com/api/v4/projects/5/snippets/11/discussions/636" ``` -## Epics **(ULTIMATE ALL)** +## Epics + +DETAILS: +**Tier:** Ultimate +**Offering:** SaaS, self-managed ### List group epic discussion items diff --git a/doc/api/dora/metrics.md b/doc/api/dora/metrics.md index 93ce6a1de30..d040151f726 100644 --- a/doc/api/dora/metrics.md +++ b/doc/api/dora/metrics.md @@ -4,7 +4,11 @@ group: Optimize info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# DevOps Research and Assessment (DORA) key metrics API **(ULTIMATE ALL)** +# DevOps Research and Assessment (DORA) key metrics API + +DETAILS: +**Tier:** Ultimate +**Offering:** SaaS, self-managed > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/279039) in GitLab 13.10. > - The legacy key/value pair `{ "" => "" }` was removed from the payload in GitLab 14.0. @@ -54,7 +58,7 @@ Example response: ## Get group-level DORA metrics -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/279039) in GitLab 13.10. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/279039) in GitLab 13.10. Get group-level DORA metrics. diff --git a/doc/api/draft_notes.md b/doc/api/draft_notes.md index 753f2064ff8..55c16911dec 100644 --- a/doc/api/draft_notes.md +++ b/doc/api/draft_notes.md @@ -4,7 +4,11 @@ group: Code Review info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Draft Notes API **(FREE ALL)** +# Draft Notes API + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed Draft notes are pending, unpublished comments on merge requests. They can be either start a discussion, or be associated with an existing discussion as a reply. They are viewable only by the author until they are published. diff --git a/doc/api/emoji_reactions.md b/doc/api/emoji_reactions.md index dc944b54003..8269ed45056 100644 --- a/doc/api/emoji_reactions.md +++ b/doc/api/emoji_reactions.md @@ -4,7 +4,11 @@ group: Project Management info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Emoji reactions API **(FREE ALL)** +# Emoji reactions API + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed > [Renamed](https://gitlab.com/gitlab-org/gitlab/-/issues/409884) from "award emoji" to "emoji reactions" in GitLab 16.0. diff --git a/doc/api/environments.md b/doc/api/environments.md index 95ed65a4885..65d7a6f3277 100644 --- a/doc/api/environments.md +++ b/doc/api/environments.md @@ -4,7 +4,11 @@ group: Environments info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Environments API **(FREE ALL)** +# Environments API + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed > Support for [GitLab CI/CD job token](../ci/jobs/ci_job_token.md) authentication [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/414549) in GitLab 16.2. @@ -256,7 +260,7 @@ curl --request DELETE --header "PRIVATE-TOKEN: " "https://git ## Delete multiple stopped review apps -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/296625) in GitLab 14.2. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/296625) in GitLab 14.2. It schedules for deletion multiple environments that have already been [stopped](../ci/environments/index.md#stopping-an-environment) and diff --git a/doc/api/epic_issues.md b/doc/api/epic_issues.md index b22048d2ec8..a74c0fd4b53 100644 --- a/doc/api/epic_issues.md +++ b/doc/api/epic_issues.md @@ -4,7 +4,11 @@ group: Product Planning info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Epic Issues API **(PREMIUM ALL)** +# Epic Issues API + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed Every API call to the epic issues API endpoint must be authenticated. diff --git a/doc/api/epic_links.md b/doc/api/epic_links.md index 80ad3506a8a..a8eace4fdbb 100644 --- a/doc/api/epic_links.md +++ b/doc/api/epic_links.md @@ -4,9 +4,13 @@ group: Product Planning info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Epic Links API **(ULTIMATE ALL)** +# Epic Links API -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/9188) in GitLab 11.8. +DETAILS: +**Tier:** Ultimate +**Offering:** SaaS, self-managed + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/9188) in GitLab 11.8. Manages parent-child [epic relationships](../user/group/epics/manage_epics.md#multi-level-child-epics). diff --git a/doc/api/epics.md b/doc/api/epics.md index 2798e74bea8..38f607bd0c4 100644 --- a/doc/api/epics.md +++ b/doc/api/epics.md @@ -4,7 +4,11 @@ group: Product Planning info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Epics API **(PREMIUM ALL)** +# Epics API + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed > - Introduced in [GitLab Ultimate](https://about.gitlab.com/pricing/) 10.2. > - Single-level Epics [were moved](https://gitlab.com/gitlab-org/gitlab/-/issues/37081) to [GitLab Premium](https://about.gitlab.com/pricing/) in 12.8. @@ -21,7 +25,7 @@ The [epic issues API](epic_issues.md) allows you to interact with issues associa ## Milestone dates integration -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/6448) in GitLab 11.3. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/6448) in GitLab 11.3. Because start date and due date can be dynamically sourced from related issue milestones, additional fields are shown when user has edit permission. These include two boolean diff --git a/doc/api/error_tracking.md b/doc/api/error_tracking.md index ff612e4bd9c..739ab238d15 100644 --- a/doc/api/error_tracking.md +++ b/doc/api/error_tracking.md @@ -4,9 +4,13 @@ group: Observability info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Error Tracking settings API **(FREE ALL)** +# Error Tracking settings API -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/34940) in GitLab 12.7. +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/34940) in GitLab 12.7. ## Error Tracking project settings @@ -111,7 +115,7 @@ Example response: ## Error Tracking client keys -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/68384) in GitLab 14.3. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/68384) in GitLab 14.3. For [integrated error tracking](https://gitlab.com/gitlab-org/gitlab/-/issues/329596) feature. Only for users with the Maintainer role for the project. diff --git a/doc/api/events.md b/doc/api/events.md index 5e9301a6550..ddb24663718 100644 --- a/doc/api/events.md +++ b/doc/api/events.md @@ -4,7 +4,11 @@ group: Compliance info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Events API **(FREE ALL)** +# Events API + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed ## Filter parameters diff --git a/doc/api/experiments.md b/doc/api/experiments.md index d886a4e8e31..8fe39ecd0e6 100644 --- a/doc/api/experiments.md +++ b/doc/api/experiments.md @@ -4,9 +4,13 @@ group: Acquisition info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Experiments API (GitLab team only) **(FREE SAAS)** +# Experiments API (GitLab team only) -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/262725) in GitLab 13.5. +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/262725) in GitLab 13.5. This API is for listing A/B experiments [defined in GitLab](../development/experiment_guide/index.md). diff --git a/doc/api/feature_flag_user_lists.md b/doc/api/feature_flag_user_lists.md index 46ffbc3bb6b..da4986eb4a7 100644 --- a/doc/api/feature_flag_user_lists.md +++ b/doc/api/feature_flag_user_lists.md @@ -4,7 +4,11 @@ group: Environments info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Feature flag user lists API **(FREE ALL)** +# Feature flag user lists API + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/205409) in [GitLab Premium](https://about.gitlab.com/pricing/) 12.10. > - [Moved](https://gitlab.com/gitlab-org/gitlab/-/issues/212318) to GitLab Free in 13.5. diff --git a/doc/api/feature_flags.md b/doc/api/feature_flags.md index c81a3131f4c..59252449832 100644 --- a/doc/api/feature_flags.md +++ b/doc/api/feature_flags.md @@ -4,7 +4,11 @@ group: Environments info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Feature flags API **(FREE ALL)** +# Feature flags API + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/9566) in GitLab Premium 12.5. > - [Moved](https://gitlab.com/gitlab-org/gitlab/-/issues/212318) to GitLab Free in 13.5. diff --git a/doc/api/features.md b/doc/api/features.md index 438963ca2be..9c0c0c92b50 100644 --- a/doc/api/features.md +++ b/doc/api/features.md @@ -4,7 +4,11 @@ group: Environments info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Feature flags API **(FREE SELF)** +# Feature flags API + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed This API is for managing Flipper-based [feature flags used in development of GitLab](../development/feature_flags/index.md). diff --git a/doc/api/freeze_periods.md b/doc/api/freeze_periods.md index e497ea19b6a..f6c71290394 100644 --- a/doc/api/freeze_periods.md +++ b/doc/api/freeze_periods.md @@ -4,9 +4,13 @@ group: Environments info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Freeze Periods API **(FREE ALL)** +# Freeze Periods API -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/29382) in GitLab 13.0. +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/29382) in GitLab 13.0. You can use the Freeze Periods API to manipulate GitLab [Freeze Period](../user/project/releases/index.md#prevent-unintentional-releases-by-setting-a-deploy-freeze) entries. diff --git a/doc/api/geo_nodes.md b/doc/api/geo_nodes.md index 3e6751fe740..3a9f1c8348a 100644 --- a/doc/api/geo_nodes.md +++ b/doc/api/geo_nodes.md @@ -4,7 +4,11 @@ group: Geo info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Geo Nodes API **(PREMIUM SELF)** +# Geo Nodes API + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** Self-managed To interact with Geo node endpoints, you must authenticate yourself as an administrator. diff --git a/doc/api/geo_sites.md b/doc/api/geo_sites.md index 8026e276202..e165ba54dc8 100644 --- a/doc/api/geo_sites.md +++ b/doc/api/geo_sites.md @@ -4,9 +4,13 @@ group: Geo info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Geo sites API **(PREMIUM SELF)** +# Geo sites API -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/369140) in GitLab 16.0. +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** Self-managed + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/369140) in GitLab 16.0. Use the Geo sites API to manage Geo site endpoints. diff --git a/doc/api/graphql/audit_report.md b/doc/api/graphql/audit_report.md index c9c2de8e850..300dc12c23c 100644 --- a/doc/api/graphql/audit_report.md +++ b/doc/api/graphql/audit_report.md @@ -4,7 +4,11 @@ group: Compliance info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Set up an Audit Report with GraphQL **(FREE ALL)** +# Set up an Audit Report with GraphQL + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed This page describes how you can use the GraphiQL explorer to set up an audit report for a specific subset of users. diff --git a/doc/api/graphql/branch_rules.md b/doc/api/graphql/branch_rules.md index f5f2a714ec6..edafda8e541 100644 --- a/doc/api/graphql/branch_rules.md +++ b/doc/api/graphql/branch_rules.md @@ -4,9 +4,13 @@ group: Source Code info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# List branch rules for a project **(FREE ALL)** +# List branch rules for a project -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/106954) in GitLab 15.8. +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/106954) in GitLab 15.8. This guide demonstrates how to use [GraphiQL explorer](getting_started.md#graphiql) to query for branch rules in a given project. diff --git a/doc/api/graphql/custom_emoji.md b/doc/api/graphql/custom_emoji.md index ef0db847091..e96f34d6d8a 100644 --- a/doc/api/graphql/custom_emoji.md +++ b/doc/api/graphql/custom_emoji.md @@ -4,7 +4,11 @@ group: Project Management info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Use custom emoji with GraphQL **(FREE ALL)** +# Use custom emoji with GraphQL + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/37911) in GitLab 13.6 [with a flag](../../administration/feature_flags.md) named `custom_emoji`. Disabled by default. > - Enabled on GitLab.com in GitLab 14.0. diff --git a/doc/api/graphql/getting_started.md b/doc/api/graphql/getting_started.md index 868059fb979..bee9a2b62f0 100644 --- a/doc/api/graphql/getting_started.md +++ b/doc/api/graphql/getting_started.md @@ -4,7 +4,11 @@ group: Import and Integrate info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Run GraphQL API queries and mutations **(FREE ALL)** +# Run GraphQL API queries and mutations + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed This guide demonstrates basic usage of the GitLab GraphQL API. @@ -63,7 +67,11 @@ curl "https://gitlab.com/api/graphql" --header "Authorization: Bearer $GRAPHQL_T # or "{\"query\": \"query {project(fullPath: \\\"//\\\") {jobs {nodes {id duration}}}}\"}" ``` -### Rails console **(FREE SELF)** +### Rails console + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed GraphQL queries can be run in a [Rails console session](../../administration/operations/rails_console.md#starting-a-rails-console-session). For example, to search projects: diff --git a/doc/api/graphql/index.md b/doc/api/graphql/index.md index 4f0811924aa..63dae176a77 100644 --- a/doc/api/graphql/index.md +++ b/doc/api/graphql/index.md @@ -5,7 +5,11 @@ description: Programmatic interaction with GitLab. info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# GraphQL API **(FREE ALL)** +# GraphQL API + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed [GraphQL](https://graphql.org/) is a query language for APIs. You can use it to request the exact data you need, and therefore limit the number of requests you need. @@ -171,7 +175,7 @@ process would pose significant risk. ### Verify against the future breaking-change schema -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/353642) in GitLab 15.6. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/353642) in GitLab 15.6. You can make calls against the GraphQL API as if all deprecated items were already removed. This way, you can verify API calls ahead of a [breaking-change release](#deprecation-and-removal-process) diff --git a/doc/api/graphql/removed_items.md b/doc/api/graphql/removed_items.md index ec4d783f3fb..9a8f5c1d130 100644 --- a/doc/api/graphql/removed_items.md +++ b/doc/api/graphql/removed_items.md @@ -4,7 +4,11 @@ group: Import and Integrate info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# GraphQL API removed items **(FREE ALL)** +# GraphQL API removed items + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed GraphQL is a versionless API, unlike the REST API. Occasionally, items have to be updated or removed from the GraphQL API. diff --git a/doc/api/graphql/sample_issue_boards.md b/doc/api/graphql/sample_issue_boards.md index 7ee209dc9ad..28245913352 100644 --- a/doc/api/graphql/sample_issue_boards.md +++ b/doc/api/graphql/sample_issue_boards.md @@ -4,7 +4,11 @@ group: Project Management info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Identify issue boards with GraphQL **(FREE ALL)** +# Identify issue boards with GraphQL + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed This page describes how you can use the GraphiQL explorer to identify existing [issue boards](../../user/project/issue_board.md) in the `gitlab-docs` documentation repository. diff --git a/doc/api/graphql/users_example.md b/doc/api/graphql/users_example.md index 479824964dc..ef3cb4ba58b 100644 --- a/doc/api/graphql/users_example.md +++ b/doc/api/graphql/users_example.md @@ -4,7 +4,11 @@ group: Authentication info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Query users with GraphQL **(FREE ALL)** +# Query users with GraphQL + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed This page describes how you can use the GraphiQL explorer to query users. diff --git a/doc/api/group_access_tokens.md b/doc/api/group_access_tokens.md index 621b3241de2..457ebb19cba 100644 --- a/doc/api/group_access_tokens.md +++ b/doc/api/group_access_tokens.md @@ -4,13 +4,17 @@ group: Authentication info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Group access tokens API **(FREE ALL)** +# Group access tokens API + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed You can read more about [group access tokens](../user/group/settings/group_access_tokens.md). ## List group access tokens -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/77236) in GitLab 14.7. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/77236) in GitLab 14.7. Get a list of [group access tokens](../user/group/settings/group_access_tokens.md). @@ -46,7 +50,7 @@ curl --header "PRIVATE-TOKEN: " "https://gitlab.example.com/a ## Get a group access token -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/82714) in GitLab 14.10. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/82714) in GitLab 14.10. Get a [group access token](../user/group/settings/group_access_tokens.md) by ID. @@ -126,7 +130,7 @@ curl --request POST --header "PRIVATE-TOKEN: " \ ## Rotate a group access token -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/403042) in GitLab 16.0 +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/403042) in GitLab 16.0 Rotate a group access token. Revokes the previous token and creates a new token that expires in one week. @@ -180,7 +184,7 @@ for more information. ## Revoke a group access token -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/77236) in GitLab 14.7. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/77236) in GitLab 14.7. Revoke a [group access token](../user/group/settings/group_access_tokens.md). diff --git a/doc/api/group_activity_analytics.md b/doc/api/group_activity_analytics.md index 65228c37b58..788f4590b57 100644 --- a/doc/api/group_activity_analytics.md +++ b/doc/api/group_activity_analytics.md @@ -4,9 +4,13 @@ group: Optimize info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Group Activity Analytics API **(PREMIUM ALL)** +# Group Activity Analytics API -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/26460) in GitLab 12.9. +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/26460) in GitLab 12.9. ## Get count of recently created issues for group diff --git a/doc/api/group_badges.md b/doc/api/group_badges.md index a7ecc993e37..fa80cbd7b24 100644 --- a/doc/api/group_badges.md +++ b/doc/api/group_badges.md @@ -4,9 +4,13 @@ group: Tenant Scale info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Group badges API **(FREE ALL)** +# Group badges API -> [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/17082) in GitLab 10.6. +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/17082) in GitLab 10.6. ## Placeholder tokens diff --git a/doc/api/group_boards.md b/doc/api/group_boards.md index 3c97c67b079..156e218d7c4 100644 --- a/doc/api/group_boards.md +++ b/doc/api/group_boards.md @@ -4,7 +4,11 @@ group: Project Management info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Group issue boards API **(FREE ALL)** +# Group issue boards API + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed Every API call to [group issue boards](../user/project/issue_board.md#group-issue-boards) must be authenticated. @@ -242,7 +246,11 @@ Example response: } ``` -## Create a group issue board **(PREMIUM ALL)** +## Create a group issue board + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed Creates a group issue board. @@ -281,7 +289,7 @@ Example response: ## Update a group issue board -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/5954) in GitLab 11.1. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/5954) in GitLab 11.1. Updates a group issue board. @@ -349,7 +357,11 @@ Example response: } ``` -## Delete a group issue board **(PREMIUM ALL)** +## Delete a group issue board + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed Deletes a group issue board. diff --git a/doc/api/group_clusters.md b/doc/api/group_clusters.md index 32a427f9a0f..ab7dbe44f47 100644 --- a/doc/api/group_clusters.md +++ b/doc/api/group_clusters.md @@ -4,7 +4,11 @@ group: Environments info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Group clusters API (certificate-based) (deprecated) **(FREE ALL)** +# Group clusters API (certificate-based) (deprecated) + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed > - [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/30213) in GitLab 12.1. > - [Deprecated](https://gitlab.com/groups/gitlab-org/configure/-/epics/8) in GitLab 14.5. diff --git a/doc/api/group_epic_boards.md b/doc/api/group_epic_boards.md index 4ad7a20d2d7..2eb488b94ee 100644 --- a/doc/api/group_epic_boards.md +++ b/doc/api/group_epic_boards.md @@ -4,9 +4,13 @@ group: Product Planning info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Group epic boards API **(PREMIUM ALL)** +# Group epic boards API -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/385903) in GitLab 15.9. +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/385903) in GitLab 15.9. Every API call to [group epic boards](../user/group/epics/epic_boards.md#epic-boards) must be authenticated. @@ -178,7 +182,7 @@ Example response: ## List group epic board lists -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/385904) in GitLab 15.9. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/385904) in GitLab 15.9. Gets a list of the epic board's lists. Does not include `open` and `closed` lists. @@ -238,7 +242,7 @@ Example response: ## Single group epic board list -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/385904) in GitLab 15.9. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/385904) in GitLab 15.9. Gets a single board list. diff --git a/doc/api/group_import_export.md b/doc/api/group_import_export.md index 7e065dd87d2..3209f5c051e 100644 --- a/doc/api/group_import_export.md +++ b/doc/api/group_import_export.md @@ -4,7 +4,11 @@ group: Import and Integrate info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Group import and export API **(FREE ALL)** +# Group import and export API + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed Use the group import and export API to export a group structure and import it to a new location. When you use the group import and export API with the [project import and export API](project_import_export.md), you can preserve connections with @@ -17,7 +21,7 @@ Group exports include the following: - Group labels - Group badges - Group members -- Group wikis **(PREMIUM SELF)** +- Group wikis (Premium and Ultimate only) - Subgroups. Each subgroup includes all data above To preserve group-level relationships from imported projects, you should run group export and import first. This way, diff --git a/doc/api/group_iterations.md b/doc/api/group_iterations.md index 0ceef8267f5..836c662359a 100644 --- a/doc/api/group_iterations.md +++ b/doc/api/group_iterations.md @@ -4,7 +4,11 @@ group: Project Management info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Group iterations API **(PREMIUM ALL)** +# Group iterations API + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/118742) in GitLab 13.5. > - Moved to GitLab Premium in 13.9. diff --git a/doc/api/group_labels.md b/doc/api/group_labels.md index 36d14c87819..96bd97f2a3b 100644 --- a/doc/api/group_labels.md +++ b/doc/api/group_labels.md @@ -4,9 +4,13 @@ group: Project Management info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Group labels API **(FREE ALL)** +# Group labels API -> [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/21368) in GitLab 11.8. +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/21368) in GitLab 11.8. This API supports managing [group labels](../user/project/labels.md#types-of-labels). It allows users to list, create, update, and delete group labels. Furthermore, users can subscribe to and diff --git a/doc/api/group_level_variables.md b/doc/api/group_level_variables.md index 68474a2aec7..510c53b8134 100644 --- a/doc/api/group_level_variables.md +++ b/doc/api/group_level_variables.md @@ -4,7 +4,11 @@ group: Pipeline Security info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Group-level Variables API **(FREE ALL)** +# Group-level Variables API + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed ## List group variables @@ -183,9 +187,13 @@ curl --request DELETE --header "PRIVATE-TOKEN: " \ "https://gitlab.example.com/api/v4/groups/1/variables/VARIABLE_1" ``` -## The `filter` parameter **(PREMIUM ALL)** +## The `filter` parameter -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/340185) in GitLab 16.9. +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/340185) in GitLab 16.9. When multiple variables have the same `key`, [GET](#show-variable-details), [PUT](#update-variable), or [DELETE](#remove-variable) requests might return: diff --git a/doc/api/group_milestones.md b/doc/api/group_milestones.md index 57994e069a5..db6d0cfc61f 100644 --- a/doc/api/group_milestones.md +++ b/doc/api/group_milestones.md @@ -4,7 +4,11 @@ group: Project Management info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Group milestones API **(FREE ALL)** +# Group milestones API + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed Use the group [milestones](../user/project/milestones/index.md) using the REST API. There's a separate [project milestones API](milestones.md) page. @@ -168,7 +172,11 @@ Parameters: | `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-path-encoding) owned by the authenticated user | | `milestone_id` | integer | yes | The ID of a group milestone | -## Get all burndown chart events for a single milestone **(PREMIUM ALL)** +## Get all burndown chart events for a single milestone + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/4737) in GitLab 12.1 > - Moved to GitLab Premium in 13.9. diff --git a/doc/api/group_protected_branches.md b/doc/api/group_protected_branches.md index 844156f80b0..7f283680ea6 100644 --- a/doc/api/group_protected_branches.md +++ b/doc/api/group_protected_branches.md @@ -4,7 +4,11 @@ group: Source Code info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Group-level protected branches API **(PREMIUM SELF)** +# Group-level protected branches API + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** Self-managed > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/110603) in GitLab 15.9 [with a flag](../administration/feature_flags.md) named `group_protected_branches`. Disabled by default. > - Flag `group_protected_branches` [renamed](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/116779) [flag](../administration/feature_flags.md) to `allow_protected_branches_for_group` GitLab 15.11. diff --git a/doc/api/group_protected_environments.md b/doc/api/group_protected_environments.md index 81d4738bdfd..f7b7455fb71 100644 --- a/doc/api/group_protected_environments.md +++ b/doc/api/group_protected_environments.md @@ -4,7 +4,11 @@ group: Environments info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Group-level protected environments API **(PREMIUM ALL)** +# Group-level protected environments API + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/215888) in GitLab 14.0. [Deployed behind the `group_level_protected_environments` flag](../administration/feature_flags.md), disabled by default. > - [Feature flag `group_level_protected_environments`](https://gitlab.com/gitlab-org/gitlab/-/issues/331085) removed in GitLab 14.3. @@ -150,7 +154,7 @@ to `production` only after the QA group `"group_id": 134` and security group ## Update a protected environment -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/351854) in GitLab 15.4. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/351854) in GitLab 15.4. Updates a single environment. diff --git a/doc/api/group_relations_export.md b/doc/api/group_relations_export.md index bd48fb13ec6..7100068b914 100644 --- a/doc/api/group_relations_export.md +++ b/doc/api/group_relations_export.md @@ -4,9 +4,13 @@ group: Import and Integrate info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Group relations export API **(FREE ALL)** +# Group relations export API -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/59978) in GitLab 13.12. +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/59978) in GitLab 13.12. The group relations export API partially exports a group's structure as separate files for each top-level diff --git a/doc/api/group_releases.md b/doc/api/group_releases.md index d32d8db4b85..a56bceffee4 100644 --- a/doc/api/group_releases.md +++ b/doc/api/group_releases.md @@ -4,7 +4,11 @@ group: Environments info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Group releases API **(FREE ALL)** +# Group releases API + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed Review your groups' [releases](../user/project/releases/index.md) with the REST API. diff --git a/doc/api/group_repository_storage_moves.md b/doc/api/group_repository_storage_moves.md index 4f168aa73f7..2b338f0cf12 100644 --- a/doc/api/group_repository_storage_moves.md +++ b/doc/api/group_repository_storage_moves.md @@ -4,9 +4,13 @@ group: IDE info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Group repository storage moves API **(PREMIUM SELF)** +# Group repository storage moves API -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/53016) in GitLab 13.9. +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** Self-managed + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/53016) in GitLab 13.9. Group wiki repositories can be moved between storages. This API can help you, for example, [migrate to Gitaly Cluster](../administration/gitaly/index.md#migrate-to-gitaly-cluster) diff --git a/doc/api/group_ssh_certificates.md b/doc/api/group_ssh_certificates.md index b6ffabb7749..c39a9988618 100644 --- a/doc/api/group_ssh_certificates.md +++ b/doc/api/group_ssh_certificates.md @@ -4,9 +4,13 @@ group: Source Code info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Group SSH certificates API **(PREMIUM SAAS)** +# Group SSH certificates API -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/421915) in GitLab 16.4 [with a flag](../user/feature_flags.md) named `ssh_certificates_rest_endpoints`. Disabled by default. +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/421915) in GitLab 16.4 [with a flag](../user/feature_flags.md) named `ssh_certificates_rest_endpoints`. Disabled by default. FLAG: On GitLab.com, this feature is not available. diff --git a/doc/api/group_wikis.md b/doc/api/group_wikis.md index 1b10523abfd..72841d78f5b 100644 --- a/doc/api/group_wikis.md +++ b/doc/api/group_wikis.md @@ -4,7 +4,11 @@ group: Knowledge info: "To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments" --- -# Group wikis API **(PREMIUM ALL)** +# Group wikis API + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/212199) in GitLab 13.5. > - The `encoding` field was [added](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/81150) in GitLab 14.9. diff --git a/doc/api/groups.md b/doc/api/groups.md index 1193f36d2fe..2e5ba9f0c79 100644 --- a/doc/api/groups.md +++ b/doc/api/groups.md @@ -4,7 +4,11 @@ group: Tenant Scale info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Groups API **(FREE ALL)** +# Groups API + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed Interact with [groups](../user/group/index.md) by using the REST API. @@ -204,7 +208,7 @@ Users of [GitLab Premium or Ultimate](https://about.gitlab.com/pricing/) also se ## List a group's descendant groups -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/217115) in GitLab 13.5 +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/217115) in GitLab 13.5 Get a list of visible descendant groups of this group. When accessed without authentication, only public groups are returned. @@ -319,7 +323,7 @@ Parameters: | `include_subgroups` | boolean | no | Include projects in subgroups of this group. Default is `false` | | `min_access_level` | integer | no | Limit to projects where current user has at least this [role (`access_level`)](members.md#roles) | | `with_custom_attributes` | boolean | no | Include [custom attributes](custom_attributes.md) in response (administrators only) | -| `with_security_reports` **(ULTIMATE ALL)** | boolean | no | Return only projects that have security reports artifacts present in any of their builds. This means "projects with security reports enabled". Default is `false` | +| `with_security_reports` | boolean | no | Return only projects that have security reports artifacts present in any of their builds. This means "projects with security reports enabled". Default is `false`. Ultimate only. | Footnotes: @@ -792,7 +796,11 @@ curl --header "PRIVATE-TOKEN: $GITLAB_LOCAL_TOKEN" \ "https://gitlab.example.com/api/v4/groups/4/avatar" ``` -### Disable the results limit **(FREE SELF)** +### Disable the results limit + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed The 100 results limit can break integrations developed using GitLab 12.4 and earlier. @@ -910,7 +918,7 @@ curl --request POST --header "PRIVATE-TOKEN: " \ ## Get groups to which a user can transfer a group -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/371117) in GitLab 15.4 +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/371117) in GitLab 15.4 Retrieve a list of groups to which the user can transfer a group. @@ -954,7 +962,7 @@ Example response: ## Transfer a group to a new parent group / Turn a subgroup to a top-level group -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/23831) in GitLab 14.6. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/23831) in GitLab 14.6. Transfer a group to a new parent group or turn a subgroup to a top-level group. Available to administrators and users: @@ -1115,7 +1123,11 @@ The `prevent_sharing_groups_outside_hierarchy` attribute is present in the respo Users of [GitLab Premium or Ultimate](https://about.gitlab.com/pricing/) also see the `wiki_access_level` attribute. -### Disable the results limit **(FREE SELF)** +### Disable the results limit + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed The 100 results limit can break integrations developed using GitLab 12.4 and earlier. @@ -1143,7 +1155,7 @@ The `shared_runners_setting` attribute determines whether shared runners are ena ### Upload a group avatar -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/36681) in GitLab 12.9. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/36681) in GitLab 12.9. To upload an avatar file from your file system, use the `--form` argument. This causes curl to post data using the header `Content-Type: multipart/form-data`. The @@ -1157,7 +1169,7 @@ curl --request PUT --header "PRIVATE-TOKEN: " "https://gitlab ### Remove a group avatar -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/96421) in GitLab 15.4. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/96421) in GitLab 15.4. To remove a group avatar, use a blank value for the `avatar` attribute. @@ -1200,9 +1212,13 @@ The response is `202 Accepted` if the user has authorization. NOTE: A GitLab.com group can't be removed if it is linked to a subscription. To remove such a group, first [link the subscription](../subscriptions/gitlab_com/index.md#change-the-linked-namespace) with a different group. -## Restore group marked for deletion **(PREMIUM ALL)** +## Restore group marked for deletion -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/33257) in GitLab 12.8. +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/33257) in GitLab 12.8. Restores a group marked for deletion. @@ -1235,9 +1251,13 @@ GET /groups?search=foobar ] ``` -## List provisioned users **(PREMIUM ALL)** +## List provisioned users -> Introduced in GitLab 14.8. +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed + +> - Introduced in GitLab 14.8. Get a list of users provisioned by a given group. Does not include subgroups. @@ -1308,9 +1328,14 @@ Example response: ] ``` -## List group users **(PREMIUM ALL EXPERIMENT)** +## List group users -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/424505) in GitLab 16.6. This feature is an [Experiment](../policy/experiment-beta-support.md). +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed +**Status:** Experiment + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/424505) in GitLab 16.6. This feature is an [Experiment](../policy/experiment-beta-support.md). Get a list of users for a group. This endpoint returns users that are related to a top-level group regardless of their current membership. For example, users that have a SAML identity connected to the group, or service accounts created @@ -1389,11 +1414,15 @@ Example response: ] ``` -## Service Accounts **(PREMIUM ALL)** +## Service Accounts + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed ### Create Service Account User -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/407775) in GitLab 16.1. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/407775) in GitLab 16.1. Creates a service account user with an auto-generated email address and username. @@ -1417,7 +1446,7 @@ Example response: ### Create Personal Access Token for Service Account User -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/406781) in GitLab 16.1. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/406781) in GitLab 16.1. ```plaintext POST /groups/:id/service_accounts/:user_id/personal_access_tokens @@ -1450,7 +1479,7 @@ Example response: ### Rotate a Personal Access Token for Service Account User -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/406781) in GitLab 16.1. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/406781) in GitLab 16.1. ```plaintext POST /groups/:id/service_accounts/:user_id/personal_access_tokens/:token_id/rotate @@ -1477,7 +1506,11 @@ Example response: } ``` -## Hooks **(PREMIUM ALL)** +## Hooks + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed Also called Group Hooks and Webhooks. These are different from [System Hooks](system_hooks.md) that are system wide and [Project Hooks](projects.md#hooks) that are limited to one project. @@ -1609,11 +1642,19 @@ DELETE /groups/:id/hooks/:hook_id | `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-path-encoding) | | `hook_id` | integer | yes | The ID of the group hook. | -## Group Audit Events **(PREMIUM ALL)** +## Group Audit Events + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed Group audit events can be accessed via the [Group Audit Events API](audit_events.md#group-audit-events) -## Sync group with LDAP **(PREMIUM SELF)** +## Sync group with LDAP + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** Self-managed Syncs the group with its linked LDAP group. Only available to group owners and administrators. @@ -1633,7 +1674,11 @@ See the [Group Members](members.md) documentation. List, add, and delete LDAP group links. -### List LDAP group links **(PREMIUM SELF)** +### List LDAP group links + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** Self-managed Lists LDAP group links. @@ -1645,7 +1690,11 @@ GET /groups/:id/ldap_group_links | --------- | -------------- | -------- | ----------- | | `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-path-encoding) | -### Add LDAP group link with CN or filter **(PREMIUM SELF)** +### Add LDAP group link with CN or filter + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** Self-managed Adds an LDAP group link using a CN or filter. Adding a group link by filter is only supported in the Premium tier and above. @@ -1664,7 +1713,11 @@ POST /groups/:id/ldap_group_links NOTE: To define the LDAP group link, provide either a `cn` or a `filter`, but not both. -### Delete LDAP group link **(PREMIUM SELF)** +### Delete LDAP group link + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** Self-managed Deletes an LDAP group link. Deprecated. Scheduled for removal in a future release. @@ -1689,7 +1742,11 @@ DELETE /groups/:id/ldap_group_links/:provider/:cn | `cn` | string | yes | The CN of an LDAP group | | `provider` | string | yes | LDAP provider for the LDAP group link | -### Delete LDAP group link with CN or filter **(PREMIUM SELF)** +### Delete LDAP group link with CN or filter + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** Self-managed Deletes an LDAP group link using a CN or filter. Deleting by filter is only supported in the Premium tier and above. @@ -1707,7 +1764,11 @@ DELETE /groups/:id/ldap_group_links NOTE: To delete the LDAP group link, provide either a `cn` or a `filter`, but not both. -## SAML Group Links **(PREMIUM ALL)** +## SAML Group Links + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/290367) in GitLab 15.3.0. > - `access_level` type [changed](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/95607) from `string` to `integer` in GitLab 15.3.3. @@ -1922,9 +1983,13 @@ DELETE /groups/:id/share/:group_id | `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-path-encoding) | | `group_id` | integer | yes | The ID of the group to share with | -## Push Rules **(PREMIUM ALL)** +## Push Rules -> Introduced in GitLab 13.4. +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed + +> - Introduced in GitLab 13.4. ### Get group push rules diff --git a/doc/api/import.md b/doc/api/import.md index e378958077a..61d7273b872 100644 --- a/doc/api/import.md +++ b/doc/api/import.md @@ -4,7 +4,11 @@ group: Import and Integrate info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Import API **(FREE ALL)** +# Import API + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed Use the Import API to import repositories from GitHub or Bitbucket Server. @@ -80,7 +84,7 @@ Example response: ### Import a public project through the API using a group access token -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/362683) in GitLab 15.7, projects are not imported into a [bot user's](../user/group/settings/group_access_tokens.md#bot-users-for-groups) namespace in any circumstances. Projects imported into a bot user's namespace could not be deleted by users with valid tokens, which represented a security risk. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/362683) in GitLab 15.7, projects are not imported into a [bot user's](../user/group/settings/group_access_tokens.md#bot-users-for-groups) namespace in any circumstances. Projects imported into a bot user's namespace could not be deleted by users with valid tokens, which represented a security risk. When you import a project from GitHub to GitLab through the API using a group access token: @@ -90,7 +94,7 @@ token: ### Cancel GitHub project import -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/364783) in GitLab 15.5. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/364783) in GitLab 15.5. Cancel an in-progress GitHub project import using the API. diff --git a/doc/api/index.md b/doc/api/index.md index 68ad4aa2e32..cb0304b53c7 100644 --- a/doc/api/index.md +++ b/doc/api/index.md @@ -4,7 +4,11 @@ group: Import and Integrate info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Extend with GitLab **(FREE ALL)** +# Extend with GitLab + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed Automate with GitLab and integrate with external applications. diff --git a/doc/api/instance_clusters.md b/doc/api/instance_clusters.md index 51be27856b3..d6ec91b1c78 100644 --- a/doc/api/instance_clusters.md +++ b/doc/api/instance_clusters.md @@ -4,7 +4,11 @@ group: Environments info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Instance clusters API (certificate-based) (deprecated) **(FREE SELF)** +# Instance clusters API (certificate-based) (deprecated) + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/36001) in GitLab 13.2. > - [Deprecated](https://gitlab.com/groups/gitlab-org/configure/-/epics/8) in GitLab 14.5. diff --git a/doc/api/instance_level_ci_variables.md b/doc/api/instance_level_ci_variables.md index ad78b192543..cef011fe103 100644 --- a/doc/api/instance_level_ci_variables.md +++ b/doc/api/instance_level_ci_variables.md @@ -4,7 +4,11 @@ group: Pipeline Security info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Instance-level CI/CD variables API **(FREE SELF)** +# Instance-level CI/CD variables API + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed ## List all instance variables diff --git a/doc/api/integrations.md b/doc/api/integrations.md index d94e0836d69..0ba22c15e32 100644 --- a/doc/api/integrations.md +++ b/doc/api/integrations.md @@ -4,7 +4,11 @@ group: Import and Integrate info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Integrations API **(FREE ALL)** +# Integrations API + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed This API enables you to work with external services that integrate with GitLab. @@ -325,7 +329,7 @@ GET /projects/:id/integrations/campfire ## ClickUp -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/120732) in GitLab 16.1. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/120732) in GitLab 16.1. ### Set up ClickUp @@ -696,7 +700,11 @@ Get the external wiki settings for a project. GET /projects/:id/integrations/external-wiki ``` -## GitHub **(PREMIUM ALL)** +## GitHub + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed ### Set up GitHub @@ -1566,7 +1574,7 @@ Example response: ## Squash TM -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/337855) in GitLab 15.10. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/337855) in GitLab 15.10. ### Set up Squash TM diff --git a/doc/api/invitations.md b/doc/api/invitations.md index 036eeaa8185..89493beafb2 100644 --- a/doc/api/invitations.md +++ b/doc/api/invitations.md @@ -4,7 +4,11 @@ group: Acquisition info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Invitations API **(FREE ALL)** +# Invitations API + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed Use the Invitations API to invite or add users to a group or project, and to list pending invitations. @@ -43,7 +47,7 @@ POST /projects/:id/invitations | `access_level` | integer | yes | A valid access level | | `expires_at` | string | no | A date string in the format YEAR-MONTH-DAY | | `invite_source` | string | no | The source of the invitation that starts the member creation process. See [this issue](https://gitlab.com/gitlab-org/gitlab/-/issues/327120). | -| `member_role_id` **(ULTIMATE ALL)** | integer | no | Assigns the new member to the provided custom role. ([Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/134100) in GitLab 16.6. | +| `member_role_id` | integer | no | Assigns the new member to the provided custom role. ([Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/134100) in GitLab 16.6. Ultimate only. | ```shell curl --request POST --header "PRIVATE-TOKEN: " \ diff --git a/doc/api/issue_links.md b/doc/api/issue_links.md index f8be853d479..87a4dba80ce 100644 --- a/doc/api/issue_links.md +++ b/doc/api/issue_links.md @@ -4,7 +4,11 @@ group: Project Management info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Issue links API **(FREE ALL)** +# Issue links API + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed > The simple "relates to" relationship [moved](https://gitlab.com/gitlab-org/gitlab/-/issues/212329) to GitLab Free in 13.4. @@ -65,7 +69,7 @@ Parameters: ## Get an issue link -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/88228) in GitLab 15.1. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/88228) in GitLab 15.1. Gets details about an issue link. diff --git a/doc/api/issues.md b/doc/api/issues.md index c58ccbcb8cb..6302041a632 100644 --- a/doc/api/issues.md +++ b/doc/api/issues.md @@ -4,7 +4,11 @@ group: Project Management info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Issues API **(FREE ALL)** +# Issues API + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed Interact with [GitLab Issues](../user/project/issues/index.md) using the REST API. @@ -2015,7 +2019,11 @@ Example response: WARNING: The `assignee` column is deprecated. We now show it as a single-sized array `assignees` to conform to the GitLab EE API. -## Promote an issue to an epic **(PREMIUM ALL)** +## Promote an issue to an epic + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed Promotes an issue to an epic by adding a comment with the `/promote` [quick action](../user/project/quick_actions.md). diff --git a/doc/api/issues_statistics.md b/doc/api/issues_statistics.md index 6f82c9214f4..e0be56320d5 100644 --- a/doc/api/issues_statistics.md +++ b/doc/api/issues_statistics.md @@ -4,7 +4,11 @@ group: Project Management info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Issues statistics API **(FREE ALL)** +# Issues statistics API + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed Every API call to the [issues](../user/project/issues/index.md) statistics API must be authenticated. diff --git a/doc/api/iterations.md b/doc/api/iterations.md index b89d1eeb15e..186b7c0b774 100644 --- a/doc/api/iterations.md +++ b/doc/api/iterations.md @@ -4,7 +4,11 @@ group: Project Management info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Project iterations API **(PREMIUM ALL)** +# Project iterations API + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/118742) in GitLab 13.5. > - Moved to GitLab Premium in 13.9. diff --git a/doc/api/job_artifacts.md b/doc/api/job_artifacts.md index 2757aaf00db..38b2fd6851e 100644 --- a/doc/api/job_artifacts.md +++ b/doc/api/job_artifacts.md @@ -4,7 +4,11 @@ group: Pipeline Security info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Job Artifacts API **(FREE ALL)** +# Job Artifacts API + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed Use the job artifacts API to download or delete job artifacts. diff --git a/doc/api/jobs.md b/doc/api/jobs.md index 886f209520d..14b2e94b09c 100644 --- a/doc/api/jobs.md +++ b/doc/api/jobs.md @@ -4,7 +4,11 @@ group: Pipeline Execution info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Jobs API **(FREE ALL)** +# Jobs API + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed ## List project jobs @@ -504,7 +508,11 @@ Example of response } ``` -## Get GitLab agent by `CI_JOB_TOKEN` **(PREMIUM ALL)** +## Get GitLab agent by `CI_JOB_TOKEN` + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed Retrieve the job that generated the `CI_JOB_TOKEN`, along with a list of allowed [agents](../user/clusters/agent/index.md). diff --git a/doc/api/keys.md b/doc/api/keys.md index 3422104184c..38279f09437 100644 --- a/doc/api/keys.md +++ b/doc/api/keys.md @@ -4,7 +4,11 @@ group: Source Code info: "To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments" --- -# Keys API **(FREE ALL)** +# Keys API + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed If using a SHA256 fingerprint in an API call, you should URL-encode the fingerprint. diff --git a/doc/api/labels.md b/doc/api/labels.md index 74850b14581..db7df2ba4fb 100644 --- a/doc/api/labels.md +++ b/doc/api/labels.md @@ -4,7 +4,11 @@ group: Project Management info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Labels API **(FREE ALL)** +# Labels API + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed Interact with [labels](../user/project/labels.md) using the REST API. diff --git a/doc/api/license.md b/doc/api/license.md index 99304df0d1b..d042ca9c530 100644 --- a/doc/api/license.md +++ b/doc/api/license.md @@ -4,7 +4,11 @@ group: Utilization info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# License **(FREE SELF)** +# License + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed To interact with license endpoints, you need to authenticate yourself as an administrator. diff --git a/doc/api/linked_epics.md b/doc/api/linked_epics.md index 6492a16569e..7710516d11d 100644 --- a/doc/api/linked_epics.md +++ b/doc/api/linked_epics.md @@ -4,7 +4,11 @@ group: Product Planning info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Linked epics API **(ULTIMATE ALL)** +# Linked epics API + +DETAILS: +**Tier:** Ultimate +**Offering:** SaaS, self-managed > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/352493) in GitLab 14.9 [with a flag](../administration/feature_flags.md) named `related_epics_widget`. Enabled by default. > - [Feature flag `related_epics_widget`](https://gitlab.com/gitlab-org/gitlab/-/issues/357089) removed in GitLab 15.0. diff --git a/doc/api/lint.md b/doc/api/lint.md index 210cec67d8f..3998383aa90 100644 --- a/doc/api/lint.md +++ b/doc/api/lint.md @@ -4,7 +4,11 @@ group: Pipeline Authoring info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# CI Lint API **(FREE ALL)** +# CI Lint API + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed ## Validate the CI/CD configuration for a namespace diff --git a/doc/api/markdown.md b/doc/api/markdown.md index cce230f073b..43f9bac514e 100644 --- a/doc/api/markdown.md +++ b/doc/api/markdown.md @@ -4,7 +4,11 @@ group: Project Management info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Markdown API **(FREE ALL)** +# Markdown API + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed Convert Markdown content to HTML. @@ -12,7 +16,7 @@ Available only in APIv4. ## Required authentication -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/93727) in GitLab 15.3 [with a flag](../administration/feature_flags.md) named `authenticate_markdown_api`. Enabled by default. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/93727) in GitLab 15.3 [with a flag](../administration/feature_flags.md) named `authenticate_markdown_api`. Enabled by default. FLAG: On self-managed GitLab, by default this feature is enabled and authentication is required. diff --git a/doc/api/member_roles.md b/doc/api/member_roles.md index 2bfbc29081f..9edb94f14f3 100644 --- a/doc/api/member_roles.md +++ b/doc/api/member_roles.md @@ -4,7 +4,11 @@ group: Authentication info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Member roles API **(ULTIMATE ALL)** +# Member roles API + +DETAILS: +**Tier:** Ultimate +**Offering:** SaaS, self-managed > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/96996) in GitLab 15.4. [Deployed behind the `customizable_roles` flag](../administration/feature_flags.md), disabled by default. > - [Enabled by default](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/110810) in GitLab 15.9. diff --git a/doc/api/members.md b/doc/api/members.md index ead5b3d6be7..c6917eaa82f 100644 --- a/doc/api/members.md +++ b/doc/api/members.md @@ -4,7 +4,11 @@ group: Authentication info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Group and project members API **(FREE ALL)** +# Group and project members API + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed > `created_by` field [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/28789) in GitLab 14.10. @@ -261,7 +265,7 @@ Example response: ## Get a member of a group or project, including inherited and invited members -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/17744) in GitLab 12.4. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/17744) in GitLab 12.4. Gets a member of a group or project, including members inherited or invited through ancestor groups. See the corresponding [endpoint to list all inherited members](#list-all-members-of-a-group-or-project-including-inherited-and-invited-members) for details. @@ -308,7 +312,7 @@ Example response: ## List all billable members of a group -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/217384) in GitLab 13.5. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/217384) in GitLab 13.5. Gets a list of group members that count as billable. The list includes members in subgroups and projects. @@ -397,7 +401,7 @@ Example response: ## List memberships for a billable member of a group -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/321560) in GitLab 13.11. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/321560) in GitLab 13.11. Gets a list of memberships for a billable member of a group. @@ -479,7 +483,7 @@ curl --request DELETE --header "PRIVATE-TOKEN: " "https://git ## Change membership state of a user in a group -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/86705) in GitLab 15.0. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/86705) in GitLab 15.0. Changes the membership state of a user in a group. The state is applied to all subgroups and projects. @@ -522,7 +526,7 @@ POST /projects/:id/members | `access_level` | integer | yes | [A valid access level](access_requests.md#valid-access-levels) | | `expires_at` | string | no | A date string in the format `YEAR-MONTH-DAY` | | `invite_source` | string | no | The source of the invitation that starts the member creation process. GitLab team members can view more information in this confidential issue: `https://gitlab.com/gitlab-org/gitlab/-/issues/327120>`. | -| `member_role_id` | integer | no | The ID of a member role **(ULTIMATE ALL)** | +| `member_role_id` | integer | no | The ID of a member role. Ultimate only. | ```shell curl --request POST --header "PRIVATE-TOKEN: " \ @@ -572,7 +576,7 @@ PUT /projects/:id/members/:user_id | `user_id` | integer | yes | The user ID of the member | | `access_level` | integer | yes | A [valid access level](access_requests.md#valid-access-levels) | | `expires_at` | string | no | A date string in the format `YEAR-MONTH-DAY` | -| `member_role_id` | integer | no | The ID of a member role **(ULTIMATE ALL)** | +| `member_role_id` | integer | no | The ID of a member role. Ultimate only. | ```shell curl --request PUT --header "PRIVATE-TOKEN: " "https://gitlab.example.com/api/v4/groups/:id/members/:user_id?access_level=40" @@ -607,7 +611,7 @@ Example response: ### Set override flag for a member of a group -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/4875) in GitLab 13.0. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/4875) in GitLab 13.0. By default, the access level of LDAP group members is set to the value specified by LDAP through Group Sync. You can allow access level overrides by calling this endpoint. @@ -653,7 +657,7 @@ Example response: ### Remove override for a member of a group -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/4875) in GitLab 13.0. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/4875) in GitLab 13.0. Sets the override flag to false and allows LDAP Group Sync to reset the access level to the LDAP-prescribed value. @@ -764,7 +768,7 @@ curl --request POST --header "PRIVATE-TOKEN: " "https://gitla ## List pending members of a group and its subgroups and projects -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/332596) in GitLab 14.6. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/332596) in GitLab 14.6. For a group and its subgroups and projects, get a list of all members in an `awaiting` state and those who are invited but do not have a GitLab account. diff --git a/doc/api/merge_request_approvals.md b/doc/api/merge_request_approvals.md index 2f33040acb0..1054f48a5f3 100644 --- a/doc/api/merge_request_approvals.md +++ b/doc/api/merge_request_approvals.md @@ -4,7 +4,11 @@ group: Source Code info: "To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments" --- -# Merge request approvals API **(PREMIUM ALL)** +# Merge request approvals API + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed > - Changing approval configuration with the `/approvals` endpoint was [deprecated](https://gitlab.com/gitlab-org/gitlab/-/issues/11132) in GitLab 12.3. > - Endpoint `/approvals` [removed](https://gitlab.com/gitlab-org/gitlab/-/issues/353097) in GitLab 16.0. @@ -15,7 +19,7 @@ in the project. Must be authenticated for all endpoints. ## Group-level MR approvals **(EXPERIMENT)** -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/428051) in GitLab 16.7 [with a flag](../administration/feature_flags.md) named `approval_group_rules`. Disabled by default. This feature is an [Experiment](../policy/experiment-beta-support.md). +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/428051) in GitLab 16.7 [with a flag](../administration/feature_flags.md) named `approval_group_rules`. Disabled by default. This feature is an [Experiment](../policy/experiment-beta-support.md). FLAG: On self-managed GitLab, by default this feature is not available. To make it available, an administrator can [enable the feature flag](../administration/feature_flags.md) named `approval_group_rules`. @@ -132,7 +136,7 @@ Supported attributes: ### Change configuration -> Moved to GitLab Premium in 13.9. +> - Moved to GitLab Premium in 13.9. If you are allowed to, you can change approval configuration using the following endpoint: @@ -619,7 +623,7 @@ Supported attributes: ### Delete project-level rule -> Moved to GitLab Premium in 13.9. +> - Moved to GitLab Premium in 13.9. You can delete project approval rules using the following endpoint: @@ -640,7 +644,7 @@ Configuration for approvals on a specific merge request. Must be authenticated f ### Get Configuration -> Moved to GitLab Premium in 13.9. +> - Moved to GitLab Premium in 13.9. You can request information about a merge request's approval status using the following endpoint: @@ -686,7 +690,7 @@ Supported attributes: ### Get the approval state of merge requests -> Moved to GitLab Premium in 13.9. +> - Moved to GitLab Premium in 13.9. You can request information about a merge request's approval state by using the following endpoint: @@ -839,7 +843,7 @@ Supported attributes: ### Get a single merge request level rule -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/82767) in GitLab 14.10. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/82767) in GitLab 14.10. You can request information about a single merge request approval rule using the following endpoint: @@ -915,7 +919,7 @@ Supported attributes: ### Create merge request level rule -> Moved to GitLab Premium in 13.9. +> - Moved to GitLab Premium in 13.9. You can create merge request approval rules using the following endpoint: @@ -1000,7 +1004,7 @@ is used. ### Update merge request level rule -> Moved to GitLab Premium in 13.9. +> - Moved to GitLab Premium in 13.9. You can update merge request approval rules using the following endpoint: @@ -1087,7 +1091,7 @@ Supported attributes: ### Delete merge request level rule -> Moved to GitLab Premium in 13.9. +> - Moved to GitLab Premium in 13.9. You can delete merge request approval rules using the following endpoint: @@ -1108,7 +1112,7 @@ Supported attributes: ## Approve merge request -> Moved to GitLab Premium in 13.9. +> - Moved to GitLab Premium in 13.9. If you are allowed to, you can approve a merge request using the following endpoint: @@ -1171,7 +1175,7 @@ does not match, the response code is `409`. ## Unapprove merge request -> Moved to GitLab Premium in 13.9. +> - Moved to GitLab Premium in 13.9. If you did approve a merge request, you can unapprove it using the following endpoint: diff --git a/doc/api/merge_request_context_commits.md b/doc/api/merge_request_context_commits.md index a38a54c0fab..e809f04a6cf 100644 --- a/doc/api/merge_request_context_commits.md +++ b/doc/api/merge_request_context_commits.md @@ -4,7 +4,11 @@ group: Code Review info: "To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments" --- -# Merge request context commits API **(FREE ALL)** +# Merge request context commits API + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed ## List MR context commits diff --git a/doc/api/merge_requests.md b/doc/api/merge_requests.md index 58f972ed1c1..6eca137aba9 100644 --- a/doc/api/merge_requests.md +++ b/doc/api/merge_requests.md @@ -4,7 +4,11 @@ group: Code Review info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Merge requests API **(FREE ALL)** +# Merge requests API + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed > - `reference` was [deprecated](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/20354) in GitLab 12.7. > - `draft` was [introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/63473) as a replacement for `work_in_progress` in GitLab 14.0. diff --git a/doc/api/merge_trains.md b/doc/api/merge_trains.md index 7fdc145f67d..8d66e432eaf 100644 --- a/doc/api/merge_trains.md +++ b/doc/api/merge_trains.md @@ -4,7 +4,11 @@ group: Pipeline Execution info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Merge Trains API **(PREMIUM ALL)** +# Merge Trains API + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed Every API call for [merge train](../ci/pipelines/merge_trains.md) must be authenticated with at lease the Developer [role](../user/permissions.md). diff --git a/doc/api/metadata.md b/doc/api/metadata.md index 82506cba905..4f8892c983e 100644 --- a/doc/api/metadata.md +++ b/doc/api/metadata.md @@ -4,7 +4,11 @@ group: Environments info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Metadata API **(FREE ALL)** +# Metadata API + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/357032) in GitLab 15.2. > - `enterprise` [introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/103969) in GitLab 15.6. diff --git a/doc/api/metrics_dashboard_annotations.md b/doc/api/metrics_dashboard_annotations.md index cee41171dbe..01ed864528d 100644 --- a/doc/api/metrics_dashboard_annotations.md +++ b/doc/api/metrics_dashboard_annotations.md @@ -4,9 +4,13 @@ group: Respond info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Dashboard annotations API **(FREE ALL)** +# Dashboard annotations API -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/29089) in GitLab 12.10 behind a disabled feature flag. +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/29089) in GitLab 12.10 behind a disabled feature flag. Metrics dashboard annotations allow you to indicate events on your graphs at a single point in time or over a time span. diff --git a/doc/api/metrics_user_starred_dashboards.md b/doc/api/metrics_user_starred_dashboards.md index c04bc901a06..dfc8df49068 100644 --- a/doc/api/metrics_user_starred_dashboards.md +++ b/doc/api/metrics_user_starred_dashboards.md @@ -4,14 +4,18 @@ group: Respond info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# User-starred metrics dashboards API **(FREE ALL)** +# User-starred metrics dashboards API + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed The starred dashboard feature makes navigating to frequently-used dashboards easier by displaying favorited dashboards at the top of the select list. ## Add a star to a dashboard -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/31316) in GitLab 13.0. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/31316) in GitLab 13.0. ```plaintext POST /projects/:id/metrics/user_starred_dashboards @@ -42,7 +46,7 @@ Example Response: ## Remove a star from a dashboard -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/31892) in GitLab 13.0. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/31892) in GitLab 13.0. ```plaintext DELETE /projects/:id/metrics/user_starred_dashboards diff --git a/doc/api/milestones.md b/doc/api/milestones.md index 92268cece41..4cfe67fbc82 100644 --- a/doc/api/milestones.md +++ b/doc/api/milestones.md @@ -4,7 +4,11 @@ group: Project Management info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Project milestones API **(FREE ALL)** +# Project milestones API + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed Use project [milestones](../user/project/milestones/index.md) with the REST API. There's a separate [group milestones API](group_milestones.md) page. @@ -180,7 +184,11 @@ Parameters: | `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding) owned by the authenticated user | | `milestone_id` | integer | yes | The ID of the project's milestone | -## Get all burndown chart events for a single milestone **(PREMIUM ALL)** +## Get all burndown chart events for a single milestone + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/4737) in GitLab 12.1 > - Moved to GitLab Premium in 13.9. diff --git a/doc/api/namespaces.md b/doc/api/namespaces.md index 6d5e15934e9..59d1e5bf5e4 100644 --- a/doc/api/namespaces.md +++ b/doc/api/namespaces.md @@ -4,7 +4,11 @@ group: Authentication info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Namespaces API **(FREE ALL)** +# Namespaces API + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed Usernames and group names fall under a special category called [namespaces](../user/namespace/index.md). diff --git a/doc/api/notes.md b/doc/api/notes.md index 40592566079..f5073030473 100644 --- a/doc/api/notes.md +++ b/doc/api/notes.md @@ -4,7 +4,11 @@ group: Project Management info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Notes API **(FREE ALL)** +# Notes API + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed Notes are comments on: @@ -467,7 +471,11 @@ Parameters: curl --request DELETE --header "PRIVATE-TOKEN: " "https://gitlab.example.com/api/v4/projects/5/merge_requests/7/notes/1602" ``` -## Epics **(PREMIUM ALL)** +## Epics + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed ### List all epic notes diff --git a/doc/api/notification_settings.md b/doc/api/notification_settings.md index 3917d0b5f7e..4b874131a22 100644 --- a/doc/api/notification_settings.md +++ b/doc/api/notification_settings.md @@ -4,7 +4,11 @@ group: Project Management info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Notification settings API **(FREE ALL)** +# Notification settings API + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed Change [notification settings](../user/profile/notifications.md) using the REST API. @@ -38,7 +42,7 @@ If the `custom` level is used, specific email events can be controlled. Availabl - `success_pipeline` - `moved_project` - `merge_when_pipeline_succeeds` -- `new_epic` **(ULTIMATE ALL)** +- `new_epic` Ultimate only. ## Global notification settings @@ -94,7 +98,7 @@ curl --request PUT --header "PRIVATE-TOKEN: " "https://gitlab | `success_pipeline` | boolean | no | Enable/disable this notification | | `moved_project` | boolean | no | Enable/disable this notification ([Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/30371) in GitLab 13.3) | | `merge_when_pipeline_succeeds` | boolean | no | Enable/disable this notification ([Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/244840) in GitLab 13.9) | -| `new_epic` | boolean | no | Enable/disable this notification ([Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/5863) in GitLab 11.3) **(ULTIMATE ALL)** | +| `new_epic` | boolean | no | Enable/disable this notification ([Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/5863) in GitLab 11.3). Ultimate only. | Example response: @@ -166,7 +170,7 @@ curl --request PUT --header "PRIVATE-TOKEN: " "https://gitlab | `success_pipeline` | boolean | no | Enable/disable this notification | | `moved_project` | boolean | no | Enable/disable this notification ([Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/30371) in GitLab 13.3) | | `merge_when_pipeline_succeeds` | boolean | no | Enable/disable this notification ([Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/244840) in GitLab 13.9) | -| `new_epic` | boolean | no | Enable/disable this notification ([Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/5863) in GitLab 11.3) **(ULTIMATE ALL)** | +| `new_epic` | boolean | no | Enable/disable this notification ([Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/5863) in GitLab 11.3). Ultimate only. | Example responses: diff --git a/doc/api/oauth2.md b/doc/api/oauth2.md index 71d387f7dd5..6de89f247a0 100644 --- a/doc/api/oauth2.md +++ b/doc/api/oauth2.md @@ -5,7 +5,11 @@ description: Third-party authorization to GitLab. info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# OAuth 2.0 identity provider API **(FREE ALL)** +# OAuth 2.0 identity provider API + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed GitLab provides an API to allow third-party services to access GitLab resources on a user's behalf with the [OAuth 2.0](https://oauth.net/2/) protocol. diff --git a/doc/api/packages.md b/doc/api/packages.md index 3d2e8e5bfbf..e5ad367e564 100644 --- a/doc/api/packages.md +++ b/doc/api/packages.md @@ -4,9 +4,13 @@ group: Package Registry info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Packages API **(FREE ALL)** +# Packages API -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/349418) support for [GitLab CI/CD job token](../ci/jobs/ci_job_token.md) authentication for the project-level API in GitLab 15.3. +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/349418) support for [GitLab CI/CD job token](../ci/jobs/ci_job_token.md) authentication for the project-level API in GitLab 15.3. The API documentation of [GitLab Packages](../administration/packages/index.md). @@ -322,7 +326,7 @@ By default, the `GET` request returns 20 results, because the API is [paginated] ## List package pipelines -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/341950) in GitLab 16.1. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/341950) in GitLab 16.1. Get a list of pipelines for a single package. The results are sorted by `id` in descending order. diff --git a/doc/api/packages/composer.md b/doc/api/packages/composer.md index 33840b31a18..e0ea703ac3c 100644 --- a/doc/api/packages/composer.md +++ b/doc/api/packages/composer.md @@ -4,7 +4,11 @@ group: Package Registry info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Composer API **(FREE ALL)** +# Composer API + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed This is the API documentation for [Composer Packages](../../user/packages/composer_repository/index.md). diff --git a/doc/api/packages/conan.md b/doc/api/packages/conan.md index 44e97f3861c..e89413abe34 100644 --- a/doc/api/packages/conan.md +++ b/doc/api/packages/conan.md @@ -4,7 +4,11 @@ group: Package Registry info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Conan API **(FREE ALL)** +# Conan API + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed This is the API documentation for [Conan Packages](../../user/packages/conan_repository/index.md). @@ -54,7 +58,7 @@ for Conan recipes. ## Ping -> Introduced in GitLab 12.2. +> - Introduced in GitLab 12.2. Ping the GitLab Conan repository to verify availability: @@ -74,7 +78,7 @@ Example response: ## Search -> Introduced in GitLab 12.4. +> - Introduced in GitLab 12.4. Search the instance for Conan packages by name: @@ -108,7 +112,7 @@ Example response: ## Authenticate -> Introduced in GitLab 12.2. +> - Introduced in GitLab 12.2. Returns a JWT to be used for Conan requests in a Bearer header: @@ -134,7 +138,7 @@ eyJhbGciOiJIUzI1NiIiheR5cCI6IkpXVCJ9.eyJhY2Nlc3NfdG9rZW4iOjMyMTQyMzAsqaVzZXJfaWQ ## Check Credentials -> Introduced in GitLab 12.4. +> - Introduced in GitLab 12.4. Checks the validity of Basic Auth credentials or a Conan JWT generated from [`/authenticate`](#authenticate). @@ -154,7 +158,7 @@ ok ## Recipe Snapshot -> Introduced in GitLab 12.5. +> - Introduced in GitLab 12.5. This returns the snapshot of the recipe files for the specified Conan recipe. The snapshot is a list of filenames with their associated md5 hash. @@ -186,7 +190,7 @@ Example response: ## Package Snapshot -> Introduced in GitLab 12.5. +> - Introduced in GitLab 12.5. This returns the snapshot of the package files for the specified Conan recipe with the specified Conan reference. The snapshot is a list of filenames with their associated md5 hash. @@ -219,7 +223,7 @@ Example response: ## Recipe Manifest -> Introduced in GitLab 12.5. +> - Introduced in GitLab 12.5. The manifest is a list of recipe filenames with their associated download URLs. @@ -253,7 +257,7 @@ the project-level route, the returned URLs contain `/projects/:id`. ## Package Manifest -> Introduced in GitLab 12.5. +> - Introduced in GitLab 12.5. The manifest is a list of package filenames with their associated download URLs. @@ -288,7 +292,7 @@ the project-level route, the returned URLs contain `/projects/:id`. ## Recipe Download URLs -> Introduced in GitLab 12.5. +> - Introduced in GitLab 12.5. Recipe download URLs return a list of recipe filenames with their associated download URLs. This attribute is the same payload as the [recipe manifest](#recipe-manifest) endpoint. @@ -323,7 +327,7 @@ the project-level route, the returned URLs contain `/projects/:id`. ## Package Download URLs -> Introduced in GitLab 12.5. +> - Introduced in GitLab 12.5. Package download URLs return a list of package filenames with their associated download URLs. This URL is the same payload as the [package manifest](#package-manifest) endpoint. @@ -359,7 +363,7 @@ the project-level route, the returned URLs contain `/projects/:id`. ## Recipe Upload URLs -> Introduced in GitLab 12.5. +> - Introduced in GitLab 12.5. Given a list of recipe filenames and file sizes, a list of URLs to upload each file is returned. @@ -405,7 +409,7 @@ the project-level route, the returned URLs contain `/projects/:id`. ## Package Upload URLs -> Introduced in GitLab 12.5. +> - Introduced in GitLab 12.5. Given a list of package filenames and file sizes, a list of URLs to upload each file is returned. @@ -454,7 +458,7 @@ the project-level route, the returned URLs contain `/projects/:id`. ## Download a Recipe file -> Introduced in GitLab 12.6. +> - Introduced in GitLab 12.6. Download a recipe file to the package registry. You must use a download URL that the [recipe download URLs endpoint](#recipe-download-urls) @@ -487,7 +491,7 @@ This example writes to `conanfile.py` in the current directory. ## Upload a Recipe file -> Introduced in GitLab 12.6. +> - Introduced in GitLab 12.6. Upload a recipe file to the package registry. You must use an upload URL that the [recipe upload URLs endpoint](#recipe-upload-urls) @@ -517,7 +521,7 @@ curl --request PUT \ ## Download a Package file -> Introduced in GitLab 12.6. +> - Introduced in GitLab 12.6. Download a package file to the package registry. You must use a download URL that the [package download URLs endpoint](#package-download-urls) @@ -552,7 +556,7 @@ This example writes to `conaninfo.txt` in the current directory. ## Upload a Package file -> Introduced in GitLab 12.6. +> - Introduced in GitLab 12.6. Upload a package file to the package registry. You must use an upload URL that the [package upload URLs endpoint](#package-upload-urls) @@ -584,7 +588,7 @@ curl --request PUT \ ## Delete a Package (delete a Conan recipe) -> Introduced in GitLab 12.5. +> - Introduced in GitLab 12.5. Delete the Conan recipe and package files from the registry: diff --git a/doc/api/packages/debian.md b/doc/api/packages/debian.md index 30ac9175feb..976addeecbf 100644 --- a/doc/api/packages/debian.md +++ b/doc/api/packages/debian.md @@ -4,7 +4,11 @@ group: Package Registry info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Debian API **(FREE SELF)** +# Debian API + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed > - Debian API [introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/42670) in GitLab 13.5. > - Debian group API [introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/66188) in GitLab 14.2. @@ -80,7 +84,7 @@ curl --request PUT \ ## Download a package -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/64923) in GitLab 14.2. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/64923) in GitLab 14.2. Download a package file. @@ -142,7 +146,7 @@ The examples in this document all use the project-level prefix. ## Download a distribution Release file -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/64067) in GitLab 14.1. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/64067) in GitLab 14.1. Download a Debian distribution file. @@ -170,7 +174,7 @@ This writes the downloaded file using the remote file name in the current direct ## Download a signed distribution Release file -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/64067) in GitLab 14.1. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/64067) in GitLab 14.1. Download a signed Debian distribution file. @@ -198,7 +202,7 @@ This writes the downloaded file using the remote file name in the current direct ## Download a release file signature -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/64923) in GitLab 14.2. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/64923) in GitLab 14.2. Download a Debian release file signature. @@ -226,7 +230,7 @@ This writes the downloaded file using the remote file name in the current direct ## Download a packages index -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/64923) in GitLab 14.2. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/64923) in GitLab 14.2. Download a packages index. @@ -256,7 +260,7 @@ This writes the downloaded file using the remote file name in the current direct ## Download a packages index by hash -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/96947) in GitLab 15.4. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/96947) in GitLab 15.4. Download a packages index by hash. @@ -287,7 +291,7 @@ This writes the downloaded file using the remote file name in the current direct ## Download a Debian Installer packages index -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/71918) in GitLab 15.4. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/71918) in GitLab 15.4. Download a Debian Installer packages index. @@ -317,7 +321,7 @@ This writes the downloaded file using the remote file name in the current direct ## Download a Debian Installer packages index by hash -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/96947) in GitLab 15.4. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/96947) in GitLab 15.4. Download a Debian Installer packages index by hash. @@ -347,7 +351,7 @@ This writes the downloaded file using the remote file name in the current direct ## Download a source packages index -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/71918) in GitLab 15.4. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/71918) in GitLab 15.4. Download a source packages index. @@ -376,7 +380,7 @@ This writes the downloaded file using the remote file name in the current direct ## Download a source packages index by hash -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/96947) in GitLab 15.4. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/96947) in GitLab 15.4. Download a source packages index by hash. diff --git a/doc/api/packages/debian_group_distributions.md b/doc/api/packages/debian_group_distributions.md index 01a8c714456..481b68f8022 100644 --- a/doc/api/packages/debian_group_distributions.md +++ b/doc/api/packages/debian_group_distributions.md @@ -4,7 +4,11 @@ group: Package Registry info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Debian group distributions API **(FREE SELF)** +# Debian group distributions API + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/66188) in GitLab 14.2. > - [Deployed behind a feature flag](../../user/feature_flags.md), disabled by default. diff --git a/doc/api/packages/debian_project_distributions.md b/doc/api/packages/debian_project_distributions.md index ca6e3a63194..e106beead0b 100644 --- a/doc/api/packages/debian_project_distributions.md +++ b/doc/api/packages/debian_project_distributions.md @@ -4,7 +4,11 @@ group: Package Registry info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Debian project distributions API **(FREE SELF)** +# Debian project distributions API + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/42670) in GitLab 13.5. > - [Deployed behind a feature flag](../../user/feature_flags.md), disabled by default. diff --git a/doc/api/packages/go_proxy.md b/doc/api/packages/go_proxy.md index aeda947a0a8..b59bf571942 100644 --- a/doc/api/packages/go_proxy.md +++ b/doc/api/packages/go_proxy.md @@ -4,7 +4,11 @@ group: Package Registry info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Go Proxy API **(FREE SELF)** +# Go Proxy API + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed This is the API documentation for [Go Packages](../../user/packages/go_proxy/index.md). This API is behind a feature flag that is disabled by default. GitLab administrators with access to @@ -24,7 +28,7 @@ for details on which headers and token types are supported. Undocumented authent ## List -> Introduced in GitLab 13.1. +> - Introduced in GitLab 13.1. Get all tagged versions for a given Go module: @@ -49,7 +53,7 @@ Example output: ## Version metadata -> Introduced in GitLab 13.1. +> - Introduced in GitLab 13.1. Get all tagged versions for a given Go module: @@ -78,7 +82,7 @@ Example output: ## Download module file -> Introduced in GitLab 13.1. +> - Introduced in GitLab 13.1. Fetch the `.mod` module file: @@ -106,7 +110,7 @@ This writes to `foo.mod` in the current directory. ## Download module source -> Introduced in GitLab 13.1. +> - Introduced in GitLab 13.1. Fetch the `.zip` of the module source: diff --git a/doc/api/packages/helm.md b/doc/api/packages/helm.md index f4c5b315f24..866267225a3 100644 --- a/doc/api/packages/helm.md +++ b/doc/api/packages/helm.md @@ -4,7 +4,11 @@ group: Package Registry info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Helm API **(FREE ALL)** +# Helm API + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed This is the API documentation for [Helm](../../user/packages/helm_repository/index.md). @@ -23,7 +27,7 @@ for details on which headers and token types are supported. Undocumented authent ## Download a chart index -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/62757) in GitLab 14.1. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/62757) in GitLab 14.1. Download a chart index: @@ -51,7 +55,7 @@ curl --user : \ ## Download a chart -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/61014) in GitLab 14.0. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/61014) in GitLab 14.0. Download a chart: @@ -73,7 +77,7 @@ curl --user : \ ## Upload a chart -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/64814) in GitLab 14.1. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/64814) in GitLab 14.1. Upload a chart: diff --git a/doc/api/packages/maven.md b/doc/api/packages/maven.md index 9bb3d2551e9..0d59c953c52 100644 --- a/doc/api/packages/maven.md +++ b/doc/api/packages/maven.md @@ -4,7 +4,11 @@ group: Package Registry info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Maven API **(FREE ALL)** +# Maven API + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed This is the API documentation for [Maven Packages](../../user/packages/maven_repository/index.md). diff --git a/doc/api/packages/npm.md b/doc/api/packages/npm.md index b4147fca28d..caea1c2ce14 100644 --- a/doc/api/packages/npm.md +++ b/doc/api/packages/npm.md @@ -4,7 +4,11 @@ group: Package Registry info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# npm API **(FREE ALL)** +# npm API + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed This is the API documentation for [npm Packages](../../user/packages/npm_registry/index.md). @@ -205,7 +209,7 @@ the instance-level route, the returned URLs contain `/api/v4/packages/npm`. ### List tags -> Introduced in GitLab 12.7. +> - Introduced in GitLab 12.7. Lists the dist-tags for the package. @@ -235,7 +239,7 @@ the instance-level route, the returned URLs contain `/api/v4/packages/npm`. ### Create or update a tag -> Introduced in GitLab 12.7. +> - Introduced in GitLab 12.7. Create or update a dist-tag. @@ -257,7 +261,7 @@ This endpoint responds successfully with `204 No Content`. ### Delete a tag -> Introduced in GitLab 12.7. +> - Introduced in GitLab 12.7. Delete a dist-tag. diff --git a/doc/api/packages/nuget.md b/doc/api/packages/nuget.md index a946fa68943..9b06d56eb8a 100644 --- a/doc/api/packages/nuget.md +++ b/doc/api/packages/nuget.md @@ -4,7 +4,11 @@ group: Package Registry info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# NuGet API **(FREE ALL)** +# NuGet API + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed This is the API documentation for [NuGet Packages](../../user/packages/nuget_repository/index.md). @@ -22,7 +26,7 @@ for details on which headers and token types are supported. Undocumented authent ## Package index -> Introduced in GitLab 12.8. +> - Introduced in GitLab 12.8. Returns the index for a given package, which includes a list of available versions: @@ -51,7 +55,7 @@ Example response: ## Download a package file -> Introduced in GitLab 12.8. +> - Introduced in GitLab 12.8. Download a NuGet package file. The [metadata service](#metadata-service) provides this URL. @@ -124,7 +128,7 @@ Upload a NuGet package file: ## Upload a symbol package file -> Introduced in GitLab 12.8. +> - Introduced in GitLab 12.8. Upload a NuGet symbol package file (`.snupkg`): @@ -285,7 +289,7 @@ the group-level route, the returned URLs contain `/groups/:id/-`. ## Metadata Service -> Introduced in GitLab 12.8. +> - Introduced in GitLab 12.8. Returns metadata for a package: @@ -337,7 +341,7 @@ Example response: ## Version Metadata Service -> Introduced in GitLab 12.8. +> - Introduced in GitLab 12.8. Returns metadata for a specific package version: @@ -377,7 +381,7 @@ Example response: ## Search Service -> Introduced in GitLab 12.8. +> - Introduced in GitLab 12.8. Given a query, search for NuGet packages in the repository: @@ -427,7 +431,7 @@ Example response: ## Delete service -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/38275) in GitLab 16.5. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/38275) in GitLab 16.5. Delete a NuGet package: @@ -458,7 +462,7 @@ Possible request responses: ## Download a debugging symbol file `.pdb` -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/416178) in GitLab 16.7. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/416178) in GitLab 16.7. Download a debugging symbol file (`.pdb`): @@ -493,7 +497,7 @@ Possible request responses: ## V2 Feed Metadata Endpoints -> Introduced in GitLab 16.3. +> - Introduced in GitLab 16.3. ### $metadata endpoint @@ -546,7 +550,7 @@ Example response: ### OData package entry endpoints -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/127667) in GitLab 16.4. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/127667) in GitLab 16.4. | Endpoint | Description | | -------- | ----------- | diff --git a/doc/api/packages/pypi.md b/doc/api/packages/pypi.md index ee4ae4fff66..9fbfebc1d07 100644 --- a/doc/api/packages/pypi.md +++ b/doc/api/packages/pypi.md @@ -4,7 +4,11 @@ group: Package Registry info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# PyPI API **(FREE ALL)** +# PyPI API + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed This is the API documentation for [PyPI Packages](../../user/packages/pypi_repository/index.md). @@ -26,7 +30,7 @@ is recommended when [FIPS mode](../../development/fips_compliance.md) is enabled ## Download a package file from a group -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/225545) in GitLab 13.12. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/225545) in GitLab 13.12. Download a PyPI package file. The [simple API](#group-level-simple-api-entry-point) usually supplies this URL. @@ -56,7 +60,7 @@ directory. ## Group-level simple API index -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/327595) in GitLab 15.1. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/327595) in GitLab 15.1. Returns a list of packages in the group as an HTML file: @@ -97,7 +101,7 @@ This writes the downloaded file to `simple_index.html` in the current directory. ## Group level simple API entry point -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/225545) in GitLab 13.12. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/225545) in GitLab 13.12. Returns the package descriptor as an HTML file: @@ -139,7 +143,7 @@ This writes the downloaded file to `simple.html` in the current directory. ## Download a package file from a project -> Introduced in GitLab 12.10. +> - Introduced in GitLab 12.10. Download a PyPI package file. The [simple API](#project-level-simple-api-entry-point) usually supplies this URL. @@ -169,7 +173,7 @@ directory. ## Project-level simple API index -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/327595) in GitLab 15.1. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/327595) in GitLab 15.1. Returns a list of packages in the project as an HTML file: @@ -210,7 +214,7 @@ This writes the downloaded file to `simple_index.html` in the current directory. ## Project-level simple API entry point -> Introduced in GitLab 12.10. +> - Introduced in GitLab 12.10. Returns the package descriptor as an HTML file: diff --git a/doc/api/packages/rubygems.md b/doc/api/packages/rubygems.md index 93675d9a6ae..d49cff2ef99 100644 --- a/doc/api/packages/rubygems.md +++ b/doc/api/packages/rubygems.md @@ -4,7 +4,11 @@ group: Package Registry info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Ruby gems API **(FREE SELF)** +# Ruby gems API + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed This is the API documentation for [Ruby gems](../../user/packages/rubygems_registry/index.md). @@ -47,7 +51,7 @@ Feature.disable(:rubygem_packages, Project.find(2)) ## Download a gem file -> Introduced in GitLab 13.10. +> - Introduced in GitLab 13.10. Download a gem: @@ -74,7 +78,7 @@ This writes the downloaded file to `my_gem-1.0.0.gem` in the current directory. ## Fetch a list of dependencies -> Introduced in GitLab 13.10. +> - Introduced in GitLab 13.10. Fetch a list of dependencies for a list of gems: @@ -129,7 +133,7 @@ This writes the downloaded file to `mypkg-1.0-SNAPSHOT.jar` in the current direc ## Upload a gem -> Introduced in GitLab 13.11. +> - Introduced in GitLab 13.11. Upload a gem: diff --git a/doc/api/packages/terraform-modules.md b/doc/api/packages/terraform-modules.md index 079b7652e67..5c7d436d55a 100644 --- a/doc/api/packages/terraform-modules.md +++ b/doc/api/packages/terraform-modules.md @@ -4,7 +4,11 @@ group: Package Registry info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Terraform Module Registry API **(FREE ALL)** +# Terraform Module Registry API + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed This is the API documentation for the [Terraform Module Registry](../../user/packages/terraform_module_registry/index.md). diff --git a/doc/api/pages.md b/doc/api/pages.md index 5467b5112df..62959a18b71 100644 --- a/doc/api/pages.md +++ b/doc/api/pages.md @@ -4,7 +4,11 @@ group: Knowledge info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Pages API **(FREE ALL)** +# Pages API + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed Endpoints for managing [GitLab Pages](https://about.gitlab.com/stages-devops-lifecycle/pages/). @@ -32,7 +36,7 @@ curl --request 'DELETE' --header "PRIVATE-TOKEN: " "https://g ## Get pages settings for a project -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/436932) in GitLab 16.8. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/436932) in GitLab 16.8. Prerequisites: diff --git a/doc/api/pages_domains.md b/doc/api/pages_domains.md index 93d01d3ebde..aa9a44bf0dc 100644 --- a/doc/api/pages_domains.md +++ b/doc/api/pages_domains.md @@ -4,7 +4,11 @@ group: Knowledge info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Pages domains API **(FREE ALL)** +# Pages domains API + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed Endpoints for connecting custom domains and TLS certificates in [GitLab Pages](https://about.gitlab.com/stages-devops-lifecycle/pages/). diff --git a/doc/api/personal_access_tokens.md b/doc/api/personal_access_tokens.md index 6cf3ee3d6b0..77a3533bc6a 100644 --- a/doc/api/personal_access_tokens.md +++ b/doc/api/personal_access_tokens.md @@ -4,7 +4,11 @@ group: Compliance info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Personal access tokens API **(FREE ALL)** +# Personal access tokens API + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed You can read more about [personal access tokens](../user/profile/personal_access_tokens.md). @@ -147,7 +151,7 @@ Get a personal access token by either: ### Using a personal access token ID -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/362239) in GitLab 15.1. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/362239) in GitLab 15.1. Get a single personal access token by its ID. Users can get their own tokens. Administrators can get any token. @@ -175,7 +179,7 @@ curl --request GET --header "PRIVATE-TOKEN: " "https://gitlab ### Using a request header -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/373999) in GitLab 15.5 +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/373999) in GitLab 15.5 Get a single personal access token and information about that token by passing the token in a header. @@ -207,7 +211,7 @@ Example response: ## Rotate a personal access token -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/403042) in GitLab 16.0 +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/403042) in GitLab 16.0 Rotate a personal access token. Revokes the previous token and creates a new token that expires in one week. @@ -257,7 +261,7 @@ Example response: ### Automatic reuse detection -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/395352) in GitLab 16.3 +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/395352) in GitLab 16.3 For each rotated token, the previous and now revoked token is referenced. This chain of references defines a token family. In a token family, only the latest @@ -332,7 +336,11 @@ curl --request DELETE --header "PRIVATE-TOKEN: " "https://git See the [Users API documentation](users.md#create-a-personal-access-token) for information on creating a personal access token. -## Create a personal access token with limited scopes for the currently authenticated user **(FREE SELF)** +## Create a personal access token with limited scopes for the currently authenticated user + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed See the [Users API documentation](users.md#create-a-personal-access-token-with-limited-scopes-for-the-currently-authenticated-user) for information on creating a personal access token for the currently authenticated user. diff --git a/doc/api/pipeline_schedules.md b/doc/api/pipeline_schedules.md index 8a2d38a4266..bd3aadbb056 100644 --- a/doc/api/pipeline_schedules.md +++ b/doc/api/pipeline_schedules.md @@ -4,7 +4,11 @@ group: Pipeline Execution info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Pipeline schedules API **(FREE ALL)** +# Pipeline schedules API + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed You can read more about [pipeline schedules](../ci/pipelines/schedules.md). @@ -104,7 +108,7 @@ curl --header "PRIVATE-TOKEN: " "https://gitlab.example.com/a ## Get all pipelines triggered by a pipeline schedule -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/368566) in GitLab 15.3. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/368566) in GitLab 15.3. Get all pipelines triggered by a pipeline schedule in a project. diff --git a/doc/api/pipeline_triggers.md b/doc/api/pipeline_triggers.md index 5ac59854f23..5d538ee0947 100644 --- a/doc/api/pipeline_triggers.md +++ b/doc/api/pipeline_triggers.md @@ -4,7 +4,11 @@ group: Pipeline Execution info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Pipeline trigger tokens API **(FREE ALL)** +# Pipeline trigger tokens API + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed You can read more about [triggering pipelines through the API](../ci/triggers/index.md). diff --git a/doc/api/pipelines.md b/doc/api/pipelines.md index d07a63cde1e..5abe30c0ad9 100644 --- a/doc/api/pipelines.md +++ b/doc/api/pipelines.md @@ -4,7 +4,11 @@ group: Pipeline Execution info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Pipelines API **(FREE ALL)** +# Pipelines API + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed ## Pipelines pagination @@ -225,7 +229,7 @@ Sample response: ### Get a pipeline's test report summary -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/65471) in GitLab 14.2. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/65471) in GitLab 14.2. NOTE: This API route is part of the [Unit test report](../ci/testing/unit_test_reports.md) feature. diff --git a/doc/api/plan_limits.md b/doc/api/plan_limits.md index 46e0cc27a94..b3763665d84 100644 --- a/doc/api/plan_limits.md +++ b/doc/api/plan_limits.md @@ -4,9 +4,13 @@ group: Authentication info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Plan limits API **(FREE SELF)** +# Plan limits API -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/54232) in GitLab 13.10. +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/54232) in GitLab 13.10. The plan limits API allows you to maintain the application limits for the existing subscription plans. diff --git a/doc/api/product_analytics.md b/doc/api/product_analytics.md index ad92818f5ba..4044a972559 100644 --- a/doc/api/product_analytics.md +++ b/doc/api/product_analytics.md @@ -4,7 +4,11 @@ group: Product Analytics info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Product analytics API **(ULTIMATE ALL)** +# Product analytics API + +DETAILS: +**Tier:** Ultimate +**Offering:** SaaS, self-managed > - Introduced in GitLab 15.4 [with a flag](../administration/feature_flags.md) named `cube_api_proxy`. Disabled by default. > - `cube_api_proxy` removed and replaced with `product_analytics_internal_preview` in GitLab 15.10. diff --git a/doc/api/project_access_tokens.md b/doc/api/project_access_tokens.md index 2f7be015e75..2308e598bc9 100644 --- a/doc/api/project_access_tokens.md +++ b/doc/api/project_access_tokens.md @@ -4,13 +4,17 @@ group: Authentication info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Project access tokens API **(FREE ALL)** +# Project access tokens API + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed You can read more about [project access tokens](../user/project/settings/project_access_tokens.md). ## List project access tokens -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/238991) in GitLab 13.9. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/238991) in GitLab 13.9. Get a list of [project access tokens](../user/project/settings/project_access_tokens.md). @@ -46,7 +50,7 @@ curl --header "PRIVATE-TOKEN: " "https://gitlab.example.com/a ## Get a project access token -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/82714) in GitLab 14.10. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/82714) in GitLab 14.10. Get a [project access token](../user/project/settings/project_access_tokens.md) by ID. @@ -135,7 +139,7 @@ curl --request POST --header "PRIVATE-TOKEN: " \ ## Rotate a project access token -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/403042) in GitLab 16.0 +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/403042) in GitLab 16.0 Rotate a project access token. Revokes the previous token and creates a new token that expires in one week. @@ -189,7 +193,7 @@ for more information. ## Revoke a project access token -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/238991) in GitLab 13.9. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/238991) in GitLab 13.9. Revoke a [project access token](../user/project/settings/project_access_tokens.md). diff --git a/doc/api/project_aliases.md b/doc/api/project_aliases.md index a52e094d821..a9829170502 100644 --- a/doc/api/project_aliases.md +++ b/doc/api/project_aliases.md @@ -4,7 +4,11 @@ group: Source Code info: "To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments" --- -# Project Aliases API **(PREMIUM SELF)** +# Project Aliases API + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** Self-managed All methods require administrator authorization. diff --git a/doc/api/project_badges.md b/doc/api/project_badges.md index 20654242467..3b3825f8d01 100644 --- a/doc/api/project_badges.md +++ b/doc/api/project_badges.md @@ -4,7 +4,11 @@ group: Source Code info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Project badges API **(FREE ALL)** +# Project badges API + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed ## Placeholder tokens diff --git a/doc/api/project_clusters.md b/doc/api/project_clusters.md index 8909b6c473d..8fd3a33575c 100644 --- a/doc/api/project_clusters.md +++ b/doc/api/project_clusters.md @@ -4,7 +4,11 @@ group: Environments info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Project clusters API (certificate-based) (deprecated) **(FREE ALL)** +# Project clusters API (certificate-based) (deprecated) + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed > - [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/23922) in GitLab 11.7. > - [Deprecated](https://gitlab.com/groups/gitlab-org/configure/-/epics/8) in GitLab 14.5. diff --git a/doc/api/project_import_export.md b/doc/api/project_import_export.md index 1cf276b4f60..0abf08d4ca1 100644 --- a/doc/api/project_import_export.md +++ b/doc/api/project_import_export.md @@ -4,7 +4,11 @@ group: Import and Integrate info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Project import and export API **(FREE ALL)** +# Project import and export API + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed Use the project import and export API to import and export projects using file transfers. @@ -213,7 +217,7 @@ As an administrator, you can modify the maximum import file size. To do so, use ## Import a file from a remote object storage **(BETA)** -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/282503) in GitLab 13.12 in [Beta](../policy/experiment-beta-support.md#beta) [with a flag](../administration/feature_flags.md) named `import_project_from_remote_file`. Enabled by default. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/282503) in GitLab 13.12 in [Beta](../policy/experiment-beta-support.md#beta) [with a flag](../administration/feature_flags.md) named `import_project_from_remote_file`. Enabled by default. FLAG: On self-managed GitLab, by default this feature is available. To hide the feature, an administrator can [disable the feature flag](../administration/feature_flags.md) named `import_project_from_remote_file`. diff --git a/doc/api/project_job_token_scopes.md b/doc/api/project_job_token_scopes.md index 59374a8b89f..c0491f2d250 100644 --- a/doc/api/project_job_token_scopes.md +++ b/doc/api/project_job_token_scopes.md @@ -4,7 +4,11 @@ group: Pipeline Security info: "To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments" --- -# Project CI/CD job token scope API **(FREE ALL)** +# Project CI/CD job token scope API + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed You can read more about the [CI/CD job token](../ci/jobs/ci_job_token.md) diff --git a/doc/api/project_level_variables.md b/doc/api/project_level_variables.md index e6d3050d59c..82a1a0548e2 100644 --- a/doc/api/project_level_variables.md +++ b/doc/api/project_level_variables.md @@ -4,7 +4,11 @@ group: Pipeline Security info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Project-level CI/CD variables API **(FREE ALL)** +# Project-level CI/CD variables API + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed ## List project variables diff --git a/doc/api/project_relations_export.md b/doc/api/project_relations_export.md index a586c940b8e..66255f6a7d9 100644 --- a/doc/api/project_relations_export.md +++ b/doc/api/project_relations_export.md @@ -4,7 +4,11 @@ group: Import and Integrate info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Project relations export API **(FREE ALL)** +# Project relations export API + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/70330) in GitLab 14.4 behind the `bulk_import` [feature flag](../administration/feature_flags.md), disabled by default. diff --git a/doc/api/project_repository_storage_moves.md b/doc/api/project_repository_storage_moves.md index 2d400956f13..221258e8bb4 100644 --- a/doc/api/project_repository_storage_moves.md +++ b/doc/api/project_repository_storage_moves.md @@ -4,9 +4,13 @@ group: Gitaly info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Project repository storage moves API **(FREE SELF)** +# Project repository storage moves API -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/31285) in GitLab 13.0. +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/31285) in GitLab 13.0. Project repositories including wiki and design repositories can be moved between storages. This API can help you when [migrating to Gitaly Cluster](../administration/gitaly/index.md#migrate-to-gitaly-cluster), for example. @@ -246,7 +250,7 @@ Example response: ## Schedule repository storage moves for all projects on a storage shard -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/47142) in GitLab 13.7. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/47142) in GitLab 13.7. Schedules repository storage moves for each project repository stored on the source storage shard. This endpoint migrates all projects at once. For more information, see diff --git a/doc/api/project_snippets.md b/doc/api/project_snippets.md index 100e161130d..c78f331e3ca 100644 --- a/doc/api/project_snippets.md +++ b/doc/api/project_snippets.md @@ -4,7 +4,11 @@ group: Source Code info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Project snippets **(FREE ALL)** +# Project snippets + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed ## Snippet visibility level diff --git a/doc/api/project_statistics.md b/doc/api/project_statistics.md index f4a5c430fe9..634b0a55466 100644 --- a/doc/api/project_statistics.md +++ b/doc/api/project_statistics.md @@ -4,7 +4,11 @@ group: Source Code info: "To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments" --- -# Project statistics API **(FREE ALL)** +# Project statistics API + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed Every API call to [project](../user/project/index.md) statistics must be authenticated. Retrieving these statistics requires write access to the repository. diff --git a/doc/api/project_templates.md b/doc/api/project_templates.md index 3585e3574b0..46b8ed687e2 100644 --- a/doc/api/project_templates.md +++ b/doc/api/project_templates.md @@ -4,7 +4,11 @@ group: Source Code info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Project templates API **(FREE ALL)** +# Project templates API + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed This API is a project-specific version of these endpoints: diff --git a/doc/api/project_vulnerabilities.md b/doc/api/project_vulnerabilities.md index 771ff4c2e8e..46aaa446a50 100644 --- a/doc/api/project_vulnerabilities.md +++ b/doc/api/project_vulnerabilities.md @@ -4,7 +4,11 @@ group: Threat Insights info: "To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments" --- -# Project Vulnerabilities API **(ULTIMATE ALL)** +# Project Vulnerabilities API + +DETAILS: +**Tier:** Ultimate +**Offering:** SaaS, self-managed > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/10242) in GitLab 12.6. > - `last_edited_at` [deprecated](https://gitlab.com/gitlab-org/gitlab/-/issues/268154) in GitLab 16.7. diff --git a/doc/api/projects.md b/doc/api/projects.md index 55fede98b92..6b2d3241d53 100644 --- a/doc/api/projects.md +++ b/doc/api/projects.md @@ -4,7 +4,11 @@ group: Tenant Scale info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Projects API **(FREE ALL)** +# Projects API + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed Interact with [projects](../user/project/index.md) by using the REST API. @@ -1348,9 +1352,13 @@ target the upstream project by default. } ``` -### Templates for issues and merge requests **(PREMIUM ALL)** +### Templates for issues and merge requests -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/55718) in GitLab 13.10. +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/55718) in GitLab 13.10. Users of [GitLab Premium or Ultimate](https://about.gitlab.com/pricing/) can also see the `issues_template` and `merge_requests_template` parameters for managing @@ -1549,7 +1557,7 @@ curl --request POST --header "PRIVATE-TOKEN: " \ | `monitor_access_level` | string | No | One of `disabled`, `private`, or `enabled`. | | `namespace_id` | integer | No | Namespace for the new project (defaults to the current user's namespace). | | `only_allow_merge_if_all_discussions_are_resolved` | boolean | No | Set whether merge requests can only be merged when all the discussions are resolved. | -| `only_allow_merge_if_all_status_checks_passed` **(ULTIMATE ALL)** | boolean | No | Indicates that merges of merge requests should be blocked unless all status checks have passed. Defaults to false. [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/369859) in GitLab 15.5 with feature flag `only_allow_merge_if_all_status_checks_passed` disabled by default. | +| `only_allow_merge_if_all_status_checks_passed` | boolean | No | Indicates that merges of merge requests should be blocked unless all status checks have passed. Defaults to false. [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/369859) in GitLab 15.5 with feature flag `only_allow_merge_if_all_status_checks_passed` disabled by default. Ultimate only. | | `only_allow_merge_if_pipeline_succeeds` | boolean | No | Set whether merge requests can only be merged with successful pipelines. This setting is named [**Pipelines must succeed**](../user/project/merge_requests/merge_when_pipeline_succeeds.md#require-a-successful-pipeline-for-merge) in the project settings. | | `packages_enabled` | boolean | No | Enable or disable packages repository feature. | | `pages_access_level` | string | No | One of `disabled`, `private`, `enabled`, or `public`. | @@ -1640,7 +1648,7 @@ POST /projects/user/:user_id | `monitor_access_level` | string | No | One of `disabled`, `private`, or `enabled`. | | `namespace_id` | integer | No | Namespace for the new project (defaults to the current user's namespace). | | `only_allow_merge_if_all_discussions_are_resolved` | boolean | No | Set whether merge requests can only be merged when all the discussions are resolved. | -| `only_allow_merge_if_all_status_checks_passed` **(ULTIMATE ALL)** | boolean | No | Indicates that merges of merge requests should be blocked unless all status checks have passed. Defaults to false. [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/369859) in GitLab 15.5 with feature flag `only_allow_merge_if_all_status_checks_passed` disabled by default. | +| `only_allow_merge_if_all_status_checks_passed` | boolean | No | Indicates that merges of merge requests should be blocked unless all status checks have passed. Defaults to false. [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/369859) in GitLab 15.5 with feature flag `only_allow_merge_if_all_status_checks_passed` disabled by default. Ultimate only. | | `only_allow_merge_if_pipeline_succeeds` | boolean | No | Set whether merge requests can only be merged with successful jobs. | | `packages_enabled` | boolean | No | Enable or disable packages repository feature. | | `pages_access_level` | string | No | One of `disabled`, `private`, `enabled`, or `public`. | @@ -1701,7 +1709,7 @@ Supported attributes: | `id` | integer or string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | | `allow_merge_on_skipped_pipeline` | boolean | No | Set whether or not merge requests can be merged with skipped jobs. | | `allow_pipeline_trigger_approve_deployment` | boolean | No | Set whether or not a pipeline triggerer is allowed to approve deployments. Premium and Ultimate only. | -| `only_allow_merge_if_all_status_checks_passed` **(ULTIMATE ALL)** | boolean | No | Indicates that merges of merge requests should be blocked unless all status checks have passed. Defaults to false.

[Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/369859) in GitLab 15.5 with feature flag `only_allow_merge_if_all_status_checks_passed` disabled by default. The feature flag was enabled by default in GitLab 15.9. | +| `only_allow_merge_if_all_status_checks_passed` | boolean | No | Indicates that merges of merge requests should be blocked unless all status checks have passed. Defaults to false.

[Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/369859) in GitLab 15.5 with feature flag `only_allow_merge_if_all_status_checks_passed` disabled by default. The feature flag was enabled by default in GitLab 15.9. Ultimate only. | | `analytics_access_level` | string | No | One of `disabled`, `private` or `enabled` | | `approvals_before_merge` | integer | No | How many approvers should approve merge requests by default. [Deprecated](https://gitlab.com/gitlab-org/gitlab/-/issues/353097) in GitLab 16.0. To configure approval rules, see [Merge request approvals API](merge_request_approvals.md). Premium and Ultimate only. | | `auto_cancel_pending_pipelines` | string | No | Auto-cancel pending pipelines. This action toggles between an enabled state and a disabled state; it is not a boolean. | @@ -2522,9 +2530,13 @@ DELETE /projects/:id | `full_path` | string | no | Full path of project to use with `permanently_remove`. [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/396500) in GitLab 15.11. To find the project path, use `path_with_namespace` from [get single project](projects.md#get-single-project). Premium and Ultimate only. | | `permanently_remove` | boolean/string | no | Immediately deletes a project if it is marked for deletion. [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/396500) in GitLab 15.11. Premium and Ultimate only. | -## Restore project marked for deletion **(PREMIUM ALL)** +## Restore project marked for deletion -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/32935) in GitLab 12.6. +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/32935) in GitLab 12.6. Restores project marked for deletion. @@ -2614,7 +2626,7 @@ Returned object: ## Remove a project avatar -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/92604) in GitLab 15.4. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/92604) in GitLab 15.4. To remove a project avatar, use a blank value for the `avatar` attribute. @@ -2901,7 +2913,11 @@ POST /projects/:id/housekeeping | `id` | integer or string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | | `task` | string | No | `prune` to trigger manual prune of unreachable objects or `eager` to trigger eager housekeeping. | -## Push rules **(PREMIUM ALL)** +## Push rules + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed ### Get project push rules @@ -2986,7 +3002,7 @@ PUT /projects/:id/push_rule ### Delete project push rule -> Moved to GitLab Premium in 13.9. +> - Moved to GitLab Premium in 13.9. Removes a push rule from a project. @@ -3000,7 +3016,7 @@ DELETE /projects/:id/push_rule ## Get groups to which a user can transfer a project -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/371006) in GitLab 15.4 +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/371006) in GitLab 15.4 Retrieve a list of groups to which the user can transfer a project. @@ -3192,9 +3208,13 @@ Read more in the [Project members](members.md) documentation. Read more in the [Project vulnerabilities](project_vulnerabilities.md) documentation. -## Get a project's pull mirror details **(PREMIUM ALL)** +## Get a project's pull mirror details -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/354506) in GitLab 15.6. +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/354506) in GitLab 15.6. Returns the details of the project's pull mirror. @@ -3228,7 +3248,11 @@ Example response: } ``` -## Configure pull mirroring for a project **(PREMIUM ALL)** +## Configure pull mirroring for a project + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed > - Field `mirror_branch_regex` [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/381667) in GitLab 15.8 [with a flag](../administration/feature_flags.md) named `mirror_only_branches_match_regex`. Disabled by default. > - [Enabled by default](https://gitlab.com/gitlab-org/gitlab/-/issues/381667) in GitLab 16.0. @@ -3282,9 +3306,13 @@ curl --request PUT --header "PRIVATE-TOKEN: " \ --data "mirror=false" ``` -## Start the pull mirroring process for a Project **(PREMIUM ALL)** +## Start the pull mirroring process for a Project -> Moved to GitLab Premium in 13.9. +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed + +> - Moved to GitLab Premium in 13.9. ```plaintext POST /projects/:id/mirror/pull @@ -3324,7 +3352,7 @@ GET /projects/:id/snapshot ## Get the path to repository storage -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/29861) in GitLab 14.0. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/29861) in GitLab 14.0. Get the path to repository storage for specified project if Gitaly Cluster is not being used. If Gitaly Cluster is being used, see [Praefect-generated replica paths (GitLab 15.0 and later)](../administration/gitaly/index.md#praefect-generated-replica-paths-gitlab-150-and-later). diff --git a/doc/api/protected_branches.md b/doc/api/protected_branches.md index 249a10fb6d4..7f10aa1b62a 100644 --- a/doc/api/protected_branches.md +++ b/doc/api/protected_branches.md @@ -4,7 +4,11 @@ group: Source Code info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Protected branches API **(FREE ALL)** +# Protected branches API + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed ## Valid access levels @@ -310,7 +314,11 @@ Example response: } ``` -### Example with user / group level access **(PREMIUM ALL)** +### Example with user / group level access + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed Elements in the `allowed_to_push` / `allowed_to_merge` / `allowed_to_unprotect` array should take the form `{user_id: integer}`, `{group_id: integer}`, or `{access_level: integer}`. Each user must have access to the project and each group must [have this project shared](../user/project/members/share_project_with_groups.md). These access levels allow [more granular control over protected branch access](../user/project/protected_branches.md). @@ -357,9 +365,13 @@ Example response: } ``` -### Example with allow to push and allow to merge access **(PREMIUM ALL)** +### Example with allow to push and allow to merge access -> Moved to GitLab Premium in 13.9. +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed + +> - Moved to GitLab Premium in 13.9. Example request: @@ -443,7 +455,7 @@ curl --request DELETE --header "PRIVATE-TOKEN: " "https://git ## Update a protected branch -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/101903) in GitLab 15.6. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/101903) in GitLab 15.6. Updates a protected branch. diff --git a/doc/api/protected_environments.md b/doc/api/protected_environments.md index 272c3d1c12b..c2a06424ddb 100644 --- a/doc/api/protected_environments.md +++ b/doc/api/protected_environments.md @@ -4,9 +4,13 @@ group: Environments info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Protected environments API **(PREMIUM ALL)** +# Protected environments API -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/30595) in GitLab 12.8. +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/30595) in GitLab 12.8. ## Valid access levels @@ -172,7 +176,7 @@ Example response: ## Update a protected environment -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/351854) in GitLab 15.4. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/351854) in GitLab 15.4. Updates a single environment. diff --git a/doc/api/protected_tags.md b/doc/api/protected_tags.md index fff2a3d82a4..841b53b7481 100644 --- a/doc/api/protected_tags.md +++ b/doc/api/protected_tags.md @@ -4,7 +4,11 @@ group: Source Code info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Protected tags API **(FREE ALL)** +# Protected tags API + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed **Valid access levels** diff --git a/doc/api/releases/index.md b/doc/api/releases/index.md index cd4ebf32083..53604f63b7f 100644 --- a/doc/api/releases/index.md +++ b/doc/api/releases/index.md @@ -4,7 +4,11 @@ group: Environments info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Releases API **(FREE ALL)** +# Releases API + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed > - Release Evidences were [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/26019) in GitLab 12.5. > - `description_html` became an opt-in field [with GitLab 13.12 for performance reasons](https://gitlab.com/gitlab-org/gitlab/-/issues/299447). @@ -410,7 +414,7 @@ Example response: ## Download a release asset -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/358188) in GitLab 15.4. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/358188) in GitLab 15.4. Download a release asset file by making a request with the following format: @@ -433,7 +437,7 @@ curl --location --header "PRIVATE-TOKEN: " "https://gitlab.ex ### Get the latest release -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/358188) in GitLab 15.4. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/358188) in GitLab 15.4. Latest release information is accessible through a permanent API URL. @@ -600,16 +604,24 @@ Example response: } ``` -### Group milestones **(PREMIUM SELF)** +### Group milestones -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/235391) in GitLab 13.5. +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** Self-managed + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/235391) in GitLab 13.5. Group milestones associated with the project may be specified in the `milestones` array for [Create a release](#create-a-release) and [Update a release](#update-a-release) API calls. Only milestones associated with the project's group may be specified, and adding milestones for ancestor groups raises an error. -## Collect release evidence **(PREMIUM SELF)** +## Collect release evidence + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** Self-managed > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/199065) in GitLab 12.10. > - [Changed](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/72448) to allow for `JOB-TOKEN` in GitLab 14.5. @@ -833,7 +845,7 @@ Example response: ## Upcoming Releases -> [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/issues/38105) in GitLab 12.1. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/issues/38105) in GitLab 12.1. A release with a `released_at` attribute set to a future date is labeled as an **Upcoming Release** [in the UI](../../user/project/releases/index.md#upcoming-releases). @@ -842,7 +854,7 @@ Additionally, if a [release is requested from the API](#list-releases), for each ## Historical releases -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/199429) in GitLab 15.2. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/199429) in GitLab 15.2. A release with a `released_at` attribute set to a past date is labeled as an **Historical release** [in the UI](../../user/project/releases/index.md#historical-releases). diff --git a/doc/api/releases/links.md b/doc/api/releases/links.md index 2e14869d213..8c12c778473 100644 --- a/doc/api/releases/links.md +++ b/doc/api/releases/links.md @@ -4,7 +4,11 @@ group: Environments info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Release links API **(FREE ALL)** +# Release links API + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed > Support for [GitLab CI/CD job token](../../ci/jobs/ci_job_token.md) authentication [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/250819) in GitLab 15.1. diff --git a/doc/api/remote_mirrors.md b/doc/api/remote_mirrors.md index 3ab69077ed3..523acbb2dc7 100644 --- a/doc/api/remote_mirrors.md +++ b/doc/api/remote_mirrors.md @@ -4,7 +4,11 @@ group: Source Code info: "To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments" --- -# Project remote mirrors API **(FREE ALL)** +# Project remote mirrors API + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed [Push mirrors](../user/project/repository/mirror/push.md) defined on a project's repository settings are called "remote mirrors". You @@ -53,7 +57,7 @@ Example response: ## Get a single project's remote mirror -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/82770) in GitLab 14.10. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/82770) in GitLab 14.10. Returns a remote mirror and its statuses: @@ -174,7 +178,7 @@ Example response: ## Delete a remote mirror -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/82778) in GitLab 14.10. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/82778) in GitLab 14.10. Delete a remote mirror. diff --git a/doc/api/repositories.md b/doc/api/repositories.md index 55df12c132f..bbb0ae418fa 100644 --- a/doc/api/repositories.md +++ b/doc/api/repositories.md @@ -4,7 +4,11 @@ group: Source Code info: "To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments" --- -# Repositories API **(FREE ALL)** +# Repositories API + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed ## List repository tree @@ -415,7 +419,7 @@ curl --request POST --header "PRIVATE-TOKEN: token" \ ## Generate changelog data -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/345934) in GitLab 14.6. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/345934) in GitLab 14.6. Generate changelog data based on commits in a repository, without committing them to a changelog file. diff --git a/doc/api/repository_files.md b/doc/api/repository_files.md index 6e538683fa4..edd03e3c38f 100644 --- a/doc/api/repository_files.md +++ b/doc/api/repository_files.md @@ -4,7 +4,11 @@ group: Source Code info: "To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments" --- -# Repository files API **(FREE ALL)** +# Repository files API + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed You can fetch, create, update, and delete files in your repository with this API. You can also [configure rate limits](../administration/settings/files_api_rate_limits.md) diff --git a/doc/api/repository_submodules.md b/doc/api/repository_submodules.md index 78ed4be7974..e55cdb049fa 100644 --- a/doc/api/repository_submodules.md +++ b/doc/api/repository_submodules.md @@ -4,7 +4,11 @@ group: Source Code info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Repository submodules API **(FREE ALL)** +# Repository submodules API + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed ## Update existing submodule reference in repository diff --git a/doc/api/resource_groups.md b/doc/api/resource_groups.md index 8f0e1ad2f24..d8caae215c0 100644 --- a/doc/api/resource_groups.md +++ b/doc/api/resource_groups.md @@ -4,7 +4,11 @@ group: Environments info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Resource group API **(FREE ALL)** +# Resource group API + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed You can read more about [controlling the job concurrency with resource groups](../ci/resource_groups/index.md). diff --git a/doc/api/resource_iteration_events.md b/doc/api/resource_iteration_events.md index 0e353a703e1..622aa29b0d7 100644 --- a/doc/api/resource_iteration_events.md +++ b/doc/api/resource_iteration_events.md @@ -4,7 +4,11 @@ group: Project Management info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Resource iteration events API **(PREMIUM ALL)** +# Resource iteration events API + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/229463) in GitLab 13.4. > - [Feature flag removed](https://gitlab.com/gitlab-org/gitlab/-/issues/229463) in GitLab 13.5. diff --git a/doc/api/resource_label_events.md b/doc/api/resource_label_events.md index 7aa3e893387..b842bcf19e0 100644 --- a/doc/api/resource_label_events.md +++ b/doc/api/resource_label_events.md @@ -4,7 +4,11 @@ group: Compliance info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Resource label events API **(FREE ALL)** +# Resource label events API + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed Resource label events keep track about who, when, and which label was added to (or removed from) an issue, merge request, or epic. @@ -95,7 +99,11 @@ Parameters: curl --header "PRIVATE-TOKEN: " "https://gitlab.example.com/api/v4/projects/5/issues/11/resource_label_events/1" ``` -## Epics **(PREMIUM ALL)** +## Epics + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed ### List group epic label events diff --git a/doc/api/resource_milestone_events.md b/doc/api/resource_milestone_events.md index bc98ade1f87..e1a78d74c25 100644 --- a/doc/api/resource_milestone_events.md +++ b/doc/api/resource_milestone_events.md @@ -4,9 +4,13 @@ group: Project Management info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Resource milestone events API **(FREE ALL)** +# Resource milestone events API -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/31720) in GitLab 13.1. +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/31720) in GitLab 13.1. Resource [milestone](../user/project/milestones/index.md) events keep track of what happens to GitLab [issues](../user/project/issues/index.md) and [merge requests](../user/project/merge_requests/index.md). diff --git a/doc/api/resource_state_events.md b/doc/api/resource_state_events.md index c2b2c80883a..d844d70e917 100644 --- a/doc/api/resource_state_events.md +++ b/doc/api/resource_state_events.md @@ -4,9 +4,13 @@ group: Project Management info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Resource state events API **(FREE ALL)** +# Resource state events API -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/35210/) in GitLab 13.2. +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/35210/) in GitLab 13.2. Resource state events keep track of what happens to GitLab [issues](../user/project/issues/index.md) [merge requests](../user/project/merge_requests/index.md) and [epics starting with GitLab 15.4](../user/group/epics/index.md) @@ -218,7 +222,7 @@ Example response: ## Epics -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/97554) in GitLab 15.4. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/97554) in GitLab 15.4. ### List group epic state events diff --git a/doc/api/resource_weight_events.md b/doc/api/resource_weight_events.md index c6d7ecde667..c4b43c287d6 100644 --- a/doc/api/resource_weight_events.md +++ b/doc/api/resource_weight_events.md @@ -4,9 +4,13 @@ group: Project Management info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Resource weight events API **(FREE ALL)** +# Resource weight events API -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/32542) in GitLab 13.2. +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/32542) in GitLab 13.2. Resource weight events keep track of what happens to GitLab [issues](../user/project/issues/index.md). diff --git a/doc/api/rest/index.md b/doc/api/rest/index.md index 1b943f37e3f..c5bc1e79a88 100644 --- a/doc/api/rest/index.md +++ b/doc/api/rest/index.md @@ -5,7 +5,11 @@ description: Programmatic interaction with GitLab. info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# REST API **(FREE ALL)** +# REST API + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed The REST APIs have been around for a longer time compared to GraphQL APIs, which may make them more familiar to some developers. It is often a good choice for @@ -865,7 +869,7 @@ API endpoints do not support `text/plain` by default, unless it's explicitly doc ## Resolve requests detected as spam -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/352913) in GitLab 14.9. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/352913) in GitLab 14.9. REST API requests can be detected as spam. If a request is detected as spam and: diff --git a/doc/api/runners.md b/doc/api/runners.md index 373fc4e4344..0dbd506d6d3 100644 --- a/doc/api/runners.md +++ b/doc/api/runners.md @@ -4,7 +4,11 @@ group: Runner info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Runners API **(FREE ALL)** +# Runners API + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed This page describes endpoints for runners registered to an instance. To create a runner linked to the current user, see [Create a runner](users.md#create-a-runner-linked-to-a-user). @@ -107,7 +111,11 @@ Example response: ] ``` -## List all runners **(FREE SELF)** +## List all runners + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed Get a list of all runners in the GitLab instance (project and shared). Access is restricted to users with administrator access. @@ -370,7 +378,7 @@ and will be removed in [a future version of the REST API](https://gitlab.com/git ## List jobs processed by a runner -> [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/15432) in GitLab 10.3. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/15432) in GitLab 10.3. List jobs that are being processed or were processed by the specified runner. The list of jobs is limited to projects where the user has at least the Reporter role. @@ -786,7 +794,7 @@ Example response: ## Reset instance's runner registration token -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/30942) in GitLab 14.3. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/30942) in GitLab 14.3. WARNING: Runner registration tokens, and support for certain configuration arguments, were [deprecated](https://gitlab.com/gitlab-org/gitlab/-/issues/380872) in GitLab 15.6 and will be removed in GitLab 17.0. After GitLab 17.0, you will no longer be able to reset runner registration tokens and the `reset_registration_token` endpoint will not function. @@ -804,7 +812,7 @@ curl --request POST --header "PRIVATE-TOKEN: " \ ## Reset project's runner registration token -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/30942) in GitLab 14.3. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/30942) in GitLab 14.3. WARNING: Runner registration tokens, and support for certain configuration arguments, were [deprecated](https://gitlab.com/gitlab-org/gitlab/-/issues/380872) in GitLab 15.6 and will be removed in GitLab 17.0. After GitLab 17.0, you will no longer be able to reset runner registration tokens and the `reset_registration_token` endpoint will not function. @@ -822,7 +830,7 @@ curl --request POST --header "PRIVATE-TOKEN: " \ ## Reset group's runner registration token -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/30942) in GitLab 14.3. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/30942) in GitLab 14.3. WARNING: Runner registration tokens, and support for certain configuration arguments, were [deprecated](https://gitlab.com/gitlab-org/gitlab/-/issues/380872) in GitLab 15.6 and will be removed in GitLab 17.0. After GitLab 17.0, you will no longer be able to reset runner registration tokens and the `reset_registration_token` endpoint will not function. diff --git a/doc/api/saml.md b/doc/api/saml.md index 548ac17e4e7..c821e200227 100644 --- a/doc/api/saml.md +++ b/doc/api/saml.md @@ -4,9 +4,13 @@ group: Authentication info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# SAML API **(PREMIUM ALL)** +# SAML API -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/227841) in GitLab 15.5. +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/227841) in GitLab 15.5. API for accessing SAML features. @@ -51,7 +55,7 @@ Example response: ## Get a single SAML identity -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/123591) in GitLab 16.1. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/123591) in GitLab 16.1. ```plaintext GET /groups/:id/saml/:uid @@ -108,7 +112,7 @@ curl --location --request PATCH "https://gitlab.example.com/api/v4/groups/33/sam ## Delete a single SAML identity -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/423592) in GitLab 16.5. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/423592) in GitLab 16.5. ```plaintext DELETE /groups/:id/saml/:uid diff --git a/doc/api/scim.md b/doc/api/scim.md index ea8284c4c4e..dfbceadde4b 100644 --- a/doc/api/scim.md +++ b/doc/api/scim.md @@ -3,9 +3,13 @@ stage: Govern group: Authentication info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# SCIM API **(PREMIUM SAAS)** +# SCIM API -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/98354) in GitLab 15.5. +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/98354) in GitLab 15.5. The GitLab SCIM API manages SCIM identities within groups and provides the `/groups/:groups_id/scim/identities` and `/groups/:groups_id/scim/:uid` endpoints. The base URL is `:///api/v4`. @@ -26,7 +30,7 @@ This API is different to the [internal group SCIM API](../development/internal_a ## Get SCIM identities for a group -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/227841) in GitLab 15.5. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/227841) in GitLab 15.5. ```plaintext GET /groups/:id/scim/identities @@ -68,7 +72,7 @@ curl --location --request GET "https://gitlab.example.com/api/v4/groups/33/scim/ ## Get a single SCIM identity -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/123591) in GitLab 16.1. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/123591) in GitLab 16.1. ```plaintext GET /groups/:id/scim/:uid @@ -99,7 +103,7 @@ Example response: ## Update `extern_uid` field for a SCIM identity -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/227841) in GitLab 15.5. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/227841) in GitLab 15.5. Fields that can be updated are: @@ -128,7 +132,7 @@ curl --location --request PATCH "https://gitlab.example.com/api/v4/groups/33/sci ## Delete a single SCIM identity -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/423592) in GitLab 16.5. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/423592) in GitLab 16.5. ```plaintext DELETE /groups/:id/scim/:uid diff --git a/doc/api/search.md b/doc/api/search.md index 68b845227db..316b8d17352 100644 --- a/doc/api/search.md +++ b/doc/api/search.md @@ -4,13 +4,21 @@ group: Global Search info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments --- -# Search API **(FREE ALL)** +# Search API + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed > [Feature flag `search_filter_by_confidential` removed](https://gitlab.com/gitlab-org/gitlab/-/issues/244923) in GitLab 13.6. Every API call to search must be authenticated. -## Additional scopes **(PREMIUM ALL)** +## Additional scopes + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed Additional scopes are available for the [Advanced Search API](#advanced-search-api) and [Group Search API](#group-search-api) if @@ -269,9 +277,13 @@ Example response: ] ``` -### Scope: `wiki_blobs` **(PREMIUM ALL)** +### Scope: `wiki_blobs` -> Moved to GitLab Premium in 13.9. +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed + +> - Moved to GitLab Premium in 13.9. This scope is available only if [Elasticsearch](../integration/advanced_search/elasticsearch.md) is enabled. @@ -301,9 +313,13 @@ Example response: NOTE: `filename` is deprecated in favor of `path`. Both return the full path of the file inside the repository, but in the future `filename` is intended to be only the file name and not the full path. For details, see [issue 34521](https://gitlab.com/gitlab-org/gitlab/-/issues/34521). -### Scope: commits **(PREMIUM ALL)** +### Scope: commits -> Moved to GitLab Premium in 13.9. +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed + +> - Moved to GitLab Premium in 13.9. This scope is available only if [Elasticsearch](../integration/advanced_search/elasticsearch.md) is enabled. @@ -336,9 +352,13 @@ Example response: ] ``` -### Scope: blobs **(PREMIUM ALL)** +### Scope: blobs -> Moved to GitLab Premium in 13.9. +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed + +> - Moved to GitLab Premium in 13.9. This scope is available only if [Elasticsearch](../integration/advanced_search/elasticsearch.md) is enabled. @@ -377,9 +397,13 @@ Example response: NOTE: `filename` is deprecated in favor of `path`. Both return the full path of the file inside the repository, but in the future `filename` is intended to be only the file name and not the full path. For details, see [issue 34521](https://gitlab.com/gitlab-org/gitlab/-/issues/34521). -### Scope: notes **(PREMIUM ALL)** +### Scope: notes -> Moved to GitLab Premium in 13.9. +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed + +> - Moved to GitLab Premium in 13.9. This scope is available only if [Elasticsearch](../integration/advanced_search/elasticsearch.md) is enabled. @@ -660,9 +684,13 @@ Example response: ] ``` -### Scope: `wiki_blobs` **(PREMIUM ALL)** +### Scope: `wiki_blobs` -> Moved to GitLab Premium in 13.9. +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed + +> - Moved to GitLab Premium in 13.9. This scope is available only if [Elasticsearch](../integration/advanced_search/elasticsearch.md) is enabled. @@ -692,9 +720,13 @@ Example response: NOTE: `filename` is deprecated in favor of `path`. Both return the full path of the file inside the repository, but in the future `filename` is intended to be only the file name and not the full path. For details, see [issue 34521](https://gitlab.com/gitlab-org/gitlab/-/issues/34521). -### Scope: `commits` **(PREMIUM ALL)** +### Scope: `commits` -> Moved to GitLab Premium in 13.9. +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed + +> - Moved to GitLab Premium in 13.9. This scope is available only if [Elasticsearch](../integration/advanced_search/elasticsearch.md) is enabled. @@ -727,9 +759,13 @@ Example response: ] ``` -### Scope: `blobs` **(PREMIUM ALL)** +### Scope: `blobs` -> Moved to GitLab Premium in 13.9. +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed + +> - Moved to GitLab Premium in 13.9. This scope is available only if [Elasticsearch](../integration/advanced_search/elasticsearch.md) is enabled. @@ -768,9 +804,13 @@ Example response: NOTE: `filename` is deprecated in favor of `path`. Both return the full path of the file inside the repository, but in the future `filename` is intended to be only the file name and not the full path. For details, see [issue 34521](https://gitlab.com/gitlab-org/gitlab/-/issues/34521). -### Scope: `notes` **(PREMIUM ALL)** +### Scope: `notes` -> Moved to GitLab Premium in 13.9. +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed + +> - Moved to GitLab Premium in 13.9. This scope is available only if [Elasticsearch](../integration/advanced_search/elasticsearch.md) is enabled. @@ -1019,9 +1059,13 @@ Example response: ] ``` -### Scope: `notes` **(PREMIUM ALL)** +### Scope: `notes` -> Moved to GitLab Premium in 13.9. +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed + +> - Moved to GitLab Premium in 13.9. ```shell curl --header "PRIVATE-TOKEN: " "https://gitlab.example.com/api/v4/projects/6/search?scope=notes&search=maxime" @@ -1054,9 +1098,13 @@ Example response: ] ``` -### Scope: `wiki_blobs` **(PREMIUM ALL)** +### Scope: `wiki_blobs` -> Moved to GitLab Premium in 13.9. +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed + +> - Moved to GitLab Premium in 13.9. Filters are available for this scope: @@ -1101,9 +1149,13 @@ Example response: NOTE: `filename` is deprecated in favor of `path`. Both return the full path of the file inside the repository, but in the future `filename` is intended to be only the file name and not the full path. For details, see [issue 34521](https://gitlab.com/gitlab-org/gitlab/-/issues/34521). -### Scope: `commits` **(PREMIUM ALL)** +### Scope: `commits` -> Moved to GitLab Premium in 13.9. +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed + +> - Moved to GitLab Premium in 13.9. This scope is available only if [Elasticsearch](../integration/advanced_search/elasticsearch.md) is enabled. @@ -1136,9 +1188,13 @@ Example response: ] ``` -### Scope: `blobs` **(PREMIUM ALL)** +### Scope: `blobs` -> Moved to GitLab Premium in 13.9. +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed + +> - Moved to GitLab Premium in 13.9. Filters are available for this scope: diff --git a/doc/api/search_admin.md b/doc/api/search_admin.md index 9e1aa1a4439..6ce990d79b3 100644 --- a/doc/api/search_admin.md +++ b/doc/api/search_admin.md @@ -4,9 +4,13 @@ group: Global Search info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments --- -# Search admin API **(PREMIUM SELF)** +# Search admin API -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/120751) in GitLab 16.1 +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** Self-managed + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/120751) in GitLab 16.1 The search admin API returns information about [advanced search migrations](../integration/advanced_search/elasticsearch.md#advanced-search-migrations). diff --git a/doc/api/secure_files.md b/doc/api/secure_files.md index 87c39520942..92c6eba4391 100644 --- a/doc/api/secure_files.md +++ b/doc/api/secure_files.md @@ -4,7 +4,11 @@ group: Pipeline Security info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Project-level Secure Files API **(FREE ALL)** +# Project-level Secure Files API + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/78227) in GitLab 14.8 [with a flag](../administration/feature_flags.md) named `ci_secure_files`. Disabled by default. > - [Generally available](https://gitlab.com/gitlab-org/gitlab/-/issues/350748) in GitLab 15.7. Feature flag `ci_secure_files` removed. diff --git a/doc/api/settings.md b/doc/api/settings.md index edc5962b509..22b95c8f7df 100644 --- a/doc/api/settings.md +++ b/doc/api/settings.md @@ -4,7 +4,11 @@ group: Authentication info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Application settings API **(FREE SELF)** +# Application settings API + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed These API calls allow you to read and modify GitLab instance [application settings](#list-of-settings-that-can-be-accessed-via-api-calls) diff --git a/doc/api/sidekiq_metrics.md b/doc/api/sidekiq_metrics.md index 0f05359d431..ade4deeb3d6 100644 --- a/doc/api/sidekiq_metrics.md +++ b/doc/api/sidekiq_metrics.md @@ -4,7 +4,11 @@ group: Distribution info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Sidekiq Metrics API **(FREE SELF)** +# Sidekiq Metrics API + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed This API endpoint allows you to retrieve some information about the current state of Sidekiq, its jobs, queues, and processes. diff --git a/doc/api/snippet_repository_storage_moves.md b/doc/api/snippet_repository_storage_moves.md index 99e259589b8..f66187e8aa7 100644 --- a/doc/api/snippet_repository_storage_moves.md +++ b/doc/api/snippet_repository_storage_moves.md @@ -4,9 +4,13 @@ group: Source Code info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Snippet repository storage moves API **(FREE SELF)** +# Snippet repository storage moves API -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/49228) in GitLab 13.8. +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/49228) in GitLab 13.8. Snippet repositories can be moved between storages. This API can help you when [migrating to Gitaly Cluster](../administration/gitaly/index.md#migrate-to-gitaly-cluster), for @@ -213,7 +217,7 @@ Example response: ## Schedule a repository storage move for a snippet -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/49228) in GitLab 13.8. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/49228) in GitLab 13.8. ```plaintext POST /snippets/:snippet_id/repository_storage_moves @@ -262,7 +266,7 @@ Example response: ## Schedule repository storage moves for all snippets on a storage shard -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/49228) in GitLab 13.8. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/49228) in GitLab 13.8. Schedules repository storage moves for each snippet repository stored on the source storage shard. This endpoint migrates all snippets at once. For more information, see diff --git a/doc/api/snippets.md b/doc/api/snippets.md index a580a11ce27..395bbe62960 100644 --- a/doc/api/snippets.md +++ b/doc/api/snippets.md @@ -4,7 +4,11 @@ group: Source Code info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Snippets API **(FREE ALL)** +# Snippets API + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed Snippets API operates on [snippets](../user/snippets.md). Related APIs exist for [project snippets](project_snippets.md) and @@ -457,7 +461,7 @@ Example response: ## List all snippets -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/419640) in GitLab 16.3. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/419640) in GitLab 16.3. List all snippets the current user has access to. Users with the Administrator or Auditor access levels can see all snippets diff --git a/doc/api/statistics.md b/doc/api/statistics.md index fc0aa9a0b39..4898c9e3284 100644 --- a/doc/api/statistics.md +++ b/doc/api/statistics.md @@ -4,7 +4,11 @@ group: Authentication info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Application statistics API **(FREE SELF)** +# Application statistics API + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed ## Get current application statistics diff --git a/doc/api/status_checks.md b/doc/api/status_checks.md index 8ba037f7e68..5e3ebd9d19c 100644 --- a/doc/api/status_checks.md +++ b/doc/api/status_checks.md @@ -4,7 +4,11 @@ group: Compliance info: "To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments" --- -# External Status Checks API **(ULTIMATE ALL)** +# External Status Checks API + +DETAILS: +**Tier:** Ultimate +**Offering:** SaaS, self-managed > - [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/3869) in GitLab 14.0, disabled behind the `:ff_external_status_checks` feature flag. > - [Feature flag removed](https://gitlab.com/gitlab-org/gitlab/-/issues/320783) in GitLab 14.1. @@ -156,7 +160,7 @@ NOTE: ## Retry failed status check for a merge request -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/383200) in GitLab 15.7. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/383200) in GitLab 15.7. For a single merge request, retry the specified failed external status check. Even though the merge request hasn't changed, this endpoint resends the current state of diff --git a/doc/api/suggestions.md b/doc/api/suggestions.md index 023c7505a73..89b725773ae 100644 --- a/doc/api/suggestions.md +++ b/doc/api/suggestions.md @@ -4,7 +4,11 @@ group: Source Code info: "To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments" --- -# Suggest Changes API **(FREE ALL)** +# Suggest Changes API + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed This page describes the API for [suggesting changes](../user/project/merge_requests/reviews/suggestions.md). diff --git a/doc/api/system_hooks.md b/doc/api/system_hooks.md index 8ee30fcb938..67d024b8d37 100644 --- a/doc/api/system_hooks.md +++ b/doc/api/system_hooks.md @@ -4,7 +4,11 @@ group: Import and Integrate info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# System hooks API **(FREE SELF)** +# System hooks API + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed All methods require administrator authorization. @@ -48,7 +52,7 @@ Example response: ## Get system hook -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/81595) in GitLab 14.9. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/81595) in GitLab 14.9. Get a system hook by its ID. diff --git a/doc/api/tags.md b/doc/api/tags.md index 2b6e90c90bd..5b89ee072cb 100644 --- a/doc/api/tags.md +++ b/doc/api/tags.md @@ -4,7 +4,11 @@ group: Source Code info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Tags API **(FREE ALL)** +# Tags API + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed ## List project repository tags @@ -192,7 +196,7 @@ Parameters: ## Get X.509 signature of a tag -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/106578) in GitLab 15.7. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/106578) in GitLab 15.7. Get the [X.509 signature from a tag](../user/project/repository/signed_commits/x509.md), if it is signed. Unsigned tags return a `404 Not Found` response. diff --git a/doc/api/templates/dockerfiles.md b/doc/api/templates/dockerfiles.md index fa863f5db95..d055c001433 100644 --- a/doc/api/templates/dockerfiles.md +++ b/doc/api/templates/dockerfiles.md @@ -4,14 +4,22 @@ group: Source Code info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Dockerfiles API **(FREE ALL)** +# Dockerfiles API + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed GitLab provides an API endpoint for instance-level Dockerfile templates. Default templates are defined at [`vendor/Dockerfile`](https://gitlab.com/gitlab-org/gitlab-foss/-/tree/master/vendor/Dockerfile) in the GitLab repository. -## Override Dockerfile API templates **(PREMIUM SELF)** +## Override Dockerfile API templates + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** Self-managed In [GitLab Premium and Ultimate](https://about.gitlab.com/pricing/) tiers, GitLab instance administrators can override templates in the diff --git a/doc/api/templates/gitignores.md b/doc/api/templates/gitignores.md index 76a49e9c418..ffc2cd33315 100644 --- a/doc/api/templates/gitignores.md +++ b/doc/api/templates/gitignores.md @@ -4,7 +4,11 @@ group: Source Code info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# .gitignore API **(FREE ALL)** +# .gitignore API + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed In GitLab, the `/gitignores` endpoint returns a list of Git `.gitignore` templates. For more information, see the [Git documentation for `.gitignore`](https://git-scm.com/docs/gitignore). diff --git a/doc/api/templates/gitlab_ci_ymls.md b/doc/api/templates/gitlab_ci_ymls.md index 25667a2e7f7..cea8fc0f0ea 100644 --- a/doc/api/templates/gitlab_ci_ymls.md +++ b/doc/api/templates/gitlab_ci_ymls.md @@ -4,7 +4,11 @@ group: Pipeline Authoring info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# GitLab CI YAML API **(FREE ALL)** +# GitLab CI YAML API + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed In GitLab, there is an API endpoint available to work with GitLab CI/CD YAML. For more information on CI/CD pipeline configuration in GitLab, see the diff --git a/doc/api/templates/licenses.md b/doc/api/templates/licenses.md index 08415660a88..1dbef4b0843 100644 --- a/doc/api/templates/licenses.md +++ b/doc/api/templates/licenses.md @@ -4,7 +4,11 @@ group: Composition Analysis info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Licenses API **(FREE ALL)** +# Licenses API + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed In GitLab, there is an API endpoint available for working with various open source license templates. For more information on the terms of various diff --git a/doc/api/todos.md b/doc/api/todos.md index d17074a92e7..b5c685a7e20 100644 --- a/doc/api/todos.md +++ b/doc/api/todos.md @@ -4,7 +4,11 @@ group: Project Management info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# GitLab To-Do List API **(FREE ALL)** +# GitLab To-Do List API + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed Interact with [to-do items](../user/todos.md) using the REST API. diff --git a/doc/api/topics.md b/doc/api/topics.md index d26f0d10d6b..b349fcaf3f2 100644 --- a/doc/api/topics.md +++ b/doc/api/topics.md @@ -4,9 +4,13 @@ group: Tenant Scale info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Topics API **(FREE ALL)** +# Topics API -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/340920) in GitLab 14.5. +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/340920) in GitLab 14.5. Interact with project topics using the REST API. @@ -200,7 +204,7 @@ curl --request PUT \ ### Remove a topic avatar -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/348148) in GitLab 14.6. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/348148) in GitLab 14.6. To remove a topic avatar, use a blank value for the `avatar` attribute. @@ -215,7 +219,7 @@ curl --request PUT \ ## Delete a project topic -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/80725) in GitLab 14.9. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/80725) in GitLab 14.9. You must be an administrator to delete a project topic. When you delete a project topic, you also delete the topic assignment for projects. @@ -240,7 +244,7 @@ curl --request DELETE \ ## Merge topics -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/95501) in GitLab 15.4. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/95501) in GitLab 15.4. You must be an administrator to merge a source topic into a target topic. When you merge topics, you delete the source topic and move all assigned projects to the target topic. diff --git a/doc/api/usage_data.md b/doc/api/usage_data.md index b0e7a1d2998..46fa88ebb6a 100644 --- a/doc/api/usage_data.md +++ b/doc/api/usage_data.md @@ -4,13 +4,17 @@ group: Analytics Instrumentation info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Service Data API **(FREE SELF)** +# Service Data API + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed The Service Data API is associated with [Service Ping](../development/internal_analytics/service_ping/index.md). ## Export Service Ping data -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/141446) in GitLab 16.9. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/141446) in GitLab 16.9. Requires a Personal Access Token with `read_service_ping` scope. @@ -42,7 +46,7 @@ Example response: ## Export metric definitions as a single YAML file -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/57270) in GitLab 13.11. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/57270) in GitLab 13.11. Export all metric definitions as a single YAML file, similar to the [Metrics Dictionary](https://metrics.gitlab.com/), for easier importing. diff --git a/doc/api/users.md b/doc/api/users.md index e0ffe69e8ef..f04faea85d8 100644 --- a/doc/api/users.md +++ b/doc/api/users.md @@ -4,7 +4,11 @@ group: Authentication info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Users API **(FREE ALL)** +# Users API + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed This documentation has information on API calls, parameters and responses for the Users API. @@ -128,7 +132,11 @@ parameter `without_project_bots=true`. GET /users?without_project_bots=true ``` -### For administrators **(FREE SELF)** +### For administrators + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed > - The `namespace_id` field in the response was [introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/82045) in GitLab 14.10. > - The `created_by` field in the response was [introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/93092) in GitLab 15.6. @@ -379,7 +387,11 @@ Parameters: } ``` -### For administrators **(FREE SELF)** +### For administrators + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed > - The `namespace_id` field in the response was [introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/82045) in GitLab 14.10. > - The `created_by` field in the response was [introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/93092) in GitLab 15.6. @@ -519,7 +531,11 @@ You can include the user's [custom attributes](custom_attributes.md) in the resp GET /users/:id?with_custom_attributes=true ``` -## User creation **(FREE SELF)** +## User creation + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed > - The `namespace_id` field in the response was [introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/82045) in GitLab 14.10. > - Ability to create an auditor user was [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/366404) in GitLab 15.3. @@ -583,7 +599,11 @@ Parameters: | `view_diffs_file_by_file` | No | Flag indicating the user sees only one file diff per page | | `website_url` | No | Website URL | -## User modification **(FREE SELF)** +## User modification + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed > - The `namespace_id` field in the response was [introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/82045) in GitLab 14.10. > - Ability to modify an auditor user was [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/366404) in GitLab 15.3. @@ -639,7 +659,11 @@ Note, at the moment this method does only return a `404` error, even in cases where a `409` (Conflict) would be more appropriate. For example, when renaming the email address to some existing one. -## Delete authentication identity from user **(FREE SELF)** +## Delete authentication identity from user + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed Deletes a user's authentication identity using the provider name associated with that identity. Available only for administrators. @@ -654,7 +678,11 @@ Parameters: | `id` | integer | yes | ID of a user | | `provider` | string | yes | External provider name | -## User deletion **(FREE SELF)** +## User deletion + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed Deletes a user. Available only for administrators. This returns a `204 No Content` status code if the operation was successfully, `404` if the resource was not found or `409` if the user cannot be soft deleted. @@ -732,7 +760,11 @@ GET /user Users on [GitLab Premium or Ultimate](https://about.gitlab.com/pricing/) also see the `shared_runners_minutes_limit`, `extra_shared_runners_minutes_limit` parameters. -### For administrators **(FREE SELF)** +### For administrators + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed > - The `namespace_id` field in the response was [introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/82045) in GitLab 14.10. > - The `created_by` field in the response was [introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/93092) in GitLab 15.6. @@ -1060,9 +1092,13 @@ Example response: } ``` -## Create Service Account User **(PREMIUM SELF)** +## Create Service Account User -> Ability to create a service account user was [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/406782) in GitLab 16.1 +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** Self-managed + +> - Ability to create a service account user was [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/406782) in GitLab 16.1 Creates a service account user with an auto-generated email address and username. Available only for administrators. @@ -1178,7 +1214,7 @@ Parameters: ## Single SSH key for given user -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/81790) in GitLab 14.9. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/81790) in GitLab 14.9. Get a single key for a given user. @@ -1246,7 +1282,11 @@ error occurs a `400 Bad Request` is returned with a message explaining the error } ``` -## Add SSH key for user **(FREE SELF)** +## Add SSH key for user + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed > The `usage_type` parameter was [introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/105551) in GitLab 15.7. @@ -1311,7 +1351,11 @@ Parameters: |-----------|---------|----------|-------------| | `key_id` | integer | yes | SSH key ID | -## Delete SSH key for given user **(FREE SELF)** +## Delete SSH key for given user + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed Deletes key owned by a specified user. Available only for administrator. @@ -1507,7 +1551,11 @@ Example response: } ``` -## Add a GPG key for a given user **(FREE SELF)** +## Add a GPG key for a given user + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed Create new GPG key owned by the specified user. Available only for administrator. @@ -1554,7 +1602,11 @@ Example response: ] ``` -## Delete a GPG key for a given user **(FREE SELF)** +## Delete a GPG key for a given user + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed Delete a GPG key owned by a specified user. Available only for administrator. @@ -1603,7 +1655,11 @@ Parameters: - **none** -## List emails for user **(FREE SELF)** +## List emails for user + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed Get a list of a specified user's emails. Available only for administrator @@ -1677,7 +1733,11 @@ error occurs a `400 Bad Request` is returned with a message explaining the error } ``` -## Add email for user **(FREE SELF)** +## Add email for user + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed Create new email owned by specified user. Available only for administrator @@ -1718,7 +1778,11 @@ Returns: - `204 No Content` if the operation was successful. - `404` if the resource was not found. -## Delete email for given user **(FREE SELF)** +## Delete email for given user + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed Prerequisites: @@ -1737,7 +1801,11 @@ Parameters: | `id` | integer | yes | ID of specified user | | `email_id` | integer | yes | Email ID | -## Block user **(FREE SELF)** +## Block user + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed Blocks the specified user. Available only for administrator. @@ -1759,7 +1827,11 @@ Returns: - A user that is blocked through LDAP. - An internal user. -## Unblock user **(FREE SELF)** +## Unblock user + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed Unblocks the specified user. Available only for administrator. @@ -1776,9 +1848,13 @@ Parameters: Returns `201 OK` on success, `404 User Not Found` is user cannot be found or `403 Forbidden` when trying to unblock a user blocked by LDAP synchronization. -## Deactivate user **(FREE SELF)** +## Deactivate user -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/22257) in GitLab 12.4. +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/22257) in GitLab 12.4. Deactivates the specified user. Available only for administrator. @@ -1801,9 +1877,13 @@ Returns: - Not [dormant](../administration/moderate_users.md#automatically-deactivate-dormant-users). - Internal. -## Activate user **(FREE SELF)** +## Activate user -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/22257) in GitLab 12.4. +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/22257) in GitLab 12.4. Activates the specified user. Available only for administrator. @@ -1823,9 +1903,13 @@ Returns: - `404 User Not Found` if the user cannot be found. - `403 Forbidden` if the user cannot be activated because they are blocked by an administrator or by LDAP synchronization. -## Ban user **(FREE SELF)** +## Ban user -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/327354) in GitLab 14.3. +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/327354) in GitLab 14.3. Bans the specified user. Available only for administrator. @@ -1843,9 +1927,13 @@ Returns: - `404 User Not Found` if user cannot be found. - `403 Forbidden` when trying to ban a user that is not active. -## Unban user **(FREE SELF)** +## Unban user -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/327354) in GitLab 14.3. +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/327354) in GitLab 14.3. Unbans the specified user. Available only for administrator. @@ -1867,7 +1955,11 @@ Returns: See the [Events API documentation](events.md#get-user-contribution-events) -## Get all impersonation tokens of a user **(FREE SELF)** +## Get all impersonation tokens of a user + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed Requires administrator access. @@ -1924,9 +2016,13 @@ Example response: ] ``` -## Approve user **(FREE SELF)** +## Approve user -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/263107) in GitLab 13.7. +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/263107) in GitLab 13.7. Approves the specified user. Available only for administrators. @@ -1965,9 +2061,13 @@ Example Responses: { "message": "The user you are trying to approve is not pending approval" } ``` -## Reject user **(FREE SELF)** +## Reject user -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/339925) in GitLab 14.3. +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/339925) in GitLab 14.3. Rejects specified user that is [pending approval](../administration/moderate_users.md#users-pending-approval). Available only for administrators. @@ -2004,7 +2104,11 @@ Example Responses: { "message": "User does not have a pending request" } ``` -## Get an impersonation token of a user **(FREE SELF)** +## Get an impersonation token of a user + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed > Requires administrators permissions. @@ -2043,7 +2147,11 @@ Example response: } ``` -## Create an impersonation token **(FREE SELF)** +## Create an impersonation token + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed Requires administrator access. Token values are returned once. Make sure you save it because you can't access it again. @@ -2088,7 +2196,11 @@ Example response: } ``` -## Revoke an impersonation token **(FREE SELF)** +## Revoke an impersonation token + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed Requires administrator access. @@ -2109,7 +2221,11 @@ Parameters: curl --request DELETE --header "PRIVATE-TOKEN: " "https://gitlab.example.com/api/v4/users/42/impersonation_tokens/1" ``` -## Create a personal access token **(FREE SELF)** +## Create a personal access token + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/17176) in GitLab 13.6. > - [Feature flag removed](https://gitlab.com/gitlab-org/gitlab/-/issues/267553) in GitLab 13.8. @@ -2153,9 +2269,13 @@ Example response: } ``` -## Create a personal access token with limited scopes for the currently authenticated user **(FREE SELF)** +## Create a personal access token with limited scopes for the currently authenticated user -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/131923) in GitLab 16.5. +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/131923) in GitLab 16.5. Use this API to create a new personal access token for the currently authenticated user. For security purposes, the token: @@ -2199,7 +2319,11 @@ Example response: } ``` -## Get user activities **(FREE SELF)** +## Get user activities + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed Pre-requisite: @@ -2256,9 +2380,13 @@ Example response: `last_activity_at` is deprecated. Use `last_activity_on` instead. -## User memberships **(FREE SELF)** +## User memberships -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/20532) in GitLab 12.8. +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/20532) in GitLab 12.8. Pre-requisite: @@ -2310,9 +2438,13 @@ Example response: ] ``` -## Disable two factor authentication **(FREE SELF)** +## Disable two factor authentication -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/295260) in GitLab 15.2. +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/295260) in GitLab 15.2. Pre-requisite: @@ -2344,7 +2476,11 @@ Returns: - `403 Forbidden` if not authenticated as an administrator. - `404 User Not Found` if user cannot be found. -## Create a runner linked to a user **(FREE ALL)** +## Create a runner linked to a user + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed Creates a runner linked to the current user. diff --git a/doc/api/version.md b/doc/api/version.md index 12f7a23ac34..1607b5b9eee 100644 --- a/doc/api/version.md +++ b/doc/api/version.md @@ -4,7 +4,11 @@ group: Environments info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Version API **(FREE ALL)** +# Version API + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed NOTE: We recommend you use the [Metadata API](metadata.md) instead of the Version API. diff --git a/doc/api/visual_review_discussions.md b/doc/api/visual_review_discussions.md index 5dbde8e5dbf..d33ce9f067d 100644 --- a/doc/api/visual_review_discussions.md +++ b/doc/api/visual_review_discussions.md @@ -5,7 +5,11 @@ info: To determine the technical writer assigned to the Stage/Group associated w --- -# Visual Review discussions API (deprecated) **(PREMIUM ALL)** +# Visual Review discussions API (deprecated) + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/18710) in GitLab 12.5. > - [Moved](https://about.gitlab.com/blog/2021/01/26/new-gitlab-product-subscription-model/) to GitLab Premium in 13.9. diff --git a/doc/api/vulnerabilities.md b/doc/api/vulnerabilities.md index e16f9b244a9..bed10f14e34 100644 --- a/doc/api/vulnerabilities.md +++ b/doc/api/vulnerabilities.md @@ -4,7 +4,11 @@ group: Threat Insights info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Vulnerabilities API **(ULTIMATE ALL)** +# Vulnerabilities API + +DETAILS: +**Tier:** Ultimate +**Offering:** SaaS, self-managed > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/10242) in GitLab 12.6. > - `last_edited_at` [deprecated](https://gitlab.com/gitlab-org/gitlab/-/issues/268154) in GitLab 16.7. diff --git a/doc/api/vulnerability_exports.md b/doc/api/vulnerability_exports.md index f2e0784cda7..e543287e93e 100644 --- a/doc/api/vulnerability_exports.md +++ b/doc/api/vulnerability_exports.md @@ -4,9 +4,13 @@ group: Threat Insights info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Vulnerability export API **(ULTIMATE ALL)** +# Vulnerability export API -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/197494) in GitLab 12.10. [Updated](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/30397) in GitLab 13.0. +DETAILS: +**Tier:** Ultimate +**Offering:** SaaS, self-managed + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/197494) in GitLab 12.10. [Updated](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/30397) in GitLab 13.0. Every API call to vulnerability exports must be [authenticated](rest/index.md#authentication). diff --git a/doc/api/vulnerability_findings.md b/doc/api/vulnerability_findings.md index c84a1e87164..176e68be357 100644 --- a/doc/api/vulnerability_findings.md +++ b/doc/api/vulnerability_findings.md @@ -4,9 +4,13 @@ group: Threat Insights info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Vulnerability Findings API **(ULTIMATE ALL)** +# Vulnerability Findings API -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/19029) in GitLab 12.5. +DETAILS: +**Tier:** Ultimate +**Offering:** SaaS, self-managed + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/19029) in GitLab 12.5. NOTE: This API resource is renamed from Vulnerabilities to Vulnerability Findings because the Vulnerabilities are reserved diff --git a/doc/api/wikis.md b/doc/api/wikis.md index fba68d6c832..ffb69f15081 100644 --- a/doc/api/wikis.md +++ b/doc/api/wikis.md @@ -4,7 +4,11 @@ group: Knowledge info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Project wikis API **(FREE ALL)** +# Project wikis API + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed > - The `encoding` field was [added](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/81150) in GitLab 14.9. > - The `render_html` attribute was [added](https://gitlab.com/gitlab-org/gitlab/-/issues/336792) in GitLab 14.9. diff --git a/doc/architecture/blueprints/gitlab_to_kubernetes_communication/index.md b/doc/architecture/blueprints/gitlab_to_kubernetes_communication/index.md index 6b1b4d452c9..06f3ef021f3 100644 --- a/doc/architecture/blueprints/gitlab_to_kubernetes_communication/index.md +++ b/doc/architecture/blueprints/gitlab_to_kubernetes_communication/index.md @@ -8,7 +8,7 @@ owning-stage: "~devops::configure" participating-stages: [] --- -# GitLab to Kubernetes communication **(FREE ALL)** +# GitLab to Kubernetes communication The goal of this document is to define how GitLab can communicate with Kubernetes and in-cluster services through the GitLab agent. diff --git a/doc/ci/caching/index.md b/doc/ci/caching/index.md index 737b18fb6c2..cf1778d68f3 100644 --- a/doc/ci/caching/index.md +++ b/doc/ci/caching/index.md @@ -4,7 +4,11 @@ group: Pipeline Authoring info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Caching in GitLab CI/CD **(FREE ALL)** +# Caching in GitLab CI/CD + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed A cache is one or more files a job downloads and saves. Subsequent jobs that use the same cache don't have to download the files again, so they execute more quickly. @@ -99,7 +103,7 @@ the global fallback cache is fetched every time a cache is not found. ### Per-cache fallback keys -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/110467) in GitLab 16.0 +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/110467) in GitLab 16.0 Each cache entry supports up to five fallback keys with the [`fallback_keys` keyword](../yaml/index.md#cachefallback_keys). When a job does not find a cache key, the job attempts to retrieve a fallback cache instead. @@ -141,7 +145,7 @@ Fallback keys follow the same processing logic as `cache:key`: ### Global fallback key -> [Introduced](https://gitlab.com/gitlab-org/gitlab-runner/-/merge_requests/1534) in GitLab Runner 13.4. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab-runner/-/merge_requests/1534) in GitLab Runner 13.4. You can use the `$CI_COMMIT_REF_SLUG` [predefined variable](../variables/predefined_variables.md) to specify your [`cache:key`](../yaml/index.md#cachekey). For example, if your @@ -265,7 +269,7 @@ cache: ### Use a variable to control a job's cache policy -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/371480) in GitLab 16.1. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/371480) in GitLab 16.1. To reduce duplication of jobs where the only difference is the pull policy, you can use a [CI/CD variable](../variables/index.md). @@ -513,7 +517,7 @@ be overwritten because caches are restored before artifacts. #### Cache key names -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/330047) in GitLab 15.0. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/330047) in GitLab 15.0. A suffix is added to the cache key, with the exception of the [global fallback cache key](#global-fallback-key). @@ -527,7 +531,7 @@ and `feature`, then the following table represents the resulting cache keys: ##### Use the same cache for all branches -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/361643) in GitLab 15.0. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/361643) in GitLab 15.0. If you do not want to use [cache key names](#cache-key-names), you can have all branches (protected and unprotected) use the same cache. diff --git a/doc/ci/chatops/index.md b/doc/ci/chatops/index.md index d84ff3550bd..0e1bc38b1b8 100644 --- a/doc/ci/chatops/index.md +++ b/doc/ci/chatops/index.md @@ -4,7 +4,11 @@ group: Environments info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# GitLab ChatOps **(FREE ALL)** +# GitLab ChatOps + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/4466) in GitLab Ultimate 10.6. > - [Moved](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/24780) to GitLab Free in 11.9. diff --git a/doc/ci/ci_cd_for_external_repos/bitbucket_integration.md b/doc/ci/ci_cd_for_external_repos/bitbucket_integration.md index 0dbc165e5ee..ef416e4f477 100644 --- a/doc/ci/ci_cd_for_external_repos/bitbucket_integration.md +++ b/doc/ci/ci_cd_for_external_repos/bitbucket_integration.md @@ -4,7 +4,11 @@ group: Pipeline Execution info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Using GitLab CI/CD with a Bitbucket Cloud repository **(PREMIUM ALL)** +# Using GitLab CI/CD with a Bitbucket Cloud repository + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed GitLab CI/CD can be used with Bitbucket Cloud by: diff --git a/doc/ci/ci_cd_for_external_repos/github_integration.md b/doc/ci/ci_cd_for_external_repos/github_integration.md index 5c57cb1d393..25114da9c32 100644 --- a/doc/ci/ci_cd_for_external_repos/github_integration.md +++ b/doc/ci/ci_cd_for_external_repos/github_integration.md @@ -4,7 +4,11 @@ group: Pipeline Execution info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Using GitLab CI/CD with a GitHub repository **(PREMIUM ALL)** +# Using GitLab CI/CD with a GitHub repository + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed GitLab CI/CD can be used with **GitHub.com** and **GitHub Enterprise** by creating a [CI/CD project](index.md) to connect your GitHub repository to diff --git a/doc/ci/ci_cd_for_external_repos/index.md b/doc/ci/ci_cd_for_external_repos/index.md index dbe56edce7e..86b82a3b993 100644 --- a/doc/ci/ci_cd_for_external_repos/index.md +++ b/doc/ci/ci_cd_for_external_repos/index.md @@ -4,7 +4,11 @@ group: Pipeline Execution info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# GitLab CI/CD for external repositories **(PREMIUM ALL)** +# GitLab CI/CD for external repositories + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed >[Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/4642) in GitLab 10.6. @@ -34,7 +38,7 @@ the [import sources configuration](../../administration/settings/import_and_expo ## Pipelines for external pull requests -> [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/issues/65139) in GitLab 12.3. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/issues/65139) in GitLab 12.3. When using GitLab CI/CD with an [external repository on GitHub](github_integration.md), it's possible to run a pipeline in the context of a Pull Request. diff --git a/doc/ci/cloud_deployment/ecs/deploy_to_aws_ecs.md b/doc/ci/cloud_deployment/ecs/deploy_to_aws_ecs.md index 82f92cdc938..eb070c65ae9 100644 --- a/doc/ci/cloud_deployment/ecs/deploy_to_aws_ecs.md +++ b/doc/ci/cloud_deployment/ecs/deploy_to_aws_ecs.md @@ -4,7 +4,11 @@ group: Environments info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Deploy to Amazon Elastic Container Service **(FREE ALL)** +# Deploy to Amazon Elastic Container Service + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed This step-by-step guide helps you deploy a project hosted on GitLab.com to the Amazon [Elastic Container Service (ECS)](https://aws.amazon.com/ecs/). diff --git a/doc/ci/cloud_deployment/index.md b/doc/ci/cloud_deployment/index.md index 14149aa6446..6f66db2189c 100644 --- a/doc/ci/cloud_deployment/index.md +++ b/doc/ci/cloud_deployment/index.md @@ -4,7 +4,11 @@ group: Environments info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Deploy to AWS from GitLab CI/CD **(FREE ALL)** +# Deploy to AWS from GitLab CI/CD + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed GitLab provides Docker images with the libraries and tools you need to deploy to AWS. You can reference these images in your CI/CD pipeline. @@ -145,7 +149,7 @@ because the override stops working when the name changes. ## Deploy your application to EC2 -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/201742) in GitLab 13.5. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/201742) in GitLab 13.5. GitLab provides a template, called `AWS/CF-Provision-and-Deploy-EC2`, to assist you in deploying to Amazon EC2. diff --git a/doc/ci/cloud_services/aws/index.md b/doc/ci/cloud_services/aws/index.md index b6086ed3543..fbf502f0f0b 100644 --- a/doc/ci/cloud_services/aws/index.md +++ b/doc/ci/cloud_services/aws/index.md @@ -4,7 +4,11 @@ group: Pipeline Security info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Configure OpenID Connect in AWS to retrieve temporary credentials **(FREE ALL)** +# Configure OpenID Connect in AWS to retrieve temporary credentials + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed WARNING: `CI_JOB_JWT_V2` was [deprecated in GitLab 15.9](../../../update/deprecations.md#old-versions-of-json-web-tokens-are-deprecated) diff --git a/doc/ci/cloud_services/azure/index.md b/doc/ci/cloud_services/azure/index.md index b3fcaabfdde..e5a775e083d 100644 --- a/doc/ci/cloud_services/azure/index.md +++ b/doc/ci/cloud_services/azure/index.md @@ -4,7 +4,11 @@ group: Pipeline Security info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Configure OpenID Connect in Azure to retrieve temporary credentials **(FREE ALL)** +# Configure OpenID Connect in Azure to retrieve temporary credentials + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed WARNING: `CI_JOB_JWT_V2` was [deprecated in GitLab 15.9](../../../update/deprecations.md#old-versions-of-json-web-tokens-are-deprecated) diff --git a/doc/ci/cloud_services/google_cloud/index.md b/doc/ci/cloud_services/google_cloud/index.md index b38566309c9..981fea5c417 100644 --- a/doc/ci/cloud_services/google_cloud/index.md +++ b/doc/ci/cloud_services/google_cloud/index.md @@ -4,7 +4,11 @@ group: Pipeline Security info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Configure OpenID Connect with GCP Workload Identity Federation **(FREE ALL)** +# Configure OpenID Connect with GCP Workload Identity Federation + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed WARNING: `CI_JOB_JWT_V2` was [deprecated in GitLab 15.9](../../../update/deprecations.md#old-versions-of-json-web-tokens-are-deprecated) diff --git a/doc/ci/cloud_services/index.md b/doc/ci/cloud_services/index.md index 17d967e7a0d..7072babdd7b 100644 --- a/doc/ci/cloud_services/index.md +++ b/doc/ci/cloud_services/index.md @@ -4,7 +4,11 @@ group: Pipeline Security info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Connect to cloud services **(FREE ALL)** +# Connect to cloud services + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed > - `CI_JOB_JWT` variable for reading secrets from Vault [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/207125) in GitLab 12.10. > - `CI_JOB_JWT_V2` variable to support additional OIDC providers [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/346737) in GitLab 14.7. diff --git a/doc/ci/components/index.md b/doc/ci/components/index.md index 55f0cc67a87..03e4573f53a 100644 --- a/doc/ci/components/index.md +++ b/doc/ci/components/index.md @@ -4,7 +4,12 @@ group: Pipeline Authoring info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# CI/CD components **(FREE ALL BETA)** +# CI/CD components + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed +**Status:** Beta > - Introduced as an [experimental feature](../../policy/experiment-beta-support.md) in GitLab 16.0, [with a flag](../../administration/feature_flags.md) named `ci_namespace_catalog_experimental`. Disabled by default. > - [Enabled on GitLab.com and self-managed](https://gitlab.com/groups/gitlab-org/-/epics/9897) in GitLab 16.2. @@ -155,7 +160,12 @@ a patch fix like `1.5.1`, then `~latest` returns the `1.5.1` release. [Issue #427286](https://gitlab.com/gitlab-org/gitlab/-/issues/427286) proposes to change this behavior. -## CI/CD Catalog **(FREE ALL BETA)** +## CI/CD Catalog + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed +**Status:** Beta > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/407249) in GitLab 16.1 as an [experiment](../../policy/experiment-beta-support.md#experiment). > - [Moved](https://gitlab.com/gitlab-org/gitlab/-/issues/432045) to [beta](../../policy/experiment-beta-support.md#beta) in GitLab 16.7. diff --git a/doc/ci/debugging.md b/doc/ci/debugging.md index 84715cda2f5..cbbc4090782 100644 --- a/doc/ci/debugging.md +++ b/doc/ci/debugging.md @@ -4,7 +4,11 @@ group: Pipeline Authoring info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Debugging CI/CD pipelines **(FREE ALL)** +# Debugging CI/CD pipelines + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed GitLab provides several tools to help make it easier to debug your CI/CD configuration. diff --git a/doc/ci/directed_acyclic_graph/index.md b/doc/ci/directed_acyclic_graph/index.md index fab784783f6..69012e3a69f 100644 --- a/doc/ci/directed_acyclic_graph/index.md +++ b/doc/ci/directed_acyclic_graph/index.md @@ -4,7 +4,11 @@ group: Pipeline Authoring info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Directed Acyclic Graph **(FREE ALL)** +# Directed Acyclic Graph + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed > - [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/issues/47063) in GitLab 12.2. > - [Feature flag removed](https://gitlab.com/gitlab-org/gitlab/-/issues/206902) in GitLab 12.10. diff --git a/doc/ci/docker/index.md b/doc/ci/docker/index.md index f4e7587f02e..880e2ea1d2a 100644 --- a/doc/ci/docker/index.md +++ b/doc/ci/docker/index.md @@ -4,7 +4,11 @@ group: Pipeline Execution info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Docker integration **(FREE ALL)** +# Docker integration + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed There are two primary ways to incorporate [Docker](https://www.docker.com) into your CI/CD workflow: diff --git a/doc/ci/docker/using_docker_build.md b/doc/ci/docker/using_docker_build.md index bc157c7ae08..5565c7ca60c 100644 --- a/doc/ci/docker/using_docker_build.md +++ b/doc/ci/docker/using_docker_build.md @@ -4,7 +4,11 @@ group: Pipeline Execution info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Use Docker to build Docker images **(FREE ALL)** +# Use Docker to build Docker images + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed You can use GitLab CI/CD with Docker to create Docker images. For example, you can create a Docker image of your application, @@ -100,7 +104,7 @@ You can use the Docker executor to run jobs in a Docker container. ##### Docker-in-Docker with TLS enabled in the Docker executor -> Introduced in GitLab Runner 11.11. +> - Introduced in GitLab Runner 11.11. The Docker daemon supports connections over TLS. TLS is the default in Docker 19.03.12 and later. @@ -253,7 +257,7 @@ You can use the [Kubernetes executor](https://docs.gitlab.com/runner/executors/k ##### Docker-in-Docker with TLS enabled in Kubernetes -> [Introduced](https://gitlab.com/gitlab-org/charts/gitlab-runner/-/issues/106) in GitLab Runner Helm Chart 0.23.0. +> - [Introduced](https://gitlab.com/gitlab-org/charts/gitlab-runner/-/issues/106) in GitLab Runner Helm Chart 0.23.0. To use Docker-in-Docker with TLS enabled in Kubernetes: @@ -469,7 +473,7 @@ services: ##### The service in the GitLab Runner configuration file -> [Introduced](https://gitlab.com/gitlab-org/gitlab-runner/-/issues/27173) in GitLab Runner 13.6. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab-runner/-/issues/27173) in GitLab Runner 13.6. If you are a GitLab Runner administrator, you can specify the `command` to configure the registry mirror for the Docker daemon. The `dind` service must be defined for the @@ -539,7 +543,7 @@ detected by the `dind` service. ##### The Kubernetes executor in the GitLab Runner configuration file -> [Introduced](https://gitlab.com/gitlab-org/gitlab-runner/-/issues/3223) in GitLab Runner 13.6. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab-runner/-/issues/3223) in GitLab Runner 13.6. If you are a GitLab Runner administrator, you can use the mirror for every `dind` service. Update the diff --git a/doc/ci/docker/using_docker_images.md b/doc/ci/docker/using_docker_images.md index 7e24016a455..09b6b7a492b 100644 --- a/doc/ci/docker/using_docker_images.md +++ b/doc/ci/docker/using_docker_images.md @@ -4,7 +4,11 @@ group: Runner info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Run your CI/CD jobs in Docker containers **(FREE ALL)** +# Run your CI/CD jobs in Docker containers + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed You can run your CI/CD jobs in separate, isolated Docker containers. @@ -91,7 +95,7 @@ The image name must be in one of the following formats: ## Extended Docker configuration options -> Introduced in GitLab and GitLab Runner 9.4. +> - Introduced in GitLab and GitLab Runner 9.4. You can use a string or a map for the `image` or `services` entries: @@ -131,7 +135,7 @@ When a CI job runs in a Docker container, the `before_script`, `script`, and `af ### Override the entrypoint of an image -> Introduced in GitLab and GitLab Runner 9.4. Read more about the [extended configuration options](../docker/using_docker_images.md#extended-docker-configuration-options). +> - Introduced in GitLab and GitLab Runner 9.4. Read more about the [extended configuration options](../docker/using_docker_images.md#extended-docker-configuration-options). Before explaining the available entrypoint override methods, let's describe how the runner starts. It uses a Docker image for the containers used in the @@ -396,7 +400,7 @@ pulling from Docker Hub fails. Docker daemon tries to use the same credentials f ### Use Credential Helpers -> Introduced in GitLab Runner 12.0. +> - Introduced in GitLab Runner 12.0. As an example, let's assume that you want to use the `.dkr.ecr..amazonaws.com/private/image:latest` image. This image is private and requires you to sign in to a private container registry. diff --git a/doc/ci/docker/using_kaniko.md b/doc/ci/docker/using_kaniko.md index 97cdbf79d02..528803ee6c5 100644 --- a/doc/ci/docker/using_kaniko.md +++ b/doc/ci/docker/using_kaniko.md @@ -4,9 +4,13 @@ group: Pipeline Execution info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Use kaniko to build Docker images **(FREE ALL)** +# Use kaniko to build Docker images -> [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/issues/45512) in GitLab 11.2. Requires GitLab Runner 11.2 and above. +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/issues/45512) in GitLab 11.2. Requires GitLab Runner 11.2 and above. [kaniko](https://github.com/GoogleContainerTools/kaniko) is a tool to build container images from a Dockerfile, inside a container or Kubernetes cluster. diff --git a/doc/ci/environments/deployment_approvals.md b/doc/ci/environments/deployment_approvals.md index f1c7b412c6f..937da11426e 100644 --- a/doc/ci/environments/deployment_approvals.md +++ b/doc/ci/environments/deployment_approvals.md @@ -5,7 +5,11 @@ info: To determine the technical writer assigned to the Stage/Group associated w description: Require approvals prior to deploying to a Protected Environment --- -# Deployment approvals **(PREMIUM ALL)** +# Deployment approvals + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/343864) in GitLab 14.7 with a flag named `deployment_approvals`. Disabled by default. > - [Generally available](https://gitlab.com/gitlab-org/gitlab/-/issues/347342) in GitLab 14.8. Feature flag `deployment_approvals` removed. @@ -148,7 +152,7 @@ To allow self-approval of a deployment job: ## Approve or reject a deployment -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/342180/) in GitLab 14.9 +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/342180/) in GitLab 14.9 Using the GitLab UI or the API, you can: diff --git a/doc/ci/environments/deployment_safety.md b/doc/ci/environments/deployment_safety.md index ec6d2c482cd..b52b02eb00f 100644 --- a/doc/ci/environments/deployment_safety.md +++ b/doc/ci/environments/deployment_safety.md @@ -4,7 +4,11 @@ group: Environments info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Deployment safety **(FREE ALL)** +# Deployment safety + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed [Deployment jobs](../jobs/index.md#deployment-jobs) are a specific kind of CI/CD job. They can be more sensitive than other jobs in a pipeline, diff --git a/doc/ci/environments/environments_dashboard.md b/doc/ci/environments/environments_dashboard.md index 24a619d9f10..6fd04561209 100644 --- a/doc/ci/environments/environments_dashboard.md +++ b/doc/ci/environments/environments_dashboard.md @@ -4,9 +4,13 @@ group: Environments info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Environments Dashboard **(PREMIUM ALL)** +# Environments Dashboard -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/3713) in GitLab 12.5. +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/3713) in GitLab 12.5. The Environments Dashboard provides a cross-project environment-based view that lets you see the big picture diff --git a/doc/ci/environments/external_deployment_tools.md b/doc/ci/environments/external_deployment_tools.md index 29c811b68be..1f292bdc7f9 100644 --- a/doc/ci/environments/external_deployment_tools.md +++ b/doc/ci/environments/external_deployment_tools.md @@ -4,9 +4,13 @@ group: Environments info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Track deployments of an external deployment tool **(FREE ALL)** +# Track deployments of an external deployment tool -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/22513) in GitLab 12.5. +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/22513) in GitLab 12.5. While GitLab offers a [built-in deployment solution](index.md), you might prefer to use an external deployment tool, such as Heroku or ArgoCD. GitLab can receive deployment events from these external tools and allows you to track the deployments within GitLab. diff --git a/doc/ci/environments/incremental_rollouts.md b/doc/ci/environments/incremental_rollouts.md index 9dd5e676924..27419da3389 100644 --- a/doc/ci/environments/incremental_rollouts.md +++ b/doc/ci/environments/incremental_rollouts.md @@ -4,7 +4,11 @@ group: Environments info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Incremental rollouts with GitLab CI/CD **(FREE ALL)** +# Incremental rollouts with GitLab CI/CD + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed When rolling out changes to your application, it is possible to release production changes to only a portion of your Kubernetes pods as a risk mitigation strategy. By releasing diff --git a/doc/ci/environments/index.md b/doc/ci/environments/index.md index c9148e04bf3..0f25a2eee46 100644 --- a/doc/ci/environments/index.md +++ b/doc/ci/environments/index.md @@ -4,7 +4,11 @@ group: Environments info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Environments and deployments **(FREE ALL)** +# Environments and deployments + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed Environments describe where code is deployed. @@ -253,7 +257,7 @@ To achieve the same result as renaming an environment: ## Deployment tier of environments -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/300741) in GitLab 13.10. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/300741) in GitLab 13.10. Sometimes, instead of using an [industry standard](https://en.wikipedia.org/wiki/Deployment_environment) environment name, like `production`, you might want to use a code name, like `customer-portal`. @@ -682,7 +686,7 @@ To delete an environment: ### Access an environment for preparation or verification purposes -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/208655) in GitLab 13.2. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/208655) in GitLab 13.2. You can define a job that accesses an environment for various purposes, such as verification or preparation. This effectively bypasses deployment creation, so that you can adjust your CD workflow more accurately. @@ -739,9 +743,13 @@ or human error can cause major issues with an environment. Things like: You can use [incident management](../../operations/incident_management/index.md) to get alerts when there are critical issues that need immediate attention. -#### View the latest alerts for environments **(ULTIMATE ALL)** +#### View the latest alerts for environments -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/214634) in GitLab 13.4. +DETAILS: +**Tier:** Ultimate +**Offering:** SaaS, self-managed + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/214634) in GitLab 13.4. If you [set up alerts for Prometheus metrics](../../operations/incident_management/integrations.md#configuration), alerts for environments are shown on the environments page. The alert with the highest @@ -755,9 +763,13 @@ longer visible on the environments page. If the alert requires a [rollback](#retry-or-roll-back-a-deployment), you can select the deployment tab from the environment page and select which deployment to roll back to. -#### Auto Rollback **(ULTIMATE ALL)** +#### Auto Rollback -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/35404) in GitLab 13.7. +DETAILS: +**Tier:** Ultimate +**Offering:** SaaS, self-managed + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/35404) in GitLab 13.7. In a typical Continuous Deployment workflow, the CI pipeline tests every commit before deploying to production. However, problematic code can still make it to production. For example, inefficient code @@ -1024,7 +1036,7 @@ To ensure the `action: stop` can always run when needed, you can: ### A deployment job failed with "This job could not be executed because it would create an environment with an invalid parameter" error -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/21182) in GitLab 14.4. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/21182) in GitLab 14.4. If your project is configured to [create a dynamic environment](#create-a-dynamic-environment), you might encounter this error because the dynamically generated parameter can't be used for creating an environment. diff --git a/doc/ci/environments/kubernetes_dashboard.md b/doc/ci/environments/kubernetes_dashboard.md index 9f5be975cdf..61f2cea5aef 100644 --- a/doc/ci/environments/kubernetes_dashboard.md +++ b/doc/ci/environments/kubernetes_dashboard.md @@ -4,7 +4,12 @@ group: Environments info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Dashboard for Kubernetes **(FREE ALL BETA)** +# Dashboard for Kubernetes + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed +**Status:** Beta > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/390769) in GitLab 16.1, with [flags](../../administration/feature_flags.md) named `environment_settings_to_graphql`, `kas_user_access`, `kas_user_access_project`, and `expose_authorized_cluster_agents`. This feature is in [Beta](../../policy/experiment-beta-support.md#beta). > - Feature flag `environment_settings_to_graphql` [removed](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/124177) in GitLab 16.2. diff --git a/doc/ci/environments/protected_environments.md b/doc/ci/environments/protected_environments.md index 9b3332bddba..34dc9459443 100644 --- a/doc/ci/environments/protected_environments.md +++ b/doc/ci/environments/protected_environments.md @@ -4,7 +4,11 @@ group: Environments info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Protected environments **(PREMIUM ALL)** +# Protected environments + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed [Environments](../environments/index.md) can be used for both testing and production reasons. @@ -255,7 +259,7 @@ To protect a group-level environment, make sure your environments have the corre #### Using the UI -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/325249) in GitLab 15.1. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/325249) in GitLab 15.1. 1. On the left sidebar, select **Search or go to** and find your group. 1. Select **Settings > CI/CD**. diff --git a/doc/ci/examples/authenticating-with-hashicorp-vault/index.md b/doc/ci/examples/authenticating-with-hashicorp-vault/index.md index ed891b46999..47c938dd0a0 100644 --- a/doc/ci/examples/authenticating-with-hashicorp-vault/index.md +++ b/doc/ci/examples/authenticating-with-hashicorp-vault/index.md @@ -4,7 +4,11 @@ group: Pipeline Security info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Authenticating and reading secrets with HashiCorp Vault **(PREMIUM ALL)** +# Authenticating and reading secrets with HashiCorp Vault + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed WARNING: Authenticating with `CI_JOB_JWT` was [deprecated in GitLab 15.9](../../../update/deprecations.md#old-versions-of-json-web-tokens-are-deprecated) diff --git a/doc/ci/examples/deployment/composer-npm-deploy.md b/doc/ci/examples/deployment/composer-npm-deploy.md index 149f99e8a66..d7ed176d522 100644 --- a/doc/ci/examples/deployment/composer-npm-deploy.md +++ b/doc/ci/examples/deployment/composer-npm-deploy.md @@ -4,7 +4,11 @@ group: Environments info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Running Composer and npm scripts with deployment via SCP in GitLab CI/CD **(FREE ALL)** +# Running Composer and npm scripts with deployment via SCP in GitLab CI/CD + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed This guide covers the building of dependencies of a PHP project while compiling assets via an npm script using [GitLab CI/CD](../../index.md). diff --git a/doc/ci/examples/deployment/index.md b/doc/ci/examples/deployment/index.md index 0ffc09c8646..140cef379cc 100644 --- a/doc/ci/examples/deployment/index.md +++ b/doc/ci/examples/deployment/index.md @@ -4,7 +4,11 @@ group: Environments info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Using Dpl as a deployment tool **(FREE ALL)** +# Using Dpl as a deployment tool + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed [Dpl](https://github.com/travis-ci/dpl) (pronounced like the letters D-P-L) is a deploy tool made for continuous deployment that's developed and used by Travis CI, but can also be diff --git a/doc/ci/examples/end_to_end_testing_webdriverio/index.md b/doc/ci/examples/end_to_end_testing_webdriverio/index.md index 8872602a027..225b9ed5740 100644 --- a/doc/ci/examples/end_to_end_testing_webdriverio/index.md +++ b/doc/ci/examples/end_to_end_testing_webdriverio/index.md @@ -9,7 +9,11 @@ description: 'Confidence checking your entire app every time a new feature is ad -# End-to-end testing with GitLab CI/CD and WebdriverIO **(FREE ALL)** +# End-to-end testing with GitLab CI/CD and WebdriverIO + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed [Review Apps](../../review_apps/index.md) are great: for every merge request (or branch, for that matter), the new code can be copied and deployed to a fresh production-like live diff --git a/doc/ci/examples/index.md b/doc/ci/examples/index.md index f618b6beec9..e0cdbebd901 100644 --- a/doc/ci/examples/index.md +++ b/doc/ci/examples/index.md @@ -4,7 +4,11 @@ group: Pipeline Execution info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# GitLab CI/CD examples **(FREE ALL)** +# GitLab CI/CD examples + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed This page contains links to a variety of examples that can help you understand how to implement [GitLab CI/CD](../index.md) for your specific use case. @@ -98,7 +102,11 @@ If a programming language or framework template is not in this list, you can con one. To create a template, submit a merge request to [the templates list](https://gitlab.com/gitlab-org/gitlab/-/tree/master/lib/gitlab/ci/templates). -### Adding templates to your GitLab installation **(PREMIUM SELF)** +### Adding templates to your GitLab installation + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** Self-managed You can add custom examples and templates to your self-managed GitLab instance. Your GitLab administrator can [designate an instance template repository](../../administration/settings/instance_template_repository.md) diff --git a/doc/ci/examples/laravel_with_gitlab_and_envoy/index.md b/doc/ci/examples/laravel_with_gitlab_and_envoy/index.md index 25a0750e5eb..9bdc22ec1bb 100644 --- a/doc/ci/examples/laravel_with_gitlab_and_envoy/index.md +++ b/doc/ci/examples/laravel_with_gitlab_and_envoy/index.md @@ -8,7 +8,11 @@ author_gitlab: mehranrasulian -# Test and deploy Laravel applications with GitLab CI/CD and Envoy **(FREE ALL)** +# Test and deploy Laravel applications with GitLab CI/CD and Envoy + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed ## Introduction diff --git a/doc/ci/examples/php.md b/doc/ci/examples/php.md index 12d3cf32d98..c885f285577 100644 --- a/doc/ci/examples/php.md +++ b/doc/ci/examples/php.md @@ -4,7 +4,11 @@ group: Pipeline Execution info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Testing PHP projects **(FREE ALL)** +# Testing PHP projects + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed This guide covers basic building instructions for PHP projects. diff --git a/doc/ci/examples/semantic-release.md b/doc/ci/examples/semantic-release.md index 6a21b6d3d83..7e33ba8c5c8 100644 --- a/doc/ci/examples/semantic-release.md +++ b/doc/ci/examples/semantic-release.md @@ -4,7 +4,11 @@ group: Package Registry info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Publish npm packages to the GitLab package registry using semantic-release **(FREE ALL)** +# Publish npm packages to the GitLab package registry using semantic-release + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed This guide demonstrates how to automatically publish npm packages to the [GitLab package registry](../../user/packages/npm_registry/index.md) by using [semantic-release](https://github.com/semantic-release/semantic-release). diff --git a/doc/ci/git_submodules.md b/doc/ci/git_submodules.md index 747c2abb61a..c90ace3139d 100644 --- a/doc/ci/git_submodules.md +++ b/doc/ci/git_submodules.md @@ -4,7 +4,11 @@ group: Pipeline Execution info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Using Git submodules with GitLab CI/CD **(FREE ALL)** +# Using Git submodules with GitLab CI/CD + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed Use [Git submodules](https://git-scm.com/book/en/v2/Git-Tools-Submodules) to keep a Git repository as a subdirectory of another Git repository. You can clone another @@ -17,7 +21,7 @@ You have multiple options to configure it to work in a GitLab CI/CD job. ### Using absolute URLs -> [Introduced](https://gitlab.com/gitlab-org/gitlab-runner/-/merge_requests/3198) in GitLab Runner 15.11. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab-runner/-/merge_requests/3198) in GitLab Runner 15.11. For example, your generated `.gitmodules` configuration might look like the following if: diff --git a/doc/ci/index.md b/doc/ci/index.md index 429db0beede..2c7f613d830 100644 --- a/doc/ci/index.md +++ b/doc/ci/index.md @@ -4,7 +4,11 @@ group: Pipeline Execution info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Get started with GitLab CI/CD **(FREE ALL)** +# Get started with GitLab CI/CD + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed CI/CD is a continuous method of software development, where you continuously build, test, deploy, and monitor iterative code changes. diff --git a/doc/ci/interactive_web_terminal/index.md b/doc/ci/interactive_web_terminal/index.md index 4108ab93797..c2a43b6c3ff 100644 --- a/doc/ci/interactive_web_terminal/index.md +++ b/doc/ci/interactive_web_terminal/index.md @@ -4,9 +4,13 @@ group: Runner info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Interactive web terminals **(FREE ALL)** +# Interactive web terminals -> [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/issues/50144) in GitLab 11.3. +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/issues/50144) in GitLab 11.3. Interactive web terminals give the user access to a terminal in GitLab for running one-off commands for their CI pipeline. You can think of it like a method for diff --git a/doc/ci/jobs/ci_job_token.md b/doc/ci/jobs/ci_job_token.md index e46a6356dd2..9334de750fe 100644 --- a/doc/ci/jobs/ci_job_token.md +++ b/doc/ci/jobs/ci_job_token.md @@ -4,7 +4,11 @@ group: Pipeline Security info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# GitLab CI/CD job token **(FREE ALL)** +# GitLab CI/CD job token + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed When a pipeline job is about to run, GitLab generates a unique token and injects it as the [`CI_JOB_TOKEN` predefined variable](../variables/predefined_variables.md). @@ -223,7 +227,11 @@ To configure the job token scope: 1. Optional. Add existing projects to the token's access scope. The user adding a project must have the Maintainer role in both projects. -## Download an artifact from a different pipeline **(PREMIUM ALL)** +## Download an artifact from a different pipeline + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed You can use the CI/CD job token to authenticate with the [jobs artifacts API endpoint](../../api/job_artifacts.md) and fetch artifacts from a different pipeline. You must specify which job to retrieve artifacts from: diff --git a/doc/ci/jobs/index.md b/doc/ci/jobs/index.md index 3cba8787821..79dd729d5dd 100644 --- a/doc/ci/jobs/index.md +++ b/doc/ci/jobs/index.md @@ -4,7 +4,11 @@ group: Pipeline Authoring info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Jobs **(FREE ALL)** +# Jobs + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed Pipeline configuration begins with jobs. Jobs are the most fundamental element of a `.gitlab-ci.yml` file. @@ -262,7 +266,7 @@ In this example: ## Specifying variables when running manual jobs -> [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/30485) in GitLab 12.2. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/30485) in GitLab 12.2. When running manual jobs you can supply additional job specific variables. @@ -312,7 +316,7 @@ In the following example: ### Custom collapsible sections -> [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/issues/14664) in GitLab 12.0. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/issues/14664) in GitLab 12.0. You can create [collapsible sections in job logs](#expand-and-collapse-job-log-sections) by manually outputting special codes @@ -355,7 +359,7 @@ this line should be hidden when collapsed ### Pre-collapse sections -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/198413) in GitLab 13.5. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/198413) in GitLab 13.5. You can make the job log automatically collapse collapsible sections by adding the `collapsed` option to the section start. Add `[collapsed=true]` after the section name and before the `\r`. The section end marker @@ -377,7 +381,7 @@ job1: ### Full screen mode -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/363617) in GitLab 16.7. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/363617) in GitLab 16.7. You can view the contents of a job log in full screen mode by clicking **Show full screen**. @@ -451,7 +455,11 @@ The configuration can be added to: ] ``` -### Job using `resource_group` gets stuck **(FREE SELF)** +### Job using `resource_group` gets stuck + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed If a job using [`resource_group`](../yaml/index.md#resource_group) gets stuck, a GitLab administrator can try run the following commands from the [rails console](../../administration/operations/rails_console.md#starting-a-rails-console-session): diff --git a/doc/ci/jobs/job_artifacts.md b/doc/ci/jobs/job_artifacts.md index 29a542668c1..7bbc9b48b5f 100644 --- a/doc/ci/jobs/job_artifacts.md +++ b/doc/ci/jobs/job_artifacts.md @@ -4,7 +4,11 @@ group: Pipeline Security info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Job artifacts **(FREE ALL)** +# Job artifacts + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed Jobs can output an archive of files and directories. This output is known as a job artifact. diff --git a/doc/ci/jobs/job_artifacts_troubleshooting.md b/doc/ci/jobs/job_artifacts_troubleshooting.md index 470c1bf4b55..d1972cd8ba4 100644 --- a/doc/ci/jobs/job_artifacts_troubleshooting.md +++ b/doc/ci/jobs/job_artifacts_troubleshooting.md @@ -38,7 +38,7 @@ wasn't created. ## Error message `Missing /usr/bin/gitlab-runner-helper. Uploading artifacts is disabled.` -> [Introduced](https://gitlab.com/gitlab-org/gitlab-runner/-/issues/3068) in GitLab 15.2, GitLab Runner uses `RUNNER_DEBUG` instead of `DEBUG`, fixing this issue. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab-runner/-/issues/3068) in GitLab 15.2, GitLab Runner uses `RUNNER_DEBUG` instead of `DEBUG`, fixing this issue. In GitLab 15.1 and earlier, setting a CI/CD variable named `DEBUG` can cause artifact uploads to fail. diff --git a/doc/ci/jobs/job_control.md b/doc/ci/jobs/job_control.md index f7b3fed7d74..c2ce6b90d1d 100644 --- a/doc/ci/jobs/job_control.md +++ b/doc/ci/jobs/job_control.md @@ -4,7 +4,11 @@ group: Pipeline Authoring info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Choose when to run jobs **(FREE ALL)** +# Choose when to run jobs + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed When a new pipeline starts, GitLab checks the pipeline configuration to determine which jobs should run in that pipeline. You can configure jobs to run depending on @@ -17,7 +21,7 @@ earlier jobs it depends on finish running. ## Specify when jobs run with `rules` -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/27863) in GitLab 12.3. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/27863) in GitLab 12.3. Use [`rules`](../yaml/index.md#rules) to include or exclude jobs in pipelines. @@ -339,7 +343,7 @@ You can use the `$` character for both variables and paths. For example, if the ### Reuse rules in different jobs -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/322992) in GitLab 14.3. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/322992) in GitLab 14.3. Use [`!reference` tags](../yaml/yaml_optimization.md#reference-tags) to reuse rules in different jobs. You can combine `!reference` rules with regular job-defined rules: @@ -616,7 +620,11 @@ To run a manual job, you must have permission to merge to the assigned branch: You can also [add custom CI/CD variables when running a manual job](index.md#specifying-variables-when-running-manual-jobs). -### Protect manual jobs **(PREMIUM ALL)** +### Protect manual jobs + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed Use [protected environments](../environments/protected_environments.md) to define a list of users authorized to run a manual job. You can authorize only @@ -655,7 +663,7 @@ by authorized users. ## Run a job after a delay -> [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/issues/51352) in GitLab 11.4. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/issues/51352) in GitLab 11.4. Use [`when: delayed`](../yaml/index.md#when) to execute scripts after a waiting period, or if you want to avoid jobs immediately entering the `pending` state. @@ -726,7 +734,7 @@ Test Boosters reports usage statistics to the author. ### Run a one-dimensional matrix of parallel jobs -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/26362) in GitLab 13.5. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/26362) in GitLab 13.5. You can create a one-dimensional matrix of parallel jobs: @@ -745,7 +753,7 @@ You can also [create a multi-dimensional matrix](../yaml/index.md#parallelmatrix ### Run a matrix of parallel trigger jobs -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/270957) in GitLab 13.10. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/270957) in GitLab 13.10. You can run a [trigger](../yaml/index.md#trigger) job multiple times in parallel in a single pipeline, but with different variable values for each instance of the job. @@ -779,7 +787,7 @@ deploystacks: [vultr, data] ### Select different runner tags for each parallel matrix job -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/239737) in GitLab 14.1. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/239737) in GitLab 14.1. You can use variables defined in `parallel: matrix` with the [`tags`](../yaml/index.md#tags) keyword for dynamic runner selection: @@ -833,7 +841,7 @@ Quotes around the `dependencies` entry are required. ## Specify a parallelized job using needs with multiple parallelized jobs -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/254821) in GitLab 16.3. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/254821) in GitLab 16.3. You can use variables defined in [`needs:parallel:matrix`](../yaml/index.md#needsparallelmatrix) with multiple parallelized jobs. @@ -1117,7 +1125,7 @@ regex-job2: ### Join variable expressions together with `&&` or `||` -> [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/issues/62867) in GitLab 12.0 +> - [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/issues/62867) in GitLab 12.0 You can join multiple expressions using `&&` (and) or `||` (or), for example: diff --git a/doc/ci/lint.md b/doc/ci/lint.md index 88ea4cd05d7..70cb7fa8dcb 100644 --- a/doc/ci/lint.md +++ b/doc/ci/lint.md @@ -4,7 +4,11 @@ group: Pipeline Authoring info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Validate GitLab CI/CD configuration **(FREE ALL)** +# Validate GitLab CI/CD configuration + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed Use the CI Lint tool to check the validity of GitLab CI/CD configuration. You can validate the syntax from a `.gitlab-ci.yml` file or any other sample CI/CD configuration. @@ -32,7 +36,7 @@ To check CI/CD configuration with the CI lint tool: ## Simulate a pipeline -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/229794) in GitLab 13.3. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/229794) in GitLab 13.3. You can simulate the creation of a GitLab CI/CD pipeline to find more complicated issues, including problems with [`needs`](yaml/index.md#needs) and [`rules`](yaml/index.md#rules) diff --git a/doc/ci/migration/bamboo.md b/doc/ci/migration/bamboo.md index b2594e7571e..5a1b76dd06b 100644 --- a/doc/ci/migration/bamboo.md +++ b/doc/ci/migration/bamboo.md @@ -4,7 +4,11 @@ group: Pipeline Authoring info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Migrating from Bamboo **(FREE ALL)** +# Migrating from Bamboo + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed This migration guide looks at how you can migrate from Atlassian Bamboo to GitLab CI/CD. The focus is on [Bamboo Specs YAML](https://docs.atlassian.com/bamboo-specs-docs/8.1.12/specs.html?yaml) diff --git a/doc/ci/migration/circleci.md b/doc/ci/migration/circleci.md index f397a1cf733..ec87d0d3e5a 100644 --- a/doc/ci/migration/circleci.md +++ b/doc/ci/migration/circleci.md @@ -4,7 +4,11 @@ group: Pipeline Authoring info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Migrating from CircleCI **(FREE ALL)** +# Migrating from CircleCI + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed If you are currently using CircleCI, you can migrate your CI/CD pipelines to [GitLab CI/CD](../index.md), and start making use of all its powerful features. diff --git a/doc/ci/migration/github_actions.md b/doc/ci/migration/github_actions.md index 6afb6cebbff..59c7c299f3b 100644 --- a/doc/ci/migration/github_actions.md +++ b/doc/ci/migration/github_actions.md @@ -4,7 +4,11 @@ group: Pipeline Authoring info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Migrating from GitHub Actions **(FREE ALL)** +# Migrating from GitHub Actions + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed If you're migrating from GitHub Actions to GitLab CI/CD, you are able to create CI/CD pipelines that replicate and enhance your GitHub Action workflows. diff --git a/doc/ci/migration/jenkins.md b/doc/ci/migration/jenkins.md index 961799b9564..c052bf3c8ea 100644 --- a/doc/ci/migration/jenkins.md +++ b/doc/ci/migration/jenkins.md @@ -4,7 +4,11 @@ group: Pipeline Authoring info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Migrating from Jenkins **(FREE ALL)** +# Migrating from Jenkins + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed If you're migrating from Jenkins to GitLab CI/CD, you are able to create CI/CD pipelines that replicate and enhance your Jenkins workflows. diff --git a/doc/ci/pipeline_editor/index.md b/doc/ci/pipeline_editor/index.md index cc7b032a487..a9c86043e55 100644 --- a/doc/ci/pipeline_editor/index.md +++ b/doc/ci/pipeline_editor/index.md @@ -4,7 +4,11 @@ group: Pipeline Authoring info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Pipeline editor **(FREE ALL)** +# Pipeline editor + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed > - [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/4540) in GitLab 13.8. > - [Feature flag removed](https://gitlab.com/gitlab-org/gitlab/-/issues/270059) in GitLab 13.10. @@ -60,7 +64,7 @@ reflected in the CI lint. It displays the same results as the existing [CI Lint ## Simulate a CI/CD pipeline -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/337282) in GitLab 15.3. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/337282) in GitLab 15.3. To look for pipeline syntax and logic issues, you can simulate the creation of a GitLab CI/CD pipeline in the **Validate** tab. A pipeline simulation can help find diff --git a/doc/ci/pipelines/cicd_minutes.md b/doc/ci/pipelines/cicd_minutes.md index a6c3bb835d0..fba745aabbe 100644 --- a/doc/ci/pipelines/cicd_minutes.md +++ b/doc/ci/pipelines/cicd_minutes.md @@ -5,7 +5,11 @@ description: Calculations, quotas, purchase information. info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Compute quota **(PREMIUM ALL)** +# Compute quota + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed > [Renamed](https://gitlab.com/groups/gitlab-com/-/epics/2150) from "CI/CD minutes" to "compute quota" or "compute minutes" in GitLab 16.1. @@ -47,7 +51,7 @@ The triggered downstream pipeline consumes compute minutes the same as other pip ## Set the compute quota for all namespaces -> [Moved](https://about.gitlab.com/blog/2021/01/26/new-gitlab-product-subscription-model/) to GitLab Premium in 13.9. +> - [Moved](https://about.gitlab.com/blog/2021/01/26/new-gitlab-product-subscription-model/) to GitLab Premium in 13.9. By default, GitLab instances do not have a compute quota. The default value for the quota is `0`, which is unlimited. @@ -69,7 +73,7 @@ If a quota is already defined for a specific namespace, this value does not chan ## Set the compute quota for a specific namespace -> [Moved](https://about.gitlab.com/blog/2021/01/26/new-gitlab-product-subscription-model/) to GitLab Premium in 13.9. +> - [Moved](https://about.gitlab.com/blog/2021/01/26/new-gitlab-product-subscription-model/) to GitLab Premium in 13.9. You can override the global value and set a compute quota for a specific namespace. @@ -137,7 +141,11 @@ The projects list shows [personal projects](../../user/project/working_with_proj with compute usage or shared runners usage in the current month only. The list is sorted in descending order of compute usage. -## Purchase additional compute minutes **(FREE SAAS)** +## Purchase additional compute minutes + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS If you're using GitLab SaaS, you can purchase additional packs of compute minutes. These additional compute minutes: @@ -160,7 +168,11 @@ Additional compute minutes bought on a trial subscription are available after th You can find pricing for additional compute minutes on the [GitLab Pricing page](https://about.gitlab.com/pricing/). -### Purchase compute minutes for a group **(FREE SAAS)** +### Purchase compute minutes for a group + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS Prerequisites: @@ -179,7 +191,11 @@ so be sure to select the correct group. After your payment is processed, the additional compute minutes are added to your group namespace. -### Purchase compute minutes for a personal namespace **(FREE SAAS)** +### Purchase compute minutes for a personal namespace + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS Prerequisites: @@ -357,7 +373,11 @@ consumption for contributor fork projects, enabling more contributions. See our [pipeline efficiency guide](pipeline_efficiency.md) for more details. -## Reset compute usage **(PREMIUM SELF)** +## Reset compute usage + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** Self-managed An administrator can reset the compute usage for a namespace for the current month. diff --git a/doc/ci/pipelines/downstream_pipelines.md b/doc/ci/pipelines/downstream_pipelines.md index 668337f4ea2..a9ef4437ba2 100644 --- a/doc/ci/pipelines/downstream_pipelines.md +++ b/doc/ci/pipelines/downstream_pipelines.md @@ -4,7 +4,11 @@ group: Pipeline Authoring info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Downstream pipelines **(FREE ALL)** +# Downstream pipelines + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed A downstream pipeline is any GitLab CI/CD pipeline triggered by another pipeline. Downstream pipelines run independently and concurrently to the upstream pipeline @@ -144,7 +148,7 @@ job3: ### Use a child pipeline configuration file in a different project -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/205157) in GitLab 13.5. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/205157) in GitLab 13.5. You can use [`include:project`](../yaml/index.md#includeproject) in a trigger job to trigger child pipelines with a configuration file in a different project: @@ -381,7 +385,7 @@ trigger_job: ### View multi-project pipelines in pipeline graphs -> [Moved](https://gitlab.com/gitlab-org/gitlab/-/issues/422282) from GitLab Premium to GitLab Free in 16.8. +> - [Moved](https://gitlab.com/gitlab-org/gitlab/-/issues/422282) from GitLab Premium to GitLab Free in 16.8. After you trigger a multi-project pipeline, the downstream pipeline displays to the right of the [pipeline graph](index.md#visualize-pipelines). @@ -389,7 +393,11 @@ to the right of the [pipeline graph](index.md#visualize-pipelines). In [pipeline mini graphs](index.md#pipeline-mini-graphs), the downstream pipeline displays to the right of the mini graph. -## Fetch artifacts from an upstream pipeline **(PREMIUM ALL)** +## Fetch artifacts from an upstream pipeline + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed ::Tabs @@ -671,7 +679,11 @@ Upstream pipelines take precedence over downstream ones. If there are two variables with the same name defined in both upstream and downstream projects, the ones defined in the upstream project take precedence. -### Pass dotenv variables created in a job **(PREMIUM ALL)** +### Pass dotenv variables created in a job + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed You can pass variables to a downstream pipeline with [`dotenv` variable inheritance](../variables/index.md#pass-an-environment-variable-to-another-job). @@ -719,7 +731,7 @@ are considered trigger variables, which have the [highest precedence](../variabl ## Downstream pipelines for deployments -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/369061) in GitLab 16.4. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/369061) in GitLab 16.4. You can use the [`environment`](../yaml/index.md#environment) keyword with [`trigger`](../yaml/index.md#trigger). You might want to use `environment` from a trigger job if your deployment and application projects are separately managed. diff --git a/doc/ci/pipelines/index.md b/doc/ci/pipelines/index.md index 0a4f4c3762b..93db3bcc2ec 100644 --- a/doc/ci/pipelines/index.md +++ b/doc/ci/pipelines/index.md @@ -4,7 +4,11 @@ group: Pipeline Authoring info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# CI/CD pipelines **(FREE ALL)** +# CI/CD pipelines + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed NOTE: Watch the @@ -150,7 +154,7 @@ The pipeline now executes the jobs as configured. #### Prefill variables in manual pipelines -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/30101) in GitLab 13.7. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/30101) in GitLab 13.7. You can use the [`description` and `value`](../yaml/index.md#variablesdescription) keywords to [define pipeline-level (global) variables](../variables/index.md#define-a-cicd-variable-in-the-gitlab-ciyml-file) @@ -219,7 +223,7 @@ variables: ### Run a pipeline by using a URL query string -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/24146) in GitLab 12.5. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/24146) in GitLab 12.5. You can use a query string to pre-populate the **Run Pipeline** page. For example, the query string `.../pipelines/new?ref=my_branch&var[foo]=bar&file_var[file_foo]=file_bar` pre-populates the @@ -279,7 +283,7 @@ pipelines. ### Delete a pipeline -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/24851) in GitLab 12.7. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/24851) in GitLab 12.7. Users with the Owner role for a project can delete a pipeline by selecting the pipeline in the **Build > Pipelines** to get to the **Pipeline Details** @@ -324,9 +328,13 @@ runners do not use regular runners, they must be [tagged](../yaml/index.md#tags) Review the [deployment safety](../environments/deployment_safety.md) page for additional security recommendations for securing your pipelines. -## Trigger a pipeline when an upstream project is rebuilt **(PREMIUM ALL)** +## Trigger a pipeline when an upstream project is rebuilt -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/9045) in GitLab 12.8. +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/9045) in GitLab 12.8. You can trigger a pipeline in your project whenever a pipeline finishes for a new tag in a different project. diff --git a/doc/ci/pipelines/merge_request_pipelines.md b/doc/ci/pipelines/merge_request_pipelines.md index 25358ecd602..3e1db6f568d 100644 --- a/doc/ci/pipelines/merge_request_pipelines.md +++ b/doc/ci/pipelines/merge_request_pipelines.md @@ -5,7 +5,11 @@ info: To determine the technical writer assigned to the Stage/Group associated w --- -# Merge request pipelines **(FREE ALL)** +# Merge request pipelines + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed > [Renamed](https://gitlab.com/gitlab-org/gitlab/-/issues/351192) from `pipelines for merge requests` to `merge request pipelines` in GitLab 14.8. @@ -175,7 +179,7 @@ To use the UI to run a pipeline in the parent project for a merge request from a ### Prevent pipelines from fork projects -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/325189) in GitLab 15.3. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/325189) in GitLab 15.3. To prevent users from running new pipelines for fork projects in the parent project use [the projects API](../../api/projects.md#edit-project) to disable the `ci_allow_fork_pipelines_to_run_in_parent_project` diff --git a/doc/ci/pipelines/merge_trains.md b/doc/ci/pipelines/merge_trains.md index 45d9e548d6a..0ce6a465bcf 100644 --- a/doc/ci/pipelines/merge_trains.md +++ b/doc/ci/pipelines/merge_trains.md @@ -4,7 +4,11 @@ group: Pipeline Execution info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Merge trains **(PREMIUM ALL)** +# Merge trains + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed > Support for [fast-forward](../../user/project/merge_requests/methods/index.md#fast-forward-merge) and [semi-linear](../../user/project/merge_requests/methods/index.md#merge-commit-with-semi-linear-history) merge methods [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/282442) in GitLab 16.5 [with a flag](../../administration/feature_flags.md) named `fast_forward_merge_trains_support`. Enabled by default. diff --git a/doc/ci/pipelines/merged_results_pipelines.md b/doc/ci/pipelines/merged_results_pipelines.md index 691de7c3f3c..7935743ebd9 100644 --- a/doc/ci/pipelines/merged_results_pipelines.md +++ b/doc/ci/pipelines/merged_results_pipelines.md @@ -4,7 +4,11 @@ group: Pipeline Execution info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Merged results pipelines **(PREMIUM ALL)** +# Merged results pipelines + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed > - [Renamed](https://gitlab.com/gitlab-org/gitlab/-/issues/351192) from `pipelines for merged results` to `merged results pipelines` in GitLab 14.8. > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/91849) in GitLab 15.1, merged results pipelines also run on [Draft merge requests](../../user/project/merge_requests/drafts.md). diff --git a/doc/ci/pipelines/pipeline_architectures.md b/doc/ci/pipelines/pipeline_architectures.md index 9ca2bf26e59..bfaa5f0bb33 100644 --- a/doc/ci/pipelines/pipeline_architectures.md +++ b/doc/ci/pipelines/pipeline_architectures.md @@ -4,7 +4,11 @@ group: Pipeline Authoring info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Pipeline architecture **(FREE ALL)** +# Pipeline architecture + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed Pipelines are the fundamental building blocks for CI/CD in GitLab. This page documents some of the important concepts related to them. diff --git a/doc/ci/pipelines/pipeline_efficiency.md b/doc/ci/pipelines/pipeline_efficiency.md index 07fc7c2dfd6..3f95dfcf0ee 100644 --- a/doc/ci/pipelines/pipeline_efficiency.md +++ b/doc/ci/pipelines/pipeline_efficiency.md @@ -4,7 +4,11 @@ group: Pipeline Execution info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Pipeline efficiency **(FREE ALL)** +# Pipeline efficiency + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed [CI/CD Pipelines](index.md) are the fundamental building blocks for [GitLab CI/CD](../index.md). Making pipelines more efficient helps you save developer time, which: diff --git a/doc/ci/pipelines/schedules.md b/doc/ci/pipelines/schedules.md index 9ea635792f3..0b2eac9874d 100644 --- a/doc/ci/pipelines/schedules.md +++ b/doc/ci/pipelines/schedules.md @@ -4,7 +4,11 @@ group: Pipeline Execution info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Scheduled pipelines **(FREE ALL)** +# Scheduled pipelines + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed Use scheduled pipelines to run GitLab CI/CD [pipelines](index.md) at regular intervals. @@ -42,7 +46,7 @@ you must delete unused schedules before you can add another. ## Edit a pipeline schedule -> Introduced in GitLab 14.8, only a pipeline schedule owner can edit the schedule. +> - Introduced in GitLab 14.8, only a pipeline schedule owner can edit the schedule. The owner of a pipeline schedule can edit it: diff --git a/doc/ci/pipelines/settings.md b/doc/ci/pipelines/settings.md index 09bfe3ac195..d9775922cf3 100644 --- a/doc/ci/pipelines/settings.md +++ b/doc/ci/pipelines/settings.md @@ -4,7 +4,11 @@ group: Pipeline Execution info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Customize pipeline configuration **(FREE ALL)** +# Customize pipeline configuration + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed You can customize how pipelines run for your project. @@ -78,7 +82,8 @@ You can set pending or running pipelines to cancel automatically when a pipeline 1. Select **Save changes**. Use the [`interruptible`](../yaml/index.md#interruptible) keyword to indicate if a -running job can be cancelled before it completes. +running job can be cancelled before it completes. After a job with +`interruptible: false` starts, the entire pipeline is no longer considered interruptible. ## Prevent outdated deployment jobs @@ -102,9 +107,13 @@ To avoid this scenario: For more information, see [Deployment safety](../environments/deployment_safety.md#prevent-outdated-deployment-jobs). -## Restrict roles that can cancel pipelines or jobs **(PREMIUM ALL)** +## Restrict roles that can cancel pipelines or jobs -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/137301) in GitLab 16.7. +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/137301) in GitLab 16.7. You can customize which roles have permission to cancel pipelines or jobs. diff --git a/doc/ci/quick_start/index.md b/doc/ci/quick_start/index.md index 0dc07a36ef5..404f6294d72 100644 --- a/doc/ci/quick_start/index.md +++ b/doc/ci/quick_start/index.md @@ -4,7 +4,11 @@ group: Pipeline Authoring info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Tutorial: Create and run your first GitLab CI/CD pipeline **(FREE ALL)** +# Tutorial: Create and run your first GitLab CI/CD pipeline + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed This tutorial shows you how to configure and run your first CI/CD pipeline in GitLab. diff --git a/doc/ci/resource_groups/index.md b/doc/ci/resource_groups/index.md index b7b9c216b14..719bb7a6eeb 100644 --- a/doc/ci/resource_groups/index.md +++ b/doc/ci/resource_groups/index.md @@ -5,9 +5,13 @@ info: To determine the technical writer assigned to the Stage/Group associated w description: Control the job concurrency in GitLab CI/CD --- -# Resource group **(FREE ALL)** +# Resource group -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/15536) in GitLab 12.7. +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/15536) in GitLab 12.7. By default, pipelines in GitLab CI/CD run concurrently. Concurrency is an important factor to improve the feedback loop in merge requests, however, there are some situations that @@ -141,7 +145,7 @@ Depending on the process mode of the resource group: ## Pipeline-level concurrency control with cross-project/parent-child pipelines -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/39057) in GitLab 13.9. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/39057) in GitLab 13.9. You can define `resource_group` for downstream pipelines that are sensitive to concurrent executions. The [`trigger` keyword](../yaml/index.md#trigger) can trigger downstream pipelines and the diff --git a/doc/ci/review_apps/index.md b/doc/ci/review_apps/index.md index eafb31241b0..2f3267f6917 100644 --- a/doc/ci/review_apps/index.md +++ b/doc/ci/review_apps/index.md @@ -4,7 +4,11 @@ group: Pipeline Execution info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Review apps **(FREE ALL)** +# Review apps + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed Review apps are a collaboration tool that provide an environment to showcase product changes. @@ -63,7 +67,7 @@ The process of configuring review apps is as follows: ### Enable review apps button -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/118844) in GitLab 12.8. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/118844) in GitLab 12.8. When configuring review apps for a project, you add a new job to the `.gitlab-ci.yml` file, as mentioned above. To facilitate this, and if you are using Kubernetes, you can select @@ -191,7 +195,11 @@ After you have the route mapping set up, it takes effect in the following locati - In the blob file view, by selecting **View** (**{external-link}**) next to the file. -## Visual Reviews (deprecated) **(PREMIUM ALL)** +## Visual Reviews (deprecated) + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/10761) in GitLab 12.0. > - [Moved](https://about.gitlab.com/blog/2021/01/26/new-gitlab-product-subscription-model/) to GitLab Premium in 13.9. @@ -299,7 +307,7 @@ merge request ID before you can provide feedback. ### Authentication for Visual Reviews -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/42750#note_317271120) in GitLab 12.10. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/42750#note_317271120) in GitLab 12.10. To enable visual reviews for private and internal projects, set the [`data-require-auth` variable](#configure-review-apps-for-visual-reviews) to `true`. When enabled, diff --git a/doc/ci/runners/configure_runners.md b/doc/ci/runners/configure_runners.md index 6212c07ce47..ef5afede227 100644 --- a/doc/ci/runners/configure_runners.md +++ b/doc/ci/runners/configure_runners.md @@ -4,7 +4,11 @@ group: Runner info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Configuring runners **(FREE ALL)** +# Configuring runners + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed If you have installed your own runners, you can configure and secure them in GitLab. @@ -87,7 +91,7 @@ To set the maximum job timeout: ## Set `script` and `after_script` timeouts -> [Introduced](https://gitlab.com/gitlab-org/gitlab-runner/-/merge_requests/4335) in GitLab Runner 16.4. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab-runner/-/merge_requests/4335) in GitLab Runner 16.4. To control the amount of time `script` and `after_script` runs before it terminates, you can set specify a timeout. @@ -417,7 +421,7 @@ osx job: ### Use CI/CD variables in tags -> Introduced in [GitLab 14.1](https://gitlab.com/gitlab-org/gitlab/-/issues/35742). +> - Introduced in [GitLab 14.1](https://gitlab.com/gitlab-org/gitlab/-/issues/35742). In the `.gitlab-ci.yml` file, use [CI/CD variables](../variables/index.md) with `tags` for dynamic runner selection: @@ -622,7 +626,7 @@ Where `$REFSPECS` is a value provided to the runner internally by GitLab. ### Sync or exclude specific submodules from CI jobs -> [Introduced](https://gitlab.com/gitlab-org/gitlab-runner/-/merge_requests/2249) in GitLab Runner 14.0. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab-runner/-/merge_requests/2249) in GitLab Runner 14.0. Use the `GIT_SUBMODULE_PATHS` variable to control which submodules have to be synced or updated. You can set it globally or per-job in the [`variables`](../yaml/index.md#variables) section. @@ -690,7 +694,7 @@ submodule commits as designed, and update them using an auto-remediation/depende ### Rewrite submodule URLs to HTTPS -> [Introduced](https://gitlab.com/gitlab-org/gitlab-runner/-/merge_requests/3198) in GitLab Runner 15.11. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab-runner/-/merge_requests/3198) in GitLab Runner 15.11. Use the `GIT_SUBMODULE_FORCE_HTTPS` variable to force a rewrite of all Git and SSH submodule URLs to HTTPS. This allows you to clone submodules on the same GitLab instance that use absolute URLs, even if they were @@ -739,7 +743,7 @@ You can set it globally or per-job in the [`variables`](../yaml/index.md#variabl ### Git submodule depth -> [Introduced](https://gitlab.com/gitlab-org/gitlab-runner/-/merge_requests/3651) in GitLab Runner 15.5. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab-runner/-/merge_requests/3651) in GitLab Runner 15.5. Use the `GIT_SUBMODULE_DEPTH` variable to specify the depth of fetching and cloning submodules when [`GIT_SUBMODULE_STRATEGY`](#git-submodule-strategy) is set to either `normal` or `recursive`. @@ -905,7 +909,7 @@ variables: ## Artifact provenance metadata -> [Introduced](https://gitlab.com/gitlab-org/gitlab-runner/-/issues/28940) in GitLab Runner 15.1. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab-runner/-/issues/28940) in GitLab Runner 15.1. NOTE: Zip archives are the only supported artifact type. Follow [the issue for details](https://gitlab.com/gitlab-org/gitlab/-/issues/367203). @@ -1016,7 +1020,7 @@ An example of provenance metadata that the GitLab Runner might generate is as fo ### Staging directory -> [Introduced](https://gitlab.com/gitlab-org/gitlab-runner/-/merge_requests/3403) in GitLab Runner 15.0. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab-runner/-/merge_requests/3403) in GitLab Runner 15.0. If you do not want to archive cache and artifacts in the system's default temporary directory, you can specify a different directory. @@ -1030,7 +1034,7 @@ used, this location is also used as scratch space when archiving. ### Configure `fastzip` to improve performance -> [Introduced](https://gitlab.com/gitlab-org/gitlab-runner/-/merge_requests/3130) in GitLab Runner 15.0. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab-runner/-/merge_requests/3130) in GitLab Runner 15.0. To tune `fastzip`, ensure the [`FF_USE_FASTZIP`](https://docs.gitlab.com/runner/configuration/feature-flags.html#available-feature-flags) flag is enabled. Then use any of the following environment variables. diff --git a/doc/ci/runners/index.md b/doc/ci/runners/index.md index 7fb7db3d829..18102e6d7a2 100644 --- a/doc/ci/runners/index.md +++ b/doc/ci/runners/index.md @@ -4,7 +4,11 @@ group: Runner SaaS info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Runner SaaS **(FREE SAAS)** +# Runner SaaS + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS You can run your CI/CD jobs on GitLab.com using SaaS runners hosted by GitLab to seamlessly build, test and deploy your application on different environments. diff --git a/doc/ci/runners/new_creation_workflow.md b/doc/ci/runners/new_creation_workflow.md index 12bffb79e33..cf753d8ca62 100644 --- a/doc/ci/runners/new_creation_workflow.md +++ b/doc/ci/runners/new_creation_workflow.md @@ -4,7 +4,11 @@ group: Runner info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Migrating to the new runner registration workflow **(FREE ALL)** +# Migrating to the new runner registration workflow + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed DISCLAIMER: This page contains information related to upcoming products, features, and functionality. diff --git a/doc/ci/runners/runner_fleet_dashboard.md b/doc/ci/runners/runner_fleet_dashboard.md index f329561cf4b..8e691eee11d 100644 --- a/doc/ci/runners/runner_fleet_dashboard.md +++ b/doc/ci/runners/runner_fleet_dashboard.md @@ -6,9 +6,12 @@ info: >- this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Runner Fleet Dashboard **(ULTIMATE)** +# Runner Fleet Dashboard -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/424495) in GitLab 16.6 +DETAILS: +**Tier:** Ultimate + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/424495) in GitLab 16.6 GitLab administrators can use the Runner Fleet Dashboard to assess the health of your instance runners. The Runner Fleet Dashboard shows: @@ -53,7 +56,12 @@ To export compute minutes used by instance runners: 1. Select **Fleet dashboard**. 1. Select **Export CSV**. -## Enable more CI analytics features with ClickHouse **(ULTIMATE EXPERIMENT)** +## Enable more CI analytics features with ClickHouse + +DETAILS: +**Tier:** Ultimate +**Offering:** SaaS, self-managed +**Status:** Experiment > - [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/11180) in GitLab 16.7 with the [flags](../../administration/feature_flags.md) named `ci_data_ingestion_to_click_house` and `clickhouse_ci_analytics`. Disabled by default. > - [Enabled by default](https://gitlab.com/gitlab-org/gitlab/-/issues/424866) in GitLab 16.8. Feature flag `clickhouse_ci_analytics` removed. diff --git a/doc/ci/runners/runners_scope.md b/doc/ci/runners/runners_scope.md index 230c5510111..143f8bea699 100644 --- a/doc/ci/runners/runners_scope.md +++ b/doc/ci/runners/runners_scope.md @@ -4,7 +4,11 @@ group: Runner info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Manage runners **(FREE ALL)** +# Manage runners + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed GitLab Runner has the following types of runners, which are available based on who you want to have access: @@ -265,7 +269,7 @@ The runner authentication token displays in the UI for only a short period of ti ### Create a group runner with a registration token (deprecated) -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/19819) in GitLab 14.10, path changed from **Settings > CI/CD > Runners**. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/19819) in GitLab 14.10, path changed from **Settings > CI/CD > Runners**. WARNING: The ability to pass a runner registration token, and support for certain configuration arguments was @@ -356,9 +360,13 @@ To delete a single or multiple group runners: - To delete all runners, select the checkbox at the top of the runner list and select **Delete selected**. 1. Select **Permanently delete runner**. -### Clean up stale group runners **(ULTIMATE ALL)** +### Clean up stale group runners -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/363012) in GitLab 15.1. +DETAILS: +**Tier:** Ultimate +**Offering:** SaaS, self-managed + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/363012) in GitLab 15.1. Prerequisites: @@ -570,9 +578,13 @@ A runner can have one of the following statuses. | `stale` | The runner has not contacted GitLab in more than 3 months. If the runner was created more than 3 months ago, but it never contacted the instance, it is also considered **stale**. | | `never_contacted` | The runner has never contacted GitLab. To make the runner contact GitLab, run `gitlab-runner run`. | -## View statistics for runner performance **(ULTIMATE ALL)** +## View statistics for runner performance -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/377963) in GitLab 15.8. +DETAILS: +**Tier:** Ultimate +**Offering:** SaaS, self-managed + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/377963) in GitLab 15.8. As an administrator, you can view runner statistics to learn about the performance of your runner fleet. @@ -590,9 +602,13 @@ To view runner statistics: 1. Select **CI/CD > Runners**. 1. Select **View metrics**. -## Determine which runners need to be upgraded **(ULTIMATE ALL)** +## Determine which runners need to be upgraded -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/365078) in GitLab 15.3. +DETAILS: +**Tier:** Ultimate +**Offering:** SaaS, self-managed + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/365078) in GitLab 15.3. The version of GitLab Runner used by your runners should be [kept up-to-date](https://docs.gitlab.com/runner/index.html#gitlab-runner-versions). diff --git a/doc/ci/runners/saas/gpu_saas_runner.md b/doc/ci/runners/saas/gpu_saas_runner.md index e9313c65f11..85e03be4990 100644 --- a/doc/ci/runners/saas/gpu_saas_runner.md +++ b/doc/ci/runners/saas/gpu_saas_runner.md @@ -4,7 +4,11 @@ group: Runner info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# GPU-enabled SaaS runners **(PREMIUM SAAS)** +# GPU-enabled SaaS runners + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS GitLab provides GPU-enabled SaaS runners to accelerate heavy compute workloads for ModelOps or HPC such as the training or deployment of Large Language Models (LLMs) as part of ModelOps workloads. diff --git a/doc/ci/runners/saas/linux_saas_runner.md b/doc/ci/runners/saas/linux_saas_runner.md index 2534db79795..210aaef01e6 100644 --- a/doc/ci/runners/saas/linux_saas_runner.md +++ b/doc/ci/runners/saas/linux_saas_runner.md @@ -4,7 +4,11 @@ group: Runner info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# SaaS runners on Linux **(FREE SAAS)** +# SaaS runners on Linux + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS When you run jobs on SaaS runners on Linux, the runners are on auto-scaled ephemeral virtual machine (VM) instances. The default region for the VMs is `us-east1`. @@ -21,9 +25,9 @@ For Free, Premium, and Ultimate plan customers, jobs on these instances consume |-----------------------------------------------|-------|--------|---------| | `saas-linux-small-amd64` | 2 | 8 GB | 25 GB | | `saas-linux-medium-amd64` | 4 | 16 GB | 50 GB | -| `saas-linux-large-amd64` **(PREMIUM SAAS)** | 8 | 32 GB | 100 GB | -| `saas-linux-xlarge-amd64` **(PREMIUM SAAS)** | 16 | 64 GB | 200 GB | -| `saas-linux-2xlarge-amd64` **(PREMIUM SAAS)** | 32 | 128 GB | 200 GB | +| `saas-linux-large-amd64` (Premium and Ultimate only) | 8 | 32 GB | 100 GB | +| `saas-linux-xlarge-amd64` (Premium and Ultimate only) | 16 | 64 GB | 200 GB | +| `saas-linux-2xlarge-amd64` (Premium and Ultimate only) | 32 | 128 GB | 200 GB | The `small` machine type is set as default. If no [tag](../../yaml/index.md#tags) keyword in your `.gitlab-ci.yml` file is specified, the jobs will run on this default runner. diff --git a/doc/ci/runners/saas/macos_saas_runner.md b/doc/ci/runners/saas/macos_saas_runner.md index 55deced783a..aedcbfc5fd6 100644 --- a/doc/ci/runners/saas/macos_saas_runner.md +++ b/doc/ci/runners/saas/macos_saas_runner.md @@ -4,7 +4,12 @@ group: Runner info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# SaaS runners on macOS **(PREMIUM SAAS BETA)** +# SaaS runners on macOS + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS +**Status:** Beta SaaS runners on macOS are in [Beta](../../../policy/experiment-beta-support.md#beta) for open source programs and customers in Premium and Ultimate plans. diff --git a/doc/ci/runners/saas/windows_saas_runner.md b/doc/ci/runners/saas/windows_saas_runner.md index 8fd502e8a3d..b9252456951 100644 --- a/doc/ci/runners/saas/windows_saas_runner.md +++ b/doc/ci/runners/saas/windows_saas_runner.md @@ -4,7 +4,12 @@ group: Runner info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# SaaS runners on Windows **(FREE SAAS BETA)** +# SaaS runners on Windows + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS +**Status:** Beta SaaS runner on Windows autoscale by launching virtual machines on the Google Cloud Platform. This solution uses an diff --git a/doc/ci/secrets/azure_key_vault.md b/doc/ci/secrets/azure_key_vault.md index 7dd27a4cd09..0f891d6750e 100644 --- a/doc/ci/secrets/azure_key_vault.md +++ b/doc/ci/secrets/azure_key_vault.md @@ -4,7 +4,11 @@ group: Pipeline Security info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Use Azure Key Vault secrets in GitLab CI/CD **(PREMIUM ALL)** +# Use Azure Key Vault secrets in GitLab CI/CD + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/271271) in GitLab and GitLab Runner 16.3. Due to [issue 424746](https://gitlab.com/gitlab-org/gitlab/-/issues/424746) this feature did not work as expected. > - [Issue 424746](https://gitlab.com/gitlab-org/gitlab/-/issues/424746) resolved and this feature made generally available in GitLab Runner 16.6. diff --git a/doc/ci/secrets/convert-to-id-tokens.md b/doc/ci/secrets/convert-to-id-tokens.md index 80d1a1febd2..3e0a790d1b1 100644 --- a/doc/ci/secrets/convert-to-id-tokens.md +++ b/doc/ci/secrets/convert-to-id-tokens.md @@ -4,7 +4,11 @@ group: Pipeline Security info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Tutorial: Update HashiCorp Vault configuration to use ID Tokens **(PREMIUM ALL)** +# Tutorial: Update HashiCorp Vault configuration to use ID Tokens + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed This tutorial demonstrates how to convert your existing CI/CD secrets configuration to use [ID Tokens](../secrets/id_token_authentication.md). diff --git a/doc/ci/secrets/gcp_secret_manager.md b/doc/ci/secrets/gcp_secret_manager.md index cad93033d9a..c6e5c030441 100644 --- a/doc/ci/secrets/gcp_secret_manager.md +++ b/doc/ci/secrets/gcp_secret_manager.md @@ -4,9 +4,13 @@ group: Pipeline Security info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Use GCP Secret Manager secrets in GitLab CI/CD **(PREMIUM ALL)** +# Use GCP Secret Manager secrets in GitLab CI/CD -> [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/11739) in GitLab and GitLab Runner 16.8. +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed + +> - [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/11739) in GitLab and GitLab Runner 16.8. You can use secrets stored in the [Google Cloud (GCP) Secret Manager](https://cloud.google.com/security/products/secret-manager) in your GitLab CI/CD pipelines. diff --git a/doc/ci/secrets/id_token_authentication.md b/doc/ci/secrets/id_token_authentication.md index 1b3a6b837a5..394ea8e5456 100644 --- a/doc/ci/secrets/id_token_authentication.md +++ b/doc/ci/secrets/id_token_authentication.md @@ -4,9 +4,13 @@ group: Pipeline Security info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# OpenID Connect (OIDC) Authentication Using ID Tokens **(FREE ALL)** +# OpenID Connect (OIDC) Authentication Using ID Tokens -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/356986) in GitLab 15.7. +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/356986) in GitLab 15.7. You can authenticate with third party services using GitLab CI/CD's [ID tokens](../yaml/index.md#id_tokens). @@ -139,7 +143,11 @@ manual_authentication: - my-authentication-script.sh $VAULT_TOKEN $PASSWORD ``` -## Automatic ID Token authentication with HashiCorp Vault **(PREMIUM ALL)** +## Automatic ID Token authentication with HashiCorp Vault + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed You can use ID tokens to automatically fetch secrets from HashiCorp Vault with the [`secrets`](../yaml/index.md#secrets) keyword. diff --git a/doc/ci/secrets/index.md b/doc/ci/secrets/index.md index 96a35703f1f..9719efe36ff 100644 --- a/doc/ci/secrets/index.md +++ b/doc/ci/secrets/index.md @@ -4,7 +4,11 @@ group: Pipeline Security info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Using external secrets in CI **(FREE ALL)** +# Using external secrets in CI + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/218746) in GitLab 13.4 and GitLab Runner 13.4. > - `file` setting [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/250695) in GitLab 14.1 and GitLab Runner 14.1. @@ -102,9 +106,13 @@ To configure your Vault server: NOTE: Support for providing these values in the user interface [is tracked in this issue](https://gitlab.com/gitlab-org/gitlab/-/issues/218677). -## Use Vault secrets in a CI job **(PREMIUM ALL)** +## Use Vault secrets in a CI job -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/28321) in GitLab 13.4 and GitLab Runner 13.4. +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/28321) in GitLab 13.4 and GitLab Runner 13.4. After [configuring your Vault server](#configure-your-vault-server), you can use the secrets stored in Vault by defining them with the `vault` keyword: diff --git a/doc/ci/secure_files/index.md b/doc/ci/secure_files/index.md index ee074c2a99c..b307ff18617 100644 --- a/doc/ci/secure_files/index.md +++ b/doc/ci/secure_files/index.md @@ -4,7 +4,11 @@ group: Pipeline Security info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Project-level Secure Files **(FREE ALL)** +# Project-level Secure Files + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/78227) in GitLab 14.8 [with a flag](../../administration/feature_flags.md) named `ci_secure_files`. Disabled by default. > - [Generally available](https://gitlab.com/gitlab-org/gitlab/-/issues/350748) in GitLab 15.7. Feature flag `ci_secure_files` removed. diff --git a/doc/ci/services/gitlab.md b/doc/ci/services/gitlab.md index 94fba9cff98..176bcabb628 100644 --- a/doc/ci/services/gitlab.md +++ b/doc/ci/services/gitlab.md @@ -4,7 +4,11 @@ group: Runner info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Use GitLab as a microservice **(FREE ALL)** +# Use GitLab as a microservice + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed Many applications need to access JSON APIs, so application tests might need access to APIs too. The following example shows how to use GitLab as a microservice to give diff --git a/doc/ci/services/index.md b/doc/ci/services/index.md index 9a624f88339..21b37ad3492 100644 --- a/doc/ci/services/index.md +++ b/doc/ci/services/index.md @@ -4,7 +4,11 @@ group: Runner info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Services **(FREE ALL)** +# Services + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed When you configure CI/CD, you specify an image, which is used to create the container where your jobs run. To specify this image, you use the `image` keyword. @@ -256,7 +260,7 @@ test: ## Available settings for `services` -> Introduced in GitLab and GitLab Runner 9.4. +> - Introduced in GitLab and GitLab Runner 9.4. | Setting | Required | GitLab version | Description | |------------|----------|----------------| ----------- | @@ -272,7 +276,7 @@ test: ## Starting multiple services from the same image -> Introduced in GitLab and GitLab Runner 9.4. Read more about the [extended configuration options](../docker/using_docker_images.md#extended-docker-configuration-options). +> - Introduced in GitLab and GitLab Runner 9.4. Read more about the [extended configuration options](../docker/using_docker_images.md#extended-docker-configuration-options). Before the new extended Docker configuration options, the following configuration would not work properly: @@ -305,7 +309,7 @@ in `.gitlab-ci.yml` file. ## Setting a command for the service -> Introduced in GitLab and GitLab Runner 9.4. Read more about the [extended configuration options](../docker/using_docker_images.md#extended-docker-configuration-options). +> - Introduced in GitLab and GitLab Runner 9.4. Read more about the [extended configuration options](../docker/using_docker_images.md#extended-docker-configuration-options). Let's assume you have a `super/sql:latest` image with some SQL database in it. You would like to use it as a service for your job. Let's also @@ -393,7 +397,7 @@ time. ## Capturing service container logs -> [Introduced](https://gitlab.com/gitlab-org/gitlab-runner/-/merge_requests/3680) in GitLab Runner 15.6. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab-runner/-/merge_requests/3680) in GitLab Runner 15.6. Logs generated by applications running in service containers can be captured for subsequent examination and debugging. You might want to look at service container's logs when the service container has started successfully, but is not diff --git a/doc/ci/services/mysql.md b/doc/ci/services/mysql.md index a5a87c2a199..d9d30de9e83 100644 --- a/doc/ci/services/mysql.md +++ b/doc/ci/services/mysql.md @@ -4,7 +4,11 @@ group: Runner info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Using MySQL **(FREE ALL)** +# Using MySQL + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed Many applications depend on MySQL as their database, and you may need it for your tests to run. diff --git a/doc/ci/services/postgres.md b/doc/ci/services/postgres.md index ea1def6377e..08fcc3bf4ff 100644 --- a/doc/ci/services/postgres.md +++ b/doc/ci/services/postgres.md @@ -4,7 +4,11 @@ group: Runner info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Using PostgreSQL **(FREE ALL)** +# Using PostgreSQL + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed As many applications depend on PostgreSQL as their database, you eventually need it in order for your tests to run. Below you are guided how to diff --git a/doc/ci/services/redis.md b/doc/ci/services/redis.md index 94c0603f31f..87ea98fe19a 100644 --- a/doc/ci/services/redis.md +++ b/doc/ci/services/redis.md @@ -4,7 +4,11 @@ group: Runner info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Using Redis **(FREE ALL)** +# Using Redis + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed As many applications depend on Redis as their key-value store, you eventually need it in order for your tests to run. Below you are guided how to diff --git a/doc/ci/ssh_keys/index.md b/doc/ci/ssh_keys/index.md index b848f436e34..01a84ad1eea 100644 --- a/doc/ci/ssh_keys/index.md +++ b/doc/ci/ssh_keys/index.md @@ -4,7 +4,11 @@ group: Pipeline Security info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Using SSH keys with GitLab CI/CD **(FREE ALL)** +# Using SSH keys with GitLab CI/CD + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed GitLab currently doesn't have built-in support for managing SSH keys in a build environment (where the GitLab Runner runs). diff --git a/doc/ci/test_cases/index.md b/doc/ci/test_cases/index.md index 56c4c475294..8645615c516 100644 --- a/doc/ci/test_cases/index.md +++ b/doc/ci/test_cases/index.md @@ -5,7 +5,11 @@ info: To determine the technical writer assigned to the Stage/Group associated w description: Test cases in GitLab can help your teams create testing scenarios in their existing development platform. --- -# Test cases **(ULTIMATE ALL)** +# Test cases + +DETAILS: +**Tier:** Ultimate +**Offering:** SaaS, self-managed Test cases in GitLab can help your teams create testing scenarios in their existing development platform. @@ -70,7 +74,7 @@ To edit a test case: ## Make a test case confidential -> Introduced for [new](https://gitlab.com/gitlab-org/gitlab/-/issues/422121) and [existing](https://gitlab.com/gitlab-org/gitlab/-/issues/422120) test cases in GitLab 16.5. +> - Introduced for [new](https://gitlab.com/gitlab-org/gitlab/-/issues/422121) and [existing](https://gitlab.com/gitlab-org/gitlab/-/issues/422120) test cases in GitLab 16.5. If you're working on a test case that contains private information, you can make it confidential. diff --git a/doc/ci/testing/accessibility_testing.md b/doc/ci/testing/accessibility_testing.md index f8faaeec8f8..a740e454592 100644 --- a/doc/ci/testing/accessibility_testing.md +++ b/doc/ci/testing/accessibility_testing.md @@ -4,7 +4,11 @@ group: Pipeline Execution info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Accessibility testing **(FREE ALL)** +# Accessibility testing + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed If your application offers a web interface, you can use [GitLab CI/CD](../index.md) to determine the accessibility diff --git a/doc/ci/testing/browser_performance_testing.md b/doc/ci/testing/browser_performance_testing.md index 2988cfedce5..7bab347e0fd 100644 --- a/doc/ci/testing/browser_performance_testing.md +++ b/doc/ci/testing/browser_performance_testing.md @@ -4,7 +4,11 @@ group: Pipeline Execution info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Browser Performance Testing **(PREMIUM ALL)** +# Browser Performance Testing + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed If your application offers a web interface and you're using [GitLab CI/CD](../index.md), you can quickly determine the rendering performance diff --git a/doc/ci/testing/code_coverage.md b/doc/ci/testing/code_coverage.md index 43df79c44f5..4e87512e543 100644 --- a/doc/ci/testing/code_coverage.md +++ b/doc/ci/testing/code_coverage.md @@ -4,7 +4,11 @@ group: Pipeline Execution info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Code coverage **(FREE ALL)** +# Code coverage + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed Use code coverage to provide insights on what source code is being validated by a test suite. Code coverage is one of many test metrics that can determine software performance and quality. @@ -84,7 +88,11 @@ To view a CSV file of the data, select **Download raw data (`.csv`)**. ![Code coverage graph of a project over time](img/code_coverage_graph_v13_1.png) -### View history of group code coverage **(PREMIUM ALL)** +### View history of group code coverage + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed To see the all the project's code coverage under a group over time, you can find view [group repository analytics](../../user/group/repositories_analytics/index.md). @@ -95,7 +103,11 @@ To see the all the project's code coverage under a group over time, you can find You can use [pipeline badges](../../user/project/badges.md#test-coverage-report-badges) to indicate the pipeline status and test coverage of your projects. These badges are determined by the latest successful pipeline. -## Coverage check approval rule **(PREMIUM ALL)** +## Coverage check approval rule + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/15765) in GitLab 14.0. > - [Made configurable in Project Settings](https://gitlab.com/gitlab-org/gitlab/-/issues/331001) in GitLab 14.1. diff --git a/doc/ci/testing/code_quality.md b/doc/ci/testing/code_quality.md index 9e6c409a0d3..74b180edf94 100644 --- a/doc/ci/testing/code_quality.md +++ b/doc/ci/testing/code_quality.md @@ -4,9 +4,13 @@ group: Static Analysis info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Code Quality **(FREE ALL)** +# Code Quality -> [Moved](https://gitlab.com/gitlab-org/gitlab/-/issues/212499) to GitLab Free in 13.2. +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed + +> - [Moved](https://gitlab.com/gitlab-org/gitlab/-/issues/212499) to GitLab Free in 13.2. Use Code Quality to analyze your source code's quality and complexity. This helps keep your project's code simple, readable, and easier to maintain. Code Quality should supplement your @@ -48,7 +52,7 @@ Code Quality results are shown in the: ### Merge request widget -> [Moved](https://gitlab.com/gitlab-org/gitlab/-/issues/212499) to GitLab Free in 13.2. +> - [Moved](https://gitlab.com/gitlab-org/gitlab/-/issues/212499) to GitLab Free in 13.2. Code Quality analysis results display in the merge request widget area if a report from the target branch is available for comparison. The merge request widget displays Code Quality findings and resolutions that @@ -58,7 +62,11 @@ full report available in the **Pipeline** details view. ![Code Quality Widget](img/code_quality_widget_13_11.png) -### Merge request changes view **(ULTIMATE ALL)** +### Merge request changes view + +DETAILS: +**Tier:** Ultimate +**Offering:** SaaS, self-managed > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/267612) in GitLab 13.11, disabled by default behind the `codequality_mr_diff` [feature flag](../../administration/feature_flags.md). > - [Enabled by default](https://gitlab.com/gitlab-org/gitlab/-/issues/284140) in GitLab 13.12. @@ -70,7 +78,11 @@ issues are marked by a symbol beside the gutter. Select the symbol to see the li ![Code Quality Inline Indicator](img/code_quality_inline_indicator_v16_7.png) -### Pipeline details view **(PREMIUM ALL)** +### Pipeline details view + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed The full list of Code Quality violations generated by a pipeline is shown in the **Code Quality** tab of the pipeline's details page. The pipeline details view displays all Code Quality findings @@ -78,7 +90,11 @@ that were found on the branch it was run on. ![Code Quality Report](img/code_quality_report_13_11.png) -### Project quality view **(ULTIMATE ALL)** +### Project quality view + +DETAILS: +**Tier:** Ultimate +**Offering:** SaaS, self-managed The project quality view displays an overview of the code quality findings. The view can be found under **Analyze > CI/CD analytics**, and requires [`project_quality_summary_page`](../../user/feature_flags.md) feature flag to be enabled for this particular project. @@ -319,7 +335,7 @@ code_quality: ## Use a private container image registry -> [Introduced](https://gitlab.com/gitlab-org/ci-cd/codequality/-/merge_requests/30) in GitLab 13.7. +> - [Introduced](https://gitlab.com/gitlab-org/ci-cd/codequality/-/merge_requests/30) in GitLab 13.7. Using a private container image registry can reduce the time taken to download images, and also reduce external dependencies. You must configure the registry prefix to be passed down diff --git a/doc/ci/testing/fail_fast_testing.md b/doc/ci/testing/fail_fast_testing.md index 22ce9bb52d8..e69cff130f9 100644 --- a/doc/ci/testing/fail_fast_testing.md +++ b/doc/ci/testing/fail_fast_testing.md @@ -4,9 +4,13 @@ group: Pipeline Execution info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Fail Fast Testing **(PREMIUM ALL)** +# Fail Fast Testing -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/198550) in GitLab 13.1. +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/198550) in GitLab 13.1. For applications that use RSpec for running tests, we've introduced the `Verify/Failfast` [template to run subsets of your test suite](https://gitlab.com/gitlab-org/gitlab/-/tree/master/lib/gitlab/ci/templates/Verify/FailFast.gitlab-ci.yml), diff --git a/doc/ci/testing/index.md b/doc/ci/testing/index.md index 2909bac4d0b..60622449029 100644 --- a/doc/ci/testing/index.md +++ b/doc/ci/testing/index.md @@ -4,7 +4,11 @@ group: Pipeline Execution info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Test with GitLab CI/CD and generate reports in merge requests **(FREE ALL)** +# Test with GitLab CI/CD and generate reports in merge requests + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed Use GitLab CI/CD to test the changes included in a feature branch. You can also display reports or link to important information directly from [merge requests](../../user/project/merge_requests/index.md). @@ -23,7 +27,11 @@ display reports or link to important information directly from [merge requests]( | [Test Coverage visualization](test_coverage_visualization.md) | See test coverage results for merge requests, in the file diff. | | [Fail fast testing](fail_fast_testing.md) | Run a subset of your RSpec test suite, so failed tests stop the pipeline before the full suite of tests run, saving resources. | -## Security Reports **(ULTIMATE ALL)** +## Security Reports + +DETAILS: +**Tier:** Ultimate +**Offering:** SaaS, self-managed In addition to the reports listed above, GitLab can do many types of [Security reports](../../user/application_security/index.md), generated by scanning and reporting any vulnerabilities found in your project: diff --git a/doc/ci/testing/load_performance_testing.md b/doc/ci/testing/load_performance_testing.md index a79136c0083..69076ca57a4 100644 --- a/doc/ci/testing/load_performance_testing.md +++ b/doc/ci/testing/load_performance_testing.md @@ -4,9 +4,13 @@ group: Pipeline Execution info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Load Performance Testing **(PREMIUM ALL)** +# Load Performance Testing -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/10683) in GitLab 13.2. +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/10683) in GitLab 13.2. With Load Performance Testing, you can test the impact of any pending code changes to your application's backend in [GitLab CI/CD](../index.md). diff --git a/doc/ci/testing/metrics_reports.md b/doc/ci/testing/metrics_reports.md index faa7add64b3..1ec3d3fe540 100644 --- a/doc/ci/testing/metrics_reports.md +++ b/doc/ci/testing/metrics_reports.md @@ -4,9 +4,13 @@ group: Pipeline Execution info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Metrics Reports **(PREMIUM ALL)** +# Metrics Reports -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/9788) in GitLab 11.10. Requires GitLab Runner 11.10 and above. +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/9788) in GitLab 11.10. Requires GitLab Runner 11.10 and above. GitLab provides a lot of great reporting tools for things like [merge requests](../../user/project/merge_requests/index.md) - [Unit test reports](unit_test_reports.md), [code quality](code_quality.md), and performance tests. While JUnit is a great open framework for tests that "pass" or "fail", it is also important to see other types of metrics from a given change. diff --git a/doc/ci/testing/test_coverage_visualization.md b/doc/ci/testing/test_coverage_visualization.md index ecd5c794344..4d56ce1af5b 100644 --- a/doc/ci/testing/test_coverage_visualization.md +++ b/doc/ci/testing/test_coverage_visualization.md @@ -4,7 +4,11 @@ group: Pipeline Execution info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Test coverage visualization **(FREE ALL)** +# Test coverage visualization + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/3708) in GitLab 12.9. > - [Feature flag removed](https://gitlab.com/gitlab-org/gitlab/-/issues/249811) in GitLab 13.5. @@ -74,7 +78,7 @@ The visualization cannot be displayed if the blocking manual job did not run. ### Data expiration -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/321323) in GitLab 13.12, the latest data is kept regardless of expiry time. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/321323) in GitLab 13.12, the latest data is kept regardless of expiry time. By default, the data used to draw the visualization on the merge request expires **one week** after creation. diff --git a/doc/ci/testing/unit_test_report_examples.md b/doc/ci/testing/unit_test_report_examples.md index bade653bf18..d298b2c0f0b 100644 --- a/doc/ci/testing/unit_test_report_examples.md +++ b/doc/ci/testing/unit_test_report_examples.md @@ -4,7 +4,11 @@ group: Pipeline Execution info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Unit test report examples **(FREE ALL)** +# Unit test report examples + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed [Unit test reports](unit_test_reports.md) can be generated for many languages and packages. Use these examples as guidelines for configuring your pipeline to generate unit test reports diff --git a/doc/ci/testing/unit_test_reports.md b/doc/ci/testing/unit_test_reports.md index 59401449b63..d7f2b9daaff 100644 --- a/doc/ci/testing/unit_test_reports.md +++ b/doc/ci/testing/unit_test_reports.md @@ -4,7 +4,11 @@ group: Pipeline Execution info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Unit test reports **(FREE ALL)** +# Unit test reports + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed > - [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/issues/45318) in GitLab 11.2. Requires GitLab Runner 11.2 and above. > - [Renamed](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/39737) from JUnit test reports to Unit test reports in GitLab 13.4. @@ -68,7 +72,7 @@ the error output. #### Copy failed test names -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/91552) in GitLab 15.2. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/91552) in GitLab 15.2. You can copy the name and path of failed tests when there are failed tests listed in the **Test summary** panel. Use name and path to find and rerun the @@ -155,7 +159,7 @@ You can also retrieve the reports via the [GitLab API](../../api/pipelines.md#ge ### Unit test reports parsing errors -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/263457) in GitLab 13.10. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/263457) in GitLab 13.10. If parsing JUnit report XML results in an error, an indicator is shown next to the job name. Hovering over the icon shows the parser error in a tooltip. If multiple parsing errors come from [grouped jobs](../jobs/index.md#group-jobs-in-a-pipeline), GitLab shows only the first error from the group. diff --git a/doc/ci/triggers/index.md b/doc/ci/triggers/index.md index b628159ad21..9f91f03e5b7 100644 --- a/doc/ci/triggers/index.md +++ b/doc/ci/triggers/index.md @@ -4,7 +4,11 @@ group: Pipeline Authoring info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Trigger pipelines by using the API **(FREE ALL)** +# Trigger pipelines by using the API + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed To trigger a pipeline for a specific branch or tag, you can use an API call to the [pipeline triggers API endpoint](../../api/pipeline_triggers.md). diff --git a/doc/ci/variables/index.md b/doc/ci/variables/index.md index 49f5f1edf41..20cab081edf 100644 --- a/doc/ci/variables/index.md +++ b/doc/ci/variables/index.md @@ -4,7 +4,11 @@ group: Pipeline Security info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# GitLab CI/CD variables **(FREE ALL)** +# GitLab CI/CD variables + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed CI/CD variables are a type of environment variable. You can use them to: @@ -169,7 +173,7 @@ To add a group variable: - **Key**: Must be one line, with no spaces, using only letters, numbers, or `_`. - **Value**: No limitations. - **Type**: `Variable` (default) or [`File`](#use-file-type-cicd-variables). - - **Environment scope** Optional. `All`, or specific [environments](../environments/index.md#limit-the-environment-scope-of-a-cicd-variable). **(PREMIUM ALL)** + - **Environment scope** Optional. `All`, or specific [environments](../environments/index.md#limit-the-environment-scope-of-a-cicd-variable). - **Protect variable** Optional. If selected, the variable is only available in pipelines that run on protected branches or tags. - **Mask variable** Optional. If selected, the variable's **Value** is masked @@ -180,7 +184,11 @@ The group variables that are available in a project are listed in the project's **Settings > CI/CD > Variables** section. Variables from [subgroups](../../user/group/subgroups/index.md) are recursively inherited. -### For an instance **(FREE SELF)** +### For an instance + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/14108) in GitLab 13.0. > - [Feature flag removed](https://gitlab.com/gitlab-org/gitlab/-/issues/299879) in GitLab 13.11. @@ -248,7 +256,7 @@ valid [secrets file](../../administration/backup_restore/troubleshooting_backup_ ### Mask a CI/CD variable -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/330650) in GitLab 13.12, the `~` character can be used in masked variables. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/330650) in GitLab 13.12, the `~` character can be used in masked variables. WARNING: Masking a CI/CD variable is not a guaranteed way to prevent malicious users from @@ -618,7 +626,7 @@ job: ### Prevent CI/CD variable expansion -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/217309) in GitLab 15.7. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/217309) in GitLab 15.7. Expanded variables treat values with the `$` character as a reference to another variable. CI/CD variables are expanded by default. To treat variables with a `$` character as raw strings, @@ -696,7 +704,7 @@ can cause the pipeline to behave unexpectedly. ### Restrict who can override variables -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/295234) in GitLab 13.8. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/295234) in GitLab 13.8. You can limit the ability to override variables to only users with the Maintainer role. When other users try to run a pipeline with overridden variables, they receive the diff --git a/doc/ci/variables/predefined_variables.md b/doc/ci/variables/predefined_variables.md index 645cd9ee9af..8d861c9ce58 100644 --- a/doc/ci/variables/predefined_variables.md +++ b/doc/ci/variables/predefined_variables.md @@ -4,7 +4,11 @@ group: Pipeline Security info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Predefined CI/CD variables reference **(FREE ALL)** +# Predefined CI/CD variables reference + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed Predefined [CI/CD variables](index.md) are available in every GitLab CI/CD pipeline. diff --git a/doc/ci/variables/where_variables_can_be_used.md b/doc/ci/variables/where_variables_can_be_used.md index 4ea45c9bae4..07ef4925480 100644 --- a/doc/ci/variables/where_variables_can_be_used.md +++ b/doc/ci/variables/where_variables_can_be_used.md @@ -4,7 +4,11 @@ group: Pipeline Security info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Where variables can be used **(FREE ALL)** +# Where variables can be used + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed As it's described in the [CI/CD variables](index.md) documentation, you can define many different variables. Some of them can be used for all GitLab CI/CD diff --git a/doc/ci/yaml/artifacts_reports.md b/doc/ci/yaml/artifacts_reports.md index 131f9e502fe..34096d18fa8 100644 --- a/doc/ci/yaml/artifacts_reports.md +++ b/doc/ci/yaml/artifacts_reports.md @@ -4,7 +4,11 @@ group: Pipeline Execution info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# GitLab CI/CD artifacts reports types **(FREE ALL)** +# GitLab CI/CD artifacts reports types + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed Use [`artifacts:reports`](index.md#artifactsreports) to: @@ -41,7 +45,7 @@ For more information, see [Accessibility testing](../testing/accessibility_testi ## `artifacts:reports:annotations` -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/38337) in GitLab 16.3. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/38337) in GitLab 16.3. The `annotations` report is used to attach auxiliary data to a job. @@ -88,7 +92,11 @@ The following is an example of what a job annotations report might look like: } ``` -## `artifacts:reports:api_fuzzing` **(ULTIMATE ALL)** +## `artifacts:reports:api_fuzzing` + +DETAILS: +**Tier:** Ultimate +**Offering:** SaaS, self-managed The `api_fuzzing` report collects [API Fuzzing bugs](../../user/application_security/api_fuzzing/index.md) as artifacts. @@ -100,7 +108,11 @@ GitLab can display the results of one or more reports in: - The pipeline [**Security** tab](../../user/application_security/vulnerability_report/pipeline.md#view-vulnerabilities-in-a-pipeline). - The [security dashboard](../../user/application_security/api_fuzzing/index.md#security-dashboard). -## `artifacts:reports:browser_performance` **(PREMIUM ALL)** +## `artifacts:reports:browser_performance` + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed > [Name changed](https://gitlab.com/gitlab-org/gitlab/-/issues/225914) from `artifacts:reports:performance` in GitLab 14.0. @@ -114,7 +126,7 @@ GitLab cannot display the combined results of multiple `browser_performance` rep ## `artifacts:reports:coverage_report` -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/344533) in GitLab 14.10. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/344533) in GitLab 14.10. Use `coverage_report` to collect coverage report in Cobertura format. @@ -152,7 +164,11 @@ GitLab can display the results of one or more reports in: The [`artifacts:expire_in`](../yaml/index.md#artifactsexpire_in) value is set to `1 week`. -## `artifacts:reports:container_scanning` **(ULTIMATE ALL)** +## `artifacts:reports:container_scanning` + +DETAILS: +**Tier:** Ultimate +**Offering:** SaaS, self-managed The `container_scanning` report collects [Container Scanning vulnerabilities](../../user/application_security/container_scanning/index.md). The collected Container Scanning report uploads to GitLab as an artifact. @@ -164,7 +180,11 @@ GitLab can display the results of one or more reports in: - The [security dashboard](../../user/application_security/security_dashboard/index.md). - The [Project Vulnerability report](../../user/application_security/vulnerability_report/index.md). -## `artifacts:reports:coverage_fuzzing` **(ULTIMATE ALL)** +## `artifacts:reports:coverage_fuzzing` + +DETAILS: +**Tier:** Ultimate +**Offering:** SaaS, self-managed The `coverage_fuzzing` report collects [coverage fuzzing bugs](../../user/application_security/coverage_fuzzing/index.md). The collected coverage fuzzing report uploads to GitLab as an artifact. @@ -177,7 +197,7 @@ GitLab can display the results of one or more reports in: ## `artifacts:reports:cyclonedx` -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/360766) in GitLab 15.3 +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/360766) in GitLab 15.3 This report is a Software Bill of Materials describing the components of a project following the [CycloneDX](https://cyclonedx.org/docs/1.4) protocol format. @@ -200,7 +220,11 @@ artifacts: - gl-sbom-bundler-gem.cdx.json ``` -## `artifacts:reports:dast` **(ULTIMATE ALL)** +## `artifacts:reports:dast` + +DETAILS: +**Tier:** Ultimate +**Offering:** SaaS, self-managed The `dast` report collects [DAST vulnerabilities](../../user/application_security/dast/index.md). The collected DAST report uploads to GitLab as an artifact. @@ -212,7 +236,11 @@ GitLab can display the results of one or more reports in: - The [Project Vulnerability report](../../user/application_security/vulnerability_report/index.md). - The [security dashboard](../../user/application_security/security_dashboard/index.md). -## `artifacts:reports:dependency_scanning` **(ULTIMATE ALL)** +## `artifacts:reports:dependency_scanning` + +DETAILS: +**Tier:** Ultimate +**Offering:** SaaS, self-managed The `dependency_scanning` report collects [Dependency Scanning vulnerabilities](../../user/application_security/dependency_scanning/index.md). The collected Dependency Scanning report uploads to GitLab as an artifact. @@ -286,7 +314,11 @@ concatenate them into a single file. Use either: - A combination of both (`junit: [rspec.xml, test-results/TEST-*.xml]`). - Directories are not supported(`junit: test-results`, `junit: test-results/**`). -## `artifacts:reports:load_performance` **(PREMIUM ALL)** +## `artifacts:reports:load_performance` + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed The `load_performance` report collects [Load Performance Testing metrics](../testing/load_performance_testing.md). The report is uploaded to GitLab as an artifact. @@ -296,7 +328,11 @@ GitLab can display the results of only one report in the merge request GitLab cannot display the combined results of multiple `load_performance` reports. -## `artifacts:reports:metrics` **(PREMIUM ALL)** +## `artifacts:reports:metrics` + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed The `metrics` report collects [Metrics](../testing/metrics_reports.md). The collected Metrics report uploads to GitLab as an artifact. @@ -304,7 +340,11 @@ artifact. GitLab can display the results of one or more reports in the merge request [metrics reports widget](../testing/metrics_reports.md#metrics-reports). -## `artifacts:reports:requirements` **(ULTIMATE ALL)** +## `artifacts:reports:requirements` + +DETAILS: +**Tier:** Ultimate +**Offering:** SaaS, self-managed The `requirements` report collects `requirements.json` files. The collected Requirements report uploads to GitLab as an artifact and existing [requirements](../../user/project/requirements/index.md) are marked as Satisfied. @@ -312,15 +352,19 @@ artifact and existing [requirements](../../user/project/requirements/index.md) a GitLab can display the results of one or more reports in the [project requirements](../../user/project/requirements/index.md#view-a-requirement). -## `artifacts:reports:repository_xray` **(ULTIMATE ALL)** +## `artifacts:reports:repository_xray` -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/432235) in GitLab 16.7. +DETAILS: +**Tier:** Ultimate +**Offering:** SaaS, self-managed + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/432235) in GitLab 16.7. The `repository_xray` report collects information about your repository for use by AI in code suggestions. ## `artifacts:reports:sast` -> [Moved](https://gitlab.com/groups/gitlab-org/-/epics/2098) from GitLab Ultimate to GitLab Free in 13.3. +> - [Moved](https://gitlab.com/groups/gitlab-org/-/epics/2098) from GitLab Ultimate to GitLab Free in 13.3. The `sast` report collects [SAST vulnerabilities](../../user/application_security/sast/index.md). The collected SAST report uploads to GitLab as an artifact. diff --git a/doc/ci/yaml/includes.md b/doc/ci/yaml/includes.md index 8da4195f5aa..c0aaec5756f 100644 --- a/doc/ci/yaml/includes.md +++ b/doc/ci/yaml/includes.md @@ -4,7 +4,11 @@ group: Pipeline Authoring info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Use CI/CD configuration from other files **(FREE ALL)** +# Use CI/CD configuration from other files + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed You can use [`include`](index.md#include) to include external YAML files in your CI/CD jobs. @@ -298,7 +302,7 @@ default: ### Use nested includes with duplicate `includes` entries -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/28987) in GitLab 14.8 +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/28987) in GitLab 14.8 Nested includes can include the same configuration file. The duplicate configuration file is included multiple times, but the effect is the same as if it was only @@ -502,7 +506,7 @@ for information about work to improve this behavior. ### `include` with `rules:changes` -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/342209) in GitLab 16.4. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/342209) in GitLab 16.4. Use [`rules:changes`](index.md#ruleschanges) to conditionally include other configuration files based on changed files. For example: diff --git a/doc/ci/yaml/index.md b/doc/ci/yaml/index.md index 543416d1216..f91e2d113d9 100644 --- a/doc/ci/yaml/index.md +++ b/doc/ci/yaml/index.md @@ -4,7 +4,11 @@ group: Pipeline Authoring info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# CI/CD YAML syntax reference **(FREE ALL)** +# CI/CD YAML syntax reference + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed This document lists the configuration options for the GitLab `.gitlab-ci.yml` file. This file is where you define the CI/CD jobs that make up your pipeline. @@ -135,7 +139,7 @@ In this example: ### `include` -> [Moved](https://gitlab.com/gitlab-org/gitlab-foss/-/issues/42861) to GitLab Free in 11.4. +> - [Moved](https://gitlab.com/gitlab-org/gitlab-foss/-/issues/42861) to GitLab Free in 11.4. Use `include` to include external YAML files in your CI/CD configuration. You can split one long `.gitlab-ci.yml` file into multiple files to increase readability, @@ -378,7 +382,7 @@ include: #### `include:inputs` -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/391331) in GitLab 15.11 as a Beta feature. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/391331) in GitLab 15.11 as a Beta feature. Use `include:inputs` to set the values for input parameters when the included configuration uses [`spec:inputs`](#specinputs) and is added to the pipeline. @@ -470,7 +474,7 @@ start. Jobs in the current stage are not stopped and continue to run. ### `workflow` -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/29654) in GitLab 12.5 +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/29654) in GitLab 12.5 Use [`workflow`](workflow.md) to control pipeline behavior. @@ -484,7 +488,7 @@ You can use some [predefined CI/CD variables](../variables/predefined_variables. #### `workflow:auto_cancel:on_new_commit` -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/412473) in GitLab 16.8 [with a flag](../../administration/feature_flags.md) named `ci_workflow_auto_cancel_on_new_commit`. Disabled by default. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/412473) in GitLab 16.8 [with a flag](../../administration/feature_flags.md) named `ci_workflow_auto_cancel_on_new_commit`. Disabled by default. FLAG: On self-managed GitLab, by default this feature is not available. To make it available per project or @@ -701,7 +705,7 @@ When the branch is something else: #### `workflow:rules:auto_cancel` -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/436467) in GitLab 16.8 [with a flag](../../administration/feature_flags.md) named `ci_workflow_auto_cancel_on_new_commit`. Disabled by default. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/436467) in GitLab 16.8 [with a flag](../../administration/feature_flags.md) named `ci_workflow_auto_cancel_on_new_commit`. Disabled by default. FLAG: On self-managed GitLab, by default this feature is not available. To make it available per project or @@ -753,7 +757,7 @@ with `---`. ### `spec` -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/391331) in GitLab 15.11 as a Beta feature. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/391331) in GitLab 15.11 as a Beta feature. Add a `spec` section to the header of a YAML file to configure the behavior of a pipeline when a configuration is added to the pipeline with the `include` keyword. @@ -803,7 +807,7 @@ scan-website: ##### `spec:inputs:default` -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/391331) in GitLab 15.11 as a Beta feature. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/391331) in GitLab 15.11 as a Beta feature. Inputs are mandatory when included, unless you set a default value with `spec:inputs:default`. @@ -845,7 +849,7 @@ In this example: ##### `spec:inputs:description` -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/415637) in GitLab 16.5. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/415637) in GitLab 16.5. Use `description` to give a description to a specific input. The description does not affect the behavior of the input and is only used to help users of the file @@ -870,7 +874,7 @@ spec: ##### `spec:inputs:options` -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/393401) in GitLab 16.6. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/393401) in GitLab 16.6. Inputs can use `options` to specify a list of allowed values for an input. The limit is 50 options per input. @@ -909,7 +913,7 @@ In this example: ##### `spec:inputs:regex` -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/410836) in GitLab 16.5. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/410836) in GitLab 16.5. Use `spec:inputs:regex` to specify a regular expression that the input must match. @@ -1286,7 +1290,7 @@ job: #### `artifacts:expose_as` -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/15018) in GitLab 12.5. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/15018) in GitLab 12.5. Use the `artifacts:expose_as` keyword to [expose job artifacts in the merge request UI](../jobs/job_artifacts.md#link-to-job-artifacts-in-the-merge-request-ui). @@ -1523,7 +1527,7 @@ job: ### `cache` -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/330047) in GitLab 15.0, caches are not shared between protected and unprotected branches. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/330047) in GitLab 15.0, caches are not shared between protected and unprotected branches. Use `cache` to specify a list of files and directories to cache between jobs. You can only use paths that are in the local working copy. @@ -1638,7 +1642,7 @@ cache-job: ##### `cache:key:files` -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/18986) in GitLab 12.5. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/18986) in GitLab 12.5. Use the `cache:key:files` keyword to generate a new key when one or two specific files change. `cache:key:files` lets you reuse some caches, and rebuild them less often, @@ -1651,6 +1655,8 @@ which speeds up subsequent pipeline runs. - An array of one or two file paths. +CI/CD variables are not supported. + **Example of `cache:key:files`**: ```yaml @@ -1681,7 +1687,7 @@ use the new cache, instead of rebuilding the dependencies. ##### `cache:key:prefix` -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/18986) in GitLab 12.5. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/18986) in GitLab 12.5. Use `cache:key:prefix` to combine a prefix with the SHA computed for [`cache:key:files`](#cachekeyfiles). @@ -1767,7 +1773,7 @@ rspec: #### `cache:unprotect` -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/362114) in GitLab 15.8. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/362114) in GitLab 15.8. Use `cache:unprotect` to set a cache to be shared between [protected](../../user/project/protected_branches.md) and unprotected branches. @@ -1794,7 +1800,7 @@ rspec: #### `cache:when` -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/18969) in GitLab 13.5 and GitLab Runner v13.5.0. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/18969) in GitLab 13.5 and GitLab Runner v13.5.0. Use `cache:when` to define when to save the cache, based on the status of the job. @@ -1951,9 +1957,13 @@ In this example: is not recorded or displayed. Check [the related issue](https://gitlab.com/gitlab-org/gitlab/-/issues/280818) for more details. -### `dast_configuration` **(ULTIMATE ALL)** +### `dast_configuration` -> [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/5981) in GitLab 14.1. +DETAILS: +**Tier:** Ultimate +**Offering:** SaaS, self-managed + +> - [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/5981) in GitLab 14.1. Use the `dast_configuration` keyword to specify a site profile and scanner profile to be used in a CI/CD configuration. Both profiles must first have been created in the project. The job's stage must @@ -2222,7 +2232,7 @@ Every time the review app is deployed, that lifetime is also reset to `1 day`. #### `environment:kubernetes` -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/27630) in GitLab 12.6. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/27630) in GitLab 12.6. Use the `kubernetes` keyword to configure deployments to a [Kubernetes cluster](../../user/infrastructure/clusters/index.md) that is associated with your project. @@ -2256,7 +2266,7 @@ environment, using the `production` #### `environment:deployment_tier` -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/300741) in GitLab 13.10. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/300741) in GitLab 13.10. Use the `deployment_tier` keyword to specify the tier of the deployment environment. @@ -2429,7 +2439,7 @@ job1: ### `id_tokens` -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/356986) in GitLab 15.7. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/356986) in GitLab 15.7. Use `id_tokens` to create [JSON web tokens (JWT)](https://www.rfc-editor.org/rfc/rfc7519) to authenticate with third party services. All JWTs created this way support OIDC authentication. The required `aud` sub-keyword is used to configure the `aud` claim for the JWT. @@ -2631,7 +2641,7 @@ job2: ### `inherit` -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/207484) in GitLab 12.9. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/207484) in GitLab 12.9. Use `inherit` to [control inheritance of default keywords and variables](../jobs/index.md#control-the-inheritance-of-default-keywords-and-global-variables). @@ -2872,7 +2882,7 @@ This example creates four paths of execution: #### `needs:artifacts` -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/14311) in GitLab 12.6. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/14311) in GitLab 12.6. When a job uses `needs`, it no longer downloads all artifacts from previous stages by default, because jobs with `needs` can start before earlier stages complete. With @@ -2921,9 +2931,13 @@ In this example: - You should not combine `needs` with [`dependencies`](#dependencies) in the same job. -#### `needs:project` **(PREMIUM ALL)** +#### `needs:project` -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/14311) in GitLab 12.7. +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/14311) in GitLab 12.7. Use `needs:project` to download artifacts from up to five jobs in other pipelines. The artifacts are downloaded from the latest successful specified job for the specified ref. @@ -3004,7 +3018,7 @@ build_job: #### `needs:pipeline:job` -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/255983) in GitLab 13.7. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/255983) in GitLab 13.7. A [child pipeline](../pipelines/downstream_pipelines.md#parent-child-pipelines) can download artifacts from a job in its parent pipeline or another child pipeline in the same parent-child pipeline hierarchy. @@ -3148,7 +3162,7 @@ upstream_status: #### `needs:parallel:matrix` -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/254821) in GitLab 16.3. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/254821) in GitLab 16.3. Jobs can use [`parallel:matrix`](#parallelmatrix) to run a job multiple times in parallel in a single pipeline, but with different variable values for each instance of the job. @@ -3252,7 +3266,7 @@ This directory is exported as an artifact and published with GitLab Pages. #### `pages:publish` -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/415821) in GitLab 16.1. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/415821) in GitLab 16.1. Use `publish` to configure the content directory of a [`pages` job](#pages). @@ -3280,9 +3294,14 @@ This example uses [Eleventy](https://www.11ty.dev) to generate a static website output the generated HTML files into a the `dist/` directory. This directory is exported as an artifact and published with GitLab Pages. -#### `pages:pages.path_prefix` **(PREMIUM ALL EXPERIMENT)** +#### `pages:pages.path_prefix` -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/129534) in GitLab 16.7 as an [Experiment](../../policy/experiment-beta-support.md) [with a flag](../../user/feature_flags.md) named `pages_multiple_versions_setting`, disabled by default. +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed +**Status:** Experiment + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/129534) in GitLab 16.7 as an [Experiment](../../policy/experiment-beta-support.md) [with a flag](../../user/feature_flags.md) named `pages_multiple_versions_setting`, disabled by default. FLAG: On self-managed GitLab, by default this feature is not available. To make it available, @@ -3317,7 +3336,7 @@ In this example, a different pages deployment is created for each branch. ### `parallel` -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/336576) in GitLab 15.9, the maximum value for `parallel` is increased from 50 to 200. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/336576) in GitLab 15.9, the maximum value for `parallel` is increased from 50 to 200. Use `parallel` to run a job multiple times in parallel in a single pipeline. @@ -3445,7 +3464,7 @@ deploystacks: [vultr, processing] ### `release` -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/19298) in GitLab 13.2. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/19298) in GitLab 13.2. Use `release` to create a [release](../../user/project/releases/index.md). @@ -3561,7 +3580,7 @@ job: #### `release:tag_message` -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/363024) in GitLab 15.3. Supported by `release-cli` v0.12.0 or later. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/363024) in GitLab 15.3. Supported by `release-cli` v0.12.0 or later. If the tag does not exist, the newly created tag is annotated with the message specified by `tag_message`. If omitted, a lightweight tag is created. @@ -3667,7 +3686,7 @@ released_at: '2021-03-15T08:00:00Z' #### `release:assets:links` -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/271454) in GitLab 13.12. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/271454) in GitLab 13.12. Use `release:assets:links` to include [asset links](../../user/project/releases/release_fields.md#release-assets) in the release. @@ -3688,7 +3707,7 @@ assets: ### `resource_group` -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/15536) in GitLab 12.7. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/15536) in GitLab 12.7. Use `resource_group` to create a [resource group](../resource_groups/index.md) that ensures a job is mutually exclusive across different pipelines for the same project. @@ -3820,7 +3839,7 @@ using variables. ### `rules` -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/27863) in GitLab 12.3. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/27863) in GitLab 12.3. Use `rules` to include or exclude jobs in pipelines. @@ -3976,7 +3995,7 @@ docker build: ##### `rules:changes:paths` -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/90171) in GitLab 15.2. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/90171) in GitLab 15.2. Use `rules:changes` to specify that a job only be added to a pipeline when specific files are changed, and use `rules:changes:paths` to specify the files. @@ -4083,7 +4102,7 @@ job: #### `rules:allow_failure` -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/30235) in GitLab 12.8. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/30235) in GitLab 12.8. Use [`allow_failure: true`](#allow_failure) in `rules` to allow a job to fail without stopping the pipeline. @@ -4238,9 +4257,13 @@ job2: - [Create custom collapsible sections](../jobs/index.md#custom-collapsible-sections) to simplify job log output. -### `secrets` **(PREMIUM ALL)** +### `secrets` -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/33014) in GitLab 13.4. +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/33014) in GitLab 13.4. Use `secrets` to specify [CI/CD secrets](../secrets/index.md) to: @@ -4250,7 +4273,7 @@ Use `secrets` to specify [CI/CD secrets](../secrets/index.md) to: #### `secrets:vault` -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/28321) in GitLab 13.4 and GitLab Runner 13.4. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/28321) in GitLab 13.4 and GitLab Runner 13.4. Use `secrets:vault` to specify secrets provided by a [HashiCorp Vault](https://www.vaultproject.io/). @@ -4300,7 +4323,7 @@ job: #### `secrets:gcp_secret_manager` -> [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/11739) in GitLab 16.8 and GitLab Runner 16.8. +> - [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/11739) in GitLab 16.8 and GitLab Runner 16.8. Use `secrets:gcp_secret_manager` to specify secrets provided by [GCP Secret Manager](https://cloud.google.com/security/products/secret-manager). @@ -4328,7 +4351,7 @@ job: #### `secrets:azure_key_vault` -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/271271) in GitLab 16.3 and GitLab Runner 16.3. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/271271) in GitLab 16.3 and GitLab Runner 16.3. Use `secrets:azure_key_vault` to specify secrets provided by a [Azure Key Vault](https://azure.microsoft.com/en-us/products/key-vault/). @@ -4356,7 +4379,7 @@ job: #### `secrets:file` -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/250695) in GitLab 14.1 and GitLab Runner 14.1. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/250695) in GitLab 14.1 and GitLab Runner 14.1. Use `secrets:file` to configure the secret to be stored as either a [`file` or `variable` type CI/CD variable](../variables/index.md#use-file-type-cicd-variables) @@ -4602,7 +4625,7 @@ job4: #### `stage: .pre` -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/31441) in GitLab 12.4. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/31441) in GitLab 12.4. Use the `.pre` stage to make a job run at the start of a pipeline. `.pre` is always the first stage in a pipeline. User-defined stages execute after `.pre`. @@ -4638,7 +4661,7 @@ job2: #### `stage: .post` -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/31441) in GitLab 12.4. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/31441) in GitLab 12.4. Use the `.post` stage to make a job run at the end of a pipeline. `.post` is always the last stage in a pipeline. User-defined stages execute before `.post`. @@ -4722,7 +4745,7 @@ In this example, only runners with *both* the `ruby` and `postgres` tags can run ### `timeout` -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/14887) in GitLab 12.3. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/14887) in GitLab 12.3. Use `timeout` to configure a timeout for a specific job. If the job runs for longer than the timeout, the job fails. @@ -5037,7 +5060,7 @@ deploy_review_job: #### `variables:description` -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/30101) in GitLab 13.7. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/30101) in GitLab 13.7. Use the `description` keyword to define a description for a pipeline-level (global) variable. The description displays with [the prefilled variable name when running a pipeline manually](../pipelines/index.md#prefill-variables-in-manual-pipelines). @@ -5063,7 +5086,7 @@ variables: #### `variables:value` -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/30101) in GitLab 13.7. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/30101) in GitLab 13.7. Use the `value` keyword to define a pipeline-level (global) variable's value. When used with [`variables: description`](#variablesdescription), the variable value is [prefilled when running a pipeline manually](../pipelines/index.md#prefill-variables-in-manual-pipelines). @@ -5090,7 +5113,7 @@ variables: #### `variables:options` -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/105502) in GitLab 15.7. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/105502) in GitLab 15.7. Use `variables:options` to define an array of values that are [selectable in the UI when running a pipeline manually](../pipelines/index.md#configure-a-list-of-selectable-prefilled-variable-values). diff --git a/doc/ci/yaml/inputs.md b/doc/ci/yaml/inputs.md index 18dcb865c06..4f3d7d6b846 100644 --- a/doc/ci/yaml/inputs.md +++ b/doc/ci/yaml/inputs.md @@ -4,7 +4,11 @@ group: Pipeline Authoring info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Define inputs for configuration added with `include` **(FREE ALL)** +# Define inputs for configuration added with `include` + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/391331) in GitLab 15.11 as a Beta feature. > - Made generally available in GitLab 16.6. @@ -186,7 +190,7 @@ spec: ## Specify functions to manipulate input values -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/409462) in GitLab 16.3. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/409462) in GitLab 16.3. You can specify predefined functions in the interpolation block to manipulate the input value. The format supported is the following: @@ -222,7 +226,7 @@ In this example, assuming the input uses the default value and `$MY_VAR` is an u #### `expand_vars` -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/387632) in GitLab 16.5. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/387632) in GitLab 16.5. Use `expand_vars` to expand [CI/CD variables](../variables/index.md) in the input value. @@ -248,7 +252,7 @@ would expand to `test my value`. #### `truncate` -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/409462) in GitLab 16.3. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/409462) in GitLab 16.3. Use `truncate` to shorten the interpolated value. For example: diff --git a/doc/ci/yaml/script.md b/doc/ci/yaml/script.md index 756f14ea5a5..1c04cfefe54 100644 --- a/doc/ci/yaml/script.md +++ b/doc/ci/yaml/script.md @@ -4,7 +4,11 @@ group: Pipeline Authoring info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Format scripts and job logs **(FREE ALL)** +# Format scripts and job logs + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed You can use special syntax in [`script`](index.md#script) sections to: diff --git a/doc/ci/yaml/signing_examples.md b/doc/ci/yaml/signing_examples.md index e56109085a3..4eb867100e5 100644 --- a/doc/ci/yaml/signing_examples.md +++ b/doc/ci/yaml/signing_examples.md @@ -4,7 +4,11 @@ group: Pipeline Security info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Use Sigstore for keyless signing and verification **(FREE SAAS)** +# Use Sigstore for keyless signing and verification + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS The [Sigstore](https://www.sigstore.dev/) project provides a CLI called [Cosign](https://docs.sigstore.dev/signing/quickstart/) which can be used for keyless signing of container images built diff --git a/doc/ci/yaml/workflow.md b/doc/ci/yaml/workflow.md index a22e4e322b6..fe74ff10951 100644 --- a/doc/ci/yaml/workflow.md +++ b/doc/ci/yaml/workflow.md @@ -4,7 +4,11 @@ group: Pipeline Authoring info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# GitLab CI/CD `workflow` keyword **(FREE ALL)** +# GitLab CI/CD `workflow` keyword + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed Use the [`workflow`](index.md#workflow) keyword to control when pipelines are created. @@ -63,7 +67,7 @@ request pipelines. ### Switch between branch pipelines and merge request pipelines -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/201845) in GitLab 13.8. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/201845) in GitLab 13.8. To make the pipeline switch from branch pipelines to merge request pipelines after a merge request is created, add a `workflow: rules` section to your `.gitlab-ci.yml` file. @@ -136,7 +140,7 @@ This example assumes that your long-lived branches are [protected](../../user/pr ## `workflow:rules` templates -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/217732) in GitLab 13.0. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/217732) in GitLab 13.0. GitLab provides templates that set up `workflow: rules` for common scenarios. These templates help prevent duplicate pipelines. diff --git a/doc/ci/yaml/yaml_optimization.md b/doc/ci/yaml/yaml_optimization.md index 67383ad8e9e..7c14ed8ce65 100644 --- a/doc/ci/yaml/yaml_optimization.md +++ b/doc/ci/yaml/yaml_optimization.md @@ -4,7 +4,11 @@ group: Pipeline Authoring info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Optimize GitLab CI/CD configuration files **(FREE ALL)** +# Optimize GitLab CI/CD configuration files + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed You can reduce complexity and duplicated configuration in your GitLab CI/CD configuration files by using: @@ -165,7 +169,7 @@ You can see that the hidden jobs are conveniently used as templates, and ### YAML anchors for scripts -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/23005) in GitLab 12.5. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/23005) in GitLab 12.5. You can use [YAML anchors](#anchors) with [script](index.md#script), [`before_script`](index.md#before_script), and [`after_script`](index.md#after_script) to use predefined commands in multiple jobs: @@ -438,7 +442,7 @@ test-vars-2: ### Nest `!reference` tags in `script`, `before_script`, and `after_script` -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/74792) in GitLab 14.8. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/74792) in GitLab 14.8. You can nest `!reference` tags up to 10 levels deep in `script`, `before_script`, and `after_script` sections. Use nested tags to define reusable sections when building more complex scripts. For example: diff --git a/doc/cloud_seed/index.md b/doc/cloud_seed/index.md index 8180669b1af..7cb903899c4 100644 --- a/doc/cloud_seed/index.md +++ b/doc/cloud_seed/index.md @@ -4,7 +4,11 @@ group: Incubation info: Cloud Seed (formerly 5mp) is a GitLab Incubation Engineering program. No technical writer assigned to this group. --- -# Cloud Seed **(FREE ALL)** +# Cloud Seed + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/371332) in GitLab 15.4 [with a flag](../administration/feature_flags.md) named `google_cloud`. Disabled by default. > - [Enabled on self-managed and GitLab.com](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/100545) in GitLab 15.5. diff --git a/doc/development/documentation/styleguide/index.md b/doc/development/documentation/styleguide/index.md index 4e937694a87..e88637064e1 100644 --- a/doc/development/documentation/styleguide/index.md +++ b/doc/development/documentation/styleguide/index.md @@ -819,10 +819,6 @@ Each topic title has an anchor link. For example, a topic with the title The first topic title on a page (the `h1`) has an anchor link, but do not use it. Link to the page instead. -If a topic title has a [product tier badge](#product-tier-badges), -do not include it in the anchor link. For example, for the topic -`## This is an example **(FREE ALL)**`, use the anchor `#this-is-an-example`. - With Kramdown, you can add a custom ID to an HTML element, but these IDs don't work in `/help`, so you should not use them. @@ -1642,11 +1638,11 @@ When names change, it is more complicated to search or grep text that has line b ### Product tier badges -Tier badges provide information about a feature and are displayed next to the topic title. +Tier badges provide information about a feature and are displayed under the topic title. #### When to add tier badges -Assign tier badges to: +Assign tier badges under: - Most H1 topic titles, except the pages under `doc/development/*` and `doc/solutions/*`. - Topic titles that don't apply to the same tier as the H1. @@ -1663,8 +1659,8 @@ Do not assign tier badges: In this case, do any or all of the following: - Use a `NOTE` in an alert box to describe the tiers. -- Add tier badges to other topic titles where this information makes more sense. -- Do not add tier badges to the H1. +- Add tier badges under other topic titles where this information makes more sense. +- Do not add tier badges under the H1. ##### Pages that don't need a tier badge @@ -1677,57 +1673,50 @@ Some pages won't have a tier badge, because no obvious tier badge applies. For e #### Available product tier badges -Tier badges should include two components, in this order: a subscription tier and an offering. -These components are surrounded by bold and parentheses, for example `**(ULTIMATE SAAS)**`. +Tier badges are how we refer to the information that's displayed under a topic title. -Subscription tiers: +Tier badges include the tier, offering, status, and version history. -- `FREE` - Applies to all tiers. -- `PREMIUM` - Applies to Premium and Ultimate tiers. -- `ULTIMATE` - Applies to Ultimate tier only. +The Markdown for tier badges should look like the following: -Offerings: +```markdown +# Topic title -- `SELF` -- `SAAS` -- `ALL` - Applies to both self-managed and SaaS. +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed +**Status:** Experiment -NOTE: -GitLab Dedicated is not currently covered by product tier badges in the documentation. -For more information, see [issue 417171](https://gitlab.com/gitlab-org/gitlab/-/issues/417171#note_1568753875). +> - [Introduced]() in GitLab 16.3. +> - Updated in GitLab 16.4. +``` -You can also add a third component for the feature's status: +For offering, use any combination of these words, in this order, separated by commas: -- `EXPERIMENT` -- `BETA` +- SaaS +- Self-managed (lowercase when not the first item) -For example, `**(FREE ALL EXPERIMENT)**`. - -- A tier or status can stand alone. -- An offering should always have a tier. -- Do not add more than one offering, tier, or status. Multiples do not render properly in the documentation. - -#### Add a tier badge - -To add a tier badge to a topic title, add the two relevant components -after the title text. You should include the subscription tier first, and then the offering. For example: -```markdown -# Topic title **(FREE ALL)** -``` +- SaaS +- SaaS, self-managed +- Self-managed -Optionally, you can add the feature status as the last part of the badge: +NOTE: +SaaS will be changing to GitLab.com and we will be adding GitLab Dedicated. We will update this page when the change occurs. -```markdown -# Topic title **(FREE ALL EXPERIMENT)** -``` +For tier, choose one: -Or add the status by itself: +- Free, Premium, and Ultimate +- Premium and Ultimate +- Ultimate -```markdown -# Topic title **(EXPERIMENT)** -``` +For status, choose one: + +- Beta +- Experiment + +Generally available features should not have a status. ##### Inline tier badges @@ -2005,7 +1994,11 @@ For an example, see [GitLab 16 changes](../../../update/versions/gitlab_16_chang Use the following template to add information to the page. ```markdown -# GitLab X changes **(FREE SELF)** +# GitLab X changes + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed This page contains upgrade information for minor and patch versions of GitLab X. Review these instructions for: @@ -2029,7 +2022,11 @@ For more information about upgrading GitLab Helm Chart, see [the release notes f - Information specific to self-compiled installations. - ... -### Geo installations **(PREMIUM SELF)** +### Geo installations + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** Self-managed - Information specific to Geo. - ... diff --git a/doc/development/documentation/versions.md b/doc/development/documentation/versions.md index 883de58eb46..be0c90bb308 100644 --- a/doc/development/documentation/versions.md +++ b/doc/development/documentation/versions.md @@ -37,20 +37,25 @@ For example: ```markdown ## Feature name -> [Introduced]() in GitLab 11.3. +> - [Introduced]() in GitLab 11.3. This feature does something. ``` -The item text must include these words in order. Capitalization doesn't matter. +The item text should include these words in order. Capitalization doesn't matter. - `introduced`, `enabled`, `deprecated`, `changed`, `moved`, `recommended`, `removed`, or `renamed` - `in` or `to` - `GitLab` (or, for external projects, the name of the project) +If you cannot use this format, you can use different language. Try to be +consistent with other notes on the page, or other notes on the docs site. + If possible, include a link to the related issue, merge request, or epic. Do not link to the pricing page. Do not include the subscription tier. +Even if you have only one item, ensure it begins with `> -`. + #### Introducing a new feature If you use `introduced`, start the sentence with the feature name or a gerund: @@ -111,7 +116,11 @@ To deprecate a page or topic: when it will be removed, and the replacement feature. ```markdown - ## Title (deprecated) **(ULTIMATE SELF)** + ## Title (deprecated) + + DETAILS: + **Tier:** Premium, Ultimate + **Offering:** SaaS, self-managed WARNING: This feature was [deprecated]() in GitLab 14.8 @@ -135,7 +144,11 @@ To deprecate a page or topic: ```markdown - ## Title (deprecated) **(ULTIMATE SELF)** + ## Title (deprecated) + + DETAILS: + **Tier:** Premium, Ultimate + **Offering:** SaaS, self-managed WARNING: This feature was [deprecated]() in GitLab 14.8 @@ -170,7 +183,11 @@ To remove a page: redirect_to: '../newpath/to/file/index.md' --- - # Title (removed) **(ULTIMATE SELF)** + # Title (removed) + + DETAILS: + **Tier:** Premium, Ultimate + **Offering:** SaaS, self-managed This feature was [deprecated]() in GitLab X.Y and [removed]() in X.Y. @@ -195,7 +212,11 @@ To remove a topic: ```markdown - ## Title (removed) **(ULTIMATE SELF)** + ## Title (removed) + + DETAILS: + **Tier:** Premium, Ultimate + **Offering:** SaaS, self-managed This feature was [deprecated]() in GitLab X.Y and [removed]() in X.Y. diff --git a/doc/development/geo/api.md b/doc/development/geo/api.md index b9f3f7ce5c9..1b73ac7e994 100644 --- a/doc/development/geo/api.md +++ b/doc/development/geo/api.md @@ -4,7 +4,12 @@ group: Geo info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Geo API **(PREMIUM SELF)** +# Geo API + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** Self-managed +**Status:** Beta The Geo API is used internally by GitLab components to assist in coordinating Geo actions. It is inaccessible to admins or users. diff --git a/doc/development/integrations/index.md b/doc/development/integrations/index.md index 23a22d2c121..2048b34dad0 100644 --- a/doc/development/integrations/index.md +++ b/doc/development/integrations/index.md @@ -119,7 +119,7 @@ The following events are supported for integrations: | [Pipeline event](../../user/project/integrations/webhook_events.md#pipeline-events) | | `pipeline` | A pipeline status changes. | [Push event](../../user/project/integrations/webhook_events.md#push-events) | ✓ | `push` | A push is made to the repository. | [Tag push event](../../user/project/integrations/webhook_events.md#tag-events) | ✓ | `tag_push` | New tags are pushed to the repository. -| Vulnerability event **(ULTIMATE ALL)** | | `vulnerability` | A new, unique vulnerability is recorded. +| Vulnerability event | | `vulnerability` | A new, unique vulnerability is recorded. Ultimate only. | [Wiki page event](../../user/project/integrations/webhook_events.md#wiki-page-events) | ✓ | `wiki_page` | A wiki page is created or updated. #### Event examples diff --git a/doc/development/internal_analytics/metrics/metrics_dictionary.md b/doc/development/internal_analytics/metrics/metrics_dictionary.md index ba3fb28743a..c88479b60e1 100644 --- a/doc/development/internal_analytics/metrics/metrics_dictionary.md +++ b/doc/development/internal_analytics/metrics/metrics_dictionary.md @@ -41,7 +41,7 @@ Each metric is defined in a separate YAML file consisting of a number of fields: | `time_frame` | yes | `string`; may be set to a value like `7d`, `28d`, `all`, `none`. | | `data_source` | yes | `string`; may be set to a value like `database`, `redis`, `redis_hll`, `prometheus`, `system`, `license`, `internal_events`. | | `data_category` | yes | `string`; [categories](#data-category) of the metric, may be set to `operational`, `optional`, `subscription`, `standard`. The default value is `optional`. | -| `instrumentation_class` | no | `string`; used for metrics with `data_source` other than `internal_events`. See [the class that implements the metric](../service_ping/metrics_instrumentation.md). | +| `instrumentation_class` | no | `string`; used for metrics with `data_source` other than `internal_events`. See [the class that implements the metric](metrics_instrumentation.md). | | `distribution` | yes | `array`; may be set to one of `ce, ee` or `ee`. The [distribution](https://about.gitlab.com/handbook/marketing/brand-and-product-marketing/product-and-solution-marketing/tiers/#definitions) where the tracked feature is available. | | `performance_indicator_type` | no | `array`; may be set to one of [`gmau`, `smau`, `paid_gmau`, `umau` or `customer_health_score`](https://about.gitlab.com/handbook/business-technology/data-team/data-catalog/xmau-analysis/). | | `tier` | yes | `array`; may contain one or a combination of `free`, `premium` or `ultimate`. The [tier](https://about.gitlab.com/handbook/marketing/brand-and-product-marketing/product-and-solution-marketing/tiers/#definitions) where the tracked feature is available. This should be verbose and contain all tiers where a metric is available. | diff --git a/doc/development/internal_api/index.md b/doc/development/internal_api/index.md index fc73fcb6c2c..c69e383e80b 100644 --- a/doc/development/internal_api/index.md +++ b/doc/development/internal_api/index.md @@ -1248,9 +1248,13 @@ Example response: - CustomersDot -## Group SCIM API **(PREMIUM SAAS)** +## Group SCIM API -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/9388) in GitLab 11.10. +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/9388) in GitLab 11.10. The group SCIM API partially implements the [RFC7644 protocol](https://www.rfc-editor.org/rfc/rfc7644). This API provides the `/groups/:group_path/Users` and `/groups/:group_path/Users/:id` endpoints. The base URL is `:///api/scim/v2`. Because this API is for **system** use for SCIM provider integration, it is subject to change without notice. @@ -1497,9 +1501,13 @@ curl --verbose --request DELETE "https://gitlab.example.com/api/scim/v2/groups/t Returns an empty response with a `204` status code if successful. -## Instance SCIM API **(PREMIUM SELF)** +## Instance SCIM API -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/378599) in GitLab 15.8. +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** Self-managed + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/378599) in GitLab 15.8. The instance SCIM API partially implements the [RFC7644 protocol](https://www.rfc-editor.org/rfc/rfc7644). This API provides the `/application/Users` and `/application/Users/:id` endpoints. The base URL is `:///api/scim/v2`. Because this API is for **system** use for SCIM provider integration, it is subject to change without notice. diff --git a/doc/development/rake_tasks.md b/doc/development/rake_tasks.md index 25b0a42db3a..44893ef9a6d 100644 --- a/doc/development/rake_tasks.md +++ b/doc/development/rake_tasks.md @@ -48,7 +48,11 @@ bin/rake "gitlab:seed:issues[group-path/project-path]" By default, this seeds an average of 2 issues per week for the last 5 weeks per project. -#### Seeding issues for Insights charts **(ULTIMATE ALL)** +#### Seeding issues for Insights charts + +DETAILS: +**Tier:** Ultimate +**Offering:** SaaS, self-managed You can seed issues specifically for working with the [Insights charts](../user/group/insights/index.md) with the diff --git a/doc/editor_extensions/gitlab_cli/index.md b/doc/editor_extensions/gitlab_cli/index.md index a0319e64a54..747f747b5e5 100644 --- a/doc/editor_extensions/gitlab_cli/index.md +++ b/doc/editor_extensions/gitlab_cli/index.md @@ -4,7 +4,11 @@ group: Code Review info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# GitLab CLI - `glab` **(FREE ALL)** +# GitLab CLI - `glab` + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed GLab is an open source GitLab CLI tool. It brings GitLab to your terminal: next to where you are already working with Git and your code, without diff --git a/doc/gitlab-basics/add-file.md b/doc/gitlab-basics/add-file.md index 41d2feb27da..c23f2b98b4e 100644 --- a/doc/gitlab-basics/add-file.md +++ b/doc/gitlab-basics/add-file.md @@ -4,7 +4,7 @@ group: Source Code info: "To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments" --- -# Use Git to add a file to a repository **(FREE ALL)** +# Use Git to add a file to a repository To add a new file from the command line: diff --git a/doc/gitlab-basics/feature_branch_workflow.md b/doc/gitlab-basics/feature_branch_workflow.md index 26fe5081b98..e19661d375b 100644 --- a/doc/gitlab-basics/feature_branch_workflow.md +++ b/doc/gitlab-basics/feature_branch_workflow.md @@ -4,7 +4,7 @@ group: Source Code info: "To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments" --- -# Feature branch workflow **(FREE ALL)** +# Feature branch workflow To merge changes from a local branch to a feature branch, follow this workflow. diff --git a/doc/gitlab-basics/start-using-git.md b/doc/gitlab-basics/start-using-git.md index a1dd99d811f..a775968e974 100644 --- a/doc/gitlab-basics/start-using-git.md +++ b/doc/gitlab-basics/start-using-git.md @@ -5,7 +5,7 @@ info: To determine the technical writer assigned to the Stage/Group associated w description: "Introduction to using Git through the command line." --- -# Command line Git **(FREE ALL)** +# Command line Git [Git](https://git-scm.com/) is an open-source distributed version control system. GitLab is built on top of Git. diff --git a/doc/install/aws/index.md b/doc/install/aws/index.md index d10f78fe024..32ab923401d 100644 --- a/doc/install/aws/index.md +++ b/doc/install/aws/index.md @@ -7,7 +7,11 @@ description: Read through the GitLab installation methods. {::options parse_block_html="true" /} -# Installing a GitLab POC on Amazon Web Services (AWS) **(FREE SELF)** +# Installing a GitLab POC on Amazon Web Services (AWS) + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed This page offers a walkthrough of a common configuration for GitLab on AWS using the official Linux package. You should customize it to accommodate your needs. diff --git a/doc/install/azure/index.md b/doc/install/azure/index.md index 3acdaa9a178..0a2a5a781fa 100644 --- a/doc/install/azure/index.md +++ b/doc/install/azure/index.md @@ -5,7 +5,11 @@ info: To determine the technical writer assigned to the Stage/Group associated w description: 'Learn how to spin up a pre-configured GitLab VM on Microsoft Azure.' --- -# Install GitLab on Microsoft Azure **(FREE SELF)** +# Install GitLab on Microsoft Azure + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed For users of the Microsoft Azure business cloud, GitLab has a pre-configured offering in the [Azure Marketplace](https://azuremarketplace.microsoft.com/en-us/marketplace/). diff --git a/doc/install/cloud_providers.md b/doc/install/cloud_providers.md index ecec2250e11..52bc25881b5 100644 --- a/doc/install/cloud_providers.md +++ b/doc/install/cloud_providers.md @@ -5,7 +5,11 @@ description: AWS, Google Cloud Platform, Azure. info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Install GitLab on a cloud provider **(FREE SELF)** +# Install GitLab on a cloud provider + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed You can install GitLab on several cloud providers. diff --git a/doc/install/docker.md b/doc/install/docker.md index b627b3ea4d2..e53ef48728f 100644 --- a/doc/install/docker.md +++ b/doc/install/docker.md @@ -4,7 +4,11 @@ group: Distribution info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Install GitLab using Docker **(FREE SELF)** +# Install GitLab using Docker + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed The GitLab Docker images are monolithic images of GitLab running all the necessary services in a single container. diff --git a/doc/install/google_cloud_platform/index.md b/doc/install/google_cloud_platform/index.md index 12bc50cdff0..bb82011d067 100644 --- a/doc/install/google_cloud_platform/index.md +++ b/doc/install/google_cloud_platform/index.md @@ -5,7 +5,11 @@ info: To determine the technical writer assigned to the Stage/Group associated w description: 'Learn how to install a GitLab instance on Google Cloud Platform.' --- -# Installing GitLab on Google Cloud Platform **(FREE SELF)** +# Installing GitLab on Google Cloud Platform + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed You can install GitLab on a [Google Cloud Platform (GCP)](https://cloud.google.com/) using the official Linux package. You should customize it to accommodate your needs. diff --git a/doc/install/index.md b/doc/install/index.md index 4f7adb99f87..3015a4f10d0 100644 --- a/doc/install/index.md +++ b/doc/install/index.md @@ -5,7 +5,11 @@ info: To determine the technical writer assigned to the Stage/Group associated w description: Read through the GitLab installation methods. --- -# Install GitLab **(FREE SELF)** +# Install GitLab + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed You can install GitLab on most GNU/Linux distributions, on several cloud providers, and in Kubernetes clusters. diff --git a/doc/install/install_methods.md b/doc/install/install_methods.md index 99be2709564..2276f382a55 100644 --- a/doc/install/install_methods.md +++ b/doc/install/install_methods.md @@ -5,7 +5,11 @@ description: Linux, Helm, Docker, Operator, source, or scripts. info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Installation methods **(FREE SELF)** +# Installation methods + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed You can install GitLab on several [cloud providers](cloud_providers.md), or use one of the following methods. diff --git a/doc/install/installation.md b/doc/install/installation.md index 0ccb475eacc..269c405c2e2 100644 --- a/doc/install/installation.md +++ b/doc/install/installation.md @@ -4,7 +4,11 @@ group: Distribution info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Self-compiled installation **(FREE SELF)** +# Self-compiled installation + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed This is the official installation guide to set up a production GitLab server using the source files. It was created for and tested on **Debian/Ubuntu** operating systems. @@ -692,7 +696,11 @@ You can specify a different Git repository by providing it as an extra parameter sudo -u git -H bundle exec rake "gitlab:workhorse:install[/home/git/gitlab-workhorse,https://example.com/gitlab-workhorse.git]" RAILS_ENV=production ``` -### Install GitLab-Elasticsearch-indexer on Enterprise Edition **(PREMIUM SELF)** +### Install GitLab-Elasticsearch-indexer on Enterprise Edition + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** Self-managed GitLab-Elasticsearch-Indexer uses [GNU Make](https://www.gnu.org/software/make/). The following command-line installs GitLab-Elasticsearch-Indexer in `/home/git/gitlab-elasticsearch-indexer` diff --git a/doc/install/next_steps.md b/doc/install/next_steps.md index 8f5142dd5f5..3027c3b21c9 100644 --- a/doc/install/next_steps.md +++ b/doc/install/next_steps.md @@ -4,7 +4,11 @@ group: Distribution info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Steps after installing GitLab **(FREE SELF)** +# Steps after installing GitLab + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed Here are a few resources you might want to check out after completing the installation. diff --git a/doc/install/postgresql_extensions.md b/doc/install/postgresql_extensions.md index 534757a71b8..739116e0bbb 100644 --- a/doc/install/postgresql_extensions.md +++ b/doc/install/postgresql_extensions.md @@ -4,7 +4,11 @@ group: Database info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Managing PostgreSQL extensions **(FREE SELF)** +# Managing PostgreSQL extensions + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed This guide documents how to manage PostgreSQL extensions for installations with an external PostgreSQL database. diff --git a/doc/install/relative_url.md b/doc/install/relative_url.md index 93719fd69ed..fd923622925 100644 --- a/doc/install/relative_url.md +++ b/doc/install/relative_url.md @@ -4,7 +4,11 @@ group: Distribution info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Install GitLab under a relative URL **(FREE SELF)** +# Install GitLab under a relative URL + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed While you should install GitLab on its own (sub)domain, sometimes this is not possible due to a variety of reasons. In that case, GitLab can also diff --git a/doc/install/requirements.md b/doc/install/requirements.md index 3fe0d005c38..bafb7e91a88 100644 --- a/doc/install/requirements.md +++ b/doc/install/requirements.md @@ -5,7 +5,11 @@ description: Prerequisites for installation. info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Installation system requirements **(FREE SELF)** +# Installation system requirements + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed This page includes information about the minimum requirements you need to install and use GitLab. diff --git a/doc/integration/advanced_search/elasticsearch.md b/doc/integration/advanced_search/elasticsearch.md index 896ad18033b..4d894e8d307 100644 --- a/doc/integration/advanced_search/elasticsearch.md +++ b/doc/integration/advanced_search/elasticsearch.md @@ -4,7 +4,11 @@ group: Global Search info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Elasticsearch **(PREMIUM ALL)** +# Elasticsearch + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed This page describes how to enable advanced search. When enabled, advanced search provides faster search response times and [improved search features](../../user/search/advanced_search.md). @@ -546,7 +550,7 @@ advanced search, which means adding or changing the way content is indexed. ### Migration dictionary files -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/414674) in GitLab 16.3. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/414674) in GitLab 16.3. Every migration has a corresponding dictionary file in the `ee/elastic/docs/` folder with the following information: diff --git a/doc/integration/advanced_search/elasticsearch_troubleshooting.md b/doc/integration/advanced_search/elasticsearch_troubleshooting.md index 7252b9b1b3d..534948e15d4 100644 --- a/doc/integration/advanced_search/elasticsearch_troubleshooting.md +++ b/doc/integration/advanced_search/elasticsearch_troubleshooting.md @@ -4,7 +4,11 @@ group: Global Search info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Troubleshooting Elasticsearch **(PREMIUM SELF)** +# Troubleshooting Elasticsearch + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** Self-managed Use the following information to troubleshoot Elasticsearch issues. diff --git a/doc/integration/akismet.md b/doc/integration/akismet.md index b8b871d83f2..ad11e3c8aab 100644 --- a/doc/integration/akismet.md +++ b/doc/integration/akismet.md @@ -4,7 +4,11 @@ group: Anti-Abuse info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Akismet **(FREE ALL)** +# Akismet + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed GitLab uses [Akismet](https://akismet.com/) to prevent the creation of spam issues on public projects. Issues created through the web UI or the API can be submitted to @@ -22,7 +26,11 @@ GitLab submits all issues to Akismet. Akismet configuration is available to users on self-managed GitLab. Akismet is already enabled on GitLab SaaS (GitLab.com), where its configuration and management are handled by GitLab Inc. -## Configure Akismet **(FREE SELF)** +## Configure Akismet + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed To use Akismet: @@ -39,7 +47,11 @@ To use Akismet: ![Screenshot of Akismet settings](img/akismet_settings.png) -## Train the Akismet filter **(FREE SELF)** +## Train the Akismet filter + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed To better differentiate between spam and ham, you can train the Akismet filter whenever there is a false positive or false negative. diff --git a/doc/integration/alicloud.md b/doc/integration/alicloud.md index ff9ad50ed77..41d9948ffe4 100644 --- a/doc/integration/alicloud.md +++ b/doc/integration/alicloud.md @@ -4,7 +4,11 @@ group: Authentication info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Use AliCloud as an OmniAuth authentication provider **(FREE ALL)** +# Use AliCloud as an OmniAuth authentication provider + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed You can enable the AliCloud OAuth 2.0 OmniAuth provider and sign in to GitLab using your AliCloud account. diff --git a/doc/integration/auth0.md b/doc/integration/auth0.md index 7ac22d4ce7d..3363c4c59c8 100644 --- a/doc/integration/auth0.md +++ b/doc/integration/auth0.md @@ -4,7 +4,11 @@ group: Authentication info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Use Auth0 as an OAuth 2.0 authentication provider **(FREE SELF)** +# Use Auth0 as an OAuth 2.0 authentication provider + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed To enable the Auth0 OmniAuth provider, you must create an Auth0 account, and an application. diff --git a/doc/integration/azure.md b/doc/integration/azure.md index 906c50338aa..0cd558ed133 100644 --- a/doc/integration/azure.md +++ b/doc/integration/azure.md @@ -4,7 +4,11 @@ group: Authentication info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Use Microsoft Azure as an OAuth 2.0 authentication provider **(FREE SELF)** +# Use Microsoft Azure as an OAuth 2.0 authentication provider + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed You can enable the Microsoft Azure OAuth 2.0 OmniAuth provider and sign in to GitLab with your Microsoft Azure credentials. You can configure the provider that uses diff --git a/doc/integration/bitbucket.md b/doc/integration/bitbucket.md index cd209157c42..2ea27c146f3 100644 --- a/doc/integration/bitbucket.md +++ b/doc/integration/bitbucket.md @@ -4,7 +4,11 @@ group: Authentication info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Integrate your GitLab server with Bitbucket Cloud **(FREE SELF)** +# Integrate your GitLab server with Bitbucket Cloud + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed You can set up Bitbucket.org as an OAuth 2.0 provider to use your Bitbucket.org account credentials to sign in to GitLab. You can also import your projects from diff --git a/doc/integration/datadog.md b/doc/integration/datadog.md index c5fe2bc5f0f..b149e1dbc98 100644 --- a/doc/integration/datadog.md +++ b/doc/integration/datadog.md @@ -4,9 +4,13 @@ group: Import and Integrate info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Datadog **(FREE ALL)** +# Datadog -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/270123) in GitLab 14.1 +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/270123) in GitLab 14.1 The Datadog integration enables you to send CI/CD pipeline and job information to [Datadog](https://www.datadoghq.com/). The [Datadog CI Visibility](https://app.datadoghq.com/ci) diff --git a/doc/integration/diffblue_cover.md b/doc/integration/diffblue_cover.md index bd1d026b5ef..1ffe57a6c64 100644 --- a/doc/integration/diffblue_cover.md +++ b/doc/integration/diffblue_cover.md @@ -7,7 +7,11 @@ description: >- GitLab --- -# Diffblue Cover **(FREE ALL)** +# Diffblue Cover + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed You can integrate the [Diffblue Cover](https://www.diffblue.com/) reinforcement learning AI tool into your CI/CD pipelines, to automatically write and maintain Java unit tests for your GitLab projects. The Diffblue Cover Pipeline for GitLab integration allows you to automatically: diff --git a/doc/integration/ding_talk.md b/doc/integration/ding_talk.md index 9a1d0ac69b4..2a4433ac044 100644 --- a/doc/integration/ding_talk.md +++ b/doc/integration/ding_talk.md @@ -4,7 +4,11 @@ group: Authentication info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Use DingTalk as an OAuth 2.0 authentication provider **(FREE SELF)** +# Use DingTalk as an OAuth 2.0 authentication provider + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/341898) in GitLab 14.5. > - [Deprecated](https://gitlab.com/gitlab-org/gitlab/-/issues/390855) in GitLab 15.10. diff --git a/doc/integration/external-issue-tracker.md b/doc/integration/external-issue-tracker.md index 5b5ec99817f..dab08d542da 100644 --- a/doc/integration/external-issue-tracker.md +++ b/doc/integration/external-issue-tracker.md @@ -4,7 +4,11 @@ group: Import and Integrate info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# External issue trackers **(FREE ALL)** +# External issue trackers + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed GitLab has its own [issue tracker](../user/project/issues/index.md), but you can also configure an external issue tracker per GitLab project. diff --git a/doc/integration/facebook.md b/doc/integration/facebook.md index 62b5e9d400b..8ebd8aac192 100644 --- a/doc/integration/facebook.md +++ b/doc/integration/facebook.md @@ -4,7 +4,11 @@ group: Authentication info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Use Facebook as an OAuth 2.0 authentication provider **(FREE ALL)** +# Use Facebook as an OAuth 2.0 authentication provider + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed You can use the Facebook OmniAuth provider to authenticate users with their Facebook account. diff --git a/doc/integration/github.md b/doc/integration/github.md index 9a92f03d645..eff65c48ce8 100644 --- a/doc/integration/github.md +++ b/doc/integration/github.md @@ -4,7 +4,11 @@ group: Authentication info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Use GitHub as an OAuth 2.0 authentication provider **(FREE SELF)** +# Use GitHub as an OAuth 2.0 authentication provider + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed You can integrate your GitLab instance with GitHub.com and GitHub Enterprise. You can import projects from GitHub, or sign in to GitLab diff --git a/doc/integration/gitlab.md b/doc/integration/gitlab.md index 81edc24f222..eebddbb1e53 100644 --- a/doc/integration/gitlab.md +++ b/doc/integration/gitlab.md @@ -4,7 +4,11 @@ group: Authentication info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Integrate your server with GitLab.com **(FREE SELF)** +# Integrate your server with GitLab.com + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed Import projects from GitLab.com and login to your GitLab instance with your GitLab.com account. diff --git a/doc/integration/gitpod.md b/doc/integration/gitpod.md index 2c074162634..77bd6156844 100644 --- a/doc/integration/gitpod.md +++ b/doc/integration/gitpod.md @@ -4,7 +4,11 @@ group: IDE info: "To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments" --- -# Gitpod **(FREE ALL)** +# Gitpod + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/228893) in GitLab 13.4. > - [Feature flag removed](https://gitlab.com/gitlab-org/gitlab/-/258206) in GitLab 13.8 @@ -37,7 +41,11 @@ With the Gitpod integration enabled for your GitLab instance, to enable it for y 1. Under **Preferences**, locate the **Integrations** section. 1. Select the **Enable Gitpod integration** checkbox and select **Save changes**. -## Configure a self-managed instance **(FREE SELF)** +## Configure a self-managed instance + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed For self-managed GitLab instances, a GitLab administrator must: diff --git a/doc/integration/gmail_action_buttons_for_gitlab.md b/doc/integration/gmail_action_buttons_for_gitlab.md index 1099065fda1..9f8b9ae09c0 100644 --- a/doc/integration/gmail_action_buttons_for_gitlab.md +++ b/doc/integration/gmail_action_buttons_for_gitlab.md @@ -4,7 +4,11 @@ group: Import and Integrate info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Gmail actions **(FREE ALL)** +# Gmail actions + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed GitLab supports [Google actions in email](https://developers.google.com/gmail/markup/actions/actions-overview). When you configure this integration, emails that require an action are marked in Gmail. diff --git a/doc/integration/google.md b/doc/integration/google.md index 6d701786d9a..9f4d928b05a 100644 --- a/doc/integration/google.md +++ b/doc/integration/google.md @@ -4,7 +4,11 @@ group: Authentication info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Use Google OAuth 2.0 as an OAuth 2.0 authentication provider **(FREE SELF)** +# Use Google OAuth 2.0 as an OAuth 2.0 authentication provider + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed To enable the Google OAuth 2.0 OmniAuth provider you must register your application with Google. Google generates a client ID and secret key for you to use. diff --git a/doc/integration/index.md b/doc/integration/index.md index 2a3154a739d..2b7009d50b0 100644 --- a/doc/integration/index.md +++ b/doc/integration/index.md @@ -5,7 +5,11 @@ description: Projects, issues, authentication, security providers. info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Integrate with GitLab **(FREE ALL)** +# Integrate with GitLab + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed You can integrate GitLab with external applications for enhanced functionality. diff --git a/doc/integration/jenkins.md b/doc/integration/jenkins.md index 542c75b5b8f..da81193584e 100644 --- a/doc/integration/jenkins.md +++ b/doc/integration/jenkins.md @@ -4,7 +4,11 @@ group: Import and Integrate info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Jenkins **(FREE ALL)** +# Jenkins + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed > [Moved](https://gitlab.com/gitlab-org/gitlab/-/issues/246756) to GitLab Free in 13.7. diff --git a/doc/integration/jira/configure.md b/doc/integration/jira/configure.md index fa6f94d116c..5e4d5bb2053 100644 --- a/doc/integration/jira/configure.md +++ b/doc/integration/jira/configure.md @@ -4,7 +4,11 @@ group: Import and Integrate info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Jira issue integration **(FREE ALL)** +# Jira issue integration + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed The Jira issue integration connects one or more GitLab projects to a Jira instance. You can host the Jira instance yourself or in [Jira Cloud](https://www.atlassian.com/migration/assess/why-cloud). The supported Jira versions are `6.x`, `7.x`, `8.x`, and `9.x`. @@ -79,7 +83,11 @@ To configure your project settings in GitLab: Your GitLab project can now interact with all Jira projects in your instance, and the project displays a Jira link that opens the Jira project. -## Create a Jira issue for a vulnerability **(ULTIMATE ALL)** +## Create a Jira issue for a vulnerability + +DETAILS: +**Tier:** Ultimate +**Offering:** SaaS, self-managed Prerequisites: diff --git a/doc/integration/jira/connect-app.md b/doc/integration/jira/connect-app.md index 5056826b1d7..44e4420c3f1 100644 --- a/doc/integration/jira/connect-app.md +++ b/doc/integration/jira/connect-app.md @@ -4,7 +4,11 @@ group: Import and Integrate info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# GitLab for Jira Cloud app **(FREE ALL)** +# GitLab for Jira Cloud app + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed NOTE: This page contains user documentation for the GitLab for Jira Cloud app. For administrator documentation, see [GitLab for Jira Cloud app administration](../../administration/settings/jira_cloud_app.md). @@ -36,7 +40,11 @@ After you link a group, the following GitLab data is synced to Jira for all proj - Deployments - Feature flags -## Install the GitLab for Jira Cloud app **(FREE SAAS)** +## Install the GitLab for Jira Cloud app + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS Prerequisites: @@ -56,9 +64,13 @@ You can now [configure the GitLab for Jira Cloud app](#configure-the-gitlab-for- For an overview, see [Configure the GitLab for Jira Cloud app from the Atlassian Marketplace](https://youtu.be/SwR-g1s1zTo). -## Configure the GitLab for Jira Cloud app **(FREE SAAS)** +## Configure the GitLab for Jira Cloud app -> **Add namespace** [renamed](https://gitlab.com/gitlab-org/gitlab/-/issues/331432) to **Link groups** in GitLab 16.1. +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS + +> - **Add namespace** [renamed](https://gitlab.com/gitlab-org/gitlab/-/issues/331432) to **Link groups** in GitLab 16.1. Prerequisites: diff --git a/doc/integration/jira/development_panel.md b/doc/integration/jira/development_panel.md index 280e1ed3581..2577cdd4c40 100644 --- a/doc/integration/jira/development_panel.md +++ b/doc/integration/jira/development_panel.md @@ -4,7 +4,11 @@ group: Import and Integrate info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Jira development panel **(FREE ALL)** +# Jira development panel + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed You can use the Jira development panel to view GitLab activity for a Jira issue directly in Jira. To set up the Jira development panel: diff --git a/doc/integration/jira/dvcs/index.md b/doc/integration/jira/dvcs/index.md index 97cb8474950..c9d713366d7 100644 --- a/doc/integration/jira/dvcs/index.md +++ b/doc/integration/jira/dvcs/index.md @@ -4,7 +4,11 @@ group: Import and Integrate info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Jira DVCS connector **(FREE ALL)** +# Jira DVCS connector + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed WARNING: The Jira DVCS connector for Jira Cloud was [deprecated](https://gitlab.com/gitlab-org/gitlab/-/issues/362168) in GitLab 15.1 diff --git a/doc/integration/jira/dvcs/troubleshooting.md b/doc/integration/jira/dvcs/troubleshooting.md index 15f35d9089c..77264733684 100644 --- a/doc/integration/jira/dvcs/troubleshooting.md +++ b/doc/integration/jira/dvcs/troubleshooting.md @@ -4,7 +4,11 @@ group: Import and Integrate info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Troubleshooting Jira DVCS connector **(FREE ALL)** +# Troubleshooting Jira DVCS connector + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed When working with the [Jira DVCS connector](index.md), you might encounter the following issues. diff --git a/doc/integration/jira/index.md b/doc/integration/jira/index.md index 05350bd2ac8..8f1b242e823 100644 --- a/doc/integration/jira/index.md +++ b/doc/integration/jira/index.md @@ -4,7 +4,11 @@ group: Import and Integrate info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Jira **(FREE ALL)** +# Jira + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed You can [import your Jira issues to GitLab](../../user/project/import/jira.md). If you want to continue to use Jira, you can integrate Jira with GitLab instead. diff --git a/doc/integration/jira/issues.md b/doc/integration/jira/issues.md index 9385ec63373..4026d4a2be2 100644 --- a/doc/integration/jira/issues.md +++ b/doc/integration/jira/issues.md @@ -4,7 +4,11 @@ group: Import and Integrate info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Jira issue management **(FREE ALL)** +# Jira issue management + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed You can [manage Jira issues directly in GitLab](configure.md). You can then refer to Jira issues by ID in GitLab commits and merge requests. @@ -47,7 +51,11 @@ create only a single cross-reference back to that merge request in Jira. You can [disable comments](#disable-comments-on-jira-issues) on issues. -### Require associated Jira issue for merge requests to be merged **(ULTIMATE ALL)** +### Require associated Jira issue for merge requests to be merged + +DETAILS: +**Tier:** Ultimate +**Offering:** SaaS, self-managed With this integration, you can prevent merge requests from being merged if they do not refer to a Jira issue. To enable this feature: @@ -63,7 +71,7 @@ Jira issue can't be merged. The merge request displays the message ## Customize Jira issue matching in GitLab -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/112826) in GitLab 15.10. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/112826) in GitLab 15.10. You can configure custom rules for how GitLab matches Jira issue keys by defining: @@ -138,7 +146,11 @@ Consider this example: - GitLab adds a formatted comment to Jira, linking back to the commit that resolved the issue. You can [disable comments](#disable-comments-on-jira-issues). -## View Jira issues **(PREMIUM ALL)** +## View Jira issues + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed You can view and search issues from a selected Jira project directly in GitLab, provided your GitLab administrator [has configured the integration](configure.md#configure-the-integration). @@ -161,7 +173,11 @@ Issues are grouped into tabs based on their - **Closed** tab: All issues with a Jira status categorized as Done. - **All** tab: All issues of any status. -### Search and filter the issue list **(PREMIUM ALL)** +### Search and filter the issue list + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed To refine the list of issues, use the search bar to search for any text contained in an issue summary (title) or description. Use any combination diff --git a/doc/integration/jira/jira_server_configuration.md b/doc/integration/jira/jira_server_configuration.md index fab00d18fcc..49c5dd14c3b 100644 --- a/doc/integration/jira/jira_server_configuration.md +++ b/doc/integration/jira/jira_server_configuration.md @@ -4,7 +4,11 @@ group: Import and Integrate info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Tutorial: Create Jira credentials **(FREE ALL)** +# Tutorial: Create Jira credentials + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed This tutorial shows you how to create Jira credentials. You can use your new Jira credentials to configure the [Jira issue integration](configure.md) in GitLab for Jira Data Center or Jira Server. diff --git a/doc/integration/jira/troubleshooting.md b/doc/integration/jira/troubleshooting.md index a9f190068b4..cf5397eb556 100644 --- a/doc/integration/jira/troubleshooting.md +++ b/doc/integration/jira/troubleshooting.md @@ -4,7 +4,11 @@ group: Import and Integrate info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Troubleshooting Jira issue integration **(FREE ALL)** +# Troubleshooting Jira issue integration + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed When working with the [Jira issue integration](configure.md), you might encounter the following issues. diff --git a/doc/integration/kerberos.md b/doc/integration/kerberos.md index 8f2e121cb26..0bbad0e06c2 100644 --- a/doc/integration/kerberos.md +++ b/doc/integration/kerberos.md @@ -4,7 +4,11 @@ group: Authentication info: "To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments" --- -# Integrate GitLab with Kerberos **(FREE SELF)** +# Integrate GitLab with Kerberos + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed GitLab can integrate with [Kerberos](https://web.mit.edu/kerberos/) as an authentication mechanism. diff --git a/doc/integration/oauth2_generic.md b/doc/integration/oauth2_generic.md index 5062d847dd1..ce45f81304a 100644 --- a/doc/integration/oauth2_generic.md +++ b/doc/integration/oauth2_generic.md @@ -4,7 +4,11 @@ group: Authentication info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Use Generic OAuth2 gem as an OAuth 2.0 authentication provider **(FREE SELF)** +# Use Generic OAuth2 gem as an OAuth 2.0 authentication provider + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed NOTE: If your provider supports the OpenID specification, you should use [`omniauth-openid-connect`](../administration/auth/oidc.md) as your authentication provider. diff --git a/doc/integration/oauth_provider.md b/doc/integration/oauth_provider.md index 1414dcad125..f237edbb558 100644 --- a/doc/integration/oauth_provider.md +++ b/doc/integration/oauth_provider.md @@ -53,7 +53,7 @@ To create a new application for your user: ## Create a group-owned application -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/16227) in GitLab 13.11. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/16227) in GitLab 13.11. To create a new application for a group: @@ -71,7 +71,11 @@ To create a new application for a group: [in GitLab 14.2 and later](https://gitlab.com/gitlab-org/gitlab/-/issues/332844). - The **Renew secret** function in [GitLab 15.9 and later](https://gitlab.com/gitlab-org/gitlab/-/issues/338243). Use this function to generate and copy a new secret for this application. Renewing a secret prevents the existing application from functioning until the credentials are updated. -## Create an instance-wide application **(FREE SELF)** +## Create an instance-wide application + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed To create an application for your GitLab instance: diff --git a/doc/integration/omniauth.md b/doc/integration/omniauth.md index ab43a14d169..60625c67313 100644 --- a/doc/integration/omniauth.md +++ b/doc/integration/omniauth.md @@ -4,7 +4,11 @@ group: Authentication info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# OmniAuth **(FREE SELF)** +# OmniAuth + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed Users can sign in to GitLab by using their credentials from Twitter, GitHub, and other popular services. [OmniAuth](https://rubygems.org/gems/omniauth/) is the Rack framework that GitLab uses to provide this authentication. @@ -165,7 +169,7 @@ your chosen [provider](#supported-providers). ### Per-provider configuration -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/89379) in GitLab 15.3. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/89379) in GitLab 15.3. If `allow_single_sign_on` is set, GitLab uses one of the following fields returned in the OmniAuth `auth_hash` to establish a username in GitLab for the user signing in, choosing the first that exists: @@ -289,7 +293,7 @@ omniauth: ## Link existing users to OmniAuth users -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/36664) in GitLab 13.4. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/36664) in GitLab 13.4. You can automatically link OmniAuth users with existing GitLab users if their email addresses match. diff --git a/doc/integration/openid_connect_provider.md b/doc/integration/openid_connect_provider.md index e638a4343b7..52b392fc32f 100644 --- a/doc/integration/openid_connect_provider.md +++ b/doc/integration/openid_connect_provider.md @@ -4,7 +4,11 @@ group: Authentication info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# GitLab as OpenID Connect identity provider **(FREE ALL)** +# GitLab as OpenID Connect identity provider + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed This document is about using GitLab as an OpenID Connect identity provider to sign in to other services. diff --git a/doc/integration/recaptcha.md b/doc/integration/recaptcha.md index bee6381a078..1f3c0828422 100644 --- a/doc/integration/recaptcha.md +++ b/doc/integration/recaptcha.md @@ -4,7 +4,11 @@ group: Anti-Abuse info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# reCAPTCHA **(FREE SELF)** +# reCAPTCHA + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed GitLab leverages [reCAPTCHA](https://www.google.com/recaptcha/about/) to protect against spam and abuse. GitLab displays the CAPTCHA form on the sign-up page diff --git a/doc/integration/salesforce.md b/doc/integration/salesforce.md index 8e95702196a..0c21a211eff 100644 --- a/doc/integration/salesforce.md +++ b/doc/integration/salesforce.md @@ -4,7 +4,11 @@ group: Authentication info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Use Salesforce as an OAuth 2.0 authentication provider **(FREE SELF)** +# Use Salesforce as an OAuth 2.0 authentication provider + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed You can integrate your GitLab instance with [Salesforce](https://www.salesforce.com/) to enable users to sign in to your GitLab instance with their Salesforce account. diff --git a/doc/integration/saml.md b/doc/integration/saml.md index 466c1ec7ed0..3ac0ab2f8cd 100644 --- a/doc/integration/saml.md +++ b/doc/integration/saml.md @@ -4,7 +4,11 @@ group: Authentication info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# SAML SSO for self-managed GitLab instances **(FREE SELF)** +# SAML SSO for self-managed GitLab instances + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed This page describes how to set up instance-wide SAML single sign on (SSO) for self-managed GitLab instances. @@ -393,7 +397,7 @@ Your IdP may need additional configuration. For more information, see ### Configure GitLab to use multiple SAML IdPs -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/14361) in GitLab 14.6. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/14361) in GitLab 14.6. You can configure GitLab to use multiple SAML IdPs if: @@ -759,10 +763,10 @@ Support for these groups depends on: | Group | Tier | GitLab Enterprise Edition (EE) Only? | |------------------------------|--------------------|--------------------------------------| -| [Required](#required-groups) | **(FREE SELF)** | Yes | -| [External](#external-groups) | **(FREE SELF)** | No | -| [Admin](#administrator-groups) | **(FREE SELF)** | Yes | -| [Auditor](#auditor-groups) | **(PREMIUM SELF)** | Yes | +| [Required](#required-groups) | Free, Premium, Ultimate | Yes | +| [External](#external-groups) | Free, Premium, Ultimate | No | +| [Admin](#administrator-groups) | Free, Premium, Ultimate | Yes | +| [Auditor](#auditor-groups) | Premium, Ultimate | Yes | Prerequisites: @@ -1250,7 +1254,11 @@ Example configuration: ::EndTabs -### Auditor groups **(PREMIUM SELF)** +### Auditor groups + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** Self-managed > Introduced in GitLab 11.4. @@ -1981,7 +1989,11 @@ NOTE: To bypass the auto sign-in setting, append `?auto_sign_in=false` in the sign in URL, for example: `https://gitlab.example.com/users/sign_in?auto_sign_in=false`. -### Map SAML response attribute names **(FREE SELF)** +### Map SAML response attribute names + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed You can use `attribute_statements` to map attribute names in a SAML response to entries in the OmniAuth [`info` hash](https://github.com/omniauth/omniauth/wiki/Auth-Hash-Schema#schema-10-and-later). @@ -2986,7 +2998,11 @@ For more information, see [Configure SAML support in GitLab](#configure-saml-sup A user can manually link their SAML identity to an existing GitLab account. For more information, see [Enable OmniAuth for an existing user](omniauth.md#enable-omniauth-for-an-existing-user). -## Configure group SAML SSO on a self-managed instance **(PREMIUM SELF)** +## Configure group SAML SSO on a self-managed instance + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** Self-managed Use group SAML SSO if you have to allow access through multiple SAML IdPs on your self-managed instance. diff --git a/doc/integration/shibboleth.md b/doc/integration/shibboleth.md index 0ff99a144c2..fb043bb3160 100644 --- a/doc/integration/shibboleth.md +++ b/doc/integration/shibboleth.md @@ -4,7 +4,11 @@ group: Authentication info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments --- -# Use Shibboleth as an authentication provider **(FREE SELF)** +# Use Shibboleth as an authentication provider + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed NOTE: Use the [GitLab SAML integration](saml.md) to integrate specific Shibboleth identity providers (IdPs). For Shibboleth federation support (Discovery Service), use this document. diff --git a/doc/integration/sourcegraph.md b/doc/integration/sourcegraph.md index 198dda7ec95..15c15d151cd 100644 --- a/doc/integration/sourcegraph.md +++ b/doc/integration/sourcegraph.md @@ -4,7 +4,11 @@ group: Source Code info: "To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments" --- -# Sourcegraph **(FREE ALL)** +# Sourcegraph + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/16556) in GitLab 12.5 [with a flag](../administration/feature_flags.md) named `sourcegraph`. Disabled by default. > - Enabled on GitLab.com in GitLab 12.5. @@ -27,12 +31,20 @@ NOTE: This feature requires user opt-in. After Sourcegraph has been enabled for your GitLab instance, you can choose to enable Sourcegraph [through your user preferences](#enable-sourcegraph-in-user-preferences). -## Set up for self-managed GitLab instances **(FREE SELF)** +## Set up for self-managed GitLab instances + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed Before you can enable Sourcegraph code intelligence in GitLab you must: configure a Sourcegraph instance with your GitLab instance as an external service. -### Set up a self-managed Sourcegraph instance **(FREE SELF)** +### Set up a self-managed Sourcegraph instance + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed If you are new to Sourcegraph, head over to the [Sourcegraph installation documentation](https://docs.sourcegraph.com/admin) and get your instance up and running. diff --git a/doc/integration/trello_power_up.md b/doc/integration/trello_power_up.md index 17b848987c9..172acd1d610 100644 --- a/doc/integration/trello_power_up.md +++ b/doc/integration/trello_power_up.md @@ -4,7 +4,11 @@ group: Import and Integrate info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Trello Power-Ups **(FREE ALL)** +# Trello Power-Ups + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed You can use Trello Power-Ups for GitLab to attach GitLab merge requests to Trello cards. diff --git a/doc/integration/twitter.md b/doc/integration/twitter.md index ce606c7d7de..98b4b9364f9 100644 --- a/doc/integration/twitter.md +++ b/doc/integration/twitter.md @@ -4,7 +4,11 @@ group: Authentication info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Twitter OAuth 1.0a OmniAuth Provider (deprecated) **(FREE SELF)** +# Twitter OAuth 1.0a OmniAuth Provider (deprecated) + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed diff --git a/doc/integration/vault.md b/doc/integration/vault.md index 8a76ef02215..18d7274da5d 100644 --- a/doc/integration/vault.md +++ b/doc/integration/vault.md @@ -4,7 +4,11 @@ group: Environments info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Vault authentication with GitLab OpenID Connect **(FREE ALL)** +# Vault authentication with GitLab OpenID Connect + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed [Vault](https://www.vaultproject.io/) is a secrets management application offered by HashiCorp. It allows you to store and manage sensitive information such as secret environment diff --git a/doc/operations/error_tracking.md b/doc/operations/error_tracking.md index a46998c11d8..8f3e97c11e4 100644 --- a/doc/operations/error_tracking.md +++ b/doc/operations/error_tracking.md @@ -4,7 +4,11 @@ group: Observability info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Error Tracking **(FREE ALL)** +# Error Tracking + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed Error Tracking allows developers to discover and view errors generated by their application. Because error information is surfaced where the code is developed, this increases efficiency and awareness. Users can choose between [GitLab Integrated error tracking](#integrated-error-tracking) and [Sentry based](#sentry-error-tracking) backends. @@ -28,7 +32,11 @@ For error tracking to work, you need: Whatever backend you choose, the [error tracking UI](#error-tracking-list) is the same. -## Integrated error tracking **(FREE SAAS)** +## Integrated error tracking + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS This guide provides you with basics of setting up error tracking for your project, using examples from different languages. diff --git a/doc/operations/feature_flags.md b/doc/operations/feature_flags.md index a55c7b54346..67f6a7d18c1 100644 --- a/doc/operations/feature_flags.md +++ b/doc/operations/feature_flags.md @@ -4,9 +4,13 @@ group: Environments info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Feature flags **(FREE ALL)** +# Feature flags -> [Moved](https://gitlab.com/gitlab-org/gitlab/-/issues/212318) from GitLab Premium to GitLab Free in 13.5. +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed + +> - [Moved](https://gitlab.com/gitlab-org/gitlab/-/issues/212318) from GitLab Premium to GitLab Free in 13.5. With feature flags, you can deploy your application's new features to production in smaller batches. You can toggle a feature on and off to subsets of users, helping you achieve Continuous Delivery. @@ -53,7 +57,7 @@ next to any feature flag in the list. ## Maximum number of feature flags -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/254379) in GitLab 13.5. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/254379) in GitLab 13.5. The maximum number of feature flags per project on self-managed GitLab instances is 200. For GitLab SaaS, the maximum number is determined by [tier](https://about.gitlab.com/pricing/): @@ -94,7 +98,7 @@ Enables the feature for all users. It uses the Standard (`default`) Unleash acti ### Percent Rollout -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/43340) in GitLab 13.5. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/43340) in GitLab 13.5. Enables the feature for a percentage of page views, with configurable consistency of behavior. This consistency is also known as stickiness. It uses the @@ -160,7 +164,7 @@ target users. See the [Ruby example](#ruby-application-example) below. ### User List -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/35930) in GitLab 13.1. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/35930) in GitLab 13.1. Enables the feature for lists of users created [in the feature flags UI](#create-a-user-list), or with the [feature flag user list API](../api/feature_flag_user_lists.md). Similar to [User IDs](#user-ids), it uses the Unleash UsersIDs (`userWithId`) activation [strategy](https://docs.getunleash.io/reference/activation-strategies#userids). @@ -191,7 +195,7 @@ When viewing a list, you can rename it by selecting **Edit** (**{pencil}**). #### Add users to a user list -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/13308) in GitLab 13.3. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/13308) in GitLab 13.3. To add users to a user list: @@ -205,7 +209,7 @@ To add users to a user list: #### Remove users from a user list -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/13308) in GitLab 13.3. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/13308) in GitLab 13.3. To remove users from a user list: @@ -214,9 +218,13 @@ To remove users from a user list: 1. Select **Edit** (**{pencil}**) next to the list you want to change. 1. Select **Remove** (**{remove}**) next to the ID you want to remove. -## Search for Code References **(PREMIUM ALL)** +## Search for Code References -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/300299) in GitLab 14.4. +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/300299) in GitLab 14.4. To remove the feature flag from the code during cleanup, find any project references to it. @@ -399,7 +407,11 @@ docker run \ There is a limitation when using the Unleash Proxy where each proxy instance can request flags only for the environment named in `UNLEASH_APP_NAME`. The Proxy sends this to GitLab on behalf of the client, which means the client can't override it. -## Feature flag related issues **(PREMIUM ALL)** +## Feature flag related issues + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/36617) in GitLab 13.2. > - [Feature flag removed](https://gitlab.com/gitlab-org/gitlab/-/issues/251234) in GitLab 13.5. diff --git a/doc/operations/incident_management/alerts.md b/doc/operations/incident_management/alerts.md index 0e03b422f9b..0f50216cac5 100644 --- a/doc/operations/incident_management/alerts.md +++ b/doc/operations/incident_management/alerts.md @@ -4,7 +4,11 @@ group: Respond info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Alerts **(FREE ALL)** +# Alerts + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed Alerts are a critical entity in your incident management workflow. They represent a notable event that might indicate a service outage or disruption. GitLab provides a list view for triage and detail view for deeper investigation of what happened. @@ -96,7 +100,7 @@ If you add a link, it is shown above the uploaded image. ### Activity feed tab -> [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/3066) in GitLab 13.1. +> - [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/3066) in GitLab 13.1. The **Activity feed** tab is a log of activity on the alert. When you take action on an alert, this is logged as a system note. This gives you a linear timeline of the alert's investigation and assignment history. @@ -153,7 +157,11 @@ When you [close an incident](manage_incidents.md#close-an-incident) that is link GitLab [changes the alert's status](#change-an-alerts-status) to **Resolved**. You are then credited with the alert's status change. -#### As an on-call responder **(PREMIUM ALL)** +#### As an on-call responder + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed On-call responders can respond to [alert pages](paging.md#escalating-an-alert) by changing the alert status. @@ -170,7 +178,7 @@ the incident status is independent and does not update when the alert status cha ### Assign an alert -> [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/3066) in GitLab 13.1. +> - [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/3066) in GitLab 13.1. In large teams, where there is shared ownership of an alert, it can be difficult to track who is investigating and working on it. Assigning alerts eases collaboration and delegation by indicating which user is owning the alert. GitLab supports only a single assignee per alert. @@ -199,14 +207,18 @@ and clear the user from the list of assignees, or select **Unassigned**. ### Create a to-do item from an alert -> [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/3066) in GitLab 13.1. +> - [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/3066) in GitLab 13.1. You can manually create a [to-do item](../../user/todos.md) for yourself from an alert, and view it later on your **To-Do List**. To add a to-do item, on the right sidebar, select **Add a to do**. -### Trigger actions from alerts **(ULTIMATE ALL)** +### Trigger actions from alerts + +DETAILS: +**Tier:** Ultimate +**Offering:** SaaS, self-managed > - Introduced in GitLab 13.1: incidents are not created automatically by default. > - Mapping common severity values from the alert payload [introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/50871) in GitLab 13.9. diff --git a/doc/operations/incident_management/escalation_policies.md b/doc/operations/incident_management/escalation_policies.md index a636ef1c665..ff5a503209c 100644 --- a/doc/operations/incident_management/escalation_policies.md +++ b/doc/operations/incident_management/escalation_policies.md @@ -4,9 +4,13 @@ group: Respond info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Escalation Policies **(PREMIUM ALL)** +# Escalation Policies -> [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/4638) in GitLab 14.1. +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed + +> - [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/4638) in GitLab 14.1. Escalation Policies protect your company from missed critical alerts. Escalation Policies contain time-boxed steps that automatically page the next responder in the escalation step if the responder diff --git a/doc/operations/incident_management/incident_timeline_events.md b/doc/operations/incident_management/incident_timeline_events.md index baea158b234..e57e5ce6cd1 100644 --- a/doc/operations/incident_management/incident_timeline_events.md +++ b/doc/operations/incident_management/incident_timeline_events.md @@ -52,13 +52,13 @@ To create a timeline event: ### Using a quick action -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/368721) in GitLab 15.4. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/368721) in GitLab 15.4. You can create a timeline event using the `/timeline` [quick action](../../user/project/quick_actions.md). ### From a comment on the incident -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/344058) in GitLab 15.4. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/344058) in GitLab 15.4. Prerequisites: @@ -76,16 +76,19 @@ The comment is shown on the incident timeline as a timeline event. ### When incident severity changes -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/375280) in GitLab 15.6. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/375280) in GitLab 15.6. A new timeline event is created when someone [changes the severity](manage_incidents.md#change-severity) of an incident. ![Incident timeline event for severity change](img/timeline_event_for_severity_change_v15_6.png) -### When labels change **(EXPERIMENT)** +### When labels change -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/365489) in GitLab 15.3 [with a flag](../../administration/feature_flags.md) named `incident_timeline_events_from_labels`. Disabled by default. +DETAILS: +**Status:** Experiment + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/365489) in GitLab 15.3 [with a flag](../../administration/feature_flags.md) named `incident_timeline_events_from_labels`. Disabled by default. FLAG: On self-managed GitLab, by default this feature is not available. To make it available per project or for your entire instance, an administrator can [enable the feature flag](../../administration/feature_flags.md) named `incident_timeline_events_from_labels`. @@ -96,7 +99,7 @@ A new timeline event is created when someone adds or removes [labels](../../user ## Delete an event -> Ability to delete an event when editing it [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/372265) in GitLab 15.7. +> - Ability to delete an event when editing it [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/372265) in GitLab 15.7. You can also delete timeline events. diff --git a/doc/operations/incident_management/incidents.md b/doc/operations/incident_management/incidents.md index 601349a00b0..c29ed88543f 100644 --- a/doc/operations/incident_management/incidents.md +++ b/doc/operations/incident_management/incidents.md @@ -4,7 +4,11 @@ group: Respond info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Incidents **(FREE ALL)** +# Incidents + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed An incident is a service disruption or outage that needs to be restored urgently. Incidents are critical in incident management workflows. @@ -48,7 +52,7 @@ For an example of the incident list in action, see this ### Sort the incident list -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/229534) in GitLab 13.3: incidents are sorted by created date by default. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/229534) in GitLab 13.3: incidents are sorted by created date by default. The incident list shows incidents sorted by incident created date, showing the newest first. @@ -97,9 +101,13 @@ Comments are displayed in threads, but can be displayed chronologically When you make changes to an incident, GitLab creates [system notes](../../user/project/system_notes.md) and displays them below the summary. -### Metrics **(PREMIUM ALL)** +### Metrics -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/235994) in GitLab 13.8. +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/235994) in GitLab 13.8. In many cases, incidents are associated to metrics. You can upload screenshots of metric charts in the **Metrics** tab: @@ -114,7 +122,7 @@ If you add a link, you can access the original graph by selecting the hyperlink ### Alert details -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/230847) in GitLab 13.4. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/230847) in GitLab 13.4. Incidents show the details of linked alerts in a separate tab. To populate this tab, the incident must have been created with a linked alert. Incidents @@ -130,17 +138,25 @@ during an incident, and the steps that were taken for it to be resolved. Read more about [timeline events](incident_timeline_events.md) and how to enable this feature. -### Recent updates view **(PREMIUM ALL)** +### Recent updates view -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/227836) in GitLab 13.5. +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/227836) in GitLab 13.5. To see the latest updates on an incident, select **Turn recent updates view on** (**{history}**) on the comment bar. Comments display un-threaded and chronologically, newest to oldest. -### Service Level Agreement countdown timer **(PREMIUM ALL)** +### Service Level Agreement countdown timer -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/241663) in GitLab 13.5. +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/241663) in GitLab 13.5. You can enable the Service Level Agreement Countdown timer on incidents to track the Service Level Agreements (SLA) you hold with your customers. The timer is diff --git a/doc/operations/incident_management/index.md b/doc/operations/incident_management/index.md index fa219b8202d..3cb86977101 100644 --- a/doc/operations/incident_management/index.md +++ b/doc/operations/incident_management/index.md @@ -4,9 +4,13 @@ group: Respond info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Incident management **(FREE ALL)** +# Incident management -> [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/2877) in GitLab 13.0. +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed + +> - [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/2877) in GitLab 13.0. Incident Management enables developers to easily triage and view the alerts and incidents generated by their application. By surfacing alerts and incidents where the code is diff --git a/doc/operations/incident_management/integrations.md b/doc/operations/incident_management/integrations.md index 516dba2fe1d..884efe8c65c 100644 --- a/doc/operations/incident_management/integrations.md +++ b/doc/operations/incident_management/integrations.md @@ -4,7 +4,11 @@ group: Respond info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Integrations **(FREE ALL)** +# Integrations + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/13203) in GitLab 12.4. > - [Moved](https://gitlab.com/gitlab-org/gitlab/-/issues/42640) from GitLab Ultimate to GitLab Free in 12.8. @@ -14,7 +18,7 @@ can [trigger paging](paging.md#paging) for on-call rotations or be used to [crea ## Integrations list -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/245331) in GitLab 13.5. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/245331) in GitLab 13.5. With at least the Maintainer role, you can view the list of configured alerts integrations by navigating to **Settings > Monitor** @@ -42,9 +46,13 @@ receive alert payloads in JSON format. You can always are available in the **View credentials** tab after you save the integration. You must also input the URL and Authorization Key in your external service. -### HTTP Endpoints **(PREMIUM ALL)** +### HTTP Endpoints -> [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/4442) in GitLab 13.6. +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed + +> - [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/4442) in GitLab 13.6. In [GitLab Premium](https://about.gitlab.com/pricing/), you can create multiple unique HTTP endpoints to receive alerts from any external source in JSON format, @@ -77,7 +85,7 @@ side of the integrations list. #### Map fields in custom alerts -> [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/4443) in GitLab 13.10. +> - [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/4443) in GitLab 13.10. You can integrate your monitoring tool's alert format with GitLab alerts. To show the correct information in the [Alert list](alerts.md) and the @@ -236,7 +244,7 @@ Ensure your requests are smaller than the #### Prometheus severity options -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/50871) in GitLab 13.9 +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/50871) in GitLab 13.9 Alerts from Prometheus can provide any of the case-insensitive follow values for [alert severity](../incident_management/alerts.md#alert-severity): @@ -358,7 +366,7 @@ using one of the above header options if your tooling supports it. ## Response body -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/342730) in GitLab 14.5. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/342730) in GitLab 14.5. The JSON response body contains a list of any alerts created within the request: @@ -379,7 +387,7 @@ Successful responses return a `200` response code. ## Triggering test alerts -> [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/3066) in GitLab in 13.2. +> - [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/3066) in GitLab in 13.2. After a [project maintainer or owner](../../user/permissions.md) configures an integration, you can trigger a test @@ -395,9 +403,13 @@ alert to confirm your integration works properly. GitLab displays an error or success message, depending on the outcome of your test. -## Automatic grouping of identical alerts **(PREMIUM ALL)** +## Automatic grouping of identical alerts -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/214557) in GitLab 13.2. +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/214557) in GitLab 13.2. In GitLab versions 13.2 and greater, GitLab groups alerts based on their payload. When an incoming alert contains the same payload as another alert @@ -411,7 +423,7 @@ If the existing alert is already `resolved`, GitLab creates a new alert instead. ## Recovery alerts -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/13402) in GitLab 13.4. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/13402) in GitLab 13.4. The alert in GitLab is automatically resolved when an HTTP Endpoint receives a payload with the end time of the alert set. For HTTP Endpoints @@ -425,9 +437,13 @@ For more information on alert properties and mappings, see You can also configure the associated [incident to be closed automatically](../incident_management/manage_incidents.md#automatically-close-incidents-via-recovery-alerts) when the alert resolves. -## Link to your Opsgenie Alerts **(PREMIUM ALL)** +## Link to your Opsgenie Alerts -> [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/3066) in GitLab 13.2. +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed + +> - [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/3066) in GitLab 13.2. WARNING: We are building deeper integration with Opsgenie and other alerting tools through diff --git a/doc/operations/incident_management/linked_resources.md b/doc/operations/incident_management/linked_resources.md index 4b44ca018bd..98add11d552 100644 --- a/doc/operations/incident_management/linked_resources.md +++ b/doc/operations/incident_management/linked_resources.md @@ -4,7 +4,11 @@ group: Respond info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Linked resources in incidents **(PREMIUM ALL)** +# Linked resources in incidents + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/230852) in GitLab 15.3 [with a flag](../../administration/feature_flags.md) named `incident_resource_links_widget`. Disabled by default. > - [Enabled on GitLab.com](https://gitlab.com/gitlab-org/gitlab/-/issues/364755) in GitLab 15.3. @@ -50,7 +54,7 @@ To add a linked resource: ### Using a quick action -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/374964) in GitLab 15.5. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/374964) in GitLab 15.5. To add multiple links to an incident, use the `/link` [quick action](../../user/project/quick_actions.md): @@ -68,7 +72,7 @@ The description shows instead of the URL in the **Linked resources** section of ### Link Zoom meetings from an incident -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/230853) in GitLab 15.4. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/230853) in GitLab 15.4. Use the `/zoom` [quick action](../../user/project/quick_actions.md) to add multiple Zoom links to an incident: diff --git a/doc/operations/incident_management/manage_incidents.md b/doc/operations/incident_management/manage_incidents.md index 4b86fb3fb4e..b2bcb8740b8 100644 --- a/doc/operations/incident_management/manage_incidents.md +++ b/doc/operations/incident_management/manage_incidents.md @@ -4,7 +4,11 @@ group: Respond info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Manage incidents **(FREE ALL)** +# Manage incidents + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed This page collects instructions for all the things you can do with [incidents](incidents.md) or in relation to them. @@ -30,7 +34,7 @@ To create an incident from the incidents list: ### From the issues list -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/230857) in GitLab 13.4. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/230857) in GitLab 13.4. Prerequisites: @@ -46,7 +50,7 @@ To create an incident from the issues list: ### From an alert -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/217745) in GitLab 13.1. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/217745) in GitLab 13.1. Create an incident issue when viewing an [alert](alerts.md). The incident description is populated from the alert. @@ -68,7 +72,11 @@ When you [close an incident](#close-an-incident) linked to an alert, GitLab [changes the alert's status](alerts.md#change-an-alerts-status) to **Resolved**. You are then credited with the alert's status change. -### Automatically, when an alert is triggered **(ULTIMATE ALL)** +### Automatically, when an alert is triggered + +DETAILS: +**Tier:** Ultimate +**Offering:** SaaS, self-managed In the project settings, you can turn on [creating an incident automatically](alerts.md#trigger-actions-from-alerts) whenever an alert is triggered. @@ -134,7 +142,7 @@ To assign a user: ## Change severity -> Editing severity on incident details page was [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/229402) in GitLab 13.4. +> - Editing severity on incident details page was [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/229402) in GitLab 13.4. See [incident list](incidents.md#incidents-list) for a full description of the severity levels available. @@ -166,7 +174,11 @@ To change the status of an incident: **Triggered** is the default status for new incidents. -### As an on-call responder **(PREMIUM ALL)** +### As an on-call responder + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed On-call responders can respond to [incident pages](paging.md#escalating-an-incident) by changing the status. @@ -181,7 +193,11 @@ In GitLab 15.1 and earlier, changing the status of an [incident created from an also changes the alert status. In [GitLab 15.2 and later](https://gitlab.com/gitlab-org/gitlab/-/issues/356057), the alert status is independent and does not change when the incident status changes. -## Change escalation policy **(PREMIUM ALL)** +## Change escalation policy + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed Prerequisites: @@ -215,7 +231,7 @@ You are then credited with the alert's status change. ### Automatically close incidents via recovery alerts -> [Introduced for HTTP integrations](https://gitlab.com/gitlab-org/gitlab/-/issues/13402) in GitLab 13.4. +> - [Introduced for HTTP integrations](https://gitlab.com/gitlab-org/gitlab/-/issues/13402) in GitLab 13.4. Turn on closing an incident automatically when GitLab receives a recovery alert from a HTTP or Prometheus webhook. diff --git a/doc/operations/incident_management/oncall_schedules.md b/doc/operations/incident_management/oncall_schedules.md index fb001bd3bf5..b3669c67fbe 100644 --- a/doc/operations/incident_management/oncall_schedules.md +++ b/doc/operations/incident_management/oncall_schedules.md @@ -4,9 +4,13 @@ group: Respond info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# On-call Schedule Management **(PREMIUM ALL)** +# On-call Schedule Management -> [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/4544) in GitLab 13.11. +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed + +> - [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/4544) in GitLab 13.11. Use on-call schedule management to create schedules for responders to rotate on-call responsibilities. Maintain the availability of your software services by putting your teams on-call. diff --git a/doc/operations/incident_management/paging.md b/doc/operations/incident_management/paging.md index 550dbb57488..096c6c9d9a3 100644 --- a/doc/operations/incident_management/paging.md +++ b/doc/operations/incident_management/paging.md @@ -4,7 +4,11 @@ group: Respond info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Paging and notifications **(FREE ALL)** +# Paging and notifications + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed When there is a new alert or incident, it is important for a responder to be notified immediately so they can triage and respond to the problem. Responders can receive @@ -12,7 +16,7 @@ notifications using the methods described on this page. ## Slack notifications -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/216326) in GitLab 13.1. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/216326) in GitLab 13.1. The GitLab for Slack app can be used to receive important incident notifications. @@ -35,7 +39,11 @@ a single email notification for new alerts. [Update the alert's status](alerts.md#change-an-alerts-status) to manage email notifications for an alert. -## Paging **(PREMIUM ALL)** +## Paging + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed In projects that have an [escalation policy](escalation_policies.md) configured, on-call responders can be automatically paged about critical problems through email. diff --git a/doc/operations/incident_management/slack.md b/doc/operations/incident_management/slack.md index 709b7bd31e8..e4fb276708c 100644 --- a/doc/operations/incident_management/slack.md +++ b/doc/operations/incident_management/slack.md @@ -4,7 +4,12 @@ group: Respond info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Incident management for Slack **(FREE SAAS BETA)** +# Incident management for Slack + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS +**Status:** Beta > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/344856) in GitLab 15.7 [with a flag](../../administration/feature_flags.md) named `incident_declare_slash_command`. Disabled by default. > - [Enabled on GitLab.com](https://gitlab.com/gitlab-org/gitlab/-/issues/378072) in GitLab 15.10 in [Beta](../../policy/experiment-beta-support.md#beta). diff --git a/doc/operations/incident_management/status_page.md b/doc/operations/incident_management/status_page.md index ac65d76bc75..6fc327ce187 100644 --- a/doc/operations/incident_management/status_page.md +++ b/doc/operations/incident_management/status_page.md @@ -4,9 +4,13 @@ group: Respond info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Status Page **(ULTIMATE ALL)** +# Status Page -> [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/2479) in GitLab 12.10. +DETAILS: +**Tier:** Ultimate +**Offering:** SaaS, self-managed + +> - [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/2479) in GitLab 12.10. With a GitLab Status Page, you can create and deploy a static website to communicate efficiently to users during an incident. The Status Page landing page displays an diff --git a/doc/operations/index.md b/doc/operations/index.md index e14d371e75d..402135b3100 100644 --- a/doc/operations/index.md +++ b/doc/operations/index.md @@ -5,7 +5,11 @@ description: Error tracking, incident management. info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Monitor application performance **(FREE ALL)** +# Monitor application performance + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed GitLab provides a variety of tools to help operate and maintain your applications. diff --git a/doc/operations/metrics.md b/doc/operations/metrics.md index b99c86d1a23..59df4784fc7 100644 --- a/doc/operations/metrics.md +++ b/doc/operations/metrics.md @@ -4,9 +4,14 @@ group: Observability info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Metrics **(ULTIMATE SAAS EXPERIMENT)** +# Metrics -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/124966) in GitLab 16.7 [with a flag](../administration/feature_flags.md) named `observability_metrics`. Disabled by default. This feature is an [Experiment](../policy/experiment-beta-support.md#experiment). +DETAILS: +**Tier:** Ultimate +**Offering:** SaaS +**Status:** Experiment + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/124966) in GitLab 16.7 [with a flag](../administration/feature_flags.md) named `observability_metrics`. Disabled by default. This feature is an [Experiment](../policy/experiment-beta-support.md#experiment). FLAG: On self-managed GitLab, by default this feature is not available. diff --git a/doc/operations/tracing.md b/doc/operations/tracing.md index df778d978af..8eb605c5b50 100644 --- a/doc/operations/tracing.md +++ b/doc/operations/tracing.md @@ -4,7 +4,12 @@ group: Observability info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Distributed tracing **(ULTIMATE SAAS BETA)** +# Distributed tracing + +DETAILS: +**Tier:** Ultimate +**Offering:** SaaS +**Status:** Beta > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/124966) in GitLab 16.2 [with flags](../administration/feature_flags.md) named `observability_group_tab` and `observability_tracing`. Disabled by default. This feature is in [Beta](../policy/experiment-beta-support.md#beta). > - Feature flag `observability_group_tab` [removed](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/133264) in GitLab 16.5. diff --git a/doc/policy/experiment-beta-support.md b/doc/policy/experiment-beta-support.md index a563ce7919d..2776b72d7c7 100644 --- a/doc/policy/experiment-beta-support.md +++ b/doc/policy/experiment-beta-support.md @@ -5,7 +5,7 @@ description: Support details. info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Support for Experiment, Beta, and Generally Available features **(PREMIUM ALL)** +# Support for Experiment, Beta, and Generally Available features Some GitLab features are released as Experiment or Beta versions and are [not fully supported](https://about.gitlab.com/support/statement-of-support/#alpha-beta-features). diff --git a/doc/raketasks/cleanup.md b/doc/raketasks/cleanup.md index 0be68a35b3c..6f1ab0a7aba 100644 --- a/doc/raketasks/cleanup.md +++ b/doc/raketasks/cleanup.md @@ -4,13 +4,17 @@ group: Distribution info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Clean up Rake tasks **(FREE SELF)** +# Clean up Rake tasks + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed GitLab provides Rake tasks for cleaning up GitLab instances. ## Remove unreferenced LFS files -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/36628) in GitLab 12.10. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/36628) in GitLab 12.10. WARNING: Do not run this within 12 hours of a GitLab upgrade. This is to ensure that all background migrations @@ -51,7 +55,7 @@ later (once a day). If you need to garbage collect them immediately, run ### Remove unreferenced LFS files immediately -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/36628) in GitLab 12.10. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/36628) in GitLab 12.10. Unreferenced LFS files are removed on a daily basis but you can remove them immediately if you need to. For example: @@ -77,7 +81,7 @@ Clean up project upload files if they don't exist in GitLab database. ### Clean up project upload files from file system -> [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/20863) in GitLab 11.2. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/20863) in GitLab 11.2. Clean up local project upload files if they don't exist in GitLab database. The task attempts to fix the file if it can find its project, otherwise it moves the @@ -115,7 +119,7 @@ If using object storage, run the [All-in-one Rake task](../administration/raketa ### Clean up project upload files from object storage -> [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/20918) in GitLab 11.2. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/20918) in GitLab 11.2. Move object store upload files to a lost and found directory if they don't exist in GitLab database. @@ -206,7 +210,7 @@ level with `NICENESS`. Below are the valid levels, but consult ## Remove expired ActiveSession lookup keys -> [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/30668) in GitLab 12.2. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/30668) in GitLab 12.2. ```shell # omnibus-gitlab diff --git a/doc/raketasks/index.md b/doc/raketasks/index.md index cff95b61d8c..f064ff1d805 100644 --- a/doc/raketasks/index.md +++ b/doc/raketasks/index.md @@ -4,7 +4,11 @@ group: Distribution info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Rake tasks **(FREE SELF)** +# Rake tasks + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed GitLab provides [Rake](https://ruby.github.io/rake/) tasks to assist you with common administration and operational processes. diff --git a/doc/raketasks/list_repos.md b/doc/raketasks/list_repos.md index 671baa18f98..5a898886343 100644 --- a/doc/raketasks/list_repos.md +++ b/doc/raketasks/list_repos.md @@ -6,7 +6,11 @@ info: To determine the technical writer assigned to the Stage/Group associated w -# List repository directories Rake task (deprecated) **(FREE SELF)** +# List repository directories Rake task (deprecated) + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed WARNING: This feature was [deprecated](https://gitlab.com/gitlab-org/gitlab/-/issues/384361) in GitLab 16.7 and is planned for removal in 17.0. diff --git a/doc/raketasks/spdx.md b/doc/raketasks/spdx.md index ee02ef87342..589282cc6c9 100644 --- a/doc/raketasks/spdx.md +++ b/doc/raketasks/spdx.md @@ -4,7 +4,11 @@ group: Composition Analysis info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# SPDX license list import Rake task **(ULTIMATE SELF)** +# SPDX license list import Rake task + +DETAILS: +**Tier:** Ultimate +**Offering:** Self-managed GitLab provides a Rake task for uploading a fresh copy of the [SPDX license list](https://spdx.org/licenses/) to a GitLab instance. This list is needed for matching the names of [License approval policies](../user/compliance/license_approval_policies.md). diff --git a/doc/raketasks/user_management.md b/doc/raketasks/user_management.md index 332d93ef207..4afd333d991 100644 --- a/doc/raketasks/user_management.md +++ b/doc/raketasks/user_management.md @@ -4,7 +4,11 @@ group: Distribution info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# User management Rake tasks **(FREE SELF)** +# User management Rake tasks + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed GitLab provides Rake tasks for managing users. Administrators can also use the Admin Area to [manage users](../administration/admin_area.md#administering-users). diff --git a/doc/raketasks/web_hooks.md b/doc/raketasks/web_hooks.md index c8576b2cffd..5c556e2ba02 100644 --- a/doc/raketasks/web_hooks.md +++ b/doc/raketasks/web_hooks.md @@ -4,7 +4,11 @@ group: Distribution info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Webhooks administration Rake tasks **(FREE SELF)** +# Webhooks administration Rake tasks + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed GitLab provides Rake tasks for webhooks management. diff --git a/doc/raketasks/x509_signatures.md b/doc/raketasks/x509_signatures.md index 6cdec4b5b36..80c9b162613 100644 --- a/doc/raketasks/x509_signatures.md +++ b/doc/raketasks/x509_signatures.md @@ -4,7 +4,11 @@ group: Source Code info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# X.509 signatures Rake task **(FREE SELF)** +# X.509 signatures Rake task + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed When [signing commits with X.509](../user/project/repository/signed_commits/x509.md), the trust anchor might change and the signatures stored within the database must be updated. diff --git a/doc/security/asset_proxy.md b/doc/security/asset_proxy.md index 8d515b55a48..d1174cb5e84 100644 --- a/doc/security/asset_proxy.md +++ b/doc/security/asset_proxy.md @@ -4,7 +4,11 @@ group: Authentication info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Proxying assets **(FREE SELF)** +# Proxying assets + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed A possible security concern when managing a public-facing GitLab instance is the ability to steal a user's IP address by referencing images in issues and comments. diff --git a/doc/security/crime_vulnerability.md b/doc/security/crime_vulnerability.md index 8b538166a02..2af777c008f 100644 --- a/doc/security/crime_vulnerability.md +++ b/doc/security/crime_vulnerability.md @@ -4,7 +4,11 @@ group: Authentication info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# How we manage the TLS protocol CRIME vulnerability **(FREE SELF)** +# How we manage the TLS protocol CRIME vulnerability + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed [CRIME](https://en.wikipedia.org/w/index.php?title=CRIME&oldid=692423806) is a security exploit against secret web cookies over connections using the HTTPS and SPDY protocols that also diff --git a/doc/security/email_verification.md b/doc/security/email_verification.md index 667ee85bb01..25d4b76c07c 100644 --- a/doc/security/email_verification.md +++ b/doc/security/email_verification.md @@ -4,9 +4,13 @@ group: Anti-Abuse info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Account email verification **(FREE ALL)** +# Account email verification -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/86352) in GitLab 15.2 [with a flag](../administration/feature_flags.md) named `require_email_verification`. Disabled by default. +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/86352) in GitLab 15.2 [with a flag](../administration/feature_flags.md) named `require_email_verification`. Disabled by default. FLAG: On self-managed GitLab, by default this feature is not available. To make it available, an administrator can [enable the feature flag](../administration/feature_flags.md) named `require_email_verification`. On GitLab.com, this feature is not available. diff --git a/doc/security/hardening.md b/doc/security/hardening.md index 0310d2abbe0..c69a0074182 100644 --- a/doc/security/hardening.md +++ b/doc/security/hardening.md @@ -4,7 +4,11 @@ group: Authentication info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# GitLab Hardening Recommendations **(FREE SELF)** +# GitLab Hardening Recommendations + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed This documentation is for GitLab instances where the overall system can be "hardened" against common and even not-so-common attacks. It is not designed to completely diff --git a/doc/security/identity_verification.md b/doc/security/identity_verification.md index 443fa1d65a7..a176d73f21a 100644 --- a/doc/security/identity_verification.md +++ b/doc/security/identity_verification.md @@ -4,9 +4,13 @@ group: Anti-Abuse info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Identity verification **(FREE ALL)** +# Identity verification -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/95722) in GitLab 15.4 [with a flag](../administration/feature_flags.md) named `identity_verification`. Disabled by default. +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/95722) in GitLab 15.4 [with a flag](../administration/feature_flags.md) named `identity_verification`. Disabled by default. FLAG: On self-managed GitLab, by default this feature is not available. diff --git a/doc/security/index.md b/doc/security/index.md index 42681709e93..ecb6db19464 100644 --- a/doc/security/index.md +++ b/doc/security/index.md @@ -5,7 +5,11 @@ description: SSH key limits, 2FA, tokens, hardening. info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Secure your installation **(FREE ALL)** +# Secure your installation + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed ## General Information diff --git a/doc/security/information_exclusivity.md b/doc/security/information_exclusivity.md index be7c6104876..6d486af6d7f 100644 --- a/doc/security/information_exclusivity.md +++ b/doc/security/information_exclusivity.md @@ -4,7 +4,11 @@ group: Authentication info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Information exclusivity **(FREE ALL)** +# Information exclusivity + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed Git is a distributed version control system (DVCS). This means that everyone who works with the source code has a local copy of the complete repository. diff --git a/doc/security/password_length_limits.md b/doc/security/password_length_limits.md index 177d5564e7d..73869a9c356 100644 --- a/doc/security/password_length_limits.md +++ b/doc/security/password_length_limits.md @@ -4,7 +4,11 @@ group: Authentication info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Custom password length limits **(FREE SELF)** +# Custom password length limits + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed By default, GitLab supports passwords with the following lengths: @@ -17,7 +21,7 @@ during new user sign-ups and when an existing user performs a password reset. ## Modify minimum password length -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/20661) in GitLab 12.6 +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/20661) in GitLab 12.6 The user password length is set to a minimum of 8 characters by default. diff --git a/doc/security/password_storage.md b/doc/security/password_storage.md index 9a9f5bbcd92..76967482291 100644 --- a/doc/security/password_storage.md +++ b/doc/security/password_storage.md @@ -4,7 +4,11 @@ group: Authentication info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Password and OAuth token storage **(FREE ALL)** +# Password and OAuth token storage + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed GitLab administrators can configure how passwords and OAuth tokens are stored. diff --git a/doc/security/passwords_for_integrated_authentication_methods.md b/doc/security/passwords_for_integrated_authentication_methods.md index c3944b83c69..9da75295f72 100644 --- a/doc/security/passwords_for_integrated_authentication_methods.md +++ b/doc/security/passwords_for_integrated_authentication_methods.md @@ -4,7 +4,11 @@ group: Authentication info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Generated passwords for users created through integrated authentication **(FREE ALL)** +# Generated passwords for users created through integrated authentication + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed GitLab allows users to set up accounts through integration with external [authentication and authorization providers](../administration/auth/index.md). diff --git a/doc/security/rate_limits.md b/doc/security/rate_limits.md index d9485ca1266..39f56ed908c 100644 --- a/doc/security/rate_limits.md +++ b/doc/security/rate_limits.md @@ -4,7 +4,11 @@ group: Authentication info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Rate limits **(FREE SELF)** +# Rate limits + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed NOTE: For GitLab.com, see @@ -75,7 +79,7 @@ For configuration information, see ### Repository archives -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/25750) in GitLab 12.9. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/25750) in GitLab 12.9. A rate limit for [downloading repository archives](../api/repositories.md#get-file-archive) is available. The limit applies to the project and to the user initiating the download either through @@ -85,7 +89,7 @@ The **rate limit** is 5 requests per minute per user. ### Webhook Testing -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/commit/35bc85c3ca093fee58d60dacdc9ed1fd9a15adec) in GitLab 13.4. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/commit/35bc85c3ca093fee58d60dacdc9ed1fd9a15adec) in GitLab 13.4. There is a rate limit for [testing webhooks](../user/project/integrations/webhooks.md#test-a-webhook), which prevents abuse of the webhook functionality. @@ -93,7 +97,7 @@ The **rate limit** is 5 requests per minute per user. ### Users sign up -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/339151) in GitLab 14.7. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/339151) in GitLab 14.7. There is a rate limit per IP address on the `/users/sign_up` endpoint. This is to mitigate attempts to misuse the endpoint. For example, to mass discover usernames or email addresses in use. @@ -102,7 +106,7 @@ The **rate limit** is 20 calls per minute per IP address. ### Update username -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/339152) in GitLab 14.7. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/339152) in GitLab 14.7. There is a rate limit on how frequently a username can be changed. This is enforced to mitigate misuse of the feature. For example, to mass discover which usernames are in use. @@ -111,7 +115,7 @@ The **rate limit** is 10 calls per minute per authenticated user. ### Username exists -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/29040) in GitLab 14.7. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/29040) in GitLab 14.7. There is a rate limit for the internal endpoint `/users/:username/exists`, used upon sign up to check if a chosen username has already been taken. This is to mitigate the risk of misuses, such as mass discovery of usernames in use. @@ -129,7 +133,7 @@ The **rate limit** defaults to 600 calls per authenticated user. You can [config ### AI action -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/118010) in GitLab 16.0. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/118010) in GitLab 16.0. There is a rate limit for the GraphQL `aiAction` mutation, which is enforced to prevent from abusing this endpoint. @@ -137,7 +141,7 @@ The **rate limit** is 160 calls per 8 hours per authenticated user. ### Delete a member using the API -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/118296) in GitLab 16.0. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/118296) in GitLab 16.0. There is a rate limit for [removing project or group members using the API endpoints](../api/members.md#remove-a-member-from-a-group-or-project) `/groups/:id/members` or `/project/:id/members`. diff --git a/doc/security/reset_user_password.md b/doc/security/reset_user_password.md index ffee1208f2a..668a311e34c 100644 --- a/doc/security/reset_user_password.md +++ b/doc/security/reset_user_password.md @@ -4,7 +4,11 @@ group: Authentication info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Reset a user's password **(FREE SELF)** +# Reset a user's password + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed You can reset user passwords by using the UI, a Rake task, a Rails console, or the [Users API](../api/users.md#user-modification). @@ -29,7 +33,7 @@ A confirmation is displayed. ## Use a Rake task -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/52347) in GitLab 13.9. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/52347) in GitLab 13.9. Use the following Rake task to reset a user's password. diff --git a/doc/security/responding_to_security_incidents.md b/doc/security/responding_to_security_incidents.md index 10d8176fe1b..803a411d230 100644 --- a/doc/security/responding_to_security_incidents.md +++ b/doc/security/responding_to_security_incidents.md @@ -4,7 +4,11 @@ group: Authentication info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Responding to security incidents **(FREE ALL)** +# Responding to security incidents + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed When a security incident occurs, you should follow the processes defined by your organization. The GitLab SIRT team created this guide: @@ -19,7 +23,11 @@ Use the suggestions/recommendations mentioned in this guide at your own risk. ## Common breach scenarios -### Credential exposure to public internet **(FREE SELF)** +### Credential exposure to public internet + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed This scenario refers to security events where sensitive authentication or authorization information has been exposed to the Internet due to misconfigurations or human errors. Such information might include: @@ -47,14 +55,22 @@ Security incidents related to credentials exposure can vary in severity from low - Document the time of credential exposure and the time when you revoked the credentials. - Review GitLab audit logs to identify any unauthorized activity associated with the exposed token. Depending on the scope and type of token, search for audit events related to newly created users, tokens, run malicious pipelines,changes to code and changes to project settings. -#### Event types **(PREMIUM SELF)** +#### Event types + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** Self-managed - Review the available [audit events](../administration/audit_events.md) for your group or namespace. - Adversaries may attempt to create tokens, SSH keys, or user accounts to maintain persistence. Look for [audit events](../administration/audit_event_streaming/audit_event_types.md) related to these activities. - Focus on CI-related [audit events](../administration/audit_event_streaming/audit_event_types.md#continuous-integration) to identify any modifications to CI/CD variables. - Review [job logs](../administration/job_logs.md) for any pipelines ran by an adversary -### Suspected compromised user account **(FREE SELF)** +### Suspected compromised user account + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed #### Response @@ -66,7 +82,11 @@ If you suspect that a user account or bot account has been compromised, you shou - Get the user to [enable two factor authentication](../user/profile/account/two_factor_authentication.md) (2FA), and consider [enforcing 2FA at the instance or group level](two_factor_authentication.md). - After completing an investigation and mitigating impacts, unblock the user. -#### Event types **(PREMIUM SELF)** +#### Event types + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** Self-managed Review the [audit events](../administration/audit_events.md) available to you to identify any suspicious account behavior. For example: @@ -82,7 +102,11 @@ Review the [audit events](../administration/audit_events.md) available to you to - Changes to connected SAML identity providers. - Changes to email addresses or notifications. -### CI/CD-related security incidents **(FREE ALL)** +### CI/CD-related security incidents + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed CI/CD workflows are an integral part of modern day software development and primarily used by developers and SREs to build, test and deploy code to production. Because these workflows are attached to the production environments, they often require access to sensitive secrets within the CI/CD pipelines. Security incidents related to CI/CD might vary based on your setup, but they can be broadly classified as follows: @@ -115,7 +139,11 @@ When secrets stored as CI variables are not [masked](../ci/variables/index.md#ma - Review audit logs for the exposed secrets systems such as CloudTrail logs for AWS or CloudAudit Logs for GCP to determine if any suspicious changes were made at the time of exposure. - Review audit logs available to you for any suspicious modifications to user and project settings. -### Suspected compromised instance **(FREE ALL)** +### Suspected compromised instance + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed Self-managed GitLab customers and administrators are responsible for: @@ -143,11 +171,19 @@ If you suspect that your GitLab instance has been compromised, you should: - Restrict inbound and outbound network access to authorized users and servers only. - Ensure all logs are routed to an independent write-only datastore. -#### Event types **(PREMIUM SELF)** +#### Event types + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** Self-managed Review [system access audit events](../administration/audit_event_streaming/audit_event_types.md#system-access) to determine any changes related to system settings, user permissions and user login events. -### Misconfigured project or group settings **(PREMIUM ALL)** +### Misconfigured project or group settings + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed Security incidents can occur as a result of improperly configured project or group settings, potentially leading to unauthorized access to sensitive or proprietary data. These incidents may include but are not limited to: @@ -165,7 +201,11 @@ If you suspect unauthorized modifications to project settings, consider taking t - If the user account appears suspicious, follow the steps outlined in the [suspected compromised user account guide](#suspected-compromised-user-account). - Consider reverting the settings to their original state by referring to the audit events and consulting the project owners and maintainers for guidance. -#### Event types **(PREMIUM SELF)** +#### Event types + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** Self-managed - Audit logs can be filtered based on the `target_type` field. Based on the security incident context, apply a filter to this field to narrow down the scope. - Look for specific audit events of [compliance management](../administration/audit_event_streaming/audit_event_types.md#compliance-management) and [audit events of groups and projects](../administration/audit_event_streaming/audit_event_types.md#groups-and-projects). diff --git a/doc/security/rotate_integrations_secrets.md b/doc/security/rotate_integrations_secrets.md index a3370d7287a..5feedd19be9 100644 --- a/doc/security/rotate_integrations_secrets.md +++ b/doc/security/rotate_integrations_secrets.md @@ -4,7 +4,11 @@ group: Authentication info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Rotate secrets of third-party integrations **(FREE SELF)** +# Rotate secrets of third-party integrations + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed Rotating secrets of third-party integrations is an important security practice that helps mitigate the risks associated with leaked secrets, such as diff --git a/doc/security/ssh_keys_restrictions.md b/doc/security/ssh_keys_restrictions.md index 465389eb1ca..e4b2f251141 100644 --- a/doc/security/ssh_keys_restrictions.md +++ b/doc/security/ssh_keys_restrictions.md @@ -4,7 +4,11 @@ group: Authentication info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Restrict allowed SSH key technologies and minimum length **(FREE SELF)** +# Restrict allowed SSH key technologies and minimum length + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed `ssh-keygen` allows users to create RSA keys with as few as 768 bits, which falls well below recommendations from certain standards groups (such as the US @@ -47,7 +51,11 @@ By default, the GitLab.com and self-managed settings for the - ECDSA_SK SSH keys are allowed (GitLab 14.8 and later). - ED25519_SK SSH keys are allowed (GitLab 14.8 and later). -## Block banned or compromised keys **(FREE ALL)** +## Block banned or compromised keys + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/24614) in GitLab 15.1 [with a flag](../administration/feature_flags.md) named `ssh_banned_key`. Enabled by default. > - Generally available in GitLab 15.2. [Feature flag `ssh_banned_key`](https://gitlab.com/gitlab-org/gitlab/-/issues/363410) removed. diff --git a/doc/security/token_overview.md b/doc/security/token_overview.md index fdff31f8e68..3aa8e6c5334 100644 --- a/doc/security/token_overview.md +++ b/doc/security/token_overview.md @@ -4,7 +4,11 @@ group: Authentication info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# GitLab Token overview **(FREE ALL)** +# GitLab Token overview + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed This document lists tokens used in GitLab, their purpose and, where applicable, security guidance. diff --git a/doc/security/two_factor_authentication.md b/doc/security/two_factor_authentication.md index 80b6988b1b1..00fa0ec05b2 100644 --- a/doc/security/two_factor_authentication.md +++ b/doc/security/two_factor_authentication.md @@ -4,7 +4,11 @@ group: Authentication info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Enforce two-factor authentication **(FREE ALL)** +# Enforce two-factor authentication + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed [Two-factor authentication (2FA)](../user/profile/account/two_factor_authentication.md) is an authentication method that requires the user to provide two different factors @@ -19,7 +23,11 @@ they would need both factors. NOTE: If you are [using and enforcing SSO](../user/group/saml_sso/index.md#sso-enforcement), you might already be enforcing 2FA on the identity provider (IDP) side. Enforcing 2FA on GitLab as well might be unnecessary. -## Enforce 2FA for all users **(FREE SELF)** +## Enforce 2FA for all users + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed Administrators can enforce 2FA for all users in two different ways: @@ -49,7 +57,11 @@ Use the [application settings API](../api/settings.md) to modify the following s For more information, see the [list of settings that can be accessed through API calls](../api/settings.md#list-of-settings-that-can-be-accessed-via-api-calls). -## Enforce 2FA for Administrator users **(FREE SELF)** +## Enforce 2FA for Administrator users + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed Administrators can enforce 2FA for administrator users in a self-managed instance. @@ -64,9 +76,13 @@ Administrators can enforce 2FA for administrator users in a self-managed instanc NOTE: If you are using an external provider to sign in into GitLab, this setting will **not** enforce 2FA for users. 2FA should be enabled on that external provider. -## Enforce 2FA for all users in a group **(FREE ALL)** +## Enforce 2FA for all users in a group -> [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/24965) in GitLab 12.0, 2FA settings for a group are also applied to subgroups. +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/24965) in GitLab 12.0, 2FA settings for a group are also applied to subgroups. Prerequisites: @@ -119,7 +135,11 @@ for the 2FA group. If you add members to a project in a group or subgroup that has 2FA enabled, 2FA is **not** required for those individually added members. -## Disable 2FA **(FREE SELF)** +## Disable 2FA + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed You can disable 2FA for a single user or all users. @@ -173,7 +193,11 @@ To disable 2FA for all users even when forced 2FA is disabled, use the following sudo -u git -H bundle exec rake gitlab:two_factor:disable_for_all_users RAILS_ENV=production ``` -## 2FA for Git over SSH operations **(PREMIUM ALL)** +## 2FA for Git over SSH operations + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/270554) in GitLab 13.7. > - [Moved](https://gitlab.com/gitlab-org/gitlab/-/issues/299088) from GitLab Free to GitLab Premium in 13.9. diff --git a/doc/security/unlock_user.md b/doc/security/unlock_user.md index 9a35673ab8e..1286ab3da37 100644 --- a/doc/security/unlock_user.md +++ b/doc/security/unlock_user.md @@ -4,11 +4,15 @@ group: Authentication info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Locked users **(FREE SELF)** +# Locked users + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed ## Self-managed users -> Configurable locked user policy [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/27048) in GitLab 16.5. +> - Configurable locked user policy [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/27048) in GitLab 16.5. By default, users are locked after 10 failed sign-in attempts. These users remain locked: diff --git a/doc/security/user_email_confirmation.md b/doc/security/user_email_confirmation.md index 1863c6e21ba..6e624c381fa 100644 --- a/doc/security/user_email_confirmation.md +++ b/doc/security/user_email_confirmation.md @@ -4,7 +4,11 @@ group: Authentication info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Make new users confirm email **(FREE SELF)** +# Make new users confirm email + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed GitLab can be configured to require confirmation of a user's email address when the user signs up. When this setting is enabled, the user is unable to sign in until @@ -19,7 +23,11 @@ they confirm their email address. By default, a user can confirm their account within 24 hours after the confirmation email was sent. After 24 hours, the confirmation token becomes invalid. -## Automatically delete unconfirmed users **(PREMIUM SELF)** +## Automatically delete unconfirmed users + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** Self-managed When email confirmation is turned on, administrators can enable the setting to [automatically delete unconfirmed users](../administration/moderate_users.md#automatically-delete-unconfirmed-users). diff --git a/doc/security/user_file_uploads.md b/doc/security/user_file_uploads.md index e73bdf4ced2..12bf4fc9dbc 100644 --- a/doc/security/user_file_uploads.md +++ b/doc/security/user_file_uploads.md @@ -4,7 +4,11 @@ group: Authentication info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# User file uploads **(FREE ALL)** +# User file uploads + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed Users can upload files to: @@ -56,7 +60,7 @@ You cannot select this option for public projects. ## Delete uploaded files -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/92791) in GitLab 15.3. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/92791) in GitLab 15.3. You should delete an uploaded file when that file contains sensitive or confidential information. When you have deleted that file, users cannot access the file and the direct URL returns a 404 error. diff --git a/doc/security/webhooks.md b/doc/security/webhooks.md index 3f16f0f6a65..141d0171fc3 100644 --- a/doc/security/webhooks.md +++ b/doc/security/webhooks.md @@ -4,7 +4,11 @@ group: Authentication info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Filtering outbound requests **(FREE SELF)** +# Filtering outbound requests + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed To protect against the risk of data loss and exposure, GitLab administrators can now use outbound request filtering controls to restrict certain outbound requests made by the GitLab instance. @@ -69,7 +73,7 @@ Prerequisites: ## Filter requests -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/377371) in GitLab 15.10. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/377371) in GitLab 15.10. Prerequisites: @@ -94,7 +98,7 @@ rules. ## Allow outbound requests to certain IP addresses and domains -> [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/issues/44496) in GitLab 12.2. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/issues/44496) in GitLab 12.2. Prerequisites: diff --git a/doc/solutions/cloud/aws/gitaly_sre_for_aws.md b/doc/solutions/cloud/aws/gitaly_sre_for_aws.md index 318316b95b8..b41909e9041 100644 --- a/doc/solutions/cloud/aws/gitaly_sre_for_aws.md +++ b/doc/solutions/cloud/aws/gitaly_sre_for_aws.md @@ -5,7 +5,11 @@ info: This page is owned by the Solutions Architecture team. description: Doing SRE for Gitaly instances on AWS. --- -# SRE Considerations for Gitaly on AWS **(FREE SELF)** +# SRE Considerations for Gitaly on AWS + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed ## Gitaly SRE considerations diff --git a/doc/solutions/cloud/aws/gitlab_single_box_on_aws.md b/doc/solutions/cloud/aws/gitlab_single_box_on_aws.md index 7a647f1d8d7..867f038fc34 100644 --- a/doc/solutions/cloud/aws/gitlab_single_box_on_aws.md +++ b/doc/solutions/cloud/aws/gitlab_single_box_on_aws.md @@ -6,7 +6,11 @@ info: This page is owned by the Solutions Architecture team. {::options parse_block_html="true" /} -# Provision GitLab on a single EC2 instance in AWS **(FREE SELF)** +# Provision GitLab on a single EC2 instance in AWS + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed If you want to provision a single GitLab instance on AWS, you have two options: diff --git a/doc/subscriptions/gitlab_com/index.md b/doc/subscriptions/gitlab_com/index.md index f5505cb3945..9d475bc03fe 100644 --- a/doc/subscriptions/gitlab_com/index.md +++ b/doc/subscriptions/gitlab_com/index.md @@ -5,7 +5,11 @@ description: Seat usage, compute minutes, storage limits, renewal info. info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# GitLab SaaS subscription **(PREMIUM SAAS)** +# GitLab SaaS subscription + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS GitLab SaaS is the GitLab software-as-a-service offering, which is available at GitLab.com. You don't need to install anything to use GitLab SaaS, you only need to @@ -134,7 +138,7 @@ For example: ### Export seat usage -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/262877) in GitLab 14.2. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/262877) in GitLab 14.2. To export seat usage data as a CSV file: @@ -163,7 +167,11 @@ For example, if you purchase a subscription for 10 users: Seats owed = 12 - 10 (Maximum users - users in subscription) -### Free Guest users **(ULTIMATE ALL)** +### Free Guest users + +DETAILS: +**Tier:** Ultimate +**Offering:** SaaS, self-managed In the **Ultimate** tier, users who are assigned the Guest role do not consume a seat. The user must not be assigned any other role, anywhere in the instance or in the namespace for GitLab SaaS. @@ -439,7 +447,7 @@ state for all projects is removed, and their excess usage is deducted from the a #### For your group namespace -> [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/5789) in GitLab 14.6. +> - [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/5789) in GitLab 14.6. If you're using GitLab SaaS, you can purchase additional storage so your pipelines aren't blocked after you have used all your storage from your diff --git a/doc/subscriptions/index.md b/doc/subscriptions/index.md index e995d2a9ffc..ef0dffbd562 100644 --- a/doc/subscriptions/index.md +++ b/doc/subscriptions/index.md @@ -4,7 +4,11 @@ group: Purchase info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Subscribe to GitLab **(PREMIUM ALL)** +# Subscribe to GitLab + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed Choose and manage the subscription that's right for you and your organization. diff --git a/doc/subscriptions/quarterly_reconciliation.md b/doc/subscriptions/quarterly_reconciliation.md index db822a3569e..03c3ab102c5 100644 --- a/doc/subscriptions/quarterly_reconciliation.md +++ b/doc/subscriptions/quarterly_reconciliation.md @@ -5,7 +5,11 @@ description: Billing examples. info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Quarterly reconciliation and annual true-ups **(PREMIUM ALL)** +# Quarterly reconciliation and annual true-ups + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed GitLab reviews your seat usage and sends you an invoice for any overages. This review can occur: diff --git a/doc/subscriptions/self_managed/index.md b/doc/subscriptions/self_managed/index.md index 6cc50103c75..1bb8bb82161 100644 --- a/doc/subscriptions/self_managed/index.md +++ b/doc/subscriptions/self_managed/index.md @@ -5,7 +5,11 @@ description: Billable users, renewal and upgrade info. info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# GitLab self-managed subscription **(PREMIUM SELF)** +# GitLab self-managed subscription + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** Self-managed After you subscribe to GitLab, you can manage the details of your self-managed subscription. @@ -87,7 +91,11 @@ If you add more users to your GitLab instance than you are licensed for, payment If you do not add these users during the renewal process, your license key will not work. -### Free Guest users **(ULTIMATE ALL)** +### Free Guest users + +DETAILS: +**Tier:** Ultimate +**Offering:** SaaS, self-managed In the **Ultimate** tier, users who are assigned the Guest role do not consume a seat. The user must not be assigned any other role, anywhere in the instance. @@ -125,7 +133,7 @@ GitLab has several features which can help you manage the number of users: ## Subscription data synchronization -> Introduced in GitLab 14.1. +> - Introduced in GitLab 14.1. Subscription data can be automatically synchronized between your self-managed instance and GitLab. To enable subscription data synchronization you must have: @@ -247,7 +255,7 @@ It also displays the following information: ## Export your license usage -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/66826) in GitLab 14.2. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/66826) in GitLab 14.2. If you are an administrator, you can export your license usage into a CSV: diff --git a/doc/topics/autodevops/cicd_variables.md b/doc/topics/autodevops/cicd_variables.md index 9d50d0dabab..2902a8c75e2 100644 --- a/doc/topics/autodevops/cicd_variables.md +++ b/doc/topics/autodevops/cicd_variables.md @@ -258,7 +258,11 @@ production, GitLab creates a `production_manual` job. You can also enable manual deployment in your [project settings](requirements.md#auto-devops-deployment-strategy). -## Deploy policy for canary environments **(PREMIUM ALL)** +## Deploy policy for canary environments + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed You can use a [canary environment](../../user/project/canary_deployments.md) before deploying any changes to production. @@ -268,7 +272,11 @@ If you set `CANARY_ENABLED`, GitLab creates two [manual jobs](../../ci/pipelines - `canary` - Deploys the application to the canary environment. - `production_manual` - Deploys the application to production. -## Incremental rollout to production **(PREMIUM ALL)** +## Incremental rollout to production + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed Use an incremental rollout to continuously deploy your application, starting with only a few pods. You can increase the number of pods @@ -313,7 +321,11 @@ With `INCREMENTAL_ROLLOUT_MODE` set to `manual` and with `STAGING_ENABLED`: ![Rollout and staging enabled](img/rollout_staging_enabled.png) -## Timed incremental rollout to production **(PREMIUM ALL)** +## Timed incremental rollout to production + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed Use a timed incremental rollout to continuously deploy your application, starting with only a few pods. diff --git a/doc/topics/autodevops/cloud_deployments/auto_devops_with_ec2.md b/doc/topics/autodevops/cloud_deployments/auto_devops_with_ec2.md index b43d334380b..3d1bd35bce9 100644 --- a/doc/topics/autodevops/cloud_deployments/auto_devops_with_ec2.md +++ b/doc/topics/autodevops/cloud_deployments/auto_devops_with_ec2.md @@ -6,7 +6,7 @@ info: To determine the technical writer assigned to the Stage/Group associated w # Use Auto DevOps to deploy to EC2 -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/216008) in GitLab 13.6. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/216008) in GitLab 13.6. To use [Auto DevOps](../index.md) to deploy to EC2: diff --git a/doc/topics/autodevops/cloud_deployments/auto_devops_with_ecs.md b/doc/topics/autodevops/cloud_deployments/auto_devops_with_ecs.md index 80079a15ed5..c9d0a8fbdea 100644 --- a/doc/topics/autodevops/cloud_deployments/auto_devops_with_ecs.md +++ b/doc/topics/autodevops/cloud_deployments/auto_devops_with_ecs.md @@ -6,7 +6,7 @@ info: To determine the technical writer assigned to the Stage/Group associated w # Use Auto DevOps to deploy to Amazon ECS -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/208132) in GitLab 13.0. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/208132) in GitLab 13.0. You can choose to target AWS ECS as a deployment platform instead of using Kubernetes. diff --git a/doc/topics/autodevops/cloud_deployments/auto_devops_with_gke.md b/doc/topics/autodevops/cloud_deployments/auto_devops_with_gke.md index 572e08f355b..c34183025bb 100644 --- a/doc/topics/autodevops/cloud_deployments/auto_devops_with_gke.md +++ b/doc/topics/autodevops/cloud_deployments/auto_devops_with_gke.md @@ -4,7 +4,11 @@ group: Environments info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Use Auto DevOps to deploy an application to Google Kubernetes Engine **(FREE ALL)** +# Use Auto DevOps to deploy an application to Google Kubernetes Engine + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed In this tutorial, we'll help you to get started with [Auto DevOps](../index.md) through an example of how to deploy an application to Google Kubernetes Engine (GKE). diff --git a/doc/topics/autodevops/customize.md b/doc/topics/autodevops/customize.md index 05535d233e0..66686e063af 100644 --- a/doc/topics/autodevops/customize.md +++ b/doc/topics/autodevops/customize.md @@ -4,7 +4,11 @@ group: Environments info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Customize Auto DevOps **(FREE ALL)** +# Customize Auto DevOps + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed You can customize components of Auto DevOps to fit your needs. For example, you can: @@ -45,7 +49,7 @@ You can customize your buildpacks when either: ### Customize buildpacks with Cloud Native Buildpacks -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/28165) in GitLab 12.10. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/28165) in GitLab 12.10. Specify either: @@ -164,7 +168,7 @@ You can extend and manage your Auto DevOps configuration with GitLab APIs: ## Forward CI/CD variables to the build environment -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/25514) in GitLab 12.3. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/25514) in GitLab 12.3. To forward CI/CD variables to the build environment, add the names of the variables you want to forward to the `AUTO_DEVOPS_BUILD_IMAGE_FORWARDED_CI_VARIABLES` CI/CD variable. @@ -219,7 +223,7 @@ repository or by specifying a project CI/CD variable: ### Customize Helm chart values -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/30628) in GitLab 12.6, `.gitlab/auto-deploy-values.yaml` is used by default for Helm upgrades. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/30628) in GitLab 12.6, `.gitlab/auto-deploy-values.yaml` is used by default for Helm upgrades. To override the default values in the `values.yaml` file in the [default Helm chart](https://gitlab.com/gitlab-org/cluster-integration/auto-deploy-image/-/tree/master/assets/auto-deploy-app), either: @@ -374,7 +378,7 @@ To use the old PostgreSQL, set the `AUTO_DEVOPS_POSTGRES_CHANNEL` variable to ### Customize values for PostgreSQL Helm Chart -> [Introduced](https://gitlab.com/gitlab-org/cluster-integration/auto-deploy-image/-/issues/113) in GitLab 13.8 with auto-deploy-image v2. +> - [Introduced](https://gitlab.com/gitlab-org/cluster-integration/auto-deploy-image/-/issues/113) in GitLab 13.8 with auto-deploy-image v2. To set custom values, do one of the following: diff --git a/doc/topics/autodevops/index.md b/doc/topics/autodevops/index.md index 58203997698..bfee5bcde20 100644 --- a/doc/topics/autodevops/index.md +++ b/doc/topics/autodevops/index.md @@ -4,7 +4,11 @@ group: Environments info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Auto DevOps **(FREE ALL)** +# Auto DevOps + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed > - [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/issues/38366) in GitLab 11.0. > - Support for the GitLab agent was [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/299350) in GitLab 14.5. @@ -115,7 +119,7 @@ To disable it, follow the same process and clear the #### At the group level -> [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/issues/52447) in GitLab 11.10. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/issues/52447) in GitLab 11.10. When you enable Auto DevOps at the group level, the subgroups and projects in that group inherit the configuration. You can save time by @@ -148,7 +152,11 @@ Auto DevOps pipeline for any project that belongs to that group: 1. Select **Build > Pipelines**. 1. To trigger the Auto DevOps pipeline, select **Run pipeline**. -#### At the instance level **(FREE SELF)** +#### At the instance level + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed To enable Auto DevOps by default for all projects, you can enable it at the instance level. You can still disable Auto DevOps for each group and project diff --git a/doc/topics/autodevops/multiple_clusters_auto_devops.md b/doc/topics/autodevops/multiple_clusters_auto_devops.md index dbdabae90d9..e8edeac10fc 100644 --- a/doc/topics/autodevops/multiple_clusters_auto_devops.md +++ b/doc/topics/autodevops/multiple_clusters_auto_devops.md @@ -4,7 +4,11 @@ group: Environments info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Multiple Kubernetes clusters for Auto DevOps **(FREE ALL)** +# Multiple Kubernetes clusters for Auto DevOps + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed When using Auto DevOps, you can deploy different environments to different Kubernetes clusters. diff --git a/doc/topics/autodevops/prepare_deployment.md b/doc/topics/autodevops/prepare_deployment.md index da33d6d8761..6daa231271b 100644 --- a/doc/topics/autodevops/prepare_deployment.md +++ b/doc/topics/autodevops/prepare_deployment.md @@ -4,7 +4,11 @@ group: Environments info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Prepare Auto DevOps for deployment **(FREE ALL)** +# Prepare Auto DevOps for deployment + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed If you enable Auto DevOps without setting the base domain and deployment strategy, GitLab can't deploy your application directly. Therefore, we diff --git a/doc/topics/autodevops/requirements.md b/doc/topics/autodevops/requirements.md index 1b9c1b0cb9e..403fb864a4d 100644 --- a/doc/topics/autodevops/requirements.md +++ b/doc/topics/autodevops/requirements.md @@ -4,7 +4,11 @@ group: Environments info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Requirements for Auto DevOps **(FREE ALL)** +# Requirements for Auto DevOps + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed Before enabling [Auto DevOps](index.md), we recommend you to prepare it for deployment. If you don't, you can use it to build and test your apps, and @@ -27,7 +31,7 @@ To prepare the deployment: ## Auto DevOps deployment strategy -> [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/issues/38542) in GitLab 11.0. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/issues/38542) in GitLab 11.0. When using Auto DevOps to deploy your applications, choose the [continuous deployment strategy](../../ci/index.md) diff --git a/doc/topics/autodevops/stages.md b/doc/topics/autodevops/stages.md index 541dfbe04fa..056ea2fe8a1 100644 --- a/doc/topics/autodevops/stages.md +++ b/doc/topics/autodevops/stages.md @@ -4,7 +4,11 @@ group: Environments info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Stages of Auto DevOps **(FREE ALL)** +# Stages of Auto DevOps + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed The following sections describe the stages of [Auto DevOps](index.md). Read them carefully to understand how each one works. @@ -188,7 +192,7 @@ might want to use a [custom buildpack](customize.md#custom-buildpacks). ## Auto Code Quality -> [Moved](https://gitlab.com/gitlab-org/gitlab/-/issues/212499) from GitLab Starter to GitLab Free in 13.2. +> - [Moved](https://gitlab.com/gitlab-org/gitlab/-/issues/212499) from GitLab Starter to GitLab Free in 13.2. Auto Code Quality uses the [Code Quality image](https://gitlab.com/gitlab-org/ci-cd/codequality) to run @@ -227,7 +231,11 @@ warnings on [Ultimate](https://about.gitlab.com/pricing/) licenses. For more information, see [Secret Detection](../../user/application_security/secret_detection/index.md). -## Auto Dependency Scanning **(ULTIMATE ALL)** +## Auto Dependency Scanning + +DETAILS: +**Tier:** Ultimate +**Offering:** SaaS, self-managed Dependency Scanning runs analysis on the project's dependencies and checks for potential security issues. The Auto Dependency Scanning stage is skipped on licenses other than @@ -289,7 +297,11 @@ deploys with Auto DevOps can undo your changes. Also, if you change something and want to undo it by deploying again, Helm may not detect that anything changed in the first place, and thus not realize that it needs to re-apply the old configuration. -## Auto DAST **(ULTIMATE ALL)** +## Auto DAST + +DETAILS: +**Tier:** Ultimate +**Offering:** SaaS, self-managed Dynamic Application Security Testing (DAST) uses the popular open source tool [OWASP ZAProxy](https://github.com/zaproxy/zaproxy) to analyze the current code @@ -330,9 +342,13 @@ You can disable DAST: - Only on feature branches by setting `REVIEW_DISABLED` variable to `"true"`. This also disables the Review App. -## Auto Browser Performance Testing **(PREMIUM ALL)** +## Auto Browser Performance Testing -> Introduced in GitLab 10.4. +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed + +> - Introduced in GitLab 10.4. Auto [Browser Performance Testing](../../ci/testing/browser_performance_testing.md) measures the browser performance of a web page with the @@ -351,9 +367,13 @@ file named `.gitlab-urls.txt` in the root directory, one file per line. For exam Any browser performance differences between the source and target branches are also [shown in the merge request widget](../../ci/testing/browser_performance_testing.md). -## Auto Load Performance Testing **(PREMIUM ALL)** +## Auto Load Performance Testing -> Introduced in GitLab 13.2. +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed + +> - Introduced in GitLab 13.2. Auto [Load Performance Testing](../../ci/testing/load_performance_testing.md) measures the server performance of an application with the @@ -370,7 +390,7 @@ Any load performance test result differences between the source and target branc ## Auto Deploy -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/216008) in GitLab 13.6, you have the choice to deploy to [Amazon Elastic Compute Cloud (Amazon EC2)](https://aws.amazon.com/ec2/) in addition to a Kubernetes cluster. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/216008) in GitLab 13.6, you have the choice to deploy to [Amazon Elastic Compute Cloud (Amazon EC2)](https://aws.amazon.com/ec2/) in addition to a Kubernetes cluster. Auto Deploy is an optional step for Auto DevOps. If the [requirements](requirements.md) are not met, the job is skipped. @@ -413,7 +433,7 @@ to upgrade your environments before upgrading to GitLab 14.0. ### GitLab deploy tokens -> [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/19507) in GitLab 11.0. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/19507) in GitLab 11.0. [GitLab Deploy Tokens](../../user/project/deploy_tokens/index.md#gitlab-deploy-token) are created for internal and private projects when Auto DevOps is enabled, and the @@ -472,7 +492,7 @@ deletion). ### Migrations -> [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/21955) in GitLab 11.4 +> - [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/21955) in GitLab 11.4 You can configure database initialization and migrations for PostgreSQL to run within the application pod by setting the project CI/CD variables `DB_INITIALIZE` and @@ -578,7 +598,7 @@ When using Cloud Native Buildpacks, instead of `/bin/herokuish procfile exec`, u ## Auto Code Intelligence -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/216438) in GitLab 13.5. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/216438) in GitLab 13.5. [GitLab code intelligence](../../user/project/code_intelligence.md) adds code navigation features common to interactive development environments (IDE), diff --git a/doc/topics/autodevops/troubleshooting.md b/doc/topics/autodevops/troubleshooting.md index bff21c19165..36af60f4f2b 100644 --- a/doc/topics/autodevops/troubleshooting.md +++ b/doc/topics/autodevops/troubleshooting.md @@ -4,7 +4,11 @@ group: Environments info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Troubleshooting Auto DevOps **(FREE ALL)** +# Troubleshooting Auto DevOps + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed The information in this documentation page describes common errors when using Auto DevOps, and any available workarounds. diff --git a/doc/topics/autodevops/upgrading_auto_deploy_dependencies.md b/doc/topics/autodevops/upgrading_auto_deploy_dependencies.md index 3a58d493657..f3147aa1231 100644 --- a/doc/topics/autodevops/upgrading_auto_deploy_dependencies.md +++ b/doc/topics/autodevops/upgrading_auto_deploy_dependencies.md @@ -4,7 +4,11 @@ group: Environments info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Upgrading deployments for newer Auto Deploy dependencies **(FREE ALL)** +# Upgrading deployments for newer Auto Deploy dependencies + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed [Auto Deploy](stages.md#auto-deploy) is a feature that deploys your application to a Kubernetes cluster. It consists of several dependencies: @@ -77,7 +81,7 @@ Kubernetes cluster, follow your cloud provider's instructions. Here's #### Helm v3 -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/228609) in GitLab 13.4. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/228609) in GitLab 13.4. The `auto-deploy-image` uses the Helm binary to manipulate the releases. Previously, `auto-deploy-image` used Helm v2, which used Tiller in a cluster. @@ -125,7 +129,7 @@ with the [v1 auto-deploy-image](#use-a-specific-version-of-auto-deploy-dependenc #### Traffic routing change for canary deployments and incremental rollouts -> [Introduced](https://gitlab.com/gitlab-org/cluster-integration/auto-deploy-image/-/merge_requests/109) in GitLab 13.4. +> - [Introduced](https://gitlab.com/gitlab-org/cluster-integration/auto-deploy-image/-/merge_requests/109) in GitLab 13.4. Auto Deploy supports advanced deployment strategies such as [canary deployments](cicd_variables.md#deploy-policy-for-canary-environments) and [incremental rollouts](../../ci/environments/incremental_rollouts.md). diff --git a/doc/topics/autodevops/upgrading_postgresql.md b/doc/topics/autodevops/upgrading_postgresql.md index 9daddfbe7c5..2863dc544e1 100644 --- a/doc/topics/autodevops/upgrading_postgresql.md +++ b/doc/topics/autodevops/upgrading_postgresql.md @@ -4,7 +4,11 @@ group: Environments info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Upgrading PostgreSQL for Auto DevOps **(FREE ALL)** +# Upgrading PostgreSQL for Auto DevOps + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed When `POSTGRES_ENABLED` is `true`, Auto DevOps provides an [in-cluster PostgreSQL database](customize.md#postgresql-database-support) for your application. diff --git a/doc/topics/build_your_application.md b/doc/topics/build_your_application.md index 787e056a1c7..3fca88bd865 100644 --- a/doc/topics/build_your_application.md +++ b/doc/topics/build_your_application.md @@ -5,7 +5,11 @@ description: Runners, jobs, pipelines, variables. info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Use CI/CD to build your application **(FREE ALL)** +# Use CI/CD to build your application + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed Use CI/CD to generate your application. diff --git a/doc/topics/git/cherry_picking.md b/doc/topics/git/cherry_picking.md index 0fe77a4a0ed..77ca96b0e44 100644 --- a/doc/topics/git/cherry_picking.md +++ b/doc/topics/git/cherry_picking.md @@ -4,7 +4,7 @@ group: Source Code info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Cherry-pick a Git commit **(FREE ALL)** +# Cherry-pick a Git commit In Git, you can *cherry-pick* a commit (a set of changes) from an existing branch, and apply those changes to another branch. Cherry-picks can help you: diff --git a/doc/topics/git/git_rebase.md b/doc/topics/git/git_rebase.md index d9bf9f758f6..f452690e338 100644 --- a/doc/topics/git/git_rebase.md +++ b/doc/topics/git/git_rebase.md @@ -5,7 +5,7 @@ info: "To determine the technical writer assigned to the Stage/Group associated description: "Introduction to Git rebase and force push, methods to resolve merge conflicts through the command line." --- -# Git rebase and force push **(FREE ALL)** +# Git rebase and force push In Git, a rebase updates your branch with the contents of another branch. A rebase confirms that changes in your branch don't conflict with diff --git a/doc/topics/git/how_to_install_git/index.md b/doc/topics/git/how_to_install_git/index.md index 5a93f0fcd69..135a3d47646 100644 --- a/doc/topics/git/how_to_install_git/index.md +++ b/doc/topics/git/how_to_install_git/index.md @@ -4,7 +4,7 @@ group: Source Code info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Installing Git **(FREE ALL)** +# Installing Git To begin contributing to GitLab projects, you must download and install the Git client on your computer. diff --git a/doc/topics/git/index.md b/doc/topics/git/index.md index 17321591e87..de544742465 100644 --- a/doc/topics/git/index.md +++ b/doc/topics/git/index.md @@ -5,7 +5,7 @@ description: Common commands and workflows. info: "To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments" --- -# Learn Git **(FREE ALL)** +# Learn Git Git is a [free and open source](https://git-scm.com/about/free-and-open-source) distributed version control system. It handles projects of all sizes quickly and diff --git a/doc/topics/git/lfs/index.md b/doc/topics/git/lfs/index.md index fb2aa8df6b7..5907e80b539 100644 --- a/doc/topics/git/lfs/index.md +++ b/doc/topics/git/lfs/index.md @@ -4,7 +4,7 @@ group: Source Code info: "To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments" --- -# Git Large File Storage (LFS) **(FREE ALL)** +# Git Large File Storage (LFS) Managing large files such as audio, video and graphics files has always been one of the shortcomings of Git. The general recommendation is to not have Git repositories @@ -18,7 +18,11 @@ In the repository view, files tracked by Git LFS display an **LFS** badge next t ![Git LFS tracking status](img/lfs_badge_v16_0.png) -## Configure your GitLab server for Git LFS **(FREE SELF)** +## Configure your GitLab server for Git LFS + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed To install Git LFS on your self-managed GitLab server, see [GitLab Git Large File Storage (LFS) Administration](../../../administration/lfs/index.md). diff --git a/doc/topics/git/numerous_undo_possibilities_in_git/index.md b/doc/topics/git/numerous_undo_possibilities_in_git/index.md index bf0f9f243d0..991cbccf69b 100644 --- a/doc/topics/git/numerous_undo_possibilities_in_git/index.md +++ b/doc/topics/git/numerous_undo_possibilities_in_git/index.md @@ -4,7 +4,7 @@ group: Source Code info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Undo options in Git **(FREE ALL)** +# Undo options in Git Git provides options for undoing changes. The method for undoing a change depends on whether the change is unstaged, staged, committed, or pushed. diff --git a/doc/topics/git/partial_clone.md b/doc/topics/git/partial_clone.md index bc73cc36b96..5c847c924a8 100644 --- a/doc/topics/git/partial_clone.md +++ b/doc/topics/git/partial_clone.md @@ -4,7 +4,7 @@ group: Source Code info: "To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments" --- -# Partial clone **(FREE ALL)** +# Partial clone As Git repositories grow in size, they can become cumbersome to work with because of: @@ -21,7 +21,7 @@ Git 2.22.0 or later is required. ## Filter by file size -> [Introduced](https://gitlab.com/gitlab-org/gitaly/-/issues/2553) in GitLab 12.10. +> - [Introduced](https://gitlab.com/gitlab-org/gitaly/-/issues/2553) in GitLab 12.10. Storing large binary files in Git is usually discouraged, because every large file added is downloaded by everyone who clones or fetches changes @@ -68,7 +68,7 @@ When changing branches, Git may download more missing files. ## Filter by object type -> [Introduced](https://gitlab.com/gitlab-org/gitaly/-/issues/2553) in GitLab 12.10. +> - [Introduced](https://gitlab.com/gitlab-org/gitaly/-/issues/2553) in GitLab 12.10. For repositories with millions of files and a long history, you can exclude all files and use [`git sparse-checkout`](https://git-scm.com/docs/git-sparse-checkout) to reduce the size of diff --git a/doc/topics/git/rollback_commits.md b/doc/topics/git/rollback_commits.md index 51be4cb6191..2d320510765 100644 --- a/doc/topics/git/rollback_commits.md +++ b/doc/topics/git/rollback_commits.md @@ -4,7 +4,7 @@ group: Source Code info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Roll back commits **(FREE ALL)** +# Roll back commits In Git, if you make a mistake, you can undo or roll back your changes. For more details, see [Undo options](numerous_undo_possibilities_in_git/index.md). diff --git a/doc/topics/git/stash.md b/doc/topics/git/stash.md index b8288d32be5..c9d3e3201bc 100644 --- a/doc/topics/git/stash.md +++ b/doc/topics/git/stash.md @@ -4,7 +4,7 @@ group: Source Code info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Git stash **(FREE ALL)** +# Git stash Use `git stash` when you want to change to a different branch, and you want to store changes that are not ready to be committed. diff --git a/doc/topics/git/troubleshooting_git.md b/doc/topics/git/troubleshooting_git.md index dd3a2efc11b..8ac67de4343 100644 --- a/doc/topics/git/troubleshooting_git.md +++ b/doc/topics/git/troubleshooting_git.md @@ -4,7 +4,7 @@ group: Source Code info: "To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments" --- -# Troubleshooting Git **(FREE ALL)** +# Troubleshooting Git Sometimes things don't work the way they should or as you might expect when you're using Git. Here are some tips on troubleshooting and resolving issues diff --git a/doc/topics/git/unstage.md b/doc/topics/git/unstage.md index 95958600fb4..f65ca18378f 100644 --- a/doc/topics/git/unstage.md +++ b/doc/topics/git/unstage.md @@ -4,7 +4,7 @@ group: Source Code info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Unstage a file in Git **(FREE ALL)** +# Unstage a file in Git When you _stage_ a file in Git, you instruct Git to track changes to the file in preparation for a commit. To disregard changes to a file, and not diff --git a/doc/topics/manage_code.md b/doc/topics/manage_code.md index 4cbd97f8898..b34f84336b3 100644 --- a/doc/topics/manage_code.md +++ b/doc/topics/manage_code.md @@ -5,7 +5,11 @@ description: Repositories, merge requests, remote development. info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Manage your code **(FREE ALL)** +# Manage your code + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed Store your source files in a repository and create merge requests. Write, debug, and collaborate on code. diff --git a/doc/topics/offline/index.md b/doc/topics/offline/index.md index b463abc79d3..3732e4790c9 100644 --- a/doc/topics/offline/index.md +++ b/doc/topics/offline/index.md @@ -5,7 +5,11 @@ description: Isolated installation. info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Offline GitLab **(FREE SELF)** +# Offline GitLab + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed Computers in an offline environment are isolated from the public internet as a security measure. This page lists all the information available for running GitLab in an offline environment. diff --git a/doc/topics/offline/quick_start_guide.md b/doc/topics/offline/quick_start_guide.md index f5489d53ae0..5596f203780 100644 --- a/doc/topics/offline/quick_start_guide.md +++ b/doc/topics/offline/quick_start_guide.md @@ -4,7 +4,11 @@ group: Distribution info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Install an offline self-managed GitLab instance **(FREE SELF)** +# Install an offline self-managed GitLab instance + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed This is a step-by-step guide that helps you install, configure, and use a self-managed GitLab instance entirely offline. diff --git a/doc/topics/plan_and_track.md b/doc/topics/plan_and_track.md index 61c359e63ba..6a1b1983884 100644 --- a/doc/topics/plan_and_track.md +++ b/doc/topics/plan_and_track.md @@ -5,7 +5,11 @@ description: Epics, issues, milestones, labels. info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Plan and track work **(FREE ALL)** +# Plan and track work + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed Plan your work by creating requirements, issues, and epics. Schedule work with milestones and track your team's time. Learn how to save time with diff --git a/doc/topics/release_your_application.md b/doc/topics/release_your_application.md index d46ae98d47c..d2ee2f2013d 100644 --- a/doc/topics/release_your_application.md +++ b/doc/topics/release_your_application.md @@ -5,7 +5,11 @@ description: Environments, packages, review apps, GitLab Pages. info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Deploy and release your application **(FREE ALL)** +# Deploy and release your application + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed Deployment is the step of the software delivery process when your application gets deployed to its final, target infrastructure. diff --git a/doc/topics/set_up_organization.md b/doc/topics/set_up_organization.md index 22a594b6117..40d56471223 100644 --- a/doc/topics/set_up_organization.md +++ b/doc/topics/set_up_organization.md @@ -5,7 +5,11 @@ description: Users, groups, namespaces, SSH keys. info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Set up your organization **(FREE ALL)** +# Set up your organization + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed Configure your organization and its users. Determine user roles and give everyone access to the projects they need. diff --git a/doc/tutorials/automate_runner_creation/index.md b/doc/tutorials/automate_runner_creation/index.md index 38261933d52..15b4f0c9385 100644 --- a/doc/tutorials/automate_runner_creation/index.md +++ b/doc/tutorials/automate_runner_creation/index.md @@ -4,7 +4,11 @@ group: Tutorials info: For assistance with this tutorial, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments-to-other-projects-and-subjects. --- -# Tutorial: Automate runner creation and registration **(FREE ALL)** +# Tutorial: Automate runner creation and registration + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed This tutorial describes how to automate runner creation and registration. diff --git a/doc/tutorials/boards_for_teams/index.md b/doc/tutorials/boards_for_teams/index.md index 8407605ecde..846e3cc0098 100644 --- a/doc/tutorials/boards_for_teams/index.md +++ b/doc/tutorials/boards_for_teams/index.md @@ -4,7 +4,11 @@ group: Project Management info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Tutorial: Set up issue boards for team hand-off **(PREMIUM ALL)** +# Tutorial: Set up issue boards for team hand-off + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, Self-managed diff --git a/doc/tutorials/compliance_pipeline/index.md b/doc/tutorials/compliance_pipeline/index.md index c906b99cd18..fd63a6d14b3 100644 --- a/doc/tutorials/compliance_pipeline/index.md +++ b/doc/tutorials/compliance_pipeline/index.md @@ -4,7 +4,11 @@ group: Compliance info: For assistance with this tutorial, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments-to-other-projects-and-subjects. --- -# Tutorial: Create a compliance pipeline **(ULTIMATE ALL)** +# Tutorial: Create a compliance pipeline + +DETAILS: +**Tier:** Ultimate +**Offering:** SaaS, self-managed You can use [compliance pipelines](../../user/group/compliance_frameworks.md#compliance-pipelines) to ensure specific compliance-related jobs are run on pipelines for all projects in a group. Compliance pipelines are applied diff --git a/doc/tutorials/configure_gitlab_runner_to_use_gke/index.md b/doc/tutorials/configure_gitlab_runner_to_use_gke/index.md index d73a00f1dfe..77679015f69 100644 --- a/doc/tutorials/configure_gitlab_runner_to_use_gke/index.md +++ b/doc/tutorials/configure_gitlab_runner_to_use_gke/index.md @@ -4,7 +4,11 @@ group: Runner info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Tutorial: Configure GitLab Runner to use the Google Kubernetes Engine **(FREE ALL)** +# Tutorial: Configure GitLab Runner to use the Google Kubernetes Engine + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed This tutorial describes how to configure GitLab Runner to use the Google Kubernetes Engine (GKE) to run jobs. diff --git a/doc/tutorials/container_scanning/index.md b/doc/tutorials/container_scanning/index.md index 31eb14f0a50..0053a81739e 100644 --- a/doc/tutorials/container_scanning/index.md +++ b/doc/tutorials/container_scanning/index.md @@ -4,7 +4,11 @@ group: Composition Analysis info: For assistance with this tutorial, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments-to-other-projects-and-subjects. --- -# Tutorial: Scan a Docker container for vulnerabilities **(FREE ALL)** +# Tutorial: Scan a Docker container for vulnerabilities + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed You can use [container scanning](../../user/application_security/container_scanning/index.md) to check for vulnerabilities in container images stored in the [container registry](../../user/packages/container_registry/index.md). diff --git a/doc/tutorials/convert_personal_namespace_to_group/index.md b/doc/tutorials/convert_personal_namespace_to_group/index.md index 57acf14d981..dddfd7c29a8 100644 --- a/doc/tutorials/convert_personal_namespace_to_group/index.md +++ b/doc/tutorials/convert_personal_namespace_to_group/index.md @@ -4,7 +4,11 @@ group: Tenant Scale info: For assistance with this tutorial, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments-to-other-projects-and-subjects. --- -# Tutorial: Convert a personal namespace into a group **(FREE SAAS)** +# Tutorial: Convert a personal namespace into a group + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS If you've started out on GitLab with a personal [namespace](../../user/namespace/index.md), but now find that you've outgrown its capabilities and its limitations hinder the collaboration on your projects, diff --git a/doc/tutorials/create_register_first_runner/index.md b/doc/tutorials/create_register_first_runner/index.md index 5b57d8f35ea..4c224bb3c47 100644 --- a/doc/tutorials/create_register_first_runner/index.md +++ b/doc/tutorials/create_register_first_runner/index.md @@ -4,7 +4,11 @@ group: Runner info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Tutorial: Create, register, and run your own project runner **(FREE ALL)** +# Tutorial: Create, register, and run your own project runner + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed This tutorial shows you how to configure and run your first runner in GitLab. diff --git a/doc/tutorials/dependency_scanning.md b/doc/tutorials/dependency_scanning.md index 08f6d228ae7..012381ec33f 100644 --- a/doc/tutorials/dependency_scanning.md +++ b/doc/tutorials/dependency_scanning.md @@ -4,7 +4,11 @@ group: Composition Analysis info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Tutorial: Set up dependency scanning **(ULTIMATE SAAS)** +# Tutorial: Set up dependency scanning + +DETAILS: +**Tier:** Ultimate +**Offering:** SaaS Dependency Scanning can automatically find security vulnerabilities in your software dependencies while you're developing and testing your applications. For example, dependency scanning lets you diff --git a/doc/tutorials/export_sbom.md b/doc/tutorials/export_sbom.md index 474bd117b02..3216763fd3d 100644 --- a/doc/tutorials/export_sbom.md +++ b/doc/tutorials/export_sbom.md @@ -4,7 +4,11 @@ group: Composition Analysis info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Tutorial: Export dependency list in SBOM format **(ULTIMATE ALL)** +# Tutorial: Export dependency list in SBOM format + +DETAILS: +**Tier:** Ultimate +**Offering:** SaaS, self-managed Dependency Scanning output can be exported to the CycloneDX JSON format. diff --git a/doc/tutorials/fuzz_testing/index.md b/doc/tutorials/fuzz_testing/index.md index b19cc07ede7..dba9573422e 100644 --- a/doc/tutorials/fuzz_testing/index.md +++ b/doc/tutorials/fuzz_testing/index.md @@ -4,7 +4,11 @@ group: Dynamic Analysis info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Tutorial: Perform fuzz testing in GitLab **(ULTIMATE ALL)** +# Tutorial: Perform fuzz testing in GitLab + +DETAILS: +**Tier:** Ultimate +**Offering:** SaaS, self-managed [Coverage-guided fuzz testing](../../user/application_security/coverage_fuzzing/index.md#coverage-guided-fuzz-testing-process) sends unexpected, malformed, or random data to your application, and then monitors your application for unstable behaviors and crashes. diff --git a/doc/tutorials/install_gitlab_single_node/index.md b/doc/tutorials/install_gitlab_single_node/index.md index 06f3369b1fb..6f6b47ce62a 100644 --- a/doc/tutorials/install_gitlab_single_node/index.md +++ b/doc/tutorials/install_gitlab_single_node/index.md @@ -4,7 +4,11 @@ group: Distribution info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Tutorial: Install and secure a single node GitLab instance **(FREE SELF)** +# Tutorial: Install and secure a single node GitLab instance + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed In this tutorial you will learn how to install and securely configure a single node GitLab instance that can accommodate up to diff --git a/doc/tutorials/issue_triage/index.md b/doc/tutorials/issue_triage/index.md index 5d0dd1dbec1..bd81d597c0a 100644 --- a/doc/tutorials/issue_triage/index.md +++ b/doc/tutorials/issue_triage/index.md @@ -4,7 +4,11 @@ group: Project Management info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Tutorial: Set up a single project for issue triage **(FREE ALL)** +# Tutorial: Set up a single project for issue triage + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed @@ -79,7 +83,11 @@ handbook published with [GitLab Pages](../../user/project/pages/index.md). -## Create scoped labels **(PREMIUM ALL)** +## Create scoped labels + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, Self-managed Next, you'll create labels to add to issues to categorize them. diff --git a/doc/tutorials/left_sidebar/index.md b/doc/tutorials/left_sidebar/index.md index b4833a26ca6..0d56c8a8ba8 100644 --- a/doc/tutorials/left_sidebar/index.md +++ b/doc/tutorials/left_sidebar/index.md @@ -4,9 +4,13 @@ group: Tutorials info: For assistance with this tutorial, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments-to-other-projects-and-subjects. --- -# Tutorial: Use the left sidebar to navigate GitLab **(FREE ALL)** +# Tutorial: Use the left sidebar to navigate GitLab -> [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/9044) in GitLab 16.0. +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed + +> - [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/9044) in GitLab 16.0. Follow this tutorial to learn how to use the new left sidebar to navigate the UI. diff --git a/doc/tutorials/manage_user/index.md b/doc/tutorials/manage_user/index.md index 836d1b71c1d..72a98174284 100644 --- a/doc/tutorials/manage_user/index.md +++ b/doc/tutorials/manage_user/index.md @@ -4,7 +4,11 @@ group: Tutorials info: For assistance with this tutorial, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments-to-other-projects-and-subjects. --- -# Tutorial: Set up your organization **(FREE SELF)** +# Tutorial: Set up your organization + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed In GitLab, you set up and manage your company's GitLab organization by: diff --git a/doc/tutorials/move_personal_project_to_group/index.md b/doc/tutorials/move_personal_project_to_group/index.md index 0abbba3874e..8c141f002aa 100644 --- a/doc/tutorials/move_personal_project_to_group/index.md +++ b/doc/tutorials/move_personal_project_to_group/index.md @@ -4,7 +4,11 @@ group: Tenant Scale info: For assistance with this tutorial, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments-to-other-projects-and-subjects. --- -# Tutorial: Move your personal project to a group **(FREE SAAS)** +# Tutorial: Move your personal project to a group + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS If you created a project under a [personal namespace](../../user/namespace/index.md), you can perform common tasks, like managing issue and merge requests, diff --git a/doc/tutorials/product_analytics_onboarding_website_project/index.md b/doc/tutorials/product_analytics_onboarding_website_project/index.md index b6039cd687b..1bc9bb864a7 100644 --- a/doc/tutorials/product_analytics_onboarding_website_project/index.md +++ b/doc/tutorials/product_analytics_onboarding_website_project/index.md @@ -4,7 +4,12 @@ group: Product Analytics info: For assistance with this tutorial, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments-to-other-projects-and-subjects. --- -# Tutorial: Set up product analytics in a GitLab Pages website project **(ULTIMATE ALL EXPERIMENT)** +# Tutorial: Set up product analytics in a GitLab Pages website project + +DETAILS: +**Tier:** Ultimate +**Offering:** SaaS, self-managed +**Status:** Experiment Understanding how your users engage with your website or application is important for making data-driven decisions. By identifying the most and least used features by your users, your team can decide where and how to spend their time effectively. diff --git a/doc/tutorials/protected_workflow/index.md b/doc/tutorials/protected_workflow/index.md index e9e3739d836..56675715941 100644 --- a/doc/tutorials/protected_workflow/index.md +++ b/doc/tutorials/protected_workflow/index.md @@ -6,7 +6,11 @@ info: "To determine the technical writer assigned to the Stage/Group associated -# Tutorial: Build a protected workflow for your project **(FREE ALL)** +# Tutorial: Build a protected workflow for your project + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed When your team starts a new project, they need a workflow that balances efficiency with appropriate reviews. In GitLab, you can create user groups, combine those diff --git a/doc/tutorials/scan_execution_policy/index.md b/doc/tutorials/scan_execution_policy/index.md index 1e2c91e6c45..264bfe50b40 100644 --- a/doc/tutorials/scan_execution_policy/index.md +++ b/doc/tutorials/scan_execution_policy/index.md @@ -4,7 +4,11 @@ group: Security Policies info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Tutorial: Set up a scan execution policy **(ULTIMATE ALL)** +# Tutorial: Set up a scan execution policy + +DETAILS: +**Tier:** Ultimate +**Offering:** SaaS, self-managed This tutorial shows you how to create and apply a [scan execution policy](../../user/application_security/policies/scan-execution-policies.md). diff --git a/doc/tutorials/scan_result_policy/index.md b/doc/tutorials/scan_result_policy/index.md index 8f31510dfbc..d5fea473b16 100644 --- a/doc/tutorials/scan_result_policy/index.md +++ b/doc/tutorials/scan_result_policy/index.md @@ -4,7 +4,11 @@ group: Security Policies info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Tutorial: Set up a scan result policy **(ULTIMATE ALL)** +# Tutorial: Set up a scan result policy + +DETAILS: +**Tier:** Ultimate +**Offering:** SaaS, self-managed This tutorial shows you how to create and configure a [scan result policy](../../user/application_security/policies/scan-result-policies.md). These policies can be set to take action based on scan results. For example, in this tutorial, you'll set up a policy that requires approval from two specified users if a vulnerability is detected in a merge request. diff --git a/doc/tutorials/update_commit_messages/index.md b/doc/tutorials/update_commit_messages/index.md index 36106dd4f98..1524118506a 100644 --- a/doc/tutorials/update_commit_messages/index.md +++ b/doc/tutorials/update_commit_messages/index.md @@ -4,7 +4,11 @@ group: Source Code info: "To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments" --- -# Tutorial: Update Git commit messages **(FREE ALL)** +# Tutorial: Update Git commit messages + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed Occasionally, after you've made a few commits to your branch, you realize you need to update one or more commit messages. Perhaps you found a typo, or some automation warned you diff --git a/doc/tutorials/website_project_with_analytics/index.md b/doc/tutorials/website_project_with_analytics/index.md index 1f11c5a4593..8238721c434 100644 --- a/doc/tutorials/website_project_with_analytics/index.md +++ b/doc/tutorials/website_project_with_analytics/index.md @@ -4,7 +4,11 @@ group: Optimize info: For assistance with this tutorial, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments-to-other-projects-and-subjects. --- -# Tutorial: Set up an analytics-powered website project **(ULTIMATE ALL)** +# Tutorial: Set up an analytics-powered website project + +DETAILS: +**Tier:** Ultimate +**Offering:** SaaS, self-managed When you work on a complex project (for example, a website), you likely collaborate with other people to build and maintain it. The way you collaborate and communicate in your team can make or break the project, so you want processes in place that help team members follow and achieve the common goal. diff --git a/doc/update/background_migrations.md b/doc/update/background_migrations.md index f1a3f7e7839..764748d1ba8 100644 --- a/doc/update/background_migrations.md +++ b/doc/update/background_migrations.md @@ -4,7 +4,11 @@ group: Database info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Background migrations and upgrades **(FREE SELF)** +# Background migrations and upgrades + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed > - Batched background migrations [introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/51332) in GitLab 13.11 [with a flag](../user/feature_flags.md) named `execute_batched_migrations_on_schedule`. Disabled by default. > - Feature flag `execute_batched_migrations_on_schedule` [enabled by default](https://gitlab.com/gitlab-org/gitlab/-/issues/329511) in GitLab 13.12. @@ -167,7 +171,7 @@ Use the following database queries to see the state of the current batched backg #### Automatic batch size optimization -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/60133) in GitLab 13.2 [with a flag](../administration/feature_flags.md) named `optimize_batched_migrations`. Enabled by default. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/60133) in GitLab 13.2 [with a flag](../administration/feature_flags.md) named `optimize_batched_migrations`. Enabled by default. WARNING: There can be [risks when disabling released features](../administration/feature_flags.md#risks-when-disabling-released-features). @@ -208,7 +212,7 @@ If the migration continues to fail with an error, either: #### Fix and retry the migration -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/67504) in GitLab 14.3. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/67504) in GitLab 14.3. All failed batched background migrations must be resolved to upgrade to a newer version of GitLab. If you [check the status](#check-the-status-of-batched-background-migrations) @@ -251,7 +255,7 @@ on a regular interval. #### Finish a failed migration manually -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/62634) in GitLab 14.1. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/62634) in GitLab 14.1. To manually finish a batched background migration that failed with an error, use the information in the failure error logs or the database: diff --git a/doc/update/background_migrations_troubleshooting.md b/doc/update/background_migrations_troubleshooting.md index f4ea9c2a556..60b89686801 100644 --- a/doc/update/background_migrations_troubleshooting.md +++ b/doc/update/background_migrations_troubleshooting.md @@ -4,7 +4,11 @@ group: Database info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Troubleshooting **(FREE SELF)** +# Troubleshooting + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed diff --git a/doc/update/deprecations.md b/doc/update/deprecations.md index d099ff303e5..bd5f5a3f3e4 100644 --- a/doc/update/deprecations.md +++ b/doc/update/deprecations.md @@ -457,6 +457,28 @@ The GraphQL fields, `isTemporaryStorageIncreaseEnabled` and `temporaryStorageInc
+### Deprecate License Scanning CI templates + +
+- Announced in GitLab 16.9 +- Removal in GitLab 17.0 ([breaking change](https://docs.gitlab.com/ee/update/terminology.html#breaking-change)) +- To discuss this change or learn more, see the [deprecation issue](https://gitlab.com/gitlab-org/gitlab/-/issues/439157). +
+ +GitLab 17.0 removes the License Scanning CI templates: + +- [`Jobs/License-Scanning.gitlab-ci.yml`](https://gitlab.com/gitlab-org/gitlab/-/blob/6d9956863d3cd066edc50a29767c2cd4a939c6fd/lib/gitlab/ci/templates/Jobs/License-Scanning.gitlab-ci.yml) +- [`Jobs/License-Scanning.latest.gitlab-ci.yml`](https://gitlab.com/gitlab-org/gitlab/-/blob/6d9956863d3cd066edc50a29767c2cd4a939c6fd/lib/gitlab/ci/templates/Jobs/License-Scanning.latest.gitlab-ci.yml) +- [`Security/License-Scanning.gitlab-ci.yml`](https://gitlab.com/gitlab-org/gitlab/-/blob/6d9956863d3cd066edc50a29767c2cd4a939c6fd/lib/gitlab/ci/templates/Security/License-Scanning.gitlab-ci.yml) + +CI configurations including any of the templates above will stop working in GitLab 17.0. + +Users are advised to use [License scanning of CycloneDX files](https://docs.gitlab.com/ee/user/compliance/license_scanning_of_cyclonedx_files/) instead. + +
+ +
+ ### Deprecate Maven versions below 3.8.8
diff --git a/doc/update/index.md b/doc/update/index.md index 77e5a2e5130..45b912e9970 100644 --- a/doc/update/index.md +++ b/doc/update/index.md @@ -5,7 +5,11 @@ description: Latest version instructions. info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Upgrade GitLab **(FREE SELF)** +# Upgrade GitLab + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed Upgrading GitLab is a relatively straightforward process, but the complexity can increase based on the installation method you have used, how old your @@ -107,10 +111,13 @@ To address the above two scenarios, it is advised to do the following prior to u as your GitLab version. Both versions [should be the same](https://docs.gitlab.com/runner/#gitlab-runner-versions). 1. Unpause your runners and unblock new jobs from starting by reverting the previous `/etc/gitlab/gitlab.rb` change. -## Checking for pending advanced search migrations **(PREMIUM SELF)** +## Checking for pending advanced search migrations -This section is only applicable if you have enabled the [Elasticsearch integration](../integration/advanced_search/elasticsearch.md) **(PREMIUM SELF)**. +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** Self-managed +This section is only applicable if you have enabled the [Elasticsearch integration](../integration/advanced_search/elasticsearch.md). Major releases require all [advanced search migrations](../integration/advanced_search/elasticsearch.md#advanced-search-migrations) to be finished from the most recent minor release in your current version before the major version upgrade. You can find pending migrations by diff --git a/doc/update/package/convert_to_ee.md b/doc/update/package/convert_to_ee.md index ae89891d4f4..437cfaa19ed 100644 --- a/doc/update/package/convert_to_ee.md +++ b/doc/update/package/convert_to_ee.md @@ -4,7 +4,11 @@ group: Distribution info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Convert Community Edition to Enterprise Edition **(FREE SELF)** +# Convert Community Edition to Enterprise Edition + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed To convert an existing GitLab Community Edition (CE) server installed using the Omnibus GitLab packages to GitLab [Enterprise Edition](https://about.gitlab.com/pricing/) (EE), you install the EE diff --git a/doc/update/package/downgrade.md b/doc/update/package/downgrade.md index ee2ff4ea4bf..40e86020b24 100644 --- a/doc/update/package/downgrade.md +++ b/doc/update/package/downgrade.md @@ -4,7 +4,11 @@ group: Distribution info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Downgrade **(FREE SELF)** +# Downgrade + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed This section contains general information on how to revert to an earlier version of a package. diff --git a/doc/update/package/index.md b/doc/update/package/index.md index 45cce799cb0..9d97450e0c4 100644 --- a/doc/update/package/index.md +++ b/doc/update/package/index.md @@ -4,7 +4,11 @@ group: Distribution info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Upgrade GitLab by using the GitLab package **(FREE SELF)** +# Upgrade GitLab by using the GitLab package + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed You can upgrade GitLab to a new version by using the GitLab package. diff --git a/doc/update/package/package_troubleshooting.md b/doc/update/package/package_troubleshooting.md index 6d83db1fac1..ca959004103 100644 --- a/doc/update/package/package_troubleshooting.md +++ b/doc/update/package/package_troubleshooting.md @@ -4,7 +4,11 @@ group: Distribution info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Troubleshooting **(FREE SELF)** +# Troubleshooting + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed ## Get the status of a GitLab installation diff --git a/doc/update/patch_versions.md b/doc/update/patch_versions.md index 96a2654c579..72ab4bd30fe 100644 --- a/doc/update/patch_versions.md +++ b/doc/update/patch_versions.md @@ -4,7 +4,11 @@ group: Distribution info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Universal update guide for patch versions for self-compiled installations **(FREE SELF)** +# Universal update guide for patch versions for self-compiled installations + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed ## Select Version to Install @@ -99,7 +103,11 @@ sudo -u git -H git checkout v$( [Changed](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/119139) in GitLab 16.0 to have `ci:` section in `config/database.yml.postgresql`. +> - [Changed](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/119139) in GitLab 16.0 to have `ci:` section in `config/database.yml.postgresql`. There might be configuration options available for [`database.yml`](https://gitlab.com/gitlab-org/gitlab/-/blob/master/config/database.yml.postgresql). View them with the command below and apply them manually to your current `database.yml`: diff --git a/doc/update/versions/gitlab_14_changes.md b/doc/update/versions/gitlab_14_changes.md index 68784a27e6b..a51fa459054 100644 --- a/doc/update/versions/gitlab_14_changes.md +++ b/doc/update/versions/gitlab_14_changes.md @@ -4,7 +4,11 @@ group: Distribution info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# GitLab 14 changes **(FREE SELF)** +# GitLab 14 changes + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed This page contains upgrade information for minor and patch versions of GitLab 14. Ensure you review these instructions for: @@ -110,7 +114,11 @@ For more information about upgrading GitLab Helm Chart, see [the release notes f For more information, see [issue 364763](https://gitlab.com/gitlab-org/gitlab/-/issues/364763). -### Geo installations **(PREMIUM SELF)** +### Geo installations + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** Self-managed - **Do not** upgrade to GitLab 14.9.0. Instead, use 14.9.1 or later. @@ -203,7 +211,11 @@ For more information about upgrading GitLab Helm Chart, see [the release notes f If your instance has Redis HA with Sentinel, follow the upgrade steps documented in [Redis HA (using Sentinel)](../zero_downtime.md#redis-ha-using-sentinel). -### Geo installations **(PREMIUM SELF)** +### Geo installations + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** Self-managed - LFS objects import and mirror issue in GitLab 14.6.0 to 14.7.2. When Geo is enabled, LFS objects fail to be saved for imported or mirrored projects. @@ -225,7 +237,11 @@ For more information about upgrading GitLab Helm Chart, see [the release notes f - If upgrading from a version earlier than 14.6.5, 14.7.4, or 14.8.2, review the [Critical Security Release: 14.8.2, 14.7.4, and 14.6.5](https://about.gitlab.com/releases/2022/02/25/critical-security-release-gitlab-14-8-2-released/) blog post. Updating to 14.6.5 or later resets runner registration tokens for your groups and projects. -### Geo installations **(PREMIUM SELF)** +### Geo installations + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** Self-managed - LFS objects import and mirror issue in GitLab 14.6.0 to 14.7.2. When Geo is enabled, LFS objects fail to be saved for imported or mirrored projects. @@ -309,7 +325,11 @@ For more information about upgrading GitLab Helm Chart, see [the release notes f are using a self-compiled installation, update paths to these binaries in your [systemd unit files](../upgrading_from_source.md#configure-systemd-units) or [init scripts](../upgrading_from_source.md#configure-sysv-init-script) by [following the documentation](../upgrading_from_source.md). -### Geo installations **(PREMIUM SELF)** +### Geo installations + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** Self-managed - There is [an issue in GitLab 14.2 through 14.7](https://gitlab.com/gitlab-org/gitlab/-/issues/299819#note_822629467) that affects Geo when the GitLab-managed object storage replication is used, causing blob object types to fail synchronization. @@ -334,7 +354,11 @@ For more information about upgrading GitLab Helm Chart, see [the release notes f ## 14.4.1 and 14.4.2 -### Geo installations **(PREMIUM SELF)** +### Geo installations + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** Self-managed - There is [an issue in GitLab 14.4.0 through 14.4.2](#1440) that can affect Geo and other features that rely on cronjobs. We recommend upgrading to GitLab 14.4.3 or later. @@ -385,7 +409,11 @@ For more information about upgrading GitLab Helm Chart, see [the release notes f the downgrade. If the errors persist after a Grafana restart you may need to reset the Grafana db and re-add the customizations. The Grafana database can be reset with `sudo gitlab-ctl reset-grafana`. -### Geo installations **(PREMIUM SELF)** +### Geo installations + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** Self-managed - There is [an issue in GitLab 14.2 through 14.7](https://gitlab.com/gitlab-org/gitlab/-/issues/299819#note_822629467) that affects Geo when the GitLab-managed object storage replication is used, causing blob object types to fail synchronization. @@ -552,7 +580,11 @@ For more information about upgrading GitLab Helm Chart, see [the release notes f - Ruby 2.7.4 is required. Refer to [the Ruby installation instructions](../../install/installation.md#2-ruby) for how to proceed. -### Geo installations **(PREMIUM SELF)** +### Geo installations + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** Self-managed - There is [an issue in GitLab 14.2 through 14.7](https://gitlab.com/gitlab-org/gitlab/-/issues/299819#note_822629467) that affects Geo when the GitLab-managed object storage replication is used, causing blob object types to fail synchronization. @@ -653,7 +685,11 @@ For more information about upgrading GitLab Helm Chart, see [the release notes f - If you encounter the error, `I18n::InvalidLocale: :en is not a valid locale`, when starting the application, follow the [patching](https://about.gitlab.com/handbook/support/workflows/patching_an_instance.html) process. Use [123476](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/123476) as the `mr_iid`. -### Geo installations **(PREMIUM SELF)** +### Geo installations + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** Self-managed - There is [an issue in GitLab 14.2 through 14.7](https://gitlab.com/gitlab-org/gitlab/-/issues/299819#note_822629467) that affects Geo when the GitLab-managed object storage replication is used, causing blob object types to fail synchronization. @@ -732,7 +768,11 @@ For more information about upgrading GitLab Helm Chart, see [the release notes f - If you encounter the error, `I18n::InvalidLocale: :en is not a valid locale`, when starting the application, follow the [patching](https://about.gitlab.com/handbook/support/workflows/patching_an_instance.html) process. Use [123475](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/123475) as the `mr_iid`. -### Geo installations **(PREMIUM SELF)** +### Geo installations + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** Self-managed - We found an [issue](https://gitlab.com/gitlab-org/gitlab/-/issues/336013) where the container registry replication wasn't fully working if you used multi-arch images. In case of a multi-arch image, only the primary architecture @@ -889,7 +929,11 @@ Other issues: The following invalid roles have been set in 'roles': redis_slave_role ``` -### Geo installations **(PREMIUM SELF)** +### Geo installations + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** Self-managed - We found an issue where [Primary sites cannot be removed from the UI](https://gitlab.com/gitlab-org/gitlab/-/issues/338231). diff --git a/doc/update/versions/gitlab_15_changes.md b/doc/update/versions/gitlab_15_changes.md index c1eb034f7f5..564b1d7c988 100644 --- a/doc/update/versions/gitlab_15_changes.md +++ b/doc/update/versions/gitlab_15_changes.md @@ -4,7 +4,11 @@ group: Distribution info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# GitLab 15 changes **(FREE SELF)** +# GitLab 15 changes + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed This page contains upgrade information for minor and patch versions of GitLab 15. Ensure you review these instructions for: @@ -36,7 +40,11 @@ In GitLab 15.11, PostgreSQL will automatically be upgraded to 13.x except for th Fault-tolerant and Geo installations support manual upgrades to PostgreSQL 13, see [Packaged PostgreSQL deployed in an HA/Geo Cluster](https://docs.gitlab.com/omnibus/settings/database.html#packaged-postgresql-deployed-in-an-hageo-cluster). -### Geo installations **(PREMIUM SELF)** +### Geo installations + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** Self-managed - Some project imports do not initialize wiki repositories on project creation. See [the details and workaround](gitlab_16_changes.md#wiki-repositories-not-initialized-on-project-creation). @@ -132,7 +140,11 @@ if you can't upgrade to 15.11.12 and later. For more information, see [issue 415724](https://gitlab.com/gitlab-org/gitlab/-/issues/415724). -### Geo installations **(PREMIUM SELF)** +### Geo installations + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** Self-managed - `pg_upgrade` fails to upgrade the bundled PostregSQL database to version 13. See [the details and workaround](#pg_upgrade-fails-to-upgrade-the-bundled-postregsql-database-to-version-13). @@ -178,7 +190,11 @@ if you can't upgrade to 15.11.12 and later. sudo apt install libkrb5-dev ``` -### Geo installations **(PREMIUM SELF)** +### Geo installations + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** Self-managed - `pg_upgrade` fails to upgrade the bundled PostregSQL database to version 13. See [the details and workaround](#pg_upgrade-fails-to-upgrade-the-bundled-postregsql-database-to-version-13). @@ -186,7 +202,11 @@ if you can't upgrade to 15.11.12 and later. ## 15.8.2 -### Geo installations **(PREMIUM SELF)** +### Geo installations + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** Self-managed - We discovered an issue where [replication and verification of projects and wikis was not keeping up](https://gitlab.com/gitlab-org/gitlab/-/issues/387980) on small number of Geo installations. Your installation may be affected if you see some projects and/or wikis persistently in the "Queued" state for verification. This can lead to data loss after a failover. - Affected versions: GitLab versions 15.6.x, 15.7.x, and 15.8.0 - 15.8.2. @@ -196,7 +216,11 @@ if you can't upgrade to 15.11.12 and later. - Due to [a bug introduced in GitLab 15.4](https://gitlab.com/gitlab-org/gitlab/-/issues/390155), if one or more Git repositories in Gitaly Cluster is [unavailable](../../administration/gitaly/recovery.md#unavailable-repositories), then [Repository checks](../../administration/repository_checks.md#repository-checks) and [Geo replication and verification](../../administration/geo/index.md) stop running for all project or project wiki repositories in the affected Gitaly Cluster. The bug was fixed by [reverting the change in GitLab 15.9.0](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/110823). Before upgrading to this version, check if you have any "unavailable" repositories. See [the bug issue](https://gitlab.com/gitlab-org/gitlab/-/issues/390155) for more information. -### Geo installations **(PREMIUM SELF)** +### Geo installations + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** Self-managed - We discovered an issue where [replication and verification of projects and wikis was not keeping up](https://gitlab.com/gitlab-org/gitlab/-/issues/387980) on small number of Geo installations. Your installation may be affected if you see some projects and/or wikis persistently in the "Queued" state for verification. This can lead to data loss after a failover. - Affected versions: GitLab versions 15.6.x, 15.7.x, and 15.8.0 - 15.8.2. @@ -207,7 +231,11 @@ if you can't upgrade to 15.11.12 and later. - Git 2.38.0 and later is required by Gitaly. For self-compiled installations, you should use the [Git version provided by Gitaly](../../install/installation.md#git). - Due to [a bug introduced in GitLab 15.4](https://gitlab.com/gitlab-org/gitlab/-/issues/390155), if one or more Git repositories in Gitaly Cluster is [unavailable](../../administration/gitaly/recovery.md#unavailable-repositories), then [Repository checks](../../administration/repository_checks.md#repository-checks) and [Geo replication and verification](../../administration/geo/index.md) stop running for all project or project wiki repositories in the affected Gitaly Cluster. The bug was fixed by [reverting the change in GitLab 15.9.0](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/110823). Before upgrading to this version, check if you have any "unavailable" repositories. See [the bug issue](https://gitlab.com/gitlab-org/gitlab/-/issues/390155) for more information. -### Geo installations **(PREMIUM SELF)** +### Geo installations + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** Self-managed - `pg_upgrade` fails to upgrade the bundled PostregSQL database to version 13. See [the details and workaround](#pg_upgrade-fails-to-upgrade-the-bundled-postregsql-database-to-version-13). @@ -220,7 +248,11 @@ if you can't upgrade to 15.11.12 and later. - Due to [a bug introduced in GitLab 15.4](https://gitlab.com/gitlab-org/gitlab/-/issues/390155), if one or more Git repositories in Gitaly Cluster is [unavailable](../../administration/gitaly/recovery.md#unavailable-repositories), then [Repository checks](../../administration/repository_checks.md#repository-checks) and [Geo replication and verification](../../administration/geo/index.md) stop running for all project or project wiki repositories in the affected Gitaly Cluster. The bug was fixed by [reverting the change in GitLab 15.9.0](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/110823). Before upgrading to this version, check if you have any "unavailable" repositories. See [the bug issue](https://gitlab.com/gitlab-org/gitlab/-/issues/390155) for more information. -### Geo installations **(PREMIUM SELF)** +### Geo installations + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** Self-managed - We discovered an issue where [replication and verification of projects and wikis was not keeping up](https://gitlab.com/gitlab-org/gitlab/-/issues/387980) on small number of Geo installations. Your installation may be affected if you see some projects and/or wikis persistently in the "Queued" state for verification. This can lead to data loss after a failover. - Affected versions: GitLab versions 15.6.x, 15.7.x, and 15.8.0 - 15.8.2. @@ -230,7 +262,11 @@ if you can't upgrade to 15.11.12 and later. - Due to [a bug introduced in GitLab 15.4](https://gitlab.com/gitlab-org/gitlab/-/issues/390155), if one or more Git repositories in Gitaly Cluster is [unavailable](../../administration/gitaly/recovery.md#unavailable-repositories), then [Repository checks](../../administration/repository_checks.md#repository-checks) and [Geo replication and verification](../../administration/geo/index.md) stop running for all project or project wiki repositories in the affected Gitaly Cluster. The bug was fixed by [reverting the change in GitLab 15.9.0](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/110823). Before upgrading to this version, check if you have any "unavailable" repositories. See [the bug issue](https://gitlab.com/gitlab-org/gitlab/-/issues/390155) for more information. -### Geo installations **(PREMIUM SELF)** +### Geo installations + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** Self-managed - We discovered an issue where [replication and verification of projects and wikis was not keeping up](https://gitlab.com/gitlab-org/gitlab/-/issues/387980) on small number of Geo installations. Your installation may be affected if you see some projects and/or wikis persistently in the "Queued" state for verification. This can lead to data loss after a failover. - Affected versions: GitLab versions 15.6.x, 15.7.x, and 15.8.0 - 15.8.2. @@ -240,7 +276,11 @@ if you can't upgrade to 15.11.12 and later. - Due to [a bug introduced in GitLab 15.4](https://gitlab.com/gitlab-org/gitlab/-/issues/390155), if one or more Git repositories in Gitaly Cluster is [unavailable](../../administration/gitaly/recovery.md#unavailable-repositories), then [Repository checks](../../administration/repository_checks.md#repository-checks) and [Geo replication and verification](../../administration/geo/index.md) stop running for all project or project wiki repositories in the affected Gitaly Cluster. The bug was fixed by [reverting the change in GitLab 15.9.0](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/110823). Before upgrading to this version, check if you have any "unavailable" repositories. See [the bug issue](https://gitlab.com/gitlab-org/gitlab/-/issues/390155) for more information. -### Geo installations **(PREMIUM SELF)** +### Geo installations + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** Self-managed - We discovered an issue where [replication and verification of projects and wikis was not keeping up](https://gitlab.com/gitlab-org/gitlab/-/issues/387980) on small number of Geo installations. Your installation may be affected if you see some projects and/or wikis persistently in the "Queued" state for verification. This can lead to data loss after a failover. - Affected versions: GitLab versions 15.6.x, 15.7.x, and 15.8.0 - 15.8.2. @@ -250,7 +290,11 @@ if you can't upgrade to 15.11.12 and later. - Due to [a bug introduced in GitLab 15.4](https://gitlab.com/gitlab-org/gitlab/-/issues/390155), if one or more Git repositories in Gitaly Cluster is [unavailable](../../administration/gitaly/recovery.md#unavailable-repositories), then [Repository checks](../../administration/repository_checks.md#repository-checks) and [Geo replication and verification](../../administration/geo/index.md) stop running for all project or project wiki repositories in the affected Gitaly Cluster. The bug was fixed by [reverting the change in GitLab 15.9.0](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/110823). Before upgrading to this version, check if you have any "unavailable" repositories. See [the bug issue](https://gitlab.com/gitlab-org/gitlab/-/issues/390155) for more information. -### Geo installations **(PREMIUM SELF)** +### Geo installations + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** Self-managed - We discovered an issue where [replication and verification of projects and wikis was not keeping up](https://gitlab.com/gitlab-org/gitlab/-/issues/387980) on small number of Geo installations. Your installation may be affected if you see some projects and/or wikis persistently in the "Queued" state for verification. This can lead to data loss after a failover. - Affected versions: GitLab versions 15.6.x, 15.7.x, and 15.8.0 - 15.8.2. @@ -260,7 +304,11 @@ if you can't upgrade to 15.11.12 and later. - Due to [a bug introduced in GitLab 15.4](https://gitlab.com/gitlab-org/gitlab/-/issues/390155), if one or more Git repositories in Gitaly Cluster is [unavailable](../../administration/gitaly/recovery.md#unavailable-repositories), then [Repository checks](../../administration/repository_checks.md#repository-checks) and [Geo replication and verification](../../administration/geo/index.md) stop running for all project or project wiki repositories in the affected Gitaly Cluster. The bug was fixed by [reverting the change in GitLab 15.9.0](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/110823). Before upgrading to this version, check if you have any "unavailable" repositories. See [the bug issue](https://gitlab.com/gitlab-org/gitlab/-/issues/390155) for more information. -### Geo installations **(PREMIUM SELF)** +### Geo installations + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** Self-managed - [Container registry push events are rejected](https://gitlab.com/gitlab-org/gitlab/-/issues/386389) by the `/api/v4/container_registry_event/events` endpoint resulting in Geo secondary sites not being aware of updates to container registry images and subsequently not replicating the upgrades. Secondary sites may contain out of date container images after a failover as a consequence. This affects versions 15.6.0 - 15.6.6 and 15.7.0 - 15.7.2. If you're using Geo with container repositories, you are advised to upgrade to GitLab 15.6.7, 15.7.3, or 15.8.0 which contain a fix for this issue and avoid potential data loss after a failover. - We discovered an issue where [replication and verification of projects and wikis was not keeping up](https://gitlab.com/gitlab-org/gitlab/-/issues/387980) on small number of Geo installations. Your installation may be affected if you see some projects and/or wikis persistently in the "Queued" state for verification. This can lead to data loss after a failover. @@ -271,7 +319,11 @@ if you can't upgrade to 15.11.12 and later. - Due to [a bug introduced in GitLab 15.4](https://gitlab.com/gitlab-org/gitlab/-/issues/390155), if one or more Git repositories in Gitaly Cluster is [unavailable](../../administration/gitaly/recovery.md#unavailable-repositories), then [Repository checks](../../administration/repository_checks.md#repository-checks) and [Geo replication and verification](../../administration/geo/index.md) stop running for all project or project wiki repositories in the affected Gitaly Cluster. The bug was fixed by [reverting the change in GitLab 15.9.0](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/110823). Before upgrading to this version, check if you have any "unavailable" repositories. See [the bug issue](https://gitlab.com/gitlab-org/gitlab/-/issues/390155) for more information. -### Geo installations **(PREMIUM SELF)** +### Geo installations + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** Self-managed - [Container registry push events are rejected](https://gitlab.com/gitlab-org/gitlab/-/issues/386389) by the `/api/v4/container_registry_event/events` endpoint resulting in Geo secondary sites not being aware of updates to container registry images and subsequently not replicating the updates. Secondary sites may contain out of date container images after a failover as a consequence. This affects versions 15.6.0 - 15.6.6 and 15.7.0 - 15.7.2. If you're using Geo with container repositories, you are advised to upgrade to GitLab 15.6.7, 15.7.3, or 15.8.0 which contain a fix for this issue and avoid potential data loss after a failover. - We discovered an issue where [replication and verification of projects and wikis was not keeping up](https://gitlab.com/gitlab-org/gitlab/-/issues/387980) on small number of Geo installations. Your installation may be affected if you see some projects and/or wikis persistently in the "Queued" state for verification. This can lead to data loss after a failover. @@ -329,7 +381,11 @@ if you can't upgrade to 15.11.12 and later. - Due to [a bug introduced in GitLab 15.4](https://gitlab.com/gitlab-org/gitlab/-/issues/390155), if one or more Git repositories in Gitaly Cluster is [unavailable](../../administration/gitaly/recovery.md#unavailable-repositories), then [Repository checks](../../administration/repository_checks.md#repository-checks) and [Geo replication and verification](../../administration/geo/index.md) stop running for all project or project wiki repositories in the affected Gitaly Cluster. The bug was fixed by [reverting the change in GitLab 15.9.0](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/110823). Before upgrading to this version, check if you have any "unavailable" repositories. See [the bug issue](https://gitlab.com/gitlab-org/gitlab/-/issues/390155) for more information. - Cloning LFS objects from secondary site downloads from the primary site even when secondary is fully synced. See [the details and workaround](gitlab_16_changes.md#cloning-lfs-objects-from-secondary-site-downloads-from-the-primary-site-even-when-secondary-is-fully-synced). -### Geo installations **(PREMIUM SELF)** +### Geo installations + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** Self-managed - `pg_upgrade` fails to upgrade the bundled PostregSQL database to version 13. See [the details and workaround](#pg_upgrade-fails-to-upgrade-the-bundled-postregsql-database-to-version-13). @@ -342,7 +398,11 @@ if you can't upgrade to 15.11.12 and later. - Due to [a bug introduced in GitLab 15.4](https://gitlab.com/gitlab-org/gitlab/-/issues/390155), if one or more Git repositories in Gitaly Cluster is [unavailable](../../administration/gitaly/recovery.md#unavailable-repositories), then [Repository checks](../../administration/repository_checks.md#repository-checks) and [Geo replication and verification](../../administration/geo/index.md) stop running for all project or project wiki repositories in the affected Gitaly Cluster. The bug was fixed by [reverting the change in GitLab 15.9.0](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/110823). Before upgrading to this version, check if you have any "unavailable" repositories. See [the bug issue](https://gitlab.com/gitlab-org/gitlab/-/issues/390155) for more information. -### Geo installations **(PREMIUM SELF)** +### Geo installations + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** Self-managed - We discovered an issue where [replication and verification of projects and wikis was not keeping up](https://gitlab.com/gitlab-org/gitlab/-/issues/387980) on small number of Geo installations. Your installation may be affected if you see some projects and/or wikis persistently in the "Queued" state for verification. This can lead to data loss after a failover. - Affected versions: GitLab versions 15.6.x, 15.7.x, and 15.8.0 - 15.8.2. @@ -352,7 +412,11 @@ if you can't upgrade to 15.11.12 and later. - Due to [a bug introduced in GitLab 15.4](https://gitlab.com/gitlab-org/gitlab/-/issues/390155), if one or more Git repositories in Gitaly Cluster is [unavailable](../../administration/gitaly/recovery.md#unavailable-repositories), then [Repository checks](../../administration/repository_checks.md#repository-checks) and [Geo replication and verification](../../administration/geo/index.md) stop running for all project or project wiki repositories in the affected Gitaly Cluster. The bug was fixed by [reverting the change in GitLab 15.9.0](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/110823). Before upgrading to this version, check if you have any "unavailable" repositories. See [the bug issue](https://gitlab.com/gitlab-org/gitlab/-/issues/390155) for more information. -### Geo installations **(PREMIUM SELF)** +### Geo installations + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** Self-managed - [Container registry push events are rejected](https://gitlab.com/gitlab-org/gitlab/-/issues/386389) by the `/api/v4/container_registry_event/events` endpoint resulting in Geo secondary sites not being aware of updates to container registry images and subsequently not replicating the updates. Secondary sites may contain out of date container images after a failover as a consequence. This affects versions 15.6.0 - 15.6.6 and 15.7.0 - 15.7.2. If you're using Geo with container repositories, you are advised to upgrade to GitLab 15.6.7, 15.7.3, or 15.8.0 which contain a fix for this issue and avoid potential data loss after a failover. - We discovered an issue where [replication and verification of projects and wikis was not keeping up](https://gitlab.com/gitlab-org/gitlab/-/issues/387980) on small number of Geo installations. Your installation may be affected if you see some projects and/or wikis persistently in the "Queued" state for verification. This can lead to data loss after a failover. @@ -361,7 +425,11 @@ if you can't upgrade to 15.11.12 and later. ## 15.6.5 -### Geo installations **(PREMIUM SELF)** +### Geo installations + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** Self-managed - [Container registry push events are rejected](https://gitlab.com/gitlab-org/gitlab/-/issues/386389) by the `/api/v4/container_registry_event/events` endpoint resulting in Geo secondary sites not being aware of updates to container registry images and subsequently not replicating the updates. Secondary sites may contain out of date container images after a failover as a consequence. This affects versions 15.6.0 - 15.6.6 and 15.7.0 - 15.7.2. If you're using Geo with container repositories, you are advised to upgrade to GitLab 15.6.7, 15.7.3, or 15.8.0 which contain a fix for this issue and avoid potential data loss after a failover. - We discovered an issue where [replication and verification of projects and wikis was not keeping up](https://gitlab.com/gitlab-org/gitlab/-/issues/387980) on small number of Geo installations. Your installation may be affected if you see some projects and/or wikis persistently in the "Queued" state for verification. This can lead to data loss after a failover. @@ -371,7 +439,11 @@ if you can't upgrade to 15.11.12 and later. ## 15.6.4 -### Geo installations **(PREMIUM SELF)** +### Geo installations + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** Self-managed - [Container registry push events are rejected](https://gitlab.com/gitlab-org/gitlab/-/issues/386389) by the `/api/v4/container_registry_event/events` endpoint resulting in Geo secondary sites not being aware of updates to container registry images and subsequently not replicating the updates. Secondary sites may contain out of date container images after a failover as a consequence. This affects versions 15.6.0 - 15.6.6, and 15.7.0 - 15.7.2. If you're using Geo with container repositories, you are advised to upgrade to GitLab 15.6.7, 15.7.3, or 15.8.0 which contain a fix for this issue and avoid potential data loss after a failover. - We discovered an issue where [replication and verification of projects and wikis was not keeping up](https://gitlab.com/gitlab-org/gitlab/-/issues/387980) on small number of Geo installations. Your installation may be affected if you see some projects and/or wikis persistently in the "Queued" state for verification. This can lead to data loss after a failover. @@ -381,7 +453,11 @@ if you can't upgrade to 15.11.12 and later. ## 15.6.3 -### Geo installations **(PREMIUM SELF)** +### Geo installations + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** Self-managed - [Container registry push events are rejected](https://gitlab.com/gitlab-org/gitlab/-/issues/386389) by the `/api/v4/container_registry_event/events` endpoint resulting in Geo secondary sites not being aware of updates to container registry images and subsequently not replicating the updates. Secondary sites may contain out of date container images after a failover as a consequence. This affects versions 15.6.0 - 15.6.6 and 15.7.0 - 15.7.2. If you're using Geo with container repositories, you are advised to upgrade to GitLab 15.6.7, 15.7.3, or 15.8.0 which contain a fix for this issue and avoid potential data loss after a failover. - We discovered an issue where [replication and verification of projects and wikis was not keeping up](https://gitlab.com/gitlab-org/gitlab/-/issues/387980) on small number of Geo installations. Your installation may be affected if you see some projects and/or wikis persistently in the "Queued" state for verification. This can lead to data loss after a failover. @@ -391,7 +467,11 @@ if you can't upgrade to 15.11.12 and later. ## 15.6.2 -### Geo installations **(PREMIUM SELF)** +### Geo installations + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** Self-managed - [Container registry push events are rejected](https://gitlab.com/gitlab-org/gitlab/-/issues/386389) by the `/api/v4/container_registry_event/events` endpoint resulting in Geo secondary sites not being aware of updates to container registry images and subsequently not replicating the updates. Secondary sites may contain out of date container images after a failover as a consequence. This affects versions 15.6.0 - 15.6.6 and 15.7.0 - 15.7.2. If you're using Geo with container repositories, you are advised to upgrade to GitLab 15.6.7, 15.7.3, or 15.8.0 which contain a fix for this issue and avoid potential data loss after a failover. - We discovered an issue where [replication and verification of projects and wikis was not keeping up](https://gitlab.com/gitlab-org/gitlab/-/issues/387980) on small number of Geo installations. Your installation may be affected if you see some projects and/or wikis persistently in the "Queued" state for verification. This can lead to data loss after a failover. @@ -401,7 +481,11 @@ if you can't upgrade to 15.11.12 and later. ## 15.6.1 -### Geo installations **(PREMIUM SELF)** +### Geo installations + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** Self-managed - [Container registry push events are rejected](https://gitlab.com/gitlab-org/gitlab/-/issues/386389) by the `/api/v4/container_registry_event/events` endpoint resulting in Geo secondary sites not being aware of updates to container registry images and subsequently not replicating the updates. Secondary sites may contain out of date container images after a failover as a consequence. This affects versions 15.6.0 - 15.6.6 and 15.7.0 - 15.7.2. If you're using Geo with container repositories, you are advised to upgrade to GitLab 15.6.7, 15.7.3, or 15.8.0 which contain a fix for this issue and avoid potential data loss after a failover. - We discovered an issue where [replication and verification of projects and wikis was not keeping up](https://gitlab.com/gitlab-org/gitlab/-/issues/387980) on small number of Geo installations. Your installation may be affected if you see some projects and/or wikis persistently in the "Queued" state for verification. This can lead to data loss after a failover. @@ -436,7 +520,11 @@ have been upgraded to 12.12 and 13.8. Unless this can cause an automatic restart of the PostgreSQL service, and can potentially cause downtime. -### Geo installations **(PREMIUM SELF)** +### Geo installations + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** Self-managed - `pg_upgrade` fails to upgrade the bundled PostregSQL database to version 13. See [the details and workaround](#pg_upgrade-fails-to-upgrade-the-bundled-postregsql-database-to-version-13). @@ -503,7 +591,11 @@ potentially cause downtime. - Due to [a bug introduced in GitLab 15.4](https://gitlab.com/gitlab-org/gitlab/-/issues/390155), if one or more Git repositories in Gitaly Cluster is [unavailable](../../administration/gitaly/recovery.md#unavailable-repositories), then [Repository checks](../../administration/repository_checks.md#repository-checks) and [Geo replication and verification](../../administration/geo/index.md) stop running for all project or project wiki repositories in the affected Gitaly Cluster. The bug was fixed by [reverting the change in GitLab 15.9.0](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/110823). Before upgrading to this version, check if you have any "unavailable" repositories. See [the bug issue](https://gitlab.com/gitlab-org/gitlab/-/issues/390155) for more information. -### Geo installations **(PREMIUM SELF)** +### Geo installations + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** Self-managed - `pg_upgrade` fails to upgrade the bundled PostregSQL database to version 13. See [the details and workaround](#pg_upgrade-fails-to-upgrade-the-bundled-postregsql-database-to-version-13). @@ -578,7 +670,11 @@ potentially cause downtime. Feature.disable(:restyle_login_page) ``` -### Geo installations **(PREMIUM SELF)** +### Geo installations + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** Self-managed - `pg_upgrade` fails to upgrade the bundled PostregSQL database to version 13. See [the details and workaround](#pg_upgrade-fails-to-upgrade-the-bundled-postregsql-database-to-version-13). @@ -649,7 +745,11 @@ A [license caching issue](https://gitlab.com/gitlab-org/gitlab/-/issues/376706) - 15.3.0 - 15.3.4 --> 15.3.5 - 15.4.1 --> 15.4.3 -### Geo installations **(PREMIUM SELF)** +### Geo installations + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** Self-managed - `pg_upgrade` fails to upgrade the bundled PostregSQL database to version 13. See [the details and workaround](#pg_upgrade-fails-to-upgrade-the-bundled-postregsql-database-to-version-13). @@ -722,7 +822,11 @@ A [license caching issue](https://gitlab.com/gitlab-org/gitlab/-/issues/376706) 1. Add `gitaly['runtime_dir'] = ''` to `/etc/gitlab/gitlab.rb` and specify a location without `noexec` set. 1. Run `sudo gitlab-ctl reconfigure`. -### Geo installations **(PREMIUM SELF)** +### Geo installations + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** Self-managed - `pg_upgrade` fails to upgrade the bundled PostregSQL database to version 13. See [the details and workaround](#pg_upgrade-fails-to-upgrade-the-bundled-postregsql-database-to-version-13). @@ -762,7 +866,11 @@ A [license caching issue](https://gitlab.com/gitlab-org/gitlab/-/issues/376706) Before you upgrade to GitLab 15.1, add an [access token](../../api/rest/index.md#authentication) to your requests. The user creating the token must have [permission](../../user/permissions.md) to create pipelines in the project. -### Geo installations **(PREMIUM SELF)** +### Geo installations + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** Self-managed - [Geo proxying](../../administration/geo/secondary_proxy/index.md) was [enabled by default for different URLs](https://gitlab.com/gitlab-org/gitlab/-/issues/346112) in 15.1. This may be a breaking change. If needed, you may [disable Geo proxying](../../administration/geo/secondary_proxy/index.md#disable-geo-proxying). If you are using SAML with different URLs, you must modify your SAML configuration and your Identity Provider configuration. For more information, see the [Geo with Single Sign-On (SSO) documentation](../../administration/geo/replication/single_sign_on.md). - LFS transfers can redirect to the primary from secondary site mid-session. See @@ -941,7 +1049,11 @@ A [license caching issue](https://gitlab.com/gitlab-org/gitlab/-/issues/376706) ... ``` -### Geo installations **(PREMIUM SELF)** +### Geo installations + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** Self-managed - Incorrect object storage LFS files deletion on Geo secondary sites. See [the details and workaround](#incorrect-object-storage-lfs-file-deletion-on-secondary-sites). diff --git a/doc/update/versions/gitlab_16_changes.md b/doc/update/versions/gitlab_16_changes.md index 4948db7bd29..a4b32f0e2d1 100644 --- a/doc/update/versions/gitlab_16_changes.md +++ b/doc/update/versions/gitlab_16_changes.md @@ -4,7 +4,11 @@ group: Distribution info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# GitLab 16 changes **(FREE SELF)** +# GitLab 16 changes + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed This page contains upgrade information for minor and patch versions of GitLab 16. Ensure you review these instructions for: @@ -593,7 +597,11 @@ Workaround: A possible workaround is to [disable proxying](../../administration/ [removed](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/118645). For more information, see the [`puma.rb.example`](https://gitlab.com/gitlab-org/gitlab/-/blob/16-0-stable-ee/config/puma.rb.example) file. -### Geo installations **(PREMIUM SELF)** +### Geo installations + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** Self-managed Specific information applies to installations using Geo: @@ -672,7 +680,11 @@ Specific information applies to Linux package installations: - [Migrate your Gitaly configuration to the new structure](#gitaly-configuration-structure-change) to ensure all your `gitaly['..']` settings continue to work in GitLab 16.0 and later. -### Geo installations **(PREMIUM SELF)** +### Geo installations + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** Self-managed Specific information applies to installations using Geo: diff --git a/doc/update/with_downtime.md b/doc/update/with_downtime.md index bd8c17fae50..c9ab938c368 100644 --- a/doc/update/with_downtime.md +++ b/doc/update/with_downtime.md @@ -4,7 +4,11 @@ group: Distribution info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Multi-node upgrades with downtime **(FREE SELF)** +# Multi-node upgrades with downtime + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed While you can upgrade a multi-node GitLab deployment [with zero downtime](zero_downtime.md), there are a number of constraints. In particular, you can upgrade to only one minor release @@ -164,7 +168,11 @@ PgBouncer are upgraded as part of the application server upgrade. Upgrade a standalone Redis server by [upgrading the GitLab package](package/index.md#upgrade-to-a-specific-version-using-the-official-repositories). -## Upgrade Redis HA (using Sentinel) **(PREMIUM SELF)** +## Upgrade Redis HA (using Sentinel) + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** Self-managed Follow [the zero downtime instructions](zero_downtime.md#redis-ha-using-sentinel) for upgrading your Redis HA cluster. diff --git a/doc/update/zero_downtime.md b/doc/update/zero_downtime.md index c40c7a0524e..1773105678c 100644 --- a/doc/update/zero_downtime.md +++ b/doc/update/zero_downtime.md @@ -4,7 +4,11 @@ group: Distribution info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Zero downtime upgrades **(FREE SELF)** +# Zero downtime upgrades + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed It's possible to upgrade to a newer major, minor, or patch version of GitLab without having to take your GitLab instance offline. However, for this to work @@ -325,7 +329,11 @@ sure you remove `/etc/gitlab/skip-auto-reconfigure` and revert setting `gitlab_rails['auto_migrate'] = false` in `/etc/gitlab/gitlab.rb` after you've completed these steps. -### Redis HA (using Sentinel) **(PREMIUM SELF)** +### Redis HA (using Sentinel) + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** Self-managed Package upgrades may involve version updates to the bundled Redis service. On instances using [Redis for scaling](../administration/redis/index.md), @@ -424,7 +432,11 @@ failover is complete, we can go ahead and upgrade the original primary node. Install the package for new version and follow regular package upgrade procedure. -## Geo deployment **(PREMIUM SELF)** +## Geo deployment + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** Self-managed WARNING: You can only upgrade one minor release at a time. @@ -541,7 +553,11 @@ sure you remove `/etc/gitlab/skip-auto-reconfigure` and revert setting `gitlab_rails['auto_migrate'] = false` in `/etc/gitlab/gitlab.rb` after you've completed these steps. -## Multi-node / HA deployment with Geo **(PREMIUM SELF)** +## Multi-node / HA deployment with Geo + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** Self-managed WARNING: You can only upgrade one minor release at a time. You also must first start with the Gitaly cluster, updating Gitaly one node one at a time. This will ensure access to the Git repositories for the remainder of the upgrade process. diff --git a/doc/user/ai_features.md b/doc/user/ai_features.md index 0891ae20918..0da3091fa60 100644 --- a/doc/user/ai_features.md +++ b/doc/user/ai_features.md @@ -53,9 +53,14 @@ GitLab is creating AI-assisted features across our DevSecOps platform. These fea The following subsections describe the experimental AI features in more detail. -### Explain code in the Web UI with Code explanation **(ULTIMATE SAAS EXPERIMENT)** +### Explain code in the Web UI with Code explanation -> Introduced in GitLab 15.11 as an [Experiment](../policy/experiment-beta-support.md#experiment) on GitLab.com. +DETAILS: +**Tier:** Ultimate +**Offering:** SaaS +**Status:** Experiment + +> - Introduced in GitLab 15.11 as an [Experiment](../policy/experiment-beta-support.md#experiment) on GitLab.com. To use this feature: @@ -98,9 +103,14 @@ code in a merge request: We cannot guarantee that the large language model produces results that are correct. Use the explanation with caution. -### Summarize issue discussions with Discussion summary **(ULTIMATE SAAS EXPERIMENT)** +### Summarize issue discussions with Discussion summary -> [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/10344) in GitLab 16.0 as an [Experiment](../policy/experiment-beta-support.md#experiment). +DETAILS: +**Tier:** Ultimate +**Offering:** SaaS +**Status:** Experiment + +> - [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/10344) in GitLab 16.0 as an [Experiment](../policy/experiment-beta-support.md#experiment). To use this feature: @@ -121,9 +131,14 @@ Provide feedback on this experimental feature in [issue 407779](https://gitlab.c **Data usage**: When you use this feature, the text of public comments on the issue are sent to the large language model referenced above. -### Forecast deployment frequency with Value stream forecasting **(ULTIMATE ALL EXPERIMENT)** +### Forecast deployment frequency with Value stream forecasting -> [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/10228) in GitLab 16.2 as an [Experiment](../policy/experiment-beta-support.md#experiment). +DETAILS: +**Tier:** Ultimate +**Offering:** SaaS, self-managed +**Status:** Experiment + +> - [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/10228) in GitLab 16.2 as an [Experiment](../policy/experiment-beta-support.md#experiment). To use this feature: @@ -146,9 +161,14 @@ For example, if you select a 30-day range, a forecast for the following 15 days Provide feedback on this experimental feature in [issue 416833](https://gitlab.com/gitlab-org/gitlab/-/issues/416833). -### Root cause analysis **(ULTIMATE SAAS EXPERIMENT)** +### Root cause analysis -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/123692) in GitLab 16.2 as an [Experiment](../policy/experiment-beta-support.md#experiment). +DETAILS: +**Tier:** Ultimate +**Offering:** SaaS +**Status:** Experiment + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/123692) in GitLab 16.2 as an [Experiment](../policy/experiment-beta-support.md#experiment). To use this feature: @@ -160,9 +180,14 @@ When the feature is available, the "Root cause analysis" button will appears on a failed CI/CD job. Selecting this button generates an analysis regarding the reason for the failure. -### Summarize an issue with Issue description generation **(ULTIMATE SAAS EXPERIMENT)** +### Summarize an issue with Issue description generation -> [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/10762) in GitLab 16.3 as an [Experiment](../policy/experiment-beta-support.md#experiment). +DETAILS: +**Tier:** Ultimate +**Offering:** SaaS +**Status:** Experiment + +> - [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/10762) in GitLab 16.3 as an [Experiment](../policy/experiment-beta-support.md#experiment). To use this feature: @@ -183,7 +208,12 @@ Provide feedback on this experimental feature in [issue 409844](https://gitlab.c **Data usage**: When you use this feature, the text you enter is sent to the large language model referenced above. -### GitLab Duo Chat **(ULTIMATE SAAS BETA)** +### GitLab Duo Chat + +DETAILS: +**Tier:** Ultimate +**Offering:** SaaS +**Status:** Beta For details about this Beta feature, see [GitLab Duo Chat](gitlab_duo_chat.md). diff --git a/doc/user/analytics/analytics_dashboards.md b/doc/user/analytics/analytics_dashboards.md index 585512698f3..4fac112c807 100644 --- a/doc/user/analytics/analytics_dashboards.md +++ b/doc/user/analytics/analytics_dashboards.md @@ -4,9 +4,14 @@ group: Product Analytics info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Analytics dashboards **(ULTIMATE ALL EXPERIMENT)** +# Analytics dashboards -> Introduced in GitLab 15.9 as an [Experiment](../../policy/experiment-beta-support.md#experiment) feature [with a flag](../../administration/feature_flags.md) named `combined_analytics_dashboards`. Disabled by default. +DETAILS: +**Tier:** Ultimate +**Offering:** SaaS, self-managed +**Status:** Experiment + +> - Introduced in GitLab 15.9 as an [Experiment](../../policy/experiment-beta-support.md#experiment) feature [with a flag](../../administration/feature_flags.md) named `combined_analytics_dashboards`. Disabled by default. FLAG: On self-managed GitLab, by default this feature is not available. To make it available per project or for your entire instance, an administrator can [enable the feature flag](../../administration/feature_flags.md) named `combined_analytics_dashboards`. @@ -101,7 +106,7 @@ To view a list of dashboards (both built-in and custom) for a project: ### View the value streams dashboard -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/137483) in GitLab 16.7 [with a flag](../../administration/feature_flags.md) named `project_analytics_dashboard_dynamic_vsd`. Disabled by default. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/137483) in GitLab 16.7 [with a flag](../../administration/feature_flags.md) named `project_analytics_dashboard_dynamic_vsd`. Disabled by default. FLAG: On self-managed GitLab, by default this feature is not available. To make it available per project or for your entire instance, an administrator can [enable the feature flag](../../administration/feature_flags.md) named `combined_analytics_dashboards` and `project_analytics_dashboard_dynamic_vsd`. @@ -139,7 +144,7 @@ To view a list of dashboards (both built-in and custom) for a group: ### View the value streams dashboard -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/132839) in GitLab 16.6 [with a flag](../../administration/feature_flags.md) named `group_analytics_dashboard_dynamic_vsd`. Disabled by default. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/132839) in GitLab 16.6 [with a flag](../../administration/feature_flags.md) named `group_analytics_dashboard_dynamic_vsd`. Disabled by default. FLAG: On self-managed GitLab, by default this feature is available. To hide the feature per project or for your entire instance, an administrator can [disable the feature flag](../../administration/feature_flags.md) named `group_analytics_dashboard_dynamic_vsd`. diff --git a/doc/user/analytics/ci_cd_analytics.md b/doc/user/analytics/ci_cd_analytics.md index 360559fad60..d8e1834d31a 100644 --- a/doc/user/analytics/ci_cd_analytics.md +++ b/doc/user/analytics/ci_cd_analytics.md @@ -4,7 +4,11 @@ group: Environments info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# CI/CD analytics **(FREE ALL)** +# CI/CD analytics + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed Use the CI/CD analytics page to view pipeline success rates and duration, and the history of DORA metrics over time. @@ -32,23 +36,35 @@ View pipeline duration history: You can view CI/CD analytics for a group or project. -### For a group **(ULTIMATE ALL)** +### For a group + +DETAILS: +**Tier:** Ultimate +**Offering:** SaaS, self-managed To view CI/CD analytics: 1. On the left sidebar, select **Search or go to** and find your group. 1. Select **Analyze > CI/CD analytics**. -### For a project **(FREE ALL)** +### For a project + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed To view CI/CD analytics: 1. On the left sidebar, select **Search or go to** and find your project. 1. Select **Analyze > CI/CD analytics**. -## View DORA deployment frequency chart **(ULTIMATE ALL)** +## View DORA deployment frequency chart -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/275991) in GitLab 13.8. +DETAILS: +**Tier:** Ultimate +**Offering:** SaaS, self-managed + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/275991) in GitLab 13.8. The [deployment frequency](dora_metrics.md#deployment-frequency) charts show information about the deployment frequency to the `production` environment. The environment must be part of the @@ -67,9 +83,13 @@ To view the deployment frequency chart: ![Deployment frequency](img/deployment_frequency_charts_v13_12.png) -## View DORA lead time for changes chart **(ULTIMATE ALL)** +## View DORA lead time for changes chart -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/250329) in GitLab 13.11. +DETAILS: +**Tier:** Ultimate +**Offering:** SaaS, self-managed + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/250329) in GitLab 13.11. The [lead time for changes](dora_metrics.md#lead-time-for-changes) chart shows information about how long it takes for merge requests to be deployed to a production environment. This chart is available for groups and projects. @@ -89,9 +109,13 @@ To view the lead time for changes chart: ![Lead time](img/lead_time_chart_v13_11.png) -## View DORA time to restore service chart **(ULTIMATE ALL)** +## View DORA time to restore service chart -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/356959) in GitLab 15.1 +DETAILS: +**Tier:** Ultimate +**Offering:** SaaS, self-managed + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/356959) in GitLab 15.1 The [time to restore service](dora_metrics.md#time-to-restore-service) chart shows information about the median time an incident was open in a production environment. This chart is available for groups and projects. @@ -105,9 +129,13 @@ To view the time to restore service chart: ![Lead time](img/time_to_restore_service_charts_v15_1.png) -## View DORA change failure rate chart **(ULTIMATE ALL)** +## View DORA change failure rate chart -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/357072) in GitLab 15.2 +DETAILS: +**Tier:** Ultimate +**Offering:** SaaS, self-managed + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/357072) in GitLab 15.2 The [change failure rate](dora_metrics.md#change-failure-rate) chart shows information about the percentage of deployments that cause an incident in a production environment. This chart is available for groups and projects. diff --git a/doc/user/analytics/code_review_analytics.md b/doc/user/analytics/code_review_analytics.md index 43c6d381874..3ca13e4c6cf 100644 --- a/doc/user/analytics/code_review_analytics.md +++ b/doc/user/analytics/code_review_analytics.md @@ -5,9 +5,13 @@ group: Optimize info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Code review analytics **(PREMIUM ALL)** +# Code review analytics -> Moved to GitLab Premium in 13.9. +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed + +> - Moved to GitLab Premium in 13.9. Code review analytics displays a table of open merge requests that have at least one non-author comment. The review time is the amount of time since the first comment by a non-author in a merge request. diff --git a/doc/user/analytics/contributor_analytics.md b/doc/user/analytics/contributor_analytics.md index 26dd79533a3..4c002775f26 100644 --- a/doc/user/analytics/contributor_analytics.md +++ b/doc/user/analytics/contributor_analytics.md @@ -4,7 +4,11 @@ group: Optimize info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Contributor analytics **(FREE ALL)** +# Contributor analytics + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed Contributor analytics give you an overview of the commits made by projects members to a project over time. diff --git a/doc/user/analytics/dora_metrics.md b/doc/user/analytics/dora_metrics.md index 372ea0a5807..a9f32d67c1b 100644 --- a/doc/user/analytics/dora_metrics.md +++ b/doc/user/analytics/dora_metrics.md @@ -4,7 +4,11 @@ group: Optimize info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# DevOps Research and Assessment (DORA) metrics **(ULTIMATE ALL)** +# DevOps Research and Assessment (DORA) metrics + +DETAILS: +**Tier:** Ultimate +**Offering:** SaaS, self-managed > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/275991) in GitLab 13.7. > - Lead time for changes [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/291746) in GitLab 13.10. @@ -33,7 +37,7 @@ This enables teams and managers to understand all aspects of productivity, quali ## Deployment frequency -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/394712) fix for the frequency calculation formula for `all` and `monthly` intervals in GitLab 16.0. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/394712) fix for the frequency calculation formula for `all` and `monthly` intervals in GitLab 16.0. Deployment frequency is the frequency of successful deployments to production over the given date range (hourly, daily, weekly, monthly, or yearly). @@ -131,9 +135,14 @@ The first step is to benchmark the quality and stability, between groups and pro - Improving the efficacy of code review processes. - Adding automated testing. -## DORA custom calculation rules **(ULTIMATE ALL EXPERIMENT)** +## DORA custom calculation rules -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/96561) in GitLab 15.4 [with a flag](../../administration/feature_flags.md) named `dora_configuration`. Disabled by default. This feature is an [Experiment](../../policy/experiment-beta-support.md). +DETAILS: +**Tier:** Ultimate +**Offering:** SaaS, self-managed +**Status:** Experiment + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/96561) in GitLab 15.4 [with a flag](../../administration/feature_flags.md) named `dora_configuration`. Disabled by default. This feature is an [Experiment](../../policy/experiment-beta-support.md). FLAG: On self-managed GitLab, by default this feature is not available. To make it available per project or for your entire instance, an administrator can [enable the feature flag](../../administration/feature_flags.md) named `dora_configuration`. diff --git a/doc/user/analytics/index.md b/doc/user/analytics/index.md index 73543b1043e..849ac0a4f62 100644 --- a/doc/user/analytics/index.md +++ b/doc/user/analytics/index.md @@ -5,7 +5,11 @@ description: Instance, group, and project analytics. info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Analyze GitLab usage **(FREE ALL)** +# Analyze GitLab usage + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed GitLab provides different types of analytics insights at the instance, group, and project level. These insights appear on the left sidebar, under [**Analyze**](../project/settings/project_features_permissions.md#disable-project-analytics). @@ -17,7 +21,7 @@ so that you can view information across multiple projects and groups in one plac ## Group-level analytics -> Moved to GitLab Premium in 13.9. +> - Moved to GitLab Premium in 13.9. Use group-level analytics to get insights into your groups': diff --git a/doc/user/analytics/merge_request_analytics.md b/doc/user/analytics/merge_request_analytics.md index 0d2c375f7ae..8fcb30cc120 100644 --- a/doc/user/analytics/merge_request_analytics.md +++ b/doc/user/analytics/merge_request_analytics.md @@ -5,7 +5,11 @@ group: Optimize info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Merge request analytics **(PREMIUM ALL)** +# Merge request analytics + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/229045) in GitLab 13.3. > - Moved to GitLab Premium in 13.9. @@ -66,7 +70,7 @@ the following information about each merge request: ## View average time between merge request creation and merge -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/229389) in GitLab 13.9. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/229389) in GitLab 13.9. The number in **Mean time to merge** shows the average time between when a merge request is created and when it's merged. Closed and not yet merged merge requests are not included. diff --git a/doc/user/analytics/productivity_analytics.md b/doc/user/analytics/productivity_analytics.md index 2644f8466c0..055fa822d83 100644 --- a/doc/user/analytics/productivity_analytics.md +++ b/doc/user/analytics/productivity_analytics.md @@ -4,7 +4,11 @@ group: Optimize info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Productivity analytics **(PREMIUM ALL)** +# Productivity analytics + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed You can use productivity analytics to identify: diff --git a/doc/user/analytics/repository_analytics.md b/doc/user/analytics/repository_analytics.md index 8bc163f6f3f..622cfd13d02 100644 --- a/doc/user/analytics/repository_analytics.md +++ b/doc/user/analytics/repository_analytics.md @@ -4,7 +4,11 @@ group: Optimize info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Repository analytics for projects **(FREE ALL)** +# Repository analytics for projects + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed Use repository analytics to view information about a project's Git repository: diff --git a/doc/user/analytics/value_streams_dashboard.md b/doc/user/analytics/value_streams_dashboard.md index 955431e858c..649224bd356 100644 --- a/doc/user/analytics/value_streams_dashboard.md +++ b/doc/user/analytics/value_streams_dashboard.md @@ -4,7 +4,11 @@ group: Optimize info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Value Streams Dashboard **(ULTIMATE ALL)** +# Value Streams Dashboard + +DETAILS: +**Tier:** Ultimate +**Offering:** SaaS, self-managed > - Introduced in GitLab 15.8 as a Closed [Beta](../../policy/experiment-beta-support.md#beta) feature [with a flag](../../administration/feature_flags.md) named `group_analytics_dashboards_page`. Disabled by default. > - Released in GitLab 15.11 as an Open [Beta](../../policy/experiment-beta-support.md#beta) feature [with a flag](../../administration/feature_flags.md) named `group_analytics_dashboards_page`. Enabled by default. @@ -55,7 +59,7 @@ The contributor count metric is available only on GitLab.com at the group-level. ### DORA Performers score panel -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/386843) in GitLab 16.2 [with a flag](../../administration/feature_flags.md) named `dora_performers_score_panel`. Disabled by default. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/386843) in GitLab 16.2 [with a flag](../../administration/feature_flags.md) named `dora_performers_score_panel`. Disabled by default. FLAG: By default this feature is not available. To make it available, an administrator can [enable the feature flag](../../administration/feature_flags.md) named `dora_performers_score_panel`. @@ -95,7 +99,11 @@ panels: If multiple topics are provided, all topics will need to match for the project to be included in the results. -## Enable or disable overview background aggregation **(ULTIMATE SELF)** +## Enable or disable overview background aggregation + +DETAILS: +**Tier:** Ultimate +**Offering:** Self-managed > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/120610) in GitLab 16.1 [with a flag](../../administration/feature_flags.md) named `value_stream_dashboard_on_off_setting`. Disabled by default. > - [Enabled on self-managed](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/130704) in GitLab 16.4. diff --git a/doc/user/application_security/api_fuzzing/create_har_files.md b/doc/user/application_security/api_fuzzing/create_har_files.md index 01515a90653..bef6ded91ba 100644 --- a/doc/user/application_security/api_fuzzing/create_har_files.md +++ b/doc/user/application_security/api_fuzzing/create_har_files.md @@ -4,7 +4,11 @@ group: Dynamic Analysis info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# HTTP Archive format **(ULTIMATE ALL)** +# HTTP Archive format + +DETAILS: +**Tier:** Ultimate +**Offering:** SaaS, Self-managed HTTP Archive (HAR) format files are an industry standard for exchanging information about HTTP requests and HTTP responses. A HAR file's content is JSON formatted, containing browser interactions diff --git a/doc/user/application_security/api_fuzzing/index.md b/doc/user/application_security/api_fuzzing/index.md index 3005e220f8b..d7f7e2d0693 100644 --- a/doc/user/application_security/api_fuzzing/index.md +++ b/doc/user/application_security/api_fuzzing/index.md @@ -4,7 +4,11 @@ group: Dynamic Analysis info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Web API Fuzz Testing **(ULTIMATE ALL)** +# Web API Fuzz Testing + +DETAILS: +**Tier:** Ultimate +**Offering:** SaaS, Self-managed Web API fuzzing performs fuzz testing of API operation parameters. Fuzz testing sets operation parameters to unexpected values in an effort to cause unexpected behavior and errors in the API @@ -83,7 +87,7 @@ In GitLab 14.0 and later, API fuzzing configuration files must be in your reposi ### Web API fuzzing configuration form -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/299234) in GitLab 13.10. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/299234) in GitLab 13.10. The API fuzzing configuration form helps you create or modify your project's API fuzzing configuration. The form lets you choose values for the most common API fuzzing options and builds @@ -1382,7 +1386,7 @@ variables: #### Debugging overrides -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/334578) in GitLab 14.8. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/334578) in GitLab 14.8. By default the output of the overrides command is hidden. If the overrides command returns a non zero exit code, the command is displayed as part of your job output. Optionally, you can set the variable `FUZZAPI_OVERRIDES_CMD_VERBOSE` to any value to display overrides command output as it is generated. This is useful when testing your overrides script, but should be disabled afterwards as it slows down testing. @@ -1542,7 +1546,7 @@ In the previous sample, you could use the script `user-pre-scan-set-up.sh` to al ### Exclude Paths -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/211892) in GitLab 14.0. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/211892) in GitLab 14.0. When testing an API it can be useful to exclude certain paths. For example, you might exclude testing of an authentication service or an older version of the API. To exclude paths, use the `FUZZAPI_EXCLUDE_PATHS` CI/CD variable . This variable is specified in your `.gitlab-ci.yml` file. To exclude multiple paths, separate entries using the `;` character. In the provided paths you can use a single character wildcard `?` and `*` for a multiple character wildcard. @@ -1583,7 +1587,7 @@ variables: ### Exclude parameters -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/292196) in GitLab 14.10. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/292196) in GitLab 14.10. While testing an API you may might want to exclude a parameter (query string, header, or body element) from testing. This may be needed because a parameter always causes a failure, slows down testing, or for other reasons. To exclude parameters you can use one of the following variables: `FUZZAPI_EXCLUDE_PARAMETER_ENV` or `FUZZAPI_EXCLUDE_PARAMETER_FILE`. @@ -1812,7 +1816,7 @@ The `api-fuzzing-exclude-parameters.json` is a JSON document that follows the st ### Exclude URLs -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/357195) in GitLab 14.10. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/357195) in GitLab 14.10. As an alternative to excluding by paths, you can filter by any other component in the URL by using the `FUZZAPI_EXCLUDE_URLS` CI/CD variable. This variable can be set in your `.gitlab-ci.yml` file. The variable can store multiple values, separated by commas (`,`). Each value is a regular expression. Because each entry is a regular expression, an entry such as `.*` excludes all URLs because it is a regular expression that matches everything. @@ -2012,7 +2016,7 @@ reported. ### View details of an API Fuzzing vulnerability -> Introduced in GitLab 13.7. +> - Introduced in GitLab 13.7. Faults detected by API Fuzzing occur in the live web application, and require manual investigation to determine if they are vulnerabilities. Fuzzing faults are included as vulnerabilities with a diff --git a/doc/user/application_security/api_security/api_discovery/index.md b/doc/user/application_security/api_security/api_discovery/index.md index 3e1e9d5bfc7..8766c659104 100644 --- a/doc/user/application_security/api_security/api_discovery/index.md +++ b/doc/user/application_security/api_security/api_discovery/index.md @@ -4,9 +4,13 @@ group: Dynamic Analysis info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# API Discovery **(ULTIMATE ALL)** +# API Discovery -> [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/9302) in GitLab 15.9. The API Discovery feature is in [Beta](../../../../policy/experiment-beta-support.md). +DETAILS: +**Tier:** Ultimate +**Offering:** SaaS, Self-managed + +> - [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/9302) in GitLab 15.9. The API Discovery feature is in [Beta](../../../../policy/experiment-beta-support.md). API Discovery analyzes your application and produces an OpenAPI document describing the web APIs it exposes. This schema document can then be used by [DAST API](../../dast_api/index.md) or [API Fuzzing](../../api_fuzzing/index.md) to perform security scans of the web API. diff --git a/doc/user/application_security/api_security/index.md b/doc/user/application_security/api_security/index.md index da771b03335..17451bb4a1c 100644 --- a/doc/user/application_security/api_security/index.md +++ b/doc/user/application_security/api_security/index.md @@ -4,7 +4,11 @@ group: Dynamic Analysis info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# API Security **(ULTIMATE ALL)** +# API Security + +DETAILS: +**Tier:** Ultimate +**Offering:** SaaS, Self-managed API Security refers to the measures taken to secure and protect web Application Programming Interfaces (APIs) from unauthorized access, misuse, and attacks. APIs are a crucial component of modern application development as they allow applications to interact with each other and exchange data. diff --git a/doc/user/application_security/breach_and_attack_simulation/index.md b/doc/user/application_security/breach_and_attack_simulation/index.md index 61b9c8af59b..16e8bd4baef 100644 --- a/doc/user/application_security/breach_and_attack_simulation/index.md +++ b/doc/user/application_security/breach_and_attack_simulation/index.md @@ -4,7 +4,11 @@ group: Incubation info: Breach and Attack Simulation is a GitLab Incubation Engineering program. No technical writer assigned to this group. --- -# Breach and Attack Simulation **(ULTIMATE ALL)** +# Breach and Attack Simulation + +DETAILS: +**Tier:** Ultimate +**Offering:** SaaS, Self-managed > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/402784) in GitLab 15.11 as an Incubating feature. > - [Included](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/119981) in the `Security/BAS.latest.gitlab-ci.yml` in GitLab 16.0. diff --git a/doc/user/application_security/configuration/index.md b/doc/user/application_security/configuration/index.md index c367d647c6c..4827fce7a3c 100644 --- a/doc/user/application_security/configuration/index.md +++ b/doc/user/application_security/configuration/index.md @@ -4,7 +4,11 @@ group: Static Analysis info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Security configuration **(FREE ALL)** +# Security configuration + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed > Security configuration page was [redesigned](https://gitlab.com/gitlab-org/gitlab/-/issues/326926) in GitLab 14.2. @@ -68,7 +72,11 @@ You can configure the following security controls: - [Coverage Fuzzing](../coverage_fuzzing/index.md) - Can be configured with `.gitlab-ci.yml`. For more details, read [Coverage Fuzzing](../../../user/application_security/coverage_fuzzing/index.md#enable-coverage-guided-fuzz-testing). -## Compliance **(ULTIMATE ALL)** +## Compliance + +DETAILS: +**Tier:** Ultimate +**Offering:** SaaS, Self-managed You can configure the following security controls: diff --git a/doc/user/application_security/container_scanning/index.md b/doc/user/application_security/container_scanning/index.md index 5be9e169078..726f3b9ae54 100644 --- a/doc/user/application_security/container_scanning/index.md +++ b/doc/user/application_security/container_scanning/index.md @@ -4,7 +4,11 @@ group: Composition Analysis info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Container Scanning **(FREE ALL)** +# Container Scanning + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed > - [Changed](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/86092) the major analyzer version from `4` to `5` in GitLab 15.0. > - [Moved](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/86783) from GitLab Ultimate to GitLab Free in 15.0. @@ -191,7 +195,7 @@ Authenticating to a remote registry is not supported when [FIPS mode](../../../d #### Dependency list -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/345434) in GitLab 14.6. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/345434) in GitLab 14.6. The `CS_DISABLE_DEPENDENCY_LIST` CI/CD variable controls whether the scan creates a [Dependency List](../dependency_list/index.md) @@ -211,7 +215,7 @@ container_scanning: #### Report language-specific findings -> [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/7277) in GitLab 14.6. +> - [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/7277) in GitLab 14.6. The `CS_DISABLE_LANGUAGE_VULNERABILITY_SCAN` CI/CD variable controls whether the scan reports findings related to programming languages. The languages supported depend on the @@ -307,7 +311,7 @@ Support depends on which scanner is used: #### FIPS-enabled images -> [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/5775) in GitLab 14.1. +> - [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/5775) in GitLab 14.1. GitLab also offers [FIPS-enabled Red Hat UBI](https://www.redhat.com/en/blog/introducing-red-hat-universal-base-image) versions of the container-scanning images. You can therefore replace standard images with FIPS-enabled @@ -333,7 +337,7 @@ the analyzer exits with an error and does not perform the scan. ### Enable Container Scanning through an automatic merge request -> [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/6334) in GitLab 14.9. +> - [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/6334) in GitLab 14.9. To enable Container Scanning in a project, create a merge request from the Security Configuration page: @@ -384,7 +388,7 @@ Do not use the `:latest` tag when selecting the scanner image. ### Setting the default branch image -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/338877) in GitLab 14.5. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/338877) in GitLab 14.5. By default, container scanning assumes that the image naming convention stores any branch-specific identifiers in the image tag rather than the image name. When the image name differs between the @@ -444,7 +448,11 @@ container_scanning: The `ADDITIONAL_CA_CERT_BUNDLE` value can also be configured as a [custom variable in the UI](../../../ci/variables/index.md#for-a-project), either as a `file`, which requires the path to the certificate, or as a variable, which requires the text representation of the certificate. -### Vulnerability allowlisting **(ULTIMATE ALL)** +### Vulnerability allowlisting + +DETAILS: +**Tier:** Ultimate +**Offering:** SaaS, Self-managed To allowlist specific vulnerabilities, follow these steps: @@ -740,7 +748,7 @@ For more information, see [Security scanner integration](../../../development/in ### CycloneDX Software Bill of Materials -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/396381) in GitLab 15.11. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/396381) in GitLab 15.11. In addition to the [JSON report file](#reports-json-format), the [Container Scanning](https://gitlab.com/gitlab-org/security-products/analyzers/container-scanning) tool outputs a [CycloneDX](https://cyclonedx.org/) Software Bill of Materials (SBOM) for the scanned image. This CycloneDX SBOM is named `gl-sbom-report.cdx.json` and is saved in the same directory as the `JSON report file`. This feature is only supported when the `Trivy` analyzer is used. @@ -790,7 +798,11 @@ Database update information for other analyzers is available in the After a vulnerability is found, you can [address it](../vulnerabilities/index.md). -## Solutions for vulnerabilities (auto-remediation) **(ULTIMATE ALL)** +## Solutions for vulnerabilities (auto-remediation) + +DETAILS: +**Tier:** Ultimate +**Offering:** SaaS, Self-managed Some vulnerabilities can be fixed by applying the solution that GitLab automatically generates. diff --git a/doc/user/application_security/continuous_vulnerability_scanning/index.md b/doc/user/application_security/continuous_vulnerability_scanning/index.md index 7d083ea1846..1cab4596ba0 100644 --- a/doc/user/application_security/continuous_vulnerability_scanning/index.md +++ b/doc/user/application_security/continuous_vulnerability_scanning/index.md @@ -4,7 +4,11 @@ group: Composition Analysis info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Continuous Vulnerability Scanning **(ULTIMATE ALL)** +# Continuous Vulnerability Scanning + +DETAILS: +**Tier:** Ultimate +**Offering:** SaaS, Self-managed > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/371063) in GitLab 16.4 as an [Experiment](../../../policy/experiment-beta-support.md#experiment) with two [features flags](../../../administration/feature_flags.md) named `dependency_scanning_on_advisory_ingestion` and `package_metadata_advisory_sync`. Enabled by default. > - [Generally available](https://gitlab.com/gitlab-org/gitlab/-/issues/427424) in GitLab 16.7 with an additional feature flag named `global_dependency_scanning_on_advisory_ingestion`. Enabled by default. diff --git a/doc/user/application_security/coverage_fuzzing/index.md b/doc/user/application_security/coverage_fuzzing/index.md index 8972d659c26..96a5d4ed58a 100644 --- a/doc/user/application_security/coverage_fuzzing/index.md +++ b/doc/user/application_security/coverage_fuzzing/index.md @@ -4,7 +4,11 @@ group: Dynamic Analysis info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Coverage-guided fuzz testing **(ULTIMATE ALL)** +# Coverage-guided fuzz testing + +DETAILS: +**Tier:** Ultimate +**Offering:** SaaS, Self-managed Coverage-guided fuzz testing sends random inputs to an instrumented version of your application in an effort to cause unexpected behavior. Such behavior indicates a bug that you should address. @@ -227,7 +231,7 @@ Prerequisites: ## Coverage-guided fuzz testing report -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/220062) in GitLab 13.3 as an [Experiment](../../../policy/experiment-beta-support.md#experiment). +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/220062) in GitLab 13.3 as an [Experiment](../../../policy/experiment-beta-support.md#experiment). For detailed information about the `gl-coverage-fuzzing-report.json` file's format, read the [schema](https://gitlab.com/gitlab-org/security-products/security-report-schemas/-/blob/master/dist/coverage-fuzzing-report-format.json). diff --git a/doc/user/application_security/cve_id_request.md b/doc/user/application_security/cve_id_request.md index efa1003fb4a..316925a8826 100644 --- a/doc/user/application_security/cve_id_request.md +++ b/doc/user/application_security/cve_id_request.md @@ -4,9 +4,13 @@ group: Threat Insights info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# CVE ID request **(FREE SAAS)** +# CVE ID request -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/41203) in GitLab 13.4, only for public projects on GitLab.com. +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/41203) in GitLab 13.4, only for public projects on GitLab.com. A [CVE](https://cve.mitre.org/index.html) identifier is assigned to a publicly-disclosed software vulnerability. GitLab is a [CVE Numbering Authority](https://about.gitlab.com/security/cve/) diff --git a/doc/user/application_security/dast/authentication.md b/doc/user/application_security/dast/authentication.md index 854526c4235..0c32d35d570 100644 --- a/doc/user/application_security/dast/authentication.md +++ b/doc/user/application_security/dast/authentication.md @@ -4,7 +4,11 @@ group: Dynamic Analysis info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# DAST authentication **(ULTIMATE ALL)** +# DAST authentication + +DETAILS: +**Tier:** Ultimate +**Offering:** SaaS, Self-managed WARNING: **DO NOT** use credentials that are valid for production systems, production servers, or any that diff --git a/doc/user/application_security/dast/authentication_troubleshooting.md b/doc/user/application_security/dast/authentication_troubleshooting.md index 62894d89ff6..e5d0d839aea 100644 --- a/doc/user/application_security/dast/authentication_troubleshooting.md +++ b/doc/user/application_security/dast/authentication_troubleshooting.md @@ -4,7 +4,11 @@ group: Dynamic Analysis info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Troubleshooting **(ULTIMATE ALL)** +# Troubleshooting + +DETAILS: +**Tier:** Ultimate +**Offering:** SaaS, Self-managed The [logs](#read-the-logs) provide insight into what DAST is doing and expecting during the authentication process. For more detailed information, configure the [authentication report](#configure-the-authentication-report). diff --git a/doc/user/application_security/dast/browser_based.md b/doc/user/application_security/dast/browser_based.md index 70c331f8840..88d304a40df 100644 --- a/doc/user/application_security/dast/browser_based.md +++ b/doc/user/application_security/dast/browser_based.md @@ -4,7 +4,11 @@ group: Dynamic Analysis info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# DAST browser-based analyzer **(ULTIMATE ALL)** +# DAST browser-based analyzer + +DETAILS: +**Tier:** Ultimate +**Offering:** SaaS, Self-managed > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/323423) in GitLab 13.12 as a Beta feature. > - [Generally available](https://gitlab.com/groups/gitlab-org/-/epics/9023) in GitLab 15.7 (GitLab DAST v3.0.50). diff --git a/doc/user/application_security/dast/browser_based_troubleshooting.md b/doc/user/application_security/dast/browser_based_troubleshooting.md index 9572c472284..0799f779ab0 100644 --- a/doc/user/application_security/dast/browser_based_troubleshooting.md +++ b/doc/user/application_security/dast/browser_based_troubleshooting.md @@ -4,7 +4,11 @@ group: Dynamic Analysis info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Troubleshooting DAST browser-based analyzer **(ULTIMATE ALL)** +# Troubleshooting DAST browser-based analyzer + +DETAILS: +**Tier:** Ultimate +**Offering:** SaaS, Self-managed The following troubleshooting scenarios have been collected from customer support cases. If you experience a problem not addressed here, or the information here does not fix your problem, create a diff --git a/doc/user/application_security/dast/checks/index.md b/doc/user/application_security/dast/checks/index.md index 0a4b16aaa1d..5a0170513ab 100644 --- a/doc/user/application_security/dast/checks/index.md +++ b/doc/user/application_security/dast/checks/index.md @@ -4,7 +4,11 @@ group: Dynamic Analysis info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# DAST browser-based crawler vulnerability checks **(ULTIMATE)** +# DAST browser-based crawler vulnerability checks + +DETAILS: +**Tier:** Ultimate +**Offering:** SaaS, Self-managed The [DAST browser-based crawler](../browser_based.md) provides a number of vulnerability checks that are used to scan for vulnerabilities in the site under test. diff --git a/doc/user/application_security/dast/dast_troubleshooting.md b/doc/user/application_security/dast/dast_troubleshooting.md index 9df98176c9a..005017c33b0 100644 --- a/doc/user/application_security/dast/dast_troubleshooting.md +++ b/doc/user/application_security/dast/dast_troubleshooting.md @@ -4,7 +4,11 @@ group: Dynamic Analysis info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Troubleshooting DAST proxy-based analyzer **(ULTIMATE ALL)** +# Troubleshooting DAST proxy-based analyzer + +DETAILS: +**Tier:** Ultimate +**Offering:** SaaS, Self-managed The following troubleshooting scenarios have been collected from customer support cases. If you experience a problem not addressed here, or the information here does not fix your problem, create a diff --git a/doc/user/application_security/dast/index.md b/doc/user/application_security/dast/index.md index 45b879dc53f..918c3c3885a 100644 --- a/doc/user/application_security/dast/index.md +++ b/doc/user/application_security/dast/index.md @@ -4,7 +4,11 @@ group: Dynamic Analysis info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Dynamic Application Security Testing (DAST) **(ULTIMATE ALL)** +# Dynamic Application Security Testing (DAST) + +DETAILS: +**Tier:** Ultimate +**Offering:** SaaS, Self-managed If you deploy your web application into a new environment, your application may become exposed to new types of attacks. For example, misconfigurations of your @@ -78,7 +82,7 @@ analyzer-specific configuration instructions. ### View scan results -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/36332) in GitLab 13.1. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/36332) in GitLab 13.1. Detected vulnerabilities appear in [merge requests](../index.md#merge-request), the [pipeline security tab](../index.md#pipeline-security-tab), and the [vulnerability report](../index.md#vulnerability-report). diff --git a/doc/user/application_security/dast/on-demand_scan.md b/doc/user/application_security/dast/on-demand_scan.md index e43057aea54..caff5c784cb 100644 --- a/doc/user/application_security/dast/on-demand_scan.md +++ b/doc/user/application_security/dast/on-demand_scan.md @@ -4,7 +4,11 @@ group: Dynamic Analysis info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# DAST On Demand Scan **(ULTIMATE ALL)** +# DAST On Demand Scan + +DETAILS: +**Tier:** Ultimate +**Offering:** SaaS, Self-managed WARNING: Do not run DAST scans against a production server. Not only can it perform *any* function that a user can, such @@ -403,7 +407,7 @@ To delete a scanner profile: ## Auditing -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/217872) in GitLab 14.1. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/217872) in GitLab 14.1. The creation, updating, and deletion of DAST profiles, DAST scanner profiles, and DAST site profiles are included in the [audit log](../../../administration/audit_events.md). diff --git a/doc/user/application_security/dast/proxy-based.md b/doc/user/application_security/dast/proxy-based.md index 447babb0ad4..254058f3e8b 100644 --- a/doc/user/application_security/dast/proxy-based.md +++ b/doc/user/application_security/dast/proxy-based.md @@ -4,7 +4,11 @@ group: Dynamic Analysis info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# DAST proxy-based analyzer **(ULTIMATE ALL)** +# DAST proxy-based analyzer + +DETAILS: +**Tier:** Ultimate +**Offering:** SaaS, Self-managed WARNING: Proxy-based DAST is [deprecated](https://gitlab.com/gitlab-org/gitlab/-/issues/430966). @@ -206,7 +210,7 @@ URLs to scan can be specified by either of the following methods: ##### Use `DAST_PATHS_FILE` CI/CD variable -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/258825) in GitLab 13.6. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/258825) in GitLab 13.6. To define the URLs to scan in a file, create a plain text file with one path per line. @@ -235,7 +239,7 @@ variables: ##### Use `DAST_PATHS` CI/CD variable -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/214120) in GitLab 13.4. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/214120) in GitLab 13.4. To specify the paths to scan in a CI/CD variable, add a comma-separated list of the paths to the `DAST_PATHS` variable. You can only scan paths of a single host. @@ -317,7 +321,7 @@ quotes (`"`), otherwise they are interpreted as numeric values. #### Hide sensitive information -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/36332) in GitLab 13.1. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/36332) in GitLab 13.1. HTTP request and response headers may contain sensitive information, including cookies and authorization credentials. By default, the following headers are masked: @@ -333,7 +337,7 @@ headers whose values you want masked. For details on how to mask headers, see #### Use Mutual TLS -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/299596) in GitLab 14.8. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/299596) in GitLab 14.8. Mutual TLS allows a target application server to verify that requests are from a known source. Browser-based scans do not support Mutual TLS. diff --git a/doc/user/application_security/dast/run_dast_offline.md b/doc/user/application_security/dast/run_dast_offline.md index ac597c99b62..516b896238a 100644 --- a/doc/user/application_security/dast/run_dast_offline.md +++ b/doc/user/application_security/dast/run_dast_offline.md @@ -4,7 +4,11 @@ group: Dynamic Analysis info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Run DAST in an offline environment **(ULTIMATE ALL)** +# Run DAST in an offline environment + +DETAILS: +**Tier:** Ultimate +**Offering:** SaaS, Self-managed For self-managed GitLab instances in an environment with limited, restricted, or intermittent access to external resources through the internet, some adjustments are required for the DAST job to diff --git a/doc/user/application_security/dast_api/index.md b/doc/user/application_security/dast_api/index.md index e69734403ea..74ca0a0c5a5 100644 --- a/doc/user/application_security/dast_api/index.md +++ b/doc/user/application_security/dast_api/index.md @@ -4,7 +4,11 @@ group: Dynamic Analysis info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# DAST API analyzer **(ULTIMATE ALL)** +# DAST API analyzer + +DETAILS: +**Tier:** Ultimate +**Offering:** SaaS, Self-managed > DAST API analyzer [became the default analyzer for on-demand DAST API scans](https://gitlab.com/groups/gitlab-org/-/epics/4254) in GitLab 15.6. @@ -1342,7 +1346,7 @@ variables: ### Debugging overrides -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/334578) in GitLab 14.8. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/334578) in GitLab 14.8. By default the output of the overrides command is hidden. If the overrides command returns a non zero exit code, the command is displayed as part of your job output. Optionally, you can set the variable `DAST_API_OVERRIDES_CMD_VERBOSE` to any value to display overrides command output as it is generated. This is useful when testing your overrides script, but should be disabled afterwards as it slows down testing. @@ -1556,7 +1560,7 @@ Consider using `DAST_API_REQUEST_HEADERS_BASE64` when storing secret header val ## Exclude Paths -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/211892) in GitLab 14.0. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/211892) in GitLab 14.0. When testing an API it can be useful to exclude certain paths. For example, you might exclude testing of an authentication service or an older version of the API. To exclude paths, use the `DAST_API_EXCLUDE_PATHS` CI/CD variable . This variable is specified in your `.gitlab-ci.yml` file. To exclude multiple paths, separate entries using the `;` character. In the provided paths you can use a single character wildcard `?` and `*` for a multiple character wildcard. @@ -1610,7 +1614,7 @@ variables: ### Exclude parameters -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/292196) in GitLab 14.10. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/292196) in GitLab 14.10. While testing an API you may might want to exclude a parameter (query string, header, or body element) from testing. This may be needed because a parameter always causes a failure, slows down testing, or for other reasons. To exclude parameters, you can set one of the following variables: `DAST_API_EXCLUDE_PARAMETER_ENV` or `DAST_API_EXCLUDE_PARAMETER_FILE`. @@ -1839,7 +1843,7 @@ The `dast-api-exclude-parameters.json` is a JSON document that follows the struc ### Exclude URLs -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/357195) in GitLab 14.10. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/357195) in GitLab 14.10. As an alternative to excluding by paths, you can filter by any other component in the URL by using the `DAST_API_EXCLUDE_URLS` CI/CD variable. This variable can be set in your `.gitlab-ci.yml` file. The variable can store multiple values, separated by commas (`,`). Each value is a regular expression. Because each entry is a regular expression, an entry like `.*` excludes all URLs because it is a regular expression that matches everything. diff --git a/doc/user/application_security/dependency_list/index.md b/doc/user/application_security/dependency_list/index.md index 7f4806a89f1..41e8240abd0 100644 --- a/doc/user/application_security/dependency_list/index.md +++ b/doc/user/application_security/dependency_list/index.md @@ -4,7 +4,11 @@ group: Composition Analysis info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Dependency list **(ULTIMATE ALL)** +# Dependency list + +DETAILS: +**Tier:** Ultimate +**Offering:** SaaS, Self-managed > - System dependencies [introduced](https://gitlab.com/groups/gitlab-org/-/epics/6698) in GitLab 14.6. > - Group-level dependency list [introduced](https://gitlab.com/groups/gitlab-org/-/epics/8090) in GitLab 16.2 [with a flag](../../../administration/feature_flags.md) named `group_level_dependencies`. Disabled by default. @@ -63,7 +67,7 @@ Details of each dependency are listed, sorted by decreasing severity of vulnerab ## Filter dependency list -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/422356) in GitLab 16.7 [with a flag](../../../administration/feature_flags.md) named `group_level_dependencies_filtering`. Disabled by default. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/422356) in GitLab 16.7 [with a flag](../../../administration/feature_flags.md) named `group_level_dependencies_filtering`. Disabled by default. FLAG: On self-managed GitLab, by default this feature is not available. To make it available, an administrator can [enable the feature flag](../../../administration/feature_flags.md) named `group_level_dependencies_filtering`. diff --git a/doc/user/application_security/dependency_scanning/index.md b/doc/user/application_security/dependency_scanning/index.md index a03dc265621..08281490932 100644 --- a/doc/user/application_security/dependency_scanning/index.md +++ b/doc/user/application_security/dependency_scanning/index.md @@ -41,7 +41,11 @@ table.no-vertical-table-lines tr { } -# Dependency Scanning **(ULTIMATE ALL)** +# Dependency Scanning + +DETAILS: +**Tier:** Ultimate +**Offering:** SaaS, Self-managed Dependency Scanning analyzes your application's dependencies for known vulnerabilities. All dependencies are scanned, including transitive dependencies, also known as nested dependencies. diff --git a/doc/user/application_security/dependency_scanning/troubleshooting_dependency_scanning.md b/doc/user/application_security/dependency_scanning/troubleshooting_dependency_scanning.md index 83004459051..2e1c0f52d0b 100644 --- a/doc/user/application_security/dependency_scanning/troubleshooting_dependency_scanning.md +++ b/doc/user/application_security/dependency_scanning/troubleshooting_dependency_scanning.md @@ -4,7 +4,11 @@ group: Composition Analysis info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Troubleshooting Dependency Scanning **(FREE ALL)** +# Troubleshooting Dependency Scanning + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed When working with dependency scanning, you might encounter the following issues. diff --git a/doc/user/application_security/get-started-security.md b/doc/user/application_security/get-started-security.md index e84149b91e8..e643340ef8e 100644 --- a/doc/user/application_security/get-started-security.md +++ b/doc/user/application_security/get-started-security.md @@ -4,7 +4,11 @@ group: Technical writing info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Get started with GitLab application security **(ULTIMATE ALL)** +# Get started with GitLab application security + +DETAILS: +**Tier:** Ultimate +**Offering:** SaaS, Self-managed For an overview, see [Adopting GitLab application security](https://www.youtube.com/watch?v=5QlxkiKR04k). diff --git a/doc/user/application_security/iac_scanning/index.md b/doc/user/application_security/iac_scanning/index.md index da4fee978d0..88ff9e92703 100644 --- a/doc/user/application_security/iac_scanning/index.md +++ b/doc/user/application_security/iac_scanning/index.md @@ -4,9 +4,13 @@ group: Static Analysis info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Infrastructure as Code scanning **(FREE ALL)** +# Infrastructure as Code scanning -> [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/6655) in GitLab 14.5. +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed + +> - [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/6655) in GitLab 14.5. Infrastructure as Code (IaC) scanning runs in your CI/CD pipeline, checking your infrastructure definition files for known vulnerabilities. Identify vulnerabilities before they're committed to @@ -78,7 +82,11 @@ Supported configuration formats: -## Customize rules **(ULTIMATE ALL)** +## Customize rules + +DETAILS: +**Tier:** Ultimate +**Offering:** SaaS, Self-managed > Support for overriding rules [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/235359) in GitLab 14.8. @@ -207,7 +215,7 @@ GitLab scanners are provided with a base Alpine image for size and maintainabili ### Use FIPS-enabled images -> [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/6479) in GitLab 14.10. +> - [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/6479) in GitLab 14.10. GitLab provides [FIPS-enabled Red Hat UBI](https://www.redhat.com/en/blog/introducing-red-hat-universal-base-image) versions of the scanners' images, in addition to the standard images. diff --git a/doc/user/application_security/index.md b/doc/user/application_security/index.md index 6441f74a41b..492786d7f5e 100644 --- a/doc/user/application_security/index.md +++ b/doc/user/application_security/index.md @@ -4,7 +4,11 @@ group: Static Analysis info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Application security **(ULTIMATE ALL)** +# Application security + +DETAILS: +**Tier:** Ultimate +**Offering:** SaaS, Self-managed GitLab can check your application for security vulnerabilities including: @@ -245,7 +249,11 @@ Security scan information appears in multiple locations and formats: - Vulnerability report - GitLab Workflow extension for VS Code -### Merge request **(FREE ALL)** +### Merge request + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed Output of all enabled application security tools is shown in a merge request widget. You can use this information to manage the risk of any issues identified in the source branch. diff --git a/doc/user/application_security/offline_deployments/index.md b/doc/user/application_security/offline_deployments/index.md index 46d2313b1fe..67a2eb09fef 100644 --- a/doc/user/application_security/offline_deployments/index.md +++ b/doc/user/application_security/offline_deployments/index.md @@ -4,7 +4,11 @@ group: Static Analysis info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Offline environments **(FREE SELF)** +# Offline environments + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed NOTE: To set up an offline environment, you must receive an [opt-out exemption of cloud licensing](https://about.gitlab.com/pricing/licensing-faq/cloud-licensing/#offline-cloud-licensing) prior to purchase. For more details, contact your GitLab sales representative. diff --git a/doc/user/application_security/policies/index.md b/doc/user/application_security/policies/index.md index bd40209320d..5840001fa62 100644 --- a/doc/user/application_security/policies/index.md +++ b/doc/user/application_security/policies/index.md @@ -4,7 +4,11 @@ group: Security Policies info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Policies **(ULTIMATE ALL)** +# Policies + +DETAILS: +**Tier:** Ultimate +**Offering:** SaaS, Self-managed > [Generally available](https://gitlab.com/gitlab-org/gitlab/-/issues/321258) in GitLab 14.4. Feature flag `security_orchestration_policies_configuration` removed. @@ -116,7 +120,11 @@ Implementation options for SPPs differ slightly between GitLab SaaS and GitLab s main difference is that on GitLab SaaS it's only possible to create subgroups. Ensuring separation of duties requires more granular permission configuration. -### Enforce policies across subgroups and projects **(ULTIMATE SAAS)** +### Enforce policies across subgroups and projects + +DETAILS: +**Tier:** Ultimate +**Offering:** SaaS To enforce policies against subgroups and projects, create a subgroup to contain the SPPs, separate to the subgroups containing the projects. Using separate subgroups allows for separation of duties, @@ -155,7 +163,11 @@ The high-level workflow for enforcing policies across multiple subgroups: path and the project's name should end with "- security policy project". For details, see [Link to a security policy project](#link-to-a-security-policy-project). -### Enforce policies across groups, subgroups, and projects **(ULTIMATE SELF)** +### Enforce policies across groups, subgroups, and projects + +DETAILS: +**Tier:** Ultimate +**Offering:** Self-managed To enforce policies against multiple groups, create a group to contain the SPPs, separate to the groups containing the projects. Using separate groups allows for separation of duties, with the SPP @@ -249,7 +261,7 @@ policies: ## Policy editor -> [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/3403) in GitLab 13.4. +> - [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/3403) in GitLab 13.4. You can use the policy editor to create, edit, and delete policies: diff --git a/doc/user/application_security/policies/scan-execution-policies.md b/doc/user/application_security/policies/scan-execution-policies.md index 26a98432d47..0efe28559f6 100644 --- a/doc/user/application_security/policies/scan-execution-policies.md +++ b/doc/user/application_security/policies/scan-execution-policies.md @@ -4,7 +4,11 @@ group: Security Policies info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Scan execution policies **(ULTIMATE ALL)** +# Scan execution policies + +DETAILS: +**Tier:** Ultimate +**Offering:** SaaS, Self-managed > - Group-level security policies [introduced](https://gitlab.com/groups/gitlab-org/-/epics/4425) in GitLab 15.2. > - Group-level security policies [enabled on GitLab.com](https://gitlab.com/gitlab-org/gitlab/-/issues/356258) in GitLab 15.4. @@ -318,7 +322,10 @@ If you want to avoid running duplicate scans, you can either remove the scans fr local jobs by setting `SAST_DISABLED: "true"`. Disabling jobs this way does not prevent the security jobs defined by scan execution policies from running. -## Experimental features **(EXPERIMENT)** +## Experimental features + +DETAILS: +**Status:** Experiment These experimental features have limitations: diff --git a/doc/user/application_security/policies/scan-result-policies.md b/doc/user/application_security/policies/scan-result-policies.md index 5e1541ce536..92be12b59dc 100644 --- a/doc/user/application_security/policies/scan-result-policies.md +++ b/doc/user/application_security/policies/scan-result-policies.md @@ -4,7 +4,11 @@ group: Security Policies info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Scan result policies **(ULTIMATE ALL)** +# Scan result policies + +DETAILS: +**Tier:** Ultimate +**Offering:** SaaS, Self-managed > Group-level scan result policies [introduced](https://gitlab.com/groups/gitlab-org/-/epics/7622) in GitLab 15.6. @@ -357,7 +361,10 @@ We have identified in [epic 11020](https://gitlab.com/groups/gitlab-org/-/epics/ - Findings or errors that cause approval to be required on a scan result policy may not be evident in the Security MR Widget. By using `merge base` in [issue 428518](https://gitlab.com/gitlab-org/gitlab/-/issues/428518) some cases will be addressed. We will additionally be [displaying more granular details](https://gitlab.com/groups/gitlab-org/-/epics/11185) about what caused security policy violations. - Security policy violations are distinct compared to findings displayed in the MR widgets. Some violations may not be present in the MR widget. We are working to harmonize our features in [epic 11020](https://gitlab.com/groups/gitlab-org/-/epics/11020) and to display policy violations explicitly in merge requests in [epic 11185](https://gitlab.com/groups/gitlab-org/-/epics/11185). -## Experimental features **(EXPERIMENT)** +## Experimental features + +DETAILS: +**Status:** Experiment ### Security policy scopes @@ -428,7 +435,11 @@ scan_result_policy: ## Troubleshooting -### Merge request rules widget shows a scan result policy is invalid or duplicated **(ULTIMATE SELF)** +### Merge request rules widget shows a scan result policy is invalid or duplicated + +DETAILS: +**Tier:** Ultimate +**Offering:** Self-managed On GitLab self-managed from 15.0 to 16.4, the most likely cause is that the project was exported from a group and imported into another, and had scan result policy rules. These rules are stored in a separate project to the one that was exported. As a result, the project contains policy rules that reference entities that don't exist in the imported project's group. The result is policy rules that are invalid, duplicated, or both. diff --git a/doc/user/application_security/sast/analyzers.md b/doc/user/application_security/sast/analyzers.md index 1f5340758c6..6a9ccae7cb9 100644 --- a/doc/user/application_security/sast/analyzers.md +++ b/doc/user/application_security/sast/analyzers.md @@ -4,9 +4,13 @@ group: Static Analysis info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# SAST analyzers **(FREE ALL)** +# SAST analyzers -> [Moved](https://gitlab.com/groups/gitlab-org/-/epics/2098) from GitLab Ultimate to GitLab Free in 13.3. +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed + +> - [Moved](https://gitlab.com/groups/gitlab-org/-/epics/2098) from GitLab Ultimate to GitLab Free in 13.3. Static Application Security Testing (SAST) uses analyzers to detect vulnerabilities in source code. Each analyzer is a wrapper around a [scanner](../terminology/index.md#scanner), a third-party code analysis tool. @@ -64,7 +68,11 @@ content directly. Instead, it enhances the results with additional properties, i - CWEs. - Location tracking fields. -- A means of identifying false positives or insignificant findings. **(ULTIMATE ALL)** +- A means of identifying false positives or insignificant findings. + +DETAILS: +**Tier:** Ultimate +**Offering:** SaaS, Self-managed ## Transition to Semgrep-based scanning diff --git a/doc/user/application_security/sast/customize_rulesets.md b/doc/user/application_security/sast/customize_rulesets.md index a9ef89077ca..71b612de205 100644 --- a/doc/user/application_security/sast/customize_rulesets.md +++ b/doc/user/application_security/sast/customize_rulesets.md @@ -4,7 +4,11 @@ group: Static Analysis info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Customize rulesets **(ULTIMATE ALL)** +# Customize rulesets + +DETAILS: +**Tier:** Ultimate +**Offering:** SaaS, Self-managed > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/235382) in GitLab 13.5. > - [Enabled](https://gitlab.com/gitlab-org/gitlab/-/issues/339614) support for @@ -82,7 +86,7 @@ To create the ruleset configuration file: ## Specify a remote configuration file -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/393452) in 16.1. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/393452) in 16.1. You can set a [CI/CD variable](../../../ci/variables/index.md) to use a ruleset configuration file that's stored outside of the current repository. This can help you apply the same rules across multiple projects. diff --git a/doc/user/application_security/sast/index.md b/doc/user/application_security/sast/index.md index 2a8a0766323..09c846ab1f6 100644 --- a/doc/user/application_security/sast/index.md +++ b/doc/user/application_security/sast/index.md @@ -4,7 +4,11 @@ group: Static Analysis info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Static Application Security Testing (SAST) **(FREE ALL)** +# Static Application Security Testing (SAST) + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed NOTE: The whitepaper ["A Seismic Shift in Application Security"](https://about.gitlab.com/resources/whitepaper-seismic-shift-application-security/) @@ -125,7 +129,11 @@ The following analyzers have multi-project support: Multi-project support in the Security Code Scan requires a Solution (`.sln`) file in the root of the repository. For details on the Solution format, see the Microsoft reference [Solution (`.sln`) file](https://learn.microsoft.com/en-us/visualstudio/extensibility/internals/solution-dot-sln-file?view=vs-2019). -## False positive detection **(ULTIMATE ALL)** +## False positive detection + +DETAILS: +**Tier:** Ultimate +**Offering:** SaaS, Self-managed > - Introduced for Ruby in GitLab 14.2. > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/378622) for Go in GitLab 15.8. @@ -140,9 +148,13 @@ False positive detection is available in a subset of the [supported languages](# ![SAST false-positives show in Vulnerability Pages](img/sast_vulnerability_page_fp_detection_v15_2.png) -## Advanced vulnerability tracking **(ULTIMATE ALL)** +## Advanced vulnerability tracking -> [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/5144) in GitLab 14.2. +DETAILS: +**Tier:** Ultimate +**Offering:** SaaS, Self-managed + +> - [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/5144) in GitLab 14.2. Source code is volatile; as developers make changes, source code may move within files or between files. Security analyzers may have already reported vulnerabilities that are being tracked in the [Vulnerability Report](../vulnerability_report/index.md). @@ -189,7 +201,7 @@ The default scanner images are built on a base Alpine image for size and maintai ### FIPS-enabled images -> [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/6479) in GitLab 14.10. +> - [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/6479) in GitLab 14.10. GitLab offers an image version, based on the [Red Hat UBI](https://www.redhat.com/en/blog/introducing-red-hat-universal-base-image) base image, that uses a FIPS 140-validated cryptographic module. To use the FIPS-enabled image, you can either: @@ -252,7 +264,11 @@ The [SAST report file](#output) is processed by GitLab and the details are shown - Merge request changes view - Vulnerability report -### Merge request widget **(ULTIMATE ALL)** +### Merge request widget + +DETAILS: +**Tier:** Ultimate +**Offering:** SaaS, Self-managed SAST results display in the merge request widget area if a report from the target branch is available for comparison. The merge request widget displays SAST results and resolutions that @@ -260,7 +276,11 @@ were introduced by the changes made in the merge request. ![Security Merge request widget](img/sast_mr_widget_v16_7.png) -### Merge request changes view **(ULTIMATE ALL)** +### Merge request changes view + +DETAILS: +**Tier:** Ultimate +**Offering:** SaaS, Self-managed > - [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/10959) in GitLab 16.6 with a [flag](../../../administration/feature_flags.md) named `sast_reports_in_inline_diff`. Disabled by default. > - Enabled by default in GitLab 16.8. @@ -315,7 +335,11 @@ When downloading, you always receive the most recent SAST artifact available. You can enable and configure SAST by using the UI, either with the default settings or with customizations. The method you can use depends on your GitLab license tier. -#### Configure SAST with customizations **(ULTIMATE ALL)** +#### Configure SAST with customizations + +DETAILS: +**Tier:** Ultimate +**Offering:** SaaS, Self-managed > [Removed](https://gitlab.com/gitlab-org/gitlab/-/issues/410013) individual SAST analyzers configuration options from the UI in GitLab 16.2. @@ -441,7 +465,7 @@ Read more on [how to use private Maven repositories](../index.md#using-private-m ### Enabling Kubesec analyzer -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/12752) in GitLab 12.6. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/12752) in GitLab 12.6. You need to set `SCAN_KUBERNETES_MANIFESTS` to `"true"` to enable the Kubesec analyzer. In `.gitlab-ci.yml`, define: @@ -626,7 +650,7 @@ flags are added to the scanner's CLI options. #### Custom CI/CD variables -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/18193) in GitLab 12.5. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/18193) in GitLab 12.5. In addition to the aforementioned SAST configuration CI/CD variables, all [custom variables](../../../ci/variables/index.md#define-a-cicd-variable-in-the-ui) are propagated diff --git a/doc/user/application_security/sast/rules.md b/doc/user/application_security/sast/rules.md index 187f8b940b2..613b3246ffe 100644 --- a/doc/user/application_security/sast/rules.md +++ b/doc/user/application_security/sast/rules.md @@ -4,7 +4,11 @@ group: Static Analysis info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# SAST rules **(FREE)** +# SAST rules + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, Self-managed GitLab SAST uses a set of [analyzers](analyzers.md) to scan code for potential vulnerabilities. Each analyzer processes the code then uses rules to find possible weaknesses in source code. diff --git a/doc/user/application_security/sast/troubleshooting.md b/doc/user/application_security/sast/troubleshooting.md index 0ac94db4f47..99a28bd6b12 100644 --- a/doc/user/application_security/sast/troubleshooting.md +++ b/doc/user/application_security/sast/troubleshooting.md @@ -4,7 +4,11 @@ group: Static Analysis info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Troubleshooting SAST **(FREE ALL)** +# Troubleshooting SAST + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed ## Debug-level logging diff --git a/doc/user/application_security/secret_detection/automatic_response.md b/doc/user/application_security/secret_detection/automatic_response.md index 762d42d7614..03bf334d5e9 100644 --- a/doc/user/application_security/secret_detection/automatic_response.md +++ b/doc/user/application_security/secret_detection/automatic_response.md @@ -4,9 +4,13 @@ group: Static Analysis info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Automatic response to leaked secrets **(ULTIMATE ALL)** +# Automatic response to leaked secrets -> [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/4639) in GitLab 13.6. +DETAILS: +**Tier:** Ultimate +**Offering:** SaaS, Self-managed + +> - [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/4639) in GitLab 13.6. GitLab Secret Detection automatically responds when it finds certain types of leaked secrets. Automatic responses can: diff --git a/doc/user/application_security/secret_detection/index.md b/doc/user/application_security/secret_detection/index.md index 9e2d67237d3..687d9f99871 100644 --- a/doc/user/application_security/secret_detection/index.md +++ b/doc/user/application_security/secret_detection/index.md @@ -4,7 +4,11 @@ group: Static Analysis info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Secret Detection **(FREE ALL)** +# Secret Detection + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed > [In GitLab 14.0](https://gitlab.com/gitlab-org/gitlab/-/issues/297269), Secret Detection jobs `secret_detection_default_branch` and `secret_detection` were consolidated into one job, `secret_detection`. @@ -286,7 +290,7 @@ In previous GitLab versions, the following variables were also available: #### Use FIPS-enabled images -> [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/6479) in GitLab 14.10. +> - [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/6479) in GitLab 14.10. The default scanner images are built off a base Alpine image for size and maintainability. GitLab offers [Red Hat UBI](https://www.redhat.com/en/blog/introducing-red-hat-universal-base-image) @@ -322,7 +326,11 @@ pipeline. To enable full history Secret Detection, set the variable `SECRET_DETECTION_HISTORIC_SCAN` to `true` in your `.gitlab-ci.yml` file. -## Custom rulesets **(ULTIMATE ALL)** +## Custom rulesets + +DETAILS: +**Tier:** Ultimate +**Offering:** SaaS, Self-managed > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/211387) in GitLab 13.5. > - [Enabled](https://gitlab.com/gitlab-org/gitlab/-/issues/339614) support for passthrough chains. @@ -516,7 +524,11 @@ For more information on the syntax of remote configurations, see the [specify a private remote configuration example](../sast/customize_rulesets.md#specify-a-private-remote-configuration) on the SAST customize rulesets page. -## Running Secret Detection in an offline environment **(PREMIUM SELF)** +## Running Secret Detection in an offline environment + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** Self-managed An offline environment has limited, restricted, or intermittent access to external resources through the internet. For self-managed GitLab instances in such an environment, Secret Detection requires diff --git a/doc/user/application_security/secret_detection/pre_receive.md b/doc/user/application_security/secret_detection/pre_receive.md index 8bb56644926..9aaf26ca849 100644 --- a/doc/user/application_security/secret_detection/pre_receive.md +++ b/doc/user/application_security/secret_detection/pre_receive.md @@ -4,9 +4,12 @@ group: Static Analysis info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Pre-receive secret detection **(EXPERIMENT)** +# Pre-receive secret detection -> [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/11439) in GitLab 16.7 as an [Experiment](../../../policy/experiment-beta-support.md) for GitLab Dedicated customers. +DETAILS: +**Status:** Experiment + +> - [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/11439) in GitLab 16.7 as an [Experiment](../../../policy/experiment-beta-support.md) for GitLab Dedicated customers. NOTE: This feature is an [Experiment](../../../policy/experiment-beta-support.md), available only on GitLab Dedicated, and is subject to the [GitLab Testing Agreement](https://about.gitlab.com/handbook/legal/testing-agreement/). diff --git a/doc/user/application_security/secure_your_application.md b/doc/user/application_security/secure_your_application.md index 095796f3dc4..6a47894f9b8 100644 --- a/doc/user/application_security/secure_your_application.md +++ b/doc/user/application_security/secure_your_application.md @@ -5,7 +5,11 @@ description: Container, dependency, and vulnerability scans. info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Secure your application **(FREE ALL)** +# Secure your application + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed GitLab can check your applications for security vulnerabilities. diff --git a/doc/user/application_security/security_dashboard/index.md b/doc/user/application_security/security_dashboard/index.md index e9f3a3a2c0b..06496bf6f64 100644 --- a/doc/user/application_security/security_dashboard/index.md +++ b/doc/user/application_security/security_dashboard/index.md @@ -4,7 +4,11 @@ group: Threat Insights info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# GitLab Security Dashboards and Security Center **(ULTIMATE ALL)** +# GitLab Security Dashboards and Security Center + +DETAILS: +**Tier:** Ultimate +**Offering:** SaaS, Self-managed ## Security Dashboards @@ -22,7 +26,7 @@ For an overview, see [Security Dashboard](https://www.youtube.com/watch?v=Uo-pDn ## Vulnerability metrics in the Value Streams Dashboard -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/383697) in GitLab 16.0. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/383697) in GitLab 16.0. You can view vulnerability metrics also in the [Value Streams Dashboard](../../../user/analytics/value_streams_dashboard.md) comparison panel, which helps you understand security exposure in the context of your organization's software delivery workflows. @@ -105,7 +109,7 @@ To view group security dashboard: ## Security Center -> [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/3426) in GitLab 13.4. +> - [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/3426) in GitLab 13.4. The Security Center is a configurable personal space where you can view vulnerabilities across all the projects you belong to. The Security Center includes: diff --git a/doc/user/application_security/terminology/index.md b/doc/user/application_security/terminology/index.md index ba501baefb0..bcbb5a00e86 100644 --- a/doc/user/application_security/terminology/index.md +++ b/doc/user/application_security/terminology/index.md @@ -4,7 +4,11 @@ group: Static Analysis info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Secure and Govern glossary **(FREE ALL)** +# Secure and Govern glossary + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed The glossary of terms aims to achieve the following: diff --git a/doc/user/application_security/vulnerabilities/index.md b/doc/user/application_security/vulnerabilities/index.md index 0fda401194d..80d26c2eea5 100644 --- a/doc/user/application_security/vulnerabilities/index.md +++ b/doc/user/application_security/vulnerabilities/index.md @@ -4,7 +4,11 @@ group: Threat Insights info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Vulnerability Page **(ULTIMATE ALL)** +# Vulnerability Page + +DETAILS: +**Tier:** Ultimate +**Offering:** SaaS, Self-managed Each vulnerability in a project has a vulnerability page containing details of the vulnerability, including: @@ -24,7 +28,12 @@ change its status to **Resolved**. This ensures that if it is accidentally reint merge, it is reported again as a new record. To change the status of multiple vulnerabilities, use the Vulnerability Report's [Activity filter](../vulnerability_report/index.md#activity-filter). -## Explaining a vulnerability **(ULTIMATE SAAS BETA)** +## Explaining a vulnerability + +DETAILS: +**Tier:** Ultimate +**Offering:** SaaS +**Status:** Beta > - [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/10368) in GitLab 16.0 as an [Experiment](../../../policy/experiment-beta-support.md#experiment) on GitLab.com. > - Promoted to [Beta](../../../policy/experiment-beta-support.md#beta) status in GitLab 16.2. @@ -77,9 +86,14 @@ The following data is shared with third-party AI APIs: record). - Filename. -## Vulnerability resolution **(ULTIMATE SAAS EXPERIMENT)** +## Vulnerability resolution -> [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/10779) in GitLab 16.7 as an [Experiment](../../../policy/experiment-beta-support.md#experiment) on GitLab.com. +DETAILS: +**Tier:** Ultimate +**Offering:** SaaS +**Status:** Experiment + +> - [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/10779) in GitLab 16.7 as an [Experiment](../../../policy/experiment-beta-support.md#experiment) on GitLab.com. Use GitLab Duo Vulnerability resolution to automatically create a merge request that resolves the vulnerability. @@ -289,7 +303,7 @@ To manually apply the patch that GitLab generated for a vulnerability: ## Enable security training for vulnerabilities -> [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/6176) in GitLab 14.9. +> - [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/6176) in GitLab 14.9. NOTE: Security training is not accessible in an environment that is offline, meaning computers that are isolated from the public internet as a security measure. Specifically, the GitLab server needs the ability to query the API endpoints for any training provider you choose to enable. Some third-party training vendors may require you to sign up for a _free_ account. Sign up for an account by going to @@ -309,7 +323,7 @@ Each integration submits the Vulnerability identifier, for example CWE or OWASP, ## View security training for a vulnerability -> [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/6176) in GitLab 14.9. +> - [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/6176) in GitLab 14.9. The vulnerability page may include a training link relevant to the detected vulnerability if security training is enabled. The availability of training depends on whether the enabled training vendor has content matching the particular vulnerability. diff --git a/doc/user/application_security/vulnerabilities/severities.md b/doc/user/application_security/vulnerabilities/severities.md index 0db848d6d11..c6643866490 100644 --- a/doc/user/application_security/vulnerabilities/severities.md +++ b/doc/user/application_security/vulnerabilities/severities.md @@ -4,7 +4,11 @@ group: Threat Insights info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Vulnerability severity levels **(ULTIMATE ALL)** +# Vulnerability severity levels + +DETAILS: +**Tier:** Ultimate +**Offering:** SaaS, Self-managed GitLab vulnerability analyzers attempt to return vulnerability severity level values whenever possible. The following is a list of available GitLab vulnerability severity levels, ranked from diff --git a/doc/user/application_security/vulnerability_report/index.md b/doc/user/application_security/vulnerability_report/index.md index 620d8c75e52..ee2d948b4ec 100644 --- a/doc/user/application_security/vulnerability_report/index.md +++ b/doc/user/application_security/vulnerability_report/index.md @@ -4,7 +4,11 @@ group: Threat Insights info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Vulnerability Report **(ULTIMATE ALL)** +# Vulnerability Report + +DETAILS: +**Tier:** Ultimate +**Offering:** SaaS, Self-managed The Vulnerability Report provides information about vulnerabilities from scans of the default branch. It contains cumulative results of all successful jobs, regardless of whether the pipeline was successful. The scan results from a @@ -133,7 +137,7 @@ The content of the Project filter depends on the current level: ### Activity filter -> Introduced in GitLab 16.7 [with a flag](../../../administration/feature_flags.md) named `activity_filter_has_remediations`. Disabled by default. +> - Introduced in GitLab 16.7 [with a flag](../../../administration/feature_flags.md) named `activity_filter_has_remediations`. Disabled by default. FLAG: On self-managed GitLab, by default the Solution Available filter is not available. To make it available, an administrator can [enable the feature flag](../../../administration/feature_flags.md) named `activity_filter_has_remediations`. On GitLab.com, this feature is not available. This feature is not ready for production use. @@ -298,7 +302,7 @@ name. ## Operational vulnerabilities -> [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/6345) in GitLab 14.6. +> - [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/6345) in GitLab 14.6. The **Operational vulnerabilities** tab lists vulnerabilities found by [Operational container scanning](../../clusters/agent/vulnerabilities.md). This tab appears on the project, group, and Security Center vulnerability reports. diff --git a/doc/user/application_security/vulnerability_report/pipeline.md b/doc/user/application_security/vulnerability_report/pipeline.md index 41cc323f3e1..5e44301b12b 100644 --- a/doc/user/application_security/vulnerability_report/pipeline.md +++ b/doc/user/application_security/vulnerability_report/pipeline.md @@ -86,7 +86,7 @@ default branch are incorporated after the pipeline finishes, according to the fo ## Retention period for findings -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/351524) in GitLab 15.5. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/351524) in GitLab 15.5. Findings are no longer available: @@ -103,7 +103,7 @@ This does not apply for the vulnerabilities existing on the default branch. ## Change status of findings -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/331408) in GitLab 16.7 [with a flag](../../../administration/feature_flags.md) named `pipeline_security_dashboard_graphql`. Disabled by default. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/331408) in GitLab 16.7 [with a flag](../../../administration/feature_flags.md) named `pipeline_security_dashboard_graphql`. Disabled by default. FLAG: On self-managed GitLab, by default this feature is not available. To make it available, an administrator can [enable the feature flag](../../../administration/feature_flags.md) named `pipeline_security_dashboard_graphql`. diff --git a/doc/user/asciidoc.md b/doc/user/asciidoc.md index ea62384b35e..613c733635b 100644 --- a/doc/user/asciidoc.md +++ b/doc/user/asciidoc.md @@ -4,7 +4,11 @@ group: Source Code info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# AsciiDoc **(FREE ALL)** +# AsciiDoc + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed GitLab uses the [Asciidoctor](https://asciidoctor.org) gem to convert AsciiDoc content to HTML5. Consult the [Asciidoctor User Manual](https://asciidoctor.org/docs/user-manual/) for a complete Asciidoctor reference. @@ -435,7 +439,7 @@ It's possible to generate diagrams and flowcharts from text in GitLab using #### Mermaid -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/31818) in GitLab 13.3. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/31818) in GitLab 13.3. Visit the [official page](https://mermaidjs.github.io/) for more details. If you're new to using Mermaid or need help identifying issues in your Mermaid code, diff --git a/doc/user/clusters/agent/ci_cd_workflow.md b/doc/user/clusters/agent/ci_cd_workflow.md index 9ff3837653e..ff386d5e57d 100644 --- a/doc/user/clusters/agent/ci_cd_workflow.md +++ b/doc/user/clusters/agent/ci_cd_workflow.md @@ -4,7 +4,11 @@ group: Environments info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Using GitLab CI/CD with a Kubernetes cluster **(FREE ALL)** +# Using GitLab CI/CD with a Kubernetes cluster + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/327409) in GitLab 14.1. > - The pre-configured variable `$KUBECONFIG` [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/324275) in GitLab 14.2. @@ -196,7 +200,11 @@ To configure your client, do one of the following: - Place the certificates in an appropriate location in the job container by updating the container image or mounting via the runner. - Not recommended. Configure the Kubernetes client with `--insecure-skip-tls-verify=true`. -## Restrict project and group access by using impersonation **(PREMIUM ALL)** +## Restrict project and group access by using impersonation + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/345014) in GitLab 14.5. > - [Changed](https://gitlab.com/gitlab-org/gitlab/-/issues/357934) in GitLab 15.5 to add impersonation support for environment tiers. @@ -300,9 +308,13 @@ The identity can be specified with the following keys: See the [official Kubernetes documentation for details](https://kubernetes.io/docs/reference/access-authn-authz/authentication/#user-impersonation). -## Restrict project and group access to specific environments **(FREE ALL)** +## Restrict project and group access to specific environments -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/343885) in GitLab 15.7. +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/343885) in GitLab 15.7. By default, if your agent is [available to a project](#authorize-the-agent), all of the project's CI/CD jobs can use that agent. diff --git a/doc/user/clusters/agent/gitops.md b/doc/user/clusters/agent/gitops.md index 7a3ab01e991..24582aa3758 100644 --- a/doc/user/clusters/agent/gitops.md +++ b/doc/user/clusters/agent/gitops.md @@ -4,7 +4,11 @@ group: Environments info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Using GitOps with a Kubernetes cluster **(FREE ALL)** +# Using GitOps with a Kubernetes cluster + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/259669) in GitLab 13.7. > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/332227) in GitLab 14.0, the `resource_inclusions` and `resource_exclusions` attributes were removed and `reconcile_timeout`, `dry_run_strategy`, `prune`, `prune_timeout`, `prune_propagation_policy`, and `inventory_policy` attributes were added. diff --git a/doc/user/clusters/agent/gitops/agent.md b/doc/user/clusters/agent/gitops/agent.md index f1fe3f98f55..4d30beae661 100644 --- a/doc/user/clusters/agent/gitops/agent.md +++ b/doc/user/clusters/agent/gitops/agent.md @@ -4,7 +4,11 @@ group: Environments info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Using GitOps with the agent for Kubernetes (deprecated) **(FREE ALL)** +# Using GitOps with the agent for Kubernetes (deprecated) + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/259669) in GitLab 13.7. > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/332227) in GitLab 14.0, the `resource_inclusions` and `resource_exclusions` attributes were removed and `reconcile_timeout`, `dry_run_strategy`, `prune`, `prune_timeout`, `prune_propagation_policy`, and `inventory_policy` attributes were added. diff --git a/doc/user/clusters/agent/gitops/example_repository_structure.md b/doc/user/clusters/agent/gitops/example_repository_structure.md index 998a221905d..628715df662 100644 --- a/doc/user/clusters/agent/gitops/example_repository_structure.md +++ b/doc/user/clusters/agent/gitops/example_repository_structure.md @@ -4,7 +4,11 @@ group: Environments info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Tutorial: Deploy a Git repository using Flux **(FREE ALL)** +# Tutorial: Deploy a Git repository using Flux + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed In this tutorial, you'll create a GitLab project that builds and deploys an application to a Kubernetes cluster using Flux. You'll set up a sample manifest project, configure it to diff --git a/doc/user/clusters/agent/gitops/flux_oci_tutorial.md b/doc/user/clusters/agent/gitops/flux_oci_tutorial.md index 921555c166a..ada250b8f8d 100644 --- a/doc/user/clusters/agent/gitops/flux_oci_tutorial.md +++ b/doc/user/clusters/agent/gitops/flux_oci_tutorial.md @@ -4,7 +4,11 @@ group: Environments info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Tutorial: Deploy an OCI artifact using Flux **(FREE ALL)** +# Tutorial: Deploy an OCI artifact using Flux + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed This tutorial teaches you how to package your Kubernetes manifests into an [OCI](https://opencontainers.org/) artifact and deploy them to your cluster using Flux. You'll set up a sample manifest project, configure it to diff --git a/doc/user/clusters/agent/gitops/flux_tutorial.md b/doc/user/clusters/agent/gitops/flux_tutorial.md index 025264cfa94..ec7b155167f 100644 --- a/doc/user/clusters/agent/gitops/flux_tutorial.md +++ b/doc/user/clusters/agent/gitops/flux_tutorial.md @@ -4,7 +4,11 @@ group: Environments info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Tutorial: Set up Flux for GitOps **(FREE ALL)** +# Tutorial: Set up Flux for GitOps + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed This tutorial teaches you how to set up Flux for GitOps. You'll complete a bootstrap installation, install `agentk` in your cluster, and deploy a simple `nginx` application. @@ -171,7 +175,7 @@ To install `agentk`: interval: 1h0m0s values: config: - kasAddress: "wss://kas.gitlab.com" + kasAddress: "wss://kas.gitlab.com" secretName: gitlab-agent-token ``` diff --git a/doc/user/clusters/agent/gitops/migrate_to_flux.md b/doc/user/clusters/agent/gitops/migrate_to_flux.md index ba97612ac6a..50bb7660511 100644 --- a/doc/user/clusters/agent/gitops/migrate_to_flux.md +++ b/doc/user/clusters/agent/gitops/migrate_to_flux.md @@ -4,7 +4,11 @@ group: Environments info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Migrate from legacy GitOps to Flux **(FREE ALL)** +# Migrate from legacy GitOps to Flux + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed Most users can migrate from their [legacy agent-based GitOps solution](agent.md) to Flux without additional work or downtime. In most cases, Flux can @@ -117,7 +121,7 @@ For more information about configuring Flux with GitLab, see ### `flux bootstrap` doesn't reconcile manifests correctly The `flux bootstrap` command creates a `kustomizations.kustomize.toolkit.fluxcd.io` -resource that points to the `manifests` directory. +resource that points to the `manifests` directory. This resource applies to all the Kubernetes manifests in the directory, without requiring a [Kustomization file](https://kubectl.docs.kubernetes.io/references/kustomize/glossary/#kustomization). diff --git a/doc/user/clusters/agent/install/index.md b/doc/user/clusters/agent/install/index.md index b8caf6d0837..cb9349cf38c 100644 --- a/doc/user/clusters/agent/install/index.md +++ b/doc/user/clusters/agent/install/index.md @@ -4,7 +4,11 @@ group: Environments info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Installing the agent for Kubernetes **(FREE ALL)** +# Installing the agent for Kubernetes + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed > - [Moved](https://gitlab.com/groups/gitlab-org/-/epics/6290) from GitLab Premium to GitLab Free in 14.5. > - [Introduced](https://gitlab.com/gitlab-org/cluster-integration/gitlab-agent/-/merge_requests/594) multi-arch images in GitLab 14.8. The first multi-arch release is `v14.8.1`. It supports AMD64 and ARM64 architectures. @@ -99,7 +103,7 @@ You must register an agent before you can install the agent in your cluster. To ### Install the agent in the cluster -> Introduced in GitLab 14.10, GitLab recommends using Helm to install the agent. +> - Introduced in GitLab 14.10, GitLab recommends using Helm to install the agent. To connect your cluster to GitLab, install the registered agent in your cluster. You can either: @@ -158,7 +162,7 @@ an [auto-generated self-signed wildcard certificate](https://docs.gitlab.com/cha ##### Use the agent behind an HTTP proxy -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/351867) in GitLab 15.0, the GitLab agent Helm chart supports setting environment variables. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/351867) in GitLab 15.0, the GitLab agent Helm chart supports setting environment variables. To configure an HTTP proxy when using the Helm chart, you can use the environment variables `HTTP_PROXY`, `HTTPS_PROXY`, and `NO_PROXY`. Upper and lowercase are both acceptable. @@ -218,7 +222,7 @@ The following example projects can help you get started with the agent. ## Updates and version compatibility -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/340882) in GitLab 14.8, GitLab warns you on the agent's list page to update the agent version installed on your cluster. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/340882) in GitLab 14.8, GitLab warns you on the agent's list page to update the agent version installed on your cluster. For the best experience, the version of the agent installed in your cluster should match the GitLab major and minor version. The previous and next minor versions are also supported. For example, if your GitLab version is v14.9.4 (major version 14, minor version 9), then versions v14.9.0 and v14.9.1 of the agent are ideal, but any v14.8.x or v14.10.x version of the agent is also supported. See [the release page](https://gitlab.com/gitlab-org/cluster-integration/gitlab-agent/-/releases) of the GitLab agent. diff --git a/doc/user/clusters/agent/user_access.md b/doc/user/clusters/agent/user_access.md index 80ee7303dfc..85c83719948 100644 --- a/doc/user/clusters/agent/user_access.md +++ b/doc/user/clusters/agent/user_access.md @@ -4,7 +4,12 @@ group: Environments info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Grant users Kubernetes access **(FREE ALL BETA)** +# Grant users Kubernetes access + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed +**Status:** Beta > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/390769) in GitLab 16.1, with [flags](../../../administration/feature_flags.md) named `environment_settings_to_graphql`, `kas_user_access`, `kas_user_access_project`, and `expose_authorized_cluster_agents`. This feature is in [Beta](../../../policy/experiment-beta-support.md#beta). > - Feature flag `environment_settings_to_graphql` [removed](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/124177) in GitLab 16.2. @@ -56,7 +61,11 @@ user_access: - id: group-3/subgroup ``` -## Configure access with user impersonation **(PREMIUM ALL)** +## Configure access with user impersonation + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed You can grant access to a Kubernetes cluster and transform requests into impersonation requests for authenticated users. @@ -143,7 +152,7 @@ subjects: ## Access a cluster with the Kubernetes API -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/131144) in GitLab 16.4. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/131144) in GitLab 16.4. You can configure an agent to allow GitLab users to access a cluster with the Kubernetes API. diff --git a/doc/user/clusters/agent/vulnerabilities.md b/doc/user/clusters/agent/vulnerabilities.md index a9f7cefff3d..904a0aa8375 100644 --- a/doc/user/clusters/agent/vulnerabilities.md +++ b/doc/user/clusters/agent/vulnerabilities.md @@ -4,7 +4,11 @@ group: Composition analysis info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Operational Container Scanning **(ULTIMATE ALL)** +# Operational Container Scanning + +DETAILS: +**Tier:** Ultimate +**Offering:** SaaS, self-managed > - [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/6346) in GitLab 14.8. > - [Deprecated](https://gitlab.com/gitlab-org/gitlab/-/issues/368828) the starboard directive in GitLab 15.4. The starboard directive is scheduled for removal in GitLab 16.0. @@ -152,7 +156,7 @@ You must have at least the Developer role. ## Scanning private images -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/415451) in GitLab 16.4. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/415451) in GitLab 16.4. To scan private images, the scanner relies on the image pull secrets (direct references and from the service account) to pull the image. diff --git a/doc/user/clusters/agent/work_with_agent.md b/doc/user/clusters/agent/work_with_agent.md index dc43eb29fb3..7ab4e29319f 100644 --- a/doc/user/clusters/agent/work_with_agent.md +++ b/doc/user/clusters/agent/work_with_agent.md @@ -4,13 +4,17 @@ group: Environments info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Managing the agent for Kubernetes instances **(FREE ALL)** +# Managing the agent for Kubernetes instances + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed Use the following tasks when you work with the agent for Kubernetes. ## View your agents -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/340882) in GitLab 14.8, the installed `agentk` version is displayed on the **Agent** tab. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/340882) in GitLab 14.8, the installed `agentk` version is displayed on the **Agent** tab. Prerequisites: @@ -32,7 +36,7 @@ On this page, you can view: ## View shared agents -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/395498) in GitLab 16.1. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/395498) in GitLab 16.1. In addition to the agents owned by your project, you can also view agents shared with the [`ci_access`](ci_cd_workflow.md) and [`user_access`](user_access.md) keywords. Once an agent @@ -48,7 +52,7 @@ The list of shared agents and their clusters are displayed. ## View an agent's activity information -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/277323) in GitLab 14.6. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/277323) in GitLab 14.6. The activity logs help you to identify problems and get the information you need for troubleshooting. You can see events from a week before the @@ -70,14 +74,14 @@ View and provide feedback about the UI in [this epic](https://gitlab.com/groups/ ## Manage an agent's workspaces -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/277323) in GitLab 16.8. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/277323) in GitLab 16.8. You can view and manage all workspaces associated with an agent. For more information, see [Manage workspaces at the agent level](../../workspace/index.md#manage-workspaces-at-the-agent-level). ## Debug the agent -> The `grpc_level` was [introduced](https://gitlab.com/gitlab-org/cluster-integration/gitlab-agent/-/merge_requests/669) in GitLab 15.1. +> - The `grpc_level` was [introduced](https://gitlab.com/gitlab-org/cluster-integration/gitlab-agent/-/merge_requests/669) in GitLab 15.1. To debug the cluster-side component (`agentk`) of the agent, set the log level according to the available options: @@ -140,7 +144,7 @@ clean up those resources manually. ### Remove an agent through the GitLab UI -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/323055) in GitLab 14.7. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/323055) in GitLab 14.7. To remove an agent from the UI: diff --git a/doc/user/clusters/environments.md b/doc/user/clusters/environments.md index 96281f2fa50..fd6d75670c4 100644 --- a/doc/user/clusters/environments.md +++ b/doc/user/clusters/environments.md @@ -4,7 +4,11 @@ group: Environments info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Cluster Environments (deprecated) **(PREMIUM ALL)** +# Cluster Environments (deprecated) + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/13392) in GitLab 12.3 for group-level clusters. > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/14809) in GitLab 12.4 for instance-level clusters. diff --git a/doc/user/clusters/management_project.md b/doc/user/clusters/management_project.md index 2c748712fe5..537d88646b6 100644 --- a/doc/user/clusters/management_project.md +++ b/doc/user/clusters/management_project.md @@ -4,7 +4,11 @@ group: Environments info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Cluster management project (deprecated) **(FREE ALL)** +# Cluster management project (deprecated) + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/32810) in GitLab 12.5. > - [Deprecated](https://gitlab.com/groups/gitlab-org/configure/-/epics/8) in GitLab 14.5. diff --git a/doc/user/clusters/management_project_template.md b/doc/user/clusters/management_project_template.md index 2b5ccd92566..c46c3863885 100644 --- a/doc/user/clusters/management_project_template.md +++ b/doc/user/clusters/management_project_template.md @@ -4,7 +4,11 @@ group: Environments info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Manage cluster applications **(FREE ALL)** +# Manage cluster applications + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/25318) in GitLab 12.10 with Helmfile support via Helm v2. > - Helm v2 support was [dropped](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/63577) in GitLab 14.0. Use Helm v3 instead. diff --git a/doc/user/clusters/migrating_from_gma_to_project_template.md b/doc/user/clusters/migrating_from_gma_to_project_template.md index e9c32eaad43..0050bb66603 100644 --- a/doc/user/clusters/migrating_from_gma_to_project_template.md +++ b/doc/user/clusters/migrating_from_gma_to_project_template.md @@ -4,7 +4,11 @@ group: Environments info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Migrate from GitLab Managed Apps to Cluster Management Projects (deprecated) **(FREE ALL)** +# Migrate from GitLab Managed Apps to Cluster Management Projects (deprecated) + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed The GitLab Managed Apps were deprecated in GitLab 14.0 in favor of user-controlled Cluster Management projects. diff --git a/doc/user/compliance/compliance_center/index.md b/doc/user/compliance/compliance_center/index.md index e3a94c119ff..3642942a9dc 100644 --- a/doc/user/compliance/compliance_center/index.md +++ b/doc/user/compliance/compliance_center/index.md @@ -4,9 +4,13 @@ group: Compliance info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Compliance center **(ULTIMATE ALL)** +# Compliance center -> [Renamed](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/122931) from Compliance report in GitLab 16.3. +DETAILS: +**Tier:** Ultimate +**Offering:** SaaS, self-managed + +> - [Renamed](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/122931) from Compliance report in GitLab 16.3. The compliance center is the central location for compliance teams to manage their compliance standards adherence reporting, violations reporting, and compliance frameworks for their group. @@ -73,7 +77,7 @@ information, see [Merge request approval rules](../../project/merge_requests/app ### Export compliance standards adherence report for projects in a group -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/413736) in GitLab 16.8 [with a flag](../../../administration/feature_flags.md) named `compliance_standards_adherence_csv_export`. Disabled by default. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/413736) in GitLab 16.8 [with a flag](../../../administration/feature_flags.md) named `compliance_standards_adherence_csv_export`. Disabled by default. FLAG: On self-managed GitLab, by default this feature is not available. To make it available, an administrator can [enable the feature flag](../../../administration/feature_flags.md) @@ -120,7 +124,7 @@ When you select a row in the compliance violations report, a drawer appears that ### View the compliance violations report for a group -> Target branch search [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/358414) in GitLab 16.0. +> - Target branch search [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/358414) in GitLab 16.0. Prerequisites: @@ -355,7 +359,7 @@ To remove a compliance framework from multiple projects in a group: ### Export a report of compliance frameworks on projects in a group -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/387912) in GitLab 16.0. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/387912) in GitLab 16.0. Export a report of compliance frameworks that are applied to projects in a group. Reports: @@ -377,7 +381,7 @@ A report is compiled and delivered to your email inbox as an attachment. #### Filter the compliance projects report -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/387911) in GitLab 15.11. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/387911) in GitLab 15.11. To filter the list of compliance frameworks: diff --git a/doc/user/compliance/index.md b/doc/user/compliance/index.md index 167eeddc00d..08da174c326 100644 --- a/doc/user/compliance/index.md +++ b/doc/user/compliance/index.md @@ -4,7 +4,11 @@ group: Compliance info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Compliance **(ULTIMATE ALL)** +# Compliance + +DETAILS: +**Tier:** Ultimate +**Offering:** SaaS, self-managed The compliance tools provided by GitLab help you keep an eye on various aspects of your project, including: diff --git a/doc/user/compliance/license_approval_policies.md b/doc/user/compliance/license_approval_policies.md index 9ec48e74aa9..be0cb4ee880 100644 --- a/doc/user/compliance/license_approval_policies.md +++ b/doc/user/compliance/license_approval_policies.md @@ -4,7 +4,11 @@ group: Security Policies info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# License approval policies **(ULTIMATE ALL)** +# License approval policies + +DETAILS: +**Tier:** Ultimate +**Offering:** SaaS, self-managed > - [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/8092) in GitLab 15.9 [with a flag](../../administration/feature_flags.md) named `license_scanning_policies`. > - [Generally available](https://gitlab.com/gitlab-org/gitlab/-/issues/397644) in GitLab 15.11. Feature flag `license_scanning_policies` removed. diff --git a/doc/user/compliance/license_list.md b/doc/user/compliance/license_list.md index 3bfc5612db9..aca71edb92e 100644 --- a/doc/user/compliance/license_list.md +++ b/doc/user/compliance/license_list.md @@ -6,7 +6,11 @@ info: To determine the technical writer assigned to the Stage/Group associated w -# License list (deprecated) **(ULTIMATE ALL)** +# License list (deprecated) + +DETAILS: +**Tier:** Ultimate +**Offering:** SaaS, self-managed WARNING: This feature was [deprecated](https://gitlab.com/gitlab-org/gitlab/-/issues/436100) in GitLab 16.8 diff --git a/doc/user/compliance/license_scanning_of_cyclonedx_files/index.md b/doc/user/compliance/license_scanning_of_cyclonedx_files/index.md index 120d0ebcc31..61f657148de 100644 --- a/doc/user/compliance/license_scanning_of_cyclonedx_files/index.md +++ b/doc/user/compliance/license_scanning_of_cyclonedx_files/index.md @@ -4,7 +4,11 @@ group: Composition Analysis info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# License scanning of CycloneDX files **(ULTIMATE ALL)** +# License scanning of CycloneDX files + +DETAILS: +**Tier:** Ultimate +**Offering:** SaaS, self-managed > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/384932) in GitLab 15.9 for GitLab SaaS [with two flags](../../../administration/feature_flags.md) named `license_scanning_sbom_scanner` and `package_metadata_synchronization`. Both flags disabled by default. > - [Generally available](https://gitlab.com/gitlab-org/gitlab/-/issues/385176) in GitLab 16.4. Feature flags `license_scanning_sbom_scanner` and `package_metadata_synchronization` removed. diff --git a/doc/user/crm/index.md b/doc/user/crm/index.md index 4f1eeb3578c..f12f4bb539f 100644 --- a/doc/user/crm/index.md +++ b/doc/user/crm/index.md @@ -4,7 +4,11 @@ group: Respond info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Customer relations management (CRM) **(FREE ALL)** +# Customer relations management (CRM) + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/2256) in GitLab 14.6 [with a flag](../../administration/feature_flags.md) named `customer_relations`. Disabled by default. > - In GitLab 14.8 and later, you can [create contacts and organizations only in root groups](https://gitlab.com/gitlab-org/gitlab/-/issues/350634). diff --git a/doc/user/custom_roles.md b/doc/user/custom_roles.md index 31f647a0afe..d5ac9e783ed 100644 --- a/doc/user/custom_roles.md +++ b/doc/user/custom_roles.md @@ -4,7 +4,11 @@ group: Authorization info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Custom roles **(ULTIMATE ALL)** +# Custom roles + +DETAILS: +**Tier:** Ultimate +**Offering:** SaaS, self-managed > - [Custom roles feature introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/106256) in GitLab 15.7 [with a flag](../administration/feature_flags.md) named `customizable_roles`. > - [Enabled by default](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/110810) in GitLab 15.9. diff --git a/doc/user/discussions/index.md b/doc/user/discussions/index.md index dfcbc8a171d..a64daf56ce9 100644 --- a/doc/user/discussions/index.md +++ b/doc/user/discussions/index.md @@ -4,7 +4,11 @@ group: Code Review info: "To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments" --- -# Comments and threads **(FREE ALL)** +# Comments and threads + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed > - Paginated merge request discussions [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/340172) in GitLab 15.1 [with a flag](../../administration/feature_flags.md) named `paginated_mr_discussions`. Disabled by default. > - Paginated merge request discussions [enabled on GitLab.com](https://gitlab.com/gitlab-org/gitlab/-/issues/364497) in GitLab 15.2. @@ -52,7 +56,7 @@ in a different color. ### Mentioning all members -> [Flag](../../administration/feature_flags.md) named `disable_all_mention` [introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/110586) in GitLab 16.1. Disabled by default. [Enabled on GitLab.com](https://gitlab.com/gitlab-org/gitlab/-/issues/18442). +> - [Flag](../../administration/feature_flags.md) named `disable_all_mention` [introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/110586) in GitLab 16.1. Disabled by default. [Enabled on GitLab.com](https://gitlab.com/gitlab-org/gitlab/-/issues/18442). FLAG: On self-managed GitLab, by default this flag is not enabled. To make it available, an administrator can [enable the feature flag](../../administration/feature_flags.md) @@ -227,7 +231,11 @@ To change the activity sort order: 1. On the right side of the page, from the **Sort or filter** dropdown list, select the sort order **Newest first** or **Oldest first** (default). -## View description change history **(PREMIUM ALL)** +## View description change history + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed You can see changes to the description listed in the history. diff --git a/doc/user/emoji_reactions.md b/doc/user/emoji_reactions.md index a72c15bb229..2f20640d4eb 100644 --- a/doc/user/emoji_reactions.md +++ b/doc/user/emoji_reactions.md @@ -4,7 +4,11 @@ group: Project Management info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Emoji reactions **(FREE ALL)** +# Emoji reactions + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed > - [Renamed](https://gitlab.com/gitlab-org/gitlab/-/issues/409884) from "award emoji" to "emoji reactions" in GitLab 16.0. > - Reacting with emoji on work items (such as tasks, objectives, and key results) [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/393599) in GitLab 16.0. @@ -75,7 +79,7 @@ For a list of custom emoji available for GitLab.com, see ### Upload custom emoji to a group -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/128355) in GitLab 16.5. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/128355) in GitLab 16.5. Upload your custom emoji to a group to use them in all its subgroups and projects. diff --git a/doc/user/enterprise_user/index.md b/doc/user/enterprise_user/index.md index 5a6ee56b775..0b8357928e9 100644 --- a/doc/user/enterprise_user/index.md +++ b/doc/user/enterprise_user/index.md @@ -4,7 +4,11 @@ group: Authentication info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Enterprise users **(PREMIUM SAAS)** +# Enterprise users + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS Enterprise users have user accounts that are administered by an organization that has [verified their email domain](../project/pages/custom_domains_ssl_tls_certification/index.md) and purchased a [GitLab subscription](../../subscriptions/index.md). @@ -176,7 +180,7 @@ These enterprise user-specific actions are in addition to the standard ### Disable two-factor authentication -> [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/9484) in GitLab 15.8. +> - [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/9484) in GitLab 15.8. Top-level group Owners can disable two-factor authentication (2FA) for enterprise users. diff --git a/doc/user/feature_flags.md b/doc/user/feature_flags.md index ccce9e9f9b4..5f8f00e9f96 100644 --- a/doc/user/feature_flags.md +++ b/doc/user/feature_flags.md @@ -8,7 +8,7 @@ layout: 'feature_flags' # All feature flags in GitLab -> Feature flag documentation warnings were [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/227806) in GitLab 13.4. +> - Feature flag documentation warnings were [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/227806) in GitLab 13.4. The following feature flags exist in GitLab. These flags determine the availability of each feature. diff --git a/doc/user/free_push_limit.md b/doc/user/free_push_limit.md index 53088cd4445..ff3c6928fa7 100644 --- a/doc/user/free_push_limit.md +++ b/doc/user/free_push_limit.md @@ -4,7 +4,11 @@ group: Acquisition info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Free push limit **(FREE SAAS)** +# Free push limit + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS A 100 MiB per-file limit applies when pushing new files to any project in the Free tier. diff --git a/doc/user/free_user_limit.md b/doc/user/free_user_limit.md index 330f041b430..a62124517ef 100644 --- a/doc/user/free_user_limit.md +++ b/doc/user/free_user_limit.md @@ -4,7 +4,11 @@ group: Acquisition info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Free user limit **(FREE SAAS)** +# Free user limit + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS A five-user limit applies to newly created top-level namespaces with private visibility on GitLab SaaS. For existing namespaces created before December 28, 2022, the limit was applied on June 13, 2023. diff --git a/doc/user/gitlab_com/index.md b/doc/user/gitlab_com/index.md index ffa04c6b916..457f73a63be 100644 --- a/doc/user/gitlab_com/index.md +++ b/doc/user/gitlab_com/index.md @@ -4,7 +4,11 @@ group: unassigned info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# GitLab.com settings **(FREE SAAS)** +# GitLab.com settings + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS This page contains information about the settings that are used on GitLab.com, available to [GitLab SaaS](https://about.gitlab.com/pricing/) customers. @@ -110,7 +114,11 @@ Similarly, you can clone a project's wiki to back it up. All files [uploaded after August 22, 2020](../project/wiki/index.md#create-a-new-wiki-page) are included when cloning. -## Delayed group deletion **(PREMIUM SAAS)** +## Delayed group deletion + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS After May 08, 2023, all groups have delayed deletion enabled by default. @@ -118,7 +126,11 @@ Groups are permanently deleted after a seven-day delay. If you are on the Free tier, your groups are immediately deleted, and you will not be able to restore them. -## Delayed project deletion **(PREMIUM SAAS)** +## Delayed project deletion + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS After May 08, 2023, all groups have delayed project deletion enabled by default. diff --git a/doc/user/gitlab_duo_chat.md b/doc/user/gitlab_duo_chat.md index 92b3013bfc2..de3c6199ed7 100644 --- a/doc/user/gitlab_duo_chat.md +++ b/doc/user/gitlab_duo_chat.md @@ -4,7 +4,12 @@ group: Duo Chat info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# GitLab Duo Chat **(ULTIMATE ALL BETA)** +# GitLab Duo Chat + +DETAILS: +**Tier:** Ultimate +**Offering:** SaaS, self-managed +**Status:** Beta > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/117695) as an [Experiment](../policy/experiment-beta-support.md#experiment) for SaaS in GitLab 16.0. > - Changed to [Beta](../policy/experiment-beta-support.md#beta) for SaaS in GitLab 16.6. @@ -51,7 +56,7 @@ GitLab Duo Chat can help in a variety of areas. ### Ask about GitLab -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/117695) for SaaS in GitLab 16.0. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/117695) for SaaS in GitLab 16.0. You can ask questions about how GitLab works. Things like: @@ -209,9 +214,13 @@ To delete all previous conversations: 1. In the text box, type `/clean` and select **Send**. -## Use GitLab Duo Chat in the Web IDE **(ULTIMATE EXPERIMENT)** +## Use GitLab Duo Chat in the Web IDE -> Introduced in GitLab 16.6 as an [EXPERIMENT](../policy/experiment-beta-support.md#experiment) +DETAILS: +**Tier:** Ultimate +**Status:** Experiment + +> - Introduced in GitLab 16.6 as an [Experiment](../policy/experiment-beta-support.md#experiment) To use GitLab Duo Chat in the Web IDE on GitLab: @@ -233,9 +242,13 @@ If you have selected code in the editor, this selection is sent along with your NOTE: GitLab Duo Chat is not available in the Web IDE on self-managed. -## Use GitLab Duo Chat in VS Code **(ULTIMATE EXPERIMENT)** +## Use GitLab Duo Chat in VS Code -> Introduced in GitLab 16.6 as an [EXPERIMENT](../policy/experiment-beta-support.md#experiment). +DETAILS: +**Tier:** Ultimate +**Status:** Experiment + +> - Introduced in GitLab 16.6 as an [Experiment](../policy/experiment-beta-support.md#experiment). To use GitLab Duo Chat in GitLab Workflow extension for VS Code: diff --git a/doc/user/group/access_and_permissions.md b/doc/user/group/access_and_permissions.md index 4628b7be9ce..5164e3679b1 100644 --- a/doc/user/group/access_and_permissions.md +++ b/doc/user/group/access_and_permissions.md @@ -8,7 +8,11 @@ info: To determine the technical writer assigned to the Stage/Group associated w Configure your groups to control group permissions and access. -## Group push rules **(PREMIUM ALL)** +## Group push rules + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/34370) in GitLab 12.8. > - [Feature flag removed](https://gitlab.com/gitlab-org/gitlab/-/issues/224129) in GitLab 13.4. @@ -52,7 +56,11 @@ To change the permitted Git access protocols for a group: 1. Choose the permitted protocols from **Enabled Git access protocols**. 1. Select **Save changes**. -## Restrict group access by IP address **(PREMIUM ALL)** +## Restrict group access by IP address + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/1985) in GitLab 12.0. > - [Moved](https://gitlab.com/gitlab-org/gitlab/-/issues/215410) from GitLab Ultimate to GitLab Premium in 13.1. @@ -112,7 +120,11 @@ Artifact and Registry downloading from runners is sourced from any Google or, in The download is therefore not added to the global allowlist. To allow runner downloading, add the [outbound runner CIDR ranges](../gitlab_com/index.md#ip-range) to your group allowlist. -## Restrict group access by domain **(PREMIUM ALL)** +## Restrict group access by domain + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed > - Support for specifying multiple email domains [added](https://gitlab.com/gitlab-org/gitlab/-/issues/33143) in GitLab 13.1. > - Support for restricting access to projects in the group [added](https://gitlab.com/gitlab-org/gitlab/-/issues/14004) in GitLab 14.1.2. @@ -204,9 +216,13 @@ your group. 1. Clear the **Allow users to request access** checkbox. 1. Select **Save changes**. -## Prevent project forking outside group **(PREMIUM ALL)** +## Prevent project forking outside group -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/216987) in GitLab 13.3. +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/216987) in GitLab 13.3. By default, projects in a group can be forked. Optionally, on [GitLab Premium and Ultimate tiers](https://about.gitlab.com/pricing/), @@ -226,7 +242,11 @@ To prevent projects from being forked outside the group: Existing forks are not removed. -## Prevent members from being added to projects in a group **(PREMIUM ALL)** +## Prevent members from being added to projects in a group + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed As a group Owner, you can prevent any new project membership for all projects in a group, allowing tighter control over project membership. @@ -254,7 +274,11 @@ After you lock the membership for a group: - All users who previously had permissions can no longer add members to a group. - API requests to add a new user to a project are not possible. -## Manage group memberships via LDAP **(PREMIUM SELF)** +## Manage group memberships via LDAP + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** Self-managed Group syncing allows LDAP groups to be mapped to GitLab groups. This provides more control over per-group user management. To configure group syncing, edit the `group_base` **DN** (`'OU=Global Groups,OU=GitLab INT,DC=GitLab,DC=org'`). This **OU** contains all groups that are associated with GitLab groups. @@ -274,7 +298,11 @@ When you add LDAP synchronization, if an LDAP user is a group member and they ar You can use a workaround to [manage project access through LDAP groups](../project/working_with_projects.md#manage-project-access-through-ldap-groups). -### Create group links via CN **(PREMIUM SELF)** +### Create group links via CN + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** Self-managed To create group links via CN: @@ -288,7 +316,11 @@ To create group links via CN: -### Create group links via filter **(PREMIUM SELF)** +### Create group links via filter + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** Self-managed To create group links via filter: @@ -298,7 +330,11 @@ To create group links via filter: 1. In the **LDAP Access** section, select the [permission level](../permissions.md) for users synced in this group. 1. Select **Add Synchronization**. -### Override user permissions **(PREMIUM SELF)** +### Override user permissions + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** Self-managed LDAP user permissions can be manually overridden by an administrator. To override a user's permissions: diff --git a/doc/user/group/clusters/index.md b/doc/user/group/clusters/index.md index bbd53c09352..f35281385f8 100644 --- a/doc/user/group/clusters/index.md +++ b/doc/user/group/clusters/index.md @@ -4,7 +4,11 @@ group: Environments info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Group-level Kubernetes clusters (certificate-based) (deprecated) **(FREE ALL)** +# Group-level Kubernetes clusters (certificate-based) (deprecated) + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed > - [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/issues/34758) in GitLab 11.6. > - [Deprecated](https://gitlab.com/groups/gitlab-org/configure/-/epics/8) in GitLab 14.5. @@ -48,7 +52,7 @@ to the project, provided the cluster is not disabled. ## Multiple Kubernetes clusters -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/35094) in GitLab 13.2. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/35094) in GitLab 13.2. You can associate more than one Kubernetes cluster to your group, and maintain different clusters for different environments, such as development, staging, and production. @@ -79,7 +83,7 @@ for deployments with a cluster not managed by GitLab, you must ensure: ### Clearing the cluster cache -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/31759) in GitLab 12.6. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/31759) in GitLab 12.6. If you choose to allow GitLab to manage your cluster for you, GitLab stores a cached version of the namespaces and service accounts it creates for your projects. If you @@ -96,7 +100,7 @@ To clear the cache: ## Base domain -> [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/24580) in GitLab 11.8. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/24580) in GitLab 11.8. Domains at the cluster level permit support for multiple domains per [multiple Kubernetes clusters](#multiple-kubernetes-clusters) When specifying a domain, @@ -105,7 +109,11 @@ the [Auto DevOps](../../../topics/autodevops/index.md) stages. The domain should have a wildcard DNS configured to the Ingress IP address. [More details](../../project/clusters/gitlab_managed_clusters.md#base-domain). -## Environment scopes **(PREMIUM ALL)** +## Environment scopes + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed When adding more than one Kubernetes cluster to your project, you need to differentiate them with an environment scope. The environment scope associates clusters with @@ -161,7 +169,11 @@ The result is: - The Staging cluster is used for the `deploy to staging` job. - The Production cluster is used for the `deploy to production` job. -## Cluster environments **(PREMIUM ALL)** +## Cluster environments + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed For a consolidated view of which CI [environments](../../../ci/environments/index.md) are deployed to the Kubernetes cluster, see the documentation for diff --git a/doc/user/group/compliance_frameworks.md b/doc/user/group/compliance_frameworks.md index 4a03db33a86..667afec222a 100644 --- a/doc/user/group/compliance_frameworks.md +++ b/doc/user/group/compliance_frameworks.md @@ -4,7 +4,11 @@ group: Compliance info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Compliance frameworks **(PREMIUM ALL)** +# Compliance frameworks + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/276221) in GitLab 13.9. > - [Feature flag removed](https://gitlab.com/gitlab-org/gitlab/-/issues/287779) in GitLab 13.12. @@ -42,7 +46,7 @@ Frameworks cannot be added to projects in personal namespaces. ### GraphQL API -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/333249) in GitLab 14.2. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/333249) in GitLab 14.2. You can use the [GraphQL API](../../api/graphql/reference/index.md#mutationprojectsetcomplianceframework) to add a compliance framework to a project. @@ -52,7 +56,7 @@ has the correct permissions. The GitLab UI presents a read-only view to discoura ## Default compliance frameworks -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/375036) in GitLab 15.6. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/375036) in GitLab 15.6. Group owners can set a default compliance framework. The default framework is applied to all the new and imported projects that are created in that group. It does not affect the framework applied to the existing projects. The @@ -62,7 +66,7 @@ A compliance framework that is set to default has a **default** label. ### Set and remove as default -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/375038) in GitLab 15.7. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/375038) in GitLab 15.7. Group owners can set a compliance framework as default (or remove the setting): @@ -113,7 +117,11 @@ mutation { } ``` -## Compliance pipelines **(ULTIMATE ALL)** +## Compliance pipelines + +DETAILS: +**Tier:** Ultimate +**Offering:** SaaS, self-managed > - [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/3156) in GitLab 13.9, disabled behind `ff_evaluate_group_level_compliance_pipeline` [feature flag](../../administration/feature_flags.md). > - [Enabled by default](https://gitlab.com/gitlab-org/gitlab/-/issues/300324) in GitLab 13.11. diff --git a/doc/user/group/contribution_analytics/index.md b/doc/user/group/contribution_analytics/index.md index 6d8d209986c..7636e74859e 100644 --- a/doc/user/group/contribution_analytics/index.md +++ b/doc/user/group/contribution_analytics/index.md @@ -3,9 +3,13 @@ stage: Plan group: Optimize info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Contribution analytics **(PREMIUM ALL)** +# Contribution analytics -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/3090) in GitLab 12.2 for subgroups. +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/3090) in GitLab 12.2 for subgroups. Contribution analytics provide an overview of the [contribution events](../../profile/contributions_calendar.md#user-contribution-events) made by your group's members. diff --git a/doc/user/group/custom_project_templates.md b/doc/user/group/custom_project_templates.md index 07158a0c06f..398f2b82175 100644 --- a/doc/user/group/custom_project_templates.md +++ b/doc/user/group/custom_project_templates.md @@ -4,9 +4,13 @@ group: Source Code info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Custom group-level project templates **(PREMIUM ALL)** +# Custom group-level project templates -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/6861) in GitLab 11.6. +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/6861) in GitLab 11.6. When you create a project, you can [choose from a list of templates](../project/index.md). These templates, for things like GitLab Pages or Ruby, populate the new project with a copy of the files contained in the diff --git a/doc/user/group/devops_adoption/index.md b/doc/user/group/devops_adoption/index.md index 978c893a0ec..5464514f968 100644 --- a/doc/user/group/devops_adoption/index.md +++ b/doc/user/group/devops_adoption/index.md @@ -4,7 +4,11 @@ group: Optimize info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Group DevOps Adoption **(ULTIMATE ALL)** +# Group DevOps Adoption + +DETAILS: +**Tier:** Ultimate +**Offering:** SaaS, self-managed > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/321083) in GitLab 13.11 as a [Beta feature](../../../policy/experiment-beta-support.md#beta). > - [Feature flag removed](https://gitlab.com/gitlab-org/gitlab/-/issues/333556) in GitLab 14.1. diff --git a/doc/user/group/epics/epic_boards.md b/doc/user/group/epics/epic_boards.md index 62d410bdc5a..caeacbcc6a7 100644 --- a/doc/user/group/epics/epic_boards.md +++ b/doc/user/group/epics/epic_boards.md @@ -4,7 +4,11 @@ group: Product Planning info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Epic boards **(PREMIUM ALL)** +# Epic boards + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed > - [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/5067) in GitLab 13.10. > - [Feature flag removed](https://gitlab.com/gitlab-org/gitlab/-/issues/290039) in GitLab 14.1. @@ -55,7 +59,7 @@ To change these options later, [edit the board](#edit-the-scope-of-an-epic-board ## Delete an epic board -> [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/5079) in GitLab 14.0. +> - [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/5079) in GitLab 14.0. Prerequisites: @@ -112,7 +116,7 @@ To remove a list from an epic board: ### Create an epic from an epic board -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/233568) in GitLab 14.0. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/233568) in GitLab 14.0. Prerequisites: @@ -129,7 +133,7 @@ To create an epic from a list in epic board: ### Filter epics -> [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/5079) in GitLab 14.0. +> - [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/5079) in GitLab 14.0. Use the filters on top of your epic board to show only the results you want. It's similar to the filtering used in the epic list, @@ -142,7 +146,7 @@ You can filter by the following: ### View count of issues, weight, and progress of an epic -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/331330) in GitLab 14.1. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/331330) in GitLab 14.1. Epics on an epic board show a summary of their issues, weight, and progress. To see the number of open and closed issues and the completed and incomplete @@ -151,7 +155,7 @@ progress icon **{progress}**. ### Move epics and lists -> [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/5079) in GitLab 14.0. +> - [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/5079) in GitLab 14.0. You can move epics and lists by dragging them. @@ -167,7 +171,7 @@ You can't move the **Open** and **Closed** lists, but you can hide them when edi #### Move an epic to the start of the list -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/367473) in GitLab 15.4. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/367473) in GitLab 15.4. When you have many epics, it's inconvenient to manually drag an epic from the bottom of a board list all the way to the top. You can move epics to the top of the list with a menu shortcut. @@ -185,7 +189,7 @@ To move an epic to the start of the list: #### Move an epic to the end of the list -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/367473) in GitLab 15.4. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/367473) in GitLab 15.4. When you have many epics, it's inconvenient to manually drag an epic from the top of a board list all the way to the bottom. You can move epics to the bottom of the list with a menu shortcut. diff --git a/doc/user/group/epics/index.md b/doc/user/group/epics/index.md index c524490eb0b..e779a112b83 100644 --- a/doc/user/group/epics/index.md +++ b/doc/user/group/epics/index.md @@ -4,7 +4,11 @@ group: Product Planning info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Epics **(PREMIUM ALL)** +# Epics + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed When [issues](../../project/issues/index.md) share a theme across projects and milestones, you can manage them by using epics. @@ -52,7 +56,11 @@ You can add issues from a different group hierarchy to an epic. To do it, paste the issue URL when [adding an existing issue](manage_epics.md#add-an-existing-issue-to-an-epic). -## Roadmap in epics **(ULTIMATE ALL)** +## Roadmap in epics + +DETAILS: +**Tier:** Ultimate +**Offering:** SaaS, self-managed If your epic contains one or more [child epics](manage_epics.md#multi-level-child-epics) that have a start or due date, a visual diff --git a/doc/user/group/epics/linked_epics.md b/doc/user/group/epics/linked_epics.md index fb63e851a69..bccdc3ae6fa 100644 --- a/doc/user/group/epics/linked_epics.md +++ b/doc/user/group/epics/linked_epics.md @@ -4,7 +4,11 @@ group: Product Planning info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Linked epics **(ULTIMATE ALL)** +# Linked epics + +DETAILS: +**Tier:** Ultimate +**Offering:** SaaS, self-managed > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/353473) in GitLab 14.9 [with a flag](../../../administration/feature_flags.md) named `related_epics_widget`. Enabled by default. > - [Feature flag `related_epics_widget`](https://gitlab.com/gitlab-org/gitlab/-/issues/357089) removed in GitLab 15.0. @@ -20,7 +24,7 @@ To manage linked epics through our API, see [Linked epics API](../../../api/link ## Add a linked epic -> Minimum required role for the group [changed](https://gitlab.com/gitlab-org/gitlab/-/issues/381308) from Reporter to Guest in GitLab 15.8. +> - Minimum required role for the group [changed](https://gitlab.com/gitlab-org/gitlab/-/issues/381308) from Reporter to Guest in GitLab 15.8. Prerequisites: @@ -61,7 +65,7 @@ The linked epics are then displayed on the epic grouped by relationship. ## Remove a linked epic -> Minimum required role for the group [changed](https://gitlab.com/gitlab-org/gitlab/-/issues/381308) from Reporter to Guest in GitLab 15.8. +> - Minimum required role for the group [changed](https://gitlab.com/gitlab-org/gitlab/-/issues/381308) from Reporter to Guest in GitLab 15.8. Prerequisites: diff --git a/doc/user/group/epics/manage_epics.md b/doc/user/group/epics/manage_epics.md index 286a1c474da..427b720bf56 100644 --- a/doc/user/group/epics/manage_epics.md +++ b/doc/user/group/epics/manage_epics.md @@ -4,7 +4,11 @@ group: Product Planning info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Manage epics **(PREMIUM ALL)** +# Manage epics + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed This page collects instructions for all the things you can do with [epics](index.md) or in relation to them. @@ -58,7 +62,7 @@ The parent epic's start date then reflects this change and propagates upwards to ### Epic color -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/79940) in GitLab 14.9 [with a flag](../../../administration/feature_flags.md) named `epic_color_highlight`. Disabled by default. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/79940) in GitLab 14.9 [with a flag](../../../administration/feature_flags.md) named `epic_color_highlight`. Disabled by default. FLAG: On self-managed GitLab, by default this feature is not available. To make it available per group, an administrator can [enable the feature flag](../../../administration/feature_flags.md) named `epic_color_highlight`. @@ -96,7 +100,7 @@ To edit an epic's start date, due date, or labels: ### Reorder list items in the epic description -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/15260) in GitLab 15.1. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/15260) in GitLab 15.1. When you view an epic that has a list in the description, you can also reorder the list items. @@ -249,7 +253,7 @@ To filter: ### Filter with the OR operator -> OR filtering for labels and authors was [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/382969) in GitLab 15.9 [with a flag](../../../administration/feature_flags.md) named `or_issuable_queries`. Disabled by default. +> - OR filtering for labels and authors was [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/382969) in GitLab 15.9 [with a flag](../../../administration/feature_flags.md) named `or_issuable_queries`. Disabled by default. FLAG: On self-managed GitLab, by default this feature is not available. @@ -282,7 +286,7 @@ The sort option and order is saved and used wherever you browse epics, including ## Change activity sort order -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/214364) in GitLab 13.2. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/214364) in GitLab 13.2. You can reverse the default order and interact with the activity feed sorted by most recent items at the top. Your preference is saved via local storage and automatically applied to every epic and issue @@ -347,7 +351,7 @@ added to the epic. #### Add an existing issue to an epic -> Minimum required role for the project [changed](https://gitlab.com/gitlab-org/gitlab/-/issues/382506) from Reporter to Guest in GitLab 15.8. +> - Minimum required role for the project [changed](https://gitlab.com/gitlab-org/gitlab/-/issues/382506) from Reporter to Guest in GitLab 15.8. You can add existing issues to an epic, including issues in a project from a [different group hierarchy](index.md#child-issues-from-different-group-hierarchies). Newly added issues appear at the top of the list of issues in the **Child issues and epics** section. @@ -375,7 +379,7 @@ To add an existing issue to an epic: #### Create an issue from an epic -> Minimum required role for the project [changed](https://gitlab.com/gitlab-org/gitlab/-/issues/382506) from Reporter to Guest in GitLab 15.8. +> - Minimum required role for the project [changed](https://gitlab.com/gitlab-org/gitlab/-/issues/382506) from Reporter to Guest in GitLab 15.8. Creating an issue from an epic enables you to maintain focus on the broader context of the epic while dividing work into smaller parts. @@ -402,7 +406,7 @@ The new issue is assigned to the epic. ### Remove an issue from an epic -> Minimum required role for the project [changed](https://gitlab.com/gitlab-org/gitlab/-/issues/382506) from Reporter to Guest in GitLab 15.8. +> - Minimum required role for the project [changed](https://gitlab.com/gitlab-org/gitlab/-/issues/382506) from Reporter to Guest in GitLab 15.8. You can remove issues from an epic when you're on the epic's details page. After you remove an issue from an epic, the issue is no longer associated with this epic. @@ -421,7 +425,7 @@ To remove an issue from an epic: ### Reorder issues assigned to an epic -> Minimum required role for the project [changed](https://gitlab.com/gitlab-org/gitlab/-/issues/382506) from Reporter to Guest in GitLab 15.8. +> - Minimum required role for the project [changed](https://gitlab.com/gitlab-org/gitlab/-/issues/382506) from Reporter to Guest in GitLab 15.8. New issues appear at the top of the list in the **Child issues and epics** section. You can reorder the list of issues by dragging them. @@ -435,7 +439,11 @@ To reorder issues assigned to an epic: 1. Go to the **Child issues and epics** section. 1. Drag issues into the desired order. -### Move issues between epics **(ULTIMATE ALL)** +### Move issues between epics + +DETAILS: +**Tier:** Ultimate +**Offering:** SaaS, self-managed > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/33039) in GitLab 13.0. > - Minimum required role for the project [changed](https://gitlab.com/gitlab-org/gitlab/-/issues/382506) from Reporter to Guest in GitLab 15.8. @@ -461,7 +469,11 @@ For an introduction to epic templates, see [GitLab Epics and Epic Template Tip]( For more on epic templates, see [Epic Templates - Repeatable sets of issues](https://about.gitlab.com/handbook/marketing/brand-and-product-marketing/product-and-solution-marketing/getting-started/104/). -## Multi-level child epics **(ULTIMATE ALL)** +## Multi-level child epics + +DETAILS: +**Tier:** Ultimate +**Offering:** SaaS, self-managed You can add any epic that belongs to a group or subgroup of the parent epic's group. New child epics appear at the top of the list of epics in the **Child issues and epics** section. @@ -490,7 +502,7 @@ To add a child epic from another group, paste the epic's URL when [adding an exi ### Add a child epic to an epic -> Minimum required role for the group [changed](https://gitlab.com/gitlab-org/gitlab/-/issues/382503) from Reporter to Guest in GitLab 15.7. +> - Minimum required role for the group [changed](https://gitlab.com/gitlab-org/gitlab/-/issues/382503) from Reporter to Guest in GitLab 15.7. Prerequisites: @@ -534,7 +546,7 @@ To move child epics to another epic: ### Reorder child epics assigned to an epic -> Minimum required role for the group [changed](https://gitlab.com/gitlab-org/gitlab/-/issues/382503) from Reporter to Guest in GitLab 15.7. +> - Minimum required role for the group [changed](https://gitlab.com/gitlab-org/gitlab/-/issues/382503) from Reporter to Guest in GitLab 15.7. New child epics appear at the top of the list in the **Child issues and epics** section. You can reorder the list of child epics. @@ -550,7 +562,7 @@ To reorder child epics assigned to an epic: ### Remove a child epic from a parent epic -> Minimum required role for the group [changed](https://gitlab.com/gitlab-org/gitlab/-/issues/382503) from Reporter to Guest in GitLab 15.7. +> - Minimum required role for the group [changed](https://gitlab.com/gitlab-org/gitlab/-/issues/382503) from Reporter to Guest in GitLab 15.7. Prerequisites: diff --git a/doc/user/group/import/index.md b/doc/user/group/import/index.md index be9b8f40f97..cbefb3fe2af 100644 --- a/doc/user/group/import/index.md +++ b/doc/user/group/import/index.md @@ -4,7 +4,11 @@ group: Import and Integrate info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Migrate GitLab groups and projects by using direct transfer **(FREE ALL)** +# Migrate GitLab groups and projects by using direct transfer + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/249160) in GitLab 13.7 for group resources [with a flag](../../feature_flags.md) named `bulk_import`. Disabled by default. > - Group items [enabled on GitLab.com and self-managed](https://gitlab.com/gitlab-org/gitlab/-/issues/338985) in GitLab 14.3. @@ -113,7 +117,7 @@ If you are migrating large projects and encounter problems with timeouts or dura ## Limits -> Eight hour time limit on migrations [removed](https://gitlab.com/gitlab-org/gitlab/-/issues/429867) in GitLab 16.7. +> - Eight hour time limit on migrations [removed](https://gitlab.com/gitlab-org/gitlab/-/issues/429867) in GitLab 16.7. Hardcoded limits apply on migration by direct transfer. @@ -164,7 +168,7 @@ be changed: ## Prerequisites -> Requirement for Maintainer role instead of Developer role introduced in GitLab 16.0 and backported to GitLab 15.11.1 and GitLab 15.10.5. +> - Requirement for Maintainer role instead of Developer role introduced in GitLab 16.0 and backported to GitLab 15.11.1 and GitLab 15.10.5. To migrate groups by direct transfer: @@ -219,7 +223,7 @@ Create the group you want to import to and connect the source GitLab instance: ## Select the groups and projects to import -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/385689) in GitLab 15.8, option to import groups with or without projects. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/385689) in GitLab 15.8, option to import groups with or without projects. After you have authorized access to the source GitLab instance, you are redirected to the GitLab group importer page. Here you can see a list of the top-level groups on the connected source instance where you have the Owner @@ -238,7 +242,7 @@ ready for production use. ## Group import history -> **Partially completed** status [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/394727) in GitLab 16.7. +> - **Partially completed** status [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/394727) in GitLab 16.7. You can view all groups migrated by you by direct transfer listed on the group import history page. This list includes: @@ -320,7 +324,10 @@ Some group items are excluded from migration because they either: - May contain sensitive information: CI/CD variables, webhooks, and deploy tokens. - Are not supported: push rules. -## Migrated project items **(BETA)** +## Migrated project items + +DETAILS: +**Status:** Beta > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/267945) in GitLab 14.4 [with a flag](../../feature_flags.md) named `bulk_import_projects`. Disabled by default. > - [Enabled on GitLab.com](https://gitlab.com/gitlab-org/gitlab/-/issues/339941) in GitLab 15.6. @@ -479,7 +486,7 @@ You can also see all migrated entities with any failures related to them using a ### Stale imports -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/352985) in GitLab 14.10. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/352985) in GitLab 14.10. When troubleshooting group migration, an import may not complete because the import workers took longer than 8 hours to execute. In this case, the `status` of either a `BulkImport` or diff --git a/doc/user/group/index.md b/doc/user/group/index.md index f4b4f9f2d39..e83a1ec011f 100644 --- a/doc/user/group/index.md +++ b/doc/user/group/index.md @@ -4,7 +4,11 @@ group: Tenant Scale info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Groups **(FREE ALL)** +# Groups + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed In GitLab, you use groups to manage one or more related projects at the same time. @@ -119,7 +123,7 @@ To edit group details: ## Leave a group -> The button to leave a group [moved](https://gitlab.com/gitlab-org/gitlab/-/issues/431539) to the Actions menu in GitLab 16.7. +> - The button to leave a group [moved](https://gitlab.com/gitlab-org/gitlab/-/issues/431539) to the Actions menu in GitLab 16.7. When you leave a group: @@ -134,7 +138,7 @@ To leave a group: ## Remove a group -> Enabled delayed deletion by default and removed the option to delete immediately [on GitLab.com](https://gitlab.com/gitlab-org/gitlab/-/issues/393622) and [on self-managed](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/119606) in GitLab 16.0. +> - Enabled delayed deletion by default and removed the option to delete immediately [on GitLab.com](https://gitlab.com/gitlab-org/gitlab/-/issues/393622) and [on self-managed](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/119606) in GitLab 16.0. To remove a group and its contents: @@ -157,7 +161,11 @@ In [GitLab 12.8 and later](https://gitlab.com/gitlab-org/gitlab/-/issues/33257), In [GitLab 13.6 and later](https://gitlab.com/gitlab-org/gitlab/-/issues/39504), if the user who sets up the deletion is removed from the group before the deletion happens, the job is cancelled, and the group is no longer scheduled for deletion. -## Remove a group immediately **(PREMIUM ALL)** +## Remove a group immediately + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/336985) in GitLab 14.2. > - Enabled delayed deletion by default and removed the option to delete immediately [on GitLab.com](https://gitlab.com/gitlab-org/gitlab/-/issues/393622) and [on self-managed](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/119606) in GitLab 16.0. @@ -179,9 +187,13 @@ To immediately remove a group marked for deletion: This action deletes the group, its subgroups, projects, and all related resources, including issues and merge requests. -## Restore a group **(PREMIUM ALL)** +## Restore a group -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/33257) in GitLab 12.8. +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/33257) in GitLab 12.8. To restore a group that is marked for deletion: @@ -278,7 +290,7 @@ You can sort members by **Account**, **Access granted**, **Max role**, or **Last ## Add users to a group -> Expiring access email notification [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/12704) in GitLab 16.2. +> - Expiring access email notification [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/12704) in GitLab 16.2. You can give a user access to all projects in a group. @@ -372,7 +384,7 @@ To change this setting globally, see [Default project creation protection](../.. ## Get the group ID -> Group ID [moved](https://gitlab.com/gitlab-org/gitlab/-/issues/431539) to the Actions menu in GitLab 16.7. +> - Group ID [moved](https://gitlab.com/gitlab-org/gitlab/-/issues/431539) to the Actions menu in GitLab 16.7. You might need the group ID if you want to interact with it using the [GitLab API](../../api/index.md). diff --git a/doc/user/group/issues_analytics/index.md b/doc/user/group/issues_analytics/index.md index efd4a46c710..d6e159ddc0c 100644 --- a/doc/user/group/issues_analytics/index.md +++ b/doc/user/group/issues_analytics/index.md @@ -4,7 +4,11 @@ group: Optimize info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Issue analytics **(PREMIUM ALL)** +# Issue analytics + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed > - Issue analytics for groups [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/7478) in GitLab 11.5. > - Issue analytics for projects [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/196561) in GitLab 12.9. @@ -38,7 +42,11 @@ shows a total of 15 months for the chart in the GitLab.org group. ![Issues created per month](img/issues_created_per_month_v12_8_a.png) -## Enhanced issue analytics **(ULTIMATE ALL)** +## Enhanced issue analytics + +DETAILS: +**Tier:** Ultimate +**Offering:** SaaS, self-managed > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/233905/) in GitLab 16.3 [with a flag](../../../administration/feature_flags.md) named `issues_completed_analytics_feature_flag`. Disabled by default. > - [Enabled on GitLab.com and self-managed](https://gitlab.com/gitlab-org/gitlab/-/issues/437542) in GitLab 16.8. @@ -53,7 +61,7 @@ You can use this metric to improve the overall turn-around time and value delive ## Drill into the information -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/196547) in GitLab 13.1. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/196547) in GitLab 13.1. You can examine details of individual issues by browsing the table located below the chart. diff --git a/doc/user/group/iterations/index.md b/doc/user/group/iterations/index.md index 90ccf2ae456..b8eb10f2bec 100644 --- a/doc/user/group/iterations/index.md +++ b/doc/user/group/iterations/index.md @@ -4,7 +4,11 @@ group: Project Management info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Iterations **(PREMIUM ALL)** +# Iterations + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/214713) in GitLab 13.1 [with a flag](../../../administration/feature_flags.md) named `group_iterations`. Disabled by default. > - [Enabled on self-managed](https://gitlab.com/gitlab-org/gitlab/-/issues/221047) in GitLab 13.2. @@ -41,7 +45,7 @@ configure iteration cadences to automatically roll over incomplete issues to the ### Create an iteration cadence -> [Changed](https://gitlab.com/gitlab-org/gitlab/-/issues/343889) the minimum user role from Developer to Reporter in GitLab 15.0. +> - [Changed](https://gitlab.com/gitlab-org/gitlab/-/issues/343889) the minimum user role from Developer to Reporter in GitLab 15.0. Prerequisites: @@ -146,7 +150,7 @@ to satisfy the requirement that there are at least two upcoming iterations sched ### Delete an iteration cadence -> [Changed](https://gitlab.com/gitlab-org/gitlab/-/issues/343889) the minimum user role from Developer to Reporter in GitLab 15.0. +> - [Changed](https://gitlab.com/gitlab-org/gitlab/-/issues/343889) the minimum user role from Developer to Reporter in GitLab 15.0. Prerequisites: @@ -163,7 +167,7 @@ To delete an iteration cadence: ## Create an iteration manually -> [Changed](https://gitlab.com/gitlab-org/gitlab/-/issues/343889) the minimum user role from Developer to Reporter in GitLab 15.0. +> - [Changed](https://gitlab.com/gitlab-org/gitlab/-/issues/343889) the minimum user role from Developer to Reporter in GitLab 15.0. When an iteration cadence has automatic scheduling enabled, iterations are created on schedule. If you disable that option, you can create iterations manually. @@ -185,7 +189,7 @@ To create an iteration: ## Edit an iteration -> [Changed](https://gitlab.com/gitlab-org/gitlab/-/issues/343889) the minimum user role from Developer to Reporter in GitLab 15.0. +> - [Changed](https://gitlab.com/gitlab-org/gitlab/-/issues/343889) the minimum user role from Developer to Reporter in GitLab 15.0. Prerequisites: @@ -238,7 +242,7 @@ To view an iteration report: ### Iteration burndown and burnup charts -> Scoped burnup and burndown charts in subgroups and projects [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/326029) in GitLab 14.9. +> - Scoped burnup and burndown charts in subgroups and projects [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/326029) in GitLab 14.9. The iteration report includes [burndown and burnup charts](../../project/milestones/burndown_and_burnup_charts.md), similar to how they appear when viewing a [milestone](../../project/milestones/index.md): @@ -248,7 +252,7 @@ similar to how they appear when viewing a [milestone](../../project/milestones/i #### View iteration charts scoped to subgroups or projects -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/326029) in GitLab 14.9. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/326029) in GitLab 14.9. View burndown and burnup charts for iterations created for a group in any of its subgroups or projects. diff --git a/doc/user/group/manage.md b/doc/user/group/manage.md index 58c3f837e26..205d05e5de8 100644 --- a/doc/user/group/manage.md +++ b/doc/user/group/manage.md @@ -99,7 +99,7 @@ In [GitLab Premium or Ultimate](https://about.gitlab.com/pricing/), GitLab admin ## Use a custom name for the initial branch -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/43290) in GitLab 13.6. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/43290) in GitLab 13.6. When you create a new project in GitLab, a default branch is created with the first push. The group owner can @@ -191,7 +191,7 @@ To transfer a group: ## Disable email notifications -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/23585) in GitLab 12.2. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/23585) in GitLab 12.2. You can disable all email notifications related to the group, which includes its subgroups and projects. @@ -205,7 +205,7 @@ To disable email notifications: ## Disable group mentions -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/21301) in GitLab 12.6. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/21301) in GitLab 12.6. You can prevent users from being added to a conversation and getting notified when anyone [mentions a group](../discussions/index.md#mentions) @@ -223,7 +223,11 @@ To disable group mentions: 1. Select **Group mentions are disabled**. 1. Select **Save changes**. -## Export members as CSV **(PREMIUM ALL)** +## Export members as CSV + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/287940) in GitLab 14.2. > - [Feature flag removed](https://gitlab.com/gitlab-org/gitlab/-/issues/336520) in GitLab 14.5. @@ -318,7 +322,11 @@ To ensure that the user cap applies when groups, subgroups, or projects are shar User cap doesn’t consider whether users are billable or not (e.g., Free Guest Users in Ultimate). In other words, if you set a cap of 500, user caps block new sign-ups after 500 users, regardless of whether those are all consuming paid seats or not. -## Group file templates **(PREMIUM ALL)** +## Group file templates + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed Use group file templates to share a set of templates for common file types with every project in a group. It is analogous to the @@ -340,7 +348,11 @@ To learn how to create templates for issues and merge requests, see Define project templates at a group level by setting a group as the template source. For more information, see [group-level project templates](custom_project_templates.md). -### Enable group file template **(PREMIUM ALL)** +### Enable group file template + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed To enable group file templates: @@ -350,9 +362,13 @@ To enable group file templates: 1. Choose a project to act as the template repository. 1. Select **Save changes**. -## Group merge checks settings **(PREMIUM ALL)** +## Group merge checks settings -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/372040) in GitLab 15.9 [with a flag](../../administration/feature_flags.md) name `support_group_level_merge_checks_setting`. Disabled by default. +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/372040) in GitLab 15.9 [with a flag](../../administration/feature_flags.md) name `support_group_level_merge_checks_setting`. Disabled by default. FLAG: On self-managed GitLab, by default this feature is not available. To make it available, an administrator can @@ -421,7 +437,11 @@ To enable this setting: 1. Under **Merge checks**, select **All threads must be resolved**. 1. Select **Save changes**. -## Group merge request approval settings **(PREMIUM ALL)** +## Group merge request approval settings + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/285458) in GitLab 13.9. [Deployed behind the `group_merge_request_approval_settings_feature_flag` flag](../../administration/feature_flags.md), disabled by default. > - [Enabled by default](https://gitlab.com/gitlab-org/gitlab/-/issues/285410) in GitLab 14.5. @@ -443,7 +463,11 @@ Approval settings should not be confused with [approval rules](../project/merge_ for the ability to set merge request approval rules for groups is tracked in [epic 4367](https://gitlab.com/groups/gitlab-org/-/epics/4367). -## Enable Code Suggestions for a group **(FREE SAAS)** +## Enable Code Suggestions for a group + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/405126) in GitLab 15.11. > - [Moved](https://gitlab.com/gitlab-org/gitlab/-/issues/408158) from GitLab Ultimate to GitLab Premium in 16.0. @@ -466,9 +490,13 @@ To update this setting: Individual users can disable Code Suggestions by disabling the feature in their [installed IDE editor extension](../project/repository/code_suggestions/index.md#supported-editor-extensions). -## Enable Experiment and Beta features **(ULTIMATE SAAS)** +## Enable Experiment and Beta features -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/118222) in GitLab 16.0. +DETAILS: +**Tier:** Ultimate +**Offering:** SaaS + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/118222) in GitLab 16.0. WARNING: [Experiment and Beta features](../../policy/experiment-beta-support.md) may produce unexpected results @@ -487,9 +515,13 @@ To enable Experiment features for a top-level group: 1. Under **Experiment and Beta features**, select the **Use Experiment and Beta features** checkbox. 1. Select **Save changes**. -## Group activity analytics **(PREMIUM ALL)** +## Group activity analytics -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/207164) in GitLab 12.10 as a [Beta feature](../../policy/experiment-beta-support.md#beta). +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/207164) in GitLab 12.10 as a [Beta feature](../../policy/experiment-beta-support.md#beta). For a group, you can view how many merge requests, issues, and members were created in the last 90 days. diff --git a/doc/user/group/moderate_users.md b/doc/user/group/moderate_users.md index 38d83c6b5f7..148d8f1bdf7 100644 --- a/doc/user/group/moderate_users.md +++ b/doc/user/group/moderate_users.md @@ -4,9 +4,13 @@ group: Anti-Abuse info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Moderate users **(ULTIMATE SAAS)** +# Moderate users -> [Introduced](https://gitlab.com/gitlab-org/modelops/anti-abuse/team-tasks/-/issues/155) in GitLab 15.8. +DETAILS: +**Tier:** Ultimate +**Offering:** SaaS + +> - [Introduced](https://gitlab.com/gitlab-org/modelops/anti-abuse/team-tasks/-/issues/155) in GitLab 15.8. This is the group-level documentation. For self-managed instances, see the [administration documentation](../../administration/moderate_users.md). diff --git a/doc/user/group/planning_hierarchy/index.md b/doc/user/group/planning_hierarchy/index.md index 3cfcba066c7..01aafef207a 100644 --- a/doc/user/group/planning_hierarchy/index.md +++ b/doc/user/group/planning_hierarchy/index.md @@ -4,7 +4,11 @@ group: Product Planning info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Planning hierarchies **(PREMIUM ALL)** +# Planning hierarchies + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed Planning hierarchies are an integral part of breaking down your work in GitLab. To understand how you can use epics and issues together in hierarchies, remember the following: @@ -30,7 +34,11 @@ graph TD Group_epic --> Project2_Issue1 ``` -### Hierarchies with multi-level epics **(ULTIMATE ALL)** +### Hierarchies with multi-level epics + +DETAILS: +**Tier:** Ultimate +**Offering:** SaaS, self-managed With the addition of [multi-level epics](../epics/manage_epics.md#multi-level-child-epics) and up to seven levels of nested epics, you can achieve the following hierarchy: diff --git a/doc/user/group/reporting/git_abuse_rate_limit.md b/doc/user/group/reporting/git_abuse_rate_limit.md index e00602aeacd..3a4d07721e5 100644 --- a/doc/user/group/reporting/git_abuse_rate_limit.md +++ b/doc/user/group/reporting/git_abuse_rate_limit.md @@ -4,9 +4,13 @@ group: Anti-Abuse info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Git abuse rate limit **(ULTIMATE ALL)** +# Git abuse rate limit -> [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/8066) in GitLab 15.2 [with a flag](../../../administration/feature_flags.md) named `limit_unique_project_downloads_per_namespace_user`. Disabled by default. +DETAILS: +**Tier:** Ultimate +**Offering:** SaaS, self-managed + +> - [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/8066) in GitLab 15.2 [with a flag](../../../administration/feature_flags.md) named `limit_unique_project_downloads_per_namespace_user`. Disabled by default. FLAG: On self-managed GitLab, by default this feature is not available. To make it available, an administrator can [enable the feature flag](../../../administration/feature_flags.md) named `limit_unique_project_downloads_per_namespace_user`. On GitLab.com, this feature is available. diff --git a/doc/user/group/repositories_analytics/index.md b/doc/user/group/repositories_analytics/index.md index baeab5b0bbc..af68c1e81eb 100644 --- a/doc/user/group/repositories_analytics/index.md +++ b/doc/user/group/repositories_analytics/index.md @@ -4,9 +4,13 @@ group: Pipeline Execution info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Repositories analytics for groups **(PREMIUM ALL)** +# Repositories analytics for groups -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/215104) in GitLab 13.4. +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/215104) in GitLab 13.4. Repositories analytics for groups provides information about test coverage for all projects in a group. An [issue exists](https://gitlab.com/gitlab-org/gitlab/-/issues/273527) to also extend support for all projects in @@ -16,7 +20,7 @@ It is similar to [repository analytics for projects](../../analytics/repository_ ## Current group code coverage -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/263478) in GitLab 13.7. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/263478) in GitLab 13.7. The **Analyze > Repository analytics** group page displays the overall test coverage of all your projects in your group. In the **Overall activity** section, you can see: @@ -27,13 +31,13 @@ In the **Overall activity** section, you can see: ## Average group test coverage from the last 30 days -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/215140) in GitLab 13.9. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/215140) in GitLab 13.9. The **Analyze > Repository analytics** group page displays the average test coverage of all your projects in your group in a graph for the last 30 days. ## Latest project test coverage list -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/267624) in GitLab 13.6. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/267624) in GitLab 13.6. To see the latest code coverage for each project in your group: @@ -46,7 +50,7 @@ You can download code coverage data for specific projects using ## Download historic test coverage data -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/215104) in GitLab 13.4. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/215104) in GitLab 13.4. You can get a CSV of the code coverage data for all of the projects in your group. This report has a maximum of 1000 records. The code coverage data is from the default branch in each project. diff --git a/doc/user/group/roadmap/index.md b/doc/user/group/roadmap/index.md index 6af2a234447..ca3a788f29f 100644 --- a/doc/user/group/roadmap/index.md +++ b/doc/user/group/roadmap/index.md @@ -4,7 +4,11 @@ group: Product Planning info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Roadmap **(PREMIUM ALL)** +# Roadmap + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed > - [Moved](https://gitlab.com/gitlab-org/gitlab/-/issues/198062) from GitLab Ultimate to GitLab Premium in 12.9. > - In [GitLab 12.9](https://gitlab.com/gitlab-org/gitlab/-/issues/5164) and later, the epic bars show epics' title, progress, and completed weight percentage. @@ -92,7 +96,7 @@ shared using URL parameters. ## Timeline duration -> [Moved](https://gitlab.com/gitlab-org/gitlab/-/issues/198062) from GitLab Ultimate to GitLab Premium in 12.9. +> - [Moved](https://gitlab.com/gitlab-org/gitlab/-/issues/198062) from GitLab Ultimate to GitLab Premium in 12.9. ### Date range presets @@ -150,9 +154,13 @@ the timeline header represent the days of the week. The timeline bar indicates the approximate position of an epic or milestone based on its start and due dates. -## Blocked epics **(ULTIMATE ALL)** +## Blocked epics -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/33587) in GitLab 15.5: View blocking epics when hovering over the "blocked" icon. +DETAILS: +**Tier:** Ultimate +**Offering:** SaaS, self-managed + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/33587) in GitLab 15.5: View blocking epics when hovering over the "blocked" icon. If an epic is [blocked by another epic](../epics/linked_epics.md#blocking-epics), an icon appears next to its title to indicate its blocked status. diff --git a/doc/user/group/saml_sso/example_saml_config.md b/doc/user/group/saml_sso/example_saml_config.md index 46666abe366..a361380e036 100644 --- a/doc/user/group/saml_sso/example_saml_config.md +++ b/doc/user/group/saml_sso/example_saml_config.md @@ -4,7 +4,11 @@ group: Authentication info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Example group SAML and SCIM configurations **(PREMIUM SAAS)** +# Example group SAML and SCIM configurations + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS These are notes and screenshots regarding Group SAML and SCIM that the GitLab Support Team sometimes uses while troubleshooting, but which do not fit into the official documentation. GitLab is making this public, so that anyone can make use of the Support team's collected knowledge. diff --git a/doc/user/group/saml_sso/group_sync.md b/doc/user/group/saml_sso/group_sync.md index 144d927f7e5..9ca7e6e0a7e 100644 --- a/doc/user/group/saml_sso/group_sync.md +++ b/doc/user/group/saml_sso/group_sync.md @@ -4,9 +4,13 @@ group: Authentication info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# SAML Group Sync **(PREMIUM ALL)** +# SAML Group Sync -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/363084) for self-managed instances in GitLab 15.1. +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/363084) for self-managed instances in GitLab 15.1. WARNING: Adding or changing Group Sync configuration can remove users from the mapped GitLab group. @@ -120,13 +124,13 @@ Users granted: ### Use the API -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/290367) in GitLab 15.3. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/290367) in GitLab 15.3. You can use the GitLab API to [list, add, and delete](../../../api/groups.md#saml-group-links) SAML group links. ## Microsoft Azure Active Directory integration -> [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/10507) in GitLab 16.3. +> - [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/10507) in GitLab 16.3. NOTE: Microsoft has [announced](https://azure.microsoft.com/en-us/updates/azure-ad-is-becoming-microsoft-entra-id/) that Azure Active Directory (AD) is being renamed to Entra ID. @@ -194,9 +198,13 @@ With this configuration, if a user signs in with SAML and Azure sends a group ov GitLab initiates a Group Sync job to call the Microsoft Graph API and retrieve the user's group membership. Then the GitLab Group membership is updated according to SAML Group Links. -## Global SAML group memberships lock **(PREMIUM SELF)** +## Global SAML group memberships lock -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/386390) in GitLab 15.10. +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** Self-managed + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/386390) in GitLab 15.10. GitLab administrators can use the global SAML group memberships lock to prevent group members from inviting new members to subgroups that have their membership synchronized with SAML Group Links. diff --git a/doc/user/group/saml_sso/index.md b/doc/user/group/saml_sso/index.md index 6f1ab305782..ff48264e6fc 100644 --- a/doc/user/group/saml_sso/index.md +++ b/doc/user/group/saml_sso/index.md @@ -4,9 +4,13 @@ group: Authentication info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# SAML SSO for GitLab.com groups **(PREMIUM SAAS)** +# SAML SSO for GitLab.com groups -> Introduced in GitLab 11.0. +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS + +> - Introduced in GitLab 11.0. Users can sign in to GitLab through their SAML identity provider. @@ -236,7 +240,7 @@ If the **NameID** is configured with the email address, [change the **NameID** f ## Configure GitLab -> Ability to set a custom role as the default membership role [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/417285) in GitLab 16.7. +> - Ability to set a custom role as the default membership role [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/417285) in GitLab 16.7. After you set up your identity provider to work with GitLab, you must configure GitLab to use it for authentication: @@ -266,7 +270,7 @@ If you are having issues configuring GitLab, see the [troubleshooting documentat ## User access and management -> SAML user provisioning [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/268142) in GitLab 13.7. +> - SAML user provisioning [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/268142) in GitLab 13.7. After group SSO is configured and enabled, users can access the GitLab.com group through the identity provider's dashboard. If [SCIM](scim_setup.md) is configured, see [user access](scim_setup.md#user-access) on the SCIM page. @@ -281,7 +285,7 @@ When a user tries to sign in with Group SSO, GitLab attempts to find or create a ### Link SAML to your existing GitLab.com account -> **Remember me** checkbox [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/121569) in GitLab 15.7. +> - **Remember me** checkbox [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/121569) in GitLab 15.7. To link SAML to your existing GitLab.com account: @@ -312,7 +316,7 @@ are then redirected to sign in through the identity provider. ### Manage user SAML identity -> Update of SAML identities using the SAML API [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/227841) in GitLab 15.5. +> - Update of SAML identities using the SAML API [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/227841) in GitLab 15.5. GitLab.com uses the SAML **NameID** to identify users. The **NameID** is: @@ -402,7 +406,7 @@ convert the information to XML. An example SAML response is shown here. ### Bypass user email confirmation with verified domains -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/238461) in GitLab 15.4. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/238461) in GitLab 15.4. By default, users provisioned with SAML or SCIM are sent a verification email to verify their identity. Instead, you can [configure GitLab with a custom domain](../../enterprise_user/index.md#set-up-a-verified-domain) and GitLab diff --git a/doc/user/group/saml_sso/scim_setup.md b/doc/user/group/saml_sso/scim_setup.md index 3c5c53cbdf6..df765de2f17 100644 --- a/doc/user/group/saml_sso/scim_setup.md +++ b/doc/user/group/saml_sso/scim_setup.md @@ -4,7 +4,11 @@ group: Authentication info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Configure SCIM for GitLab.com groups **(PREMIUM SAAS)** +# Configure SCIM for GitLab.com groups + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS You can use the open standard System for Cross-domain Identity Management (SCIM) to automatically: diff --git a/doc/user/group/saml_sso/troubleshooting.md b/doc/user/group/saml_sso/troubleshooting.md index 1e7c749a705..6e9e38fc4bb 100644 --- a/doc/user/group/saml_sso/troubleshooting.md +++ b/doc/user/group/saml_sso/troubleshooting.md @@ -4,7 +4,11 @@ group: Authentication info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Troubleshooting SAML **(FREE ALL)** +# Troubleshooting SAML + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed This page contains possible solutions for problems you might encounter when using: @@ -67,7 +71,11 @@ openssl x509 -in -noout -fingerprint -sha1 Replace `filename.crt` with the name of the certificate file. -## Searching Rails log for a SAML response **(FREE SELF)** +## Searching Rails log for a SAML response + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed You can find the base64-encoded SAML Response in the [`production_json.log`](../../../administration/logs/index.md#production_jsonlog). This response is sent from the identity provider, and contains user information that is consumed by GitLab. @@ -206,7 +214,11 @@ Alternatively, the SAML response may be missing the `InResponseTo` attribute in The identity provider administrator should ensure that the login is initiated by the service provider and not only the identity provider. -### Message: "There is already a GitLab account associated with this email address. Sign in with your existing credentials to connect your organization's account" **(PREMIUM SAAS)** +### Message: "There is already a GitLab account associated with this email address. Sign in with your existing credentials to connect your organization's account" + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS A user can see this message when they are trying to [manually link SAML to their existing GitLab.com account](index.md#link-saml-to-your-existing-gitlabcom-account). @@ -216,7 +228,11 @@ to [reset their password](https://gitlab.com/users/password/new) if both: - The account was provisioned by SCIM. - They are signing in with username and password for the first time. -### Message: "SAML Name ID and email address do not match your user account" **(PREMIUM SAAS)** +### Message: "SAML Name ID and email address do not match your user account" + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS Users might get an error that states "SAML Name ID and email address do not match your user account. Contact an administrator." This means: @@ -246,7 +262,11 @@ Ensure that the **GitLab single sign-on URL** (for GitLab.com) or the instance U For GitLab.com, alternatively, when users need to [link SAML to their existing GitLab.com account](index.md#link-saml-to-your-existing-gitlabcom-account), provide the **GitLab single sign-on URL** and instruct users not to use the SAML app on first sign in. -### Users receive a 404 **(PREMIUM SAAS)** +### Users receive a 404 + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS If the user receives a `404` after signing in successfully, check if you have IP restrictions configured. IP restriction settings are configured: @@ -297,7 +317,11 @@ If a subset of users are receiving a `404` after signing in to the IdP, first ve curl --request PATCH "https://gitlab.example.com/api/scim/v2/groups/test_group/Users/f0b1d561c-21ff-4092-beab-8154b17f82f2" --header "Authorization: Bearer " --header "Content-Type: application/scim+json" --data '{ "Operations": [{"op":"Replace","path":"active","value":"true"}] }' ``` -### 500 error after login **(FREE SELF)** +### 500 error after login + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed If you see a "500 error" in GitLab when you are redirected back from the SAML sign-in page, this could indicate that: @@ -307,7 +331,11 @@ sign-in page, this could indicate that: - The certificate set your `gitlab.rb` file for `identity provider_cert_fingerprint` or `identity provider_cert` file is incorrect. - Your `gitlab.rb` file is set to enable `identity provider_cert_fingerprint`, and `identity provider_cert` is being provided, or the reverse. -### 422 error after login **(FREE SELF)** +### 422 error after login + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed If you see a "422 error" in GitLab when you are redirected from the SAML sign-in page, you might have an incorrectly configured Assertion Consumer @@ -333,7 +361,11 @@ To implement this workaround: 1. Add or remove a domain as appropriate to **Allowed domains for sign-ups** and **Denied domains for sign-ups**. 1. Select **Save changes**. -### User is blocked when signing in through SAML **(FREE SELF)** +### User is blocked when signing in through SAML + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed The following are the most likely reasons that a user is blocked when signing in through SAML: @@ -348,7 +380,11 @@ Pay particular attention to the following 403 errors: - `app_not_configured` - `app_not_configured_for_user` -## Message: "The member's email address is not linked to a SAML account" **(PREMIUM SAAS)** +## Message: "The member's email address is not linked to a SAML account" + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS This error appears when you try to invite a user to a GitLab.com group (or subgroup or project within a group) that has [SAML SSO enforcement](index.md#sso-enforcement) enabled. diff --git a/doc/user/group/saml_sso/troubleshooting_scim.md b/doc/user/group/saml_sso/troubleshooting_scim.md index 47b2144c7ff..e214198e94b 100644 --- a/doc/user/group/saml_sso/troubleshooting_scim.md +++ b/doc/user/group/saml_sso/troubleshooting_scim.md @@ -4,7 +4,11 @@ group: Authentication info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Troubleshooting SCIM **(FREE ALL)** +# Troubleshooting SCIM + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed This section contains possible solutions for problems you might encounter. @@ -99,7 +103,11 @@ When the SCIM app changes: - In GitLab self-managed, blocks users. 1. Turn on sync for the new SCIM app to [link existing users](scim_setup.md#link-scim-and-saml-identities). -## SCIM app returns `"User has already been taken","status":409` error **(PREMIUM SAAS)** +## SCIM app returns `"User has already been taken","status":409` error + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS Changing the SAML or SCIM configuration or provider can cause the following problems: @@ -131,7 +139,11 @@ To resolve this issue, you can do either of the following: - Disable the [Restrict group access by domain](../access_and_permissions.md) feature by removing all domains. -## Search Rails logs for SCIM requests **(PREMIUM SAAS)** +## Search Rails logs for SCIM requests + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS GitLab.com administrators can search for SCIM requests in the `api_json.log` using the `pubsub-rails-inf-gprd-*` index in [Kibana](https://about.gitlab.com/handbook/support/workflows/kibana.html#using-kibana). Use the following filters based diff --git a/doc/user/group/settings/group_access_tokens.md b/doc/user/group/settings/group_access_tokens.md index a8633c0cbbe..6667e1236d3 100644 --- a/doc/user/group/settings/group_access_tokens.md +++ b/doc/user/group/settings/group_access_tokens.md @@ -4,7 +4,11 @@ group: Authentication info: "To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments" --- -# Group access tokens **(FREE)** +# Group access tokens + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed With group access tokens, you can use a single token to: @@ -115,7 +119,7 @@ or API. However, administrators can use a workaround: ## Revoke a group access token using the UI -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/214045) in GitLab 14.7. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/214045) in GitLab 14.7. To revoke a group access token: diff --git a/doc/user/group/ssh_certificates.md b/doc/user/group/ssh_certificates.md index 25c5f4b1be8..8936bf8ae2f 100644 --- a/doc/user/group/ssh_certificates.md +++ b/doc/user/group/ssh_certificates.md @@ -4,7 +4,11 @@ group: Source Code info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Manage group's SSH certificates **(PREMIUM SAAS)** +# Manage group's SSH certificates + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS Manage Git access to the projects by sharing public Certified Authority (`CA`) files in your organization's top-level group. @@ -14,7 +18,7 @@ To temporarily grant Git access to your projects, you can use SSH certificates. ## Add a CA certificate to a top-level group -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/421915) in GitLab 16.4 [with a flag](../feature_flags.md) named `ssh_certificates_rest_endpoints`. Disabled by default. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/421915) in GitLab 16.4 [with a flag](../feature_flags.md) named `ssh_certificates_rest_endpoints`. Disabled by default. FLAG: On GitLab.com, this feature is not available. @@ -59,7 +63,7 @@ The user certificates can only be used to access the projects within the top-lev ## Enforce SSH certificates -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/421915) in GitLab 16.7 [with a flag](../feature_flags.md) named `enforce_ssh_certificates_via_settings`. Disabled by default. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/421915) in GitLab 16.7 [with a flag](../feature_flags.md) named `enforce_ssh_certificates_via_settings`. Disabled by default. FLAG: On GitLab.com, this feature is not available. diff --git a/doc/user/group/subgroups/index.md b/doc/user/group/subgroups/index.md index a43de3ef73b..da3c008d293 100644 --- a/doc/user/group/subgroups/index.md +++ b/doc/user/group/subgroups/index.md @@ -4,9 +4,13 @@ group: Tenant Scale info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Subgroups **(FREE ALL)** +# Subgroups -> [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/issues/2772) in GitLab 9.0. +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/issues/2772) in GitLab 9.0. You can organize GitLab [groups](../index.md) into subgroups. You can use subgroups to: diff --git a/doc/user/group/value_stream_analytics/index.md b/doc/user/group/value_stream_analytics/index.md index 8bc8efc890b..50f20071a61 100644 --- a/doc/user/group/value_stream_analytics/index.md +++ b/doc/user/group/value_stream_analytics/index.md @@ -4,7 +4,11 @@ group: Optimize info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Value stream analytics **(FREE ALL)** +# Value stream analytics + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed Value stream analytics measures the time it takes to go from an idea to production. @@ -100,7 +104,11 @@ These events play a key role in the duration calculation, which is calculated by To learn what start and end events can be paired, see [Validating start and end events](../../../development/value_stream_analytics.md#validating-start-and-end-events). -### How value stream analytics aggregates data **(PREMIUM ALL)** +### How value stream analytics aggregates data + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/335391) in GitLab 14.5. > - Filter by stop date toggle [added](https://gitlab.com/gitlab-org/gitlab/-/issues/352428) in GitLab 14.9 @@ -275,7 +283,11 @@ Value stream analytics includes the following lifecycle metrics: - **New issues**: Number of new issues created. - **Deploys**: Total number of deployments to production. -### DORA metrics **(ULTIMATE ALL)** +### DORA metrics + +DETAILS: +**Tier:** Ultimate +**Offering:** SaaS, self-managed > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/340150) lead time for changes DORA metric in GitLab 14.5. > - DORA API-based deployment metrics for value stream analytics for groups were [moved](https://gitlab.com/gitlab-org/gitlab/-/issues/337256) from GitLab Ultimate to GitLab Premium in GitLab 14.3. @@ -354,7 +366,11 @@ NOTE: The date range selector filters items by the event time. The event time is when the selected stage finished for the given item. -## View tasks by type **(PREMIUM ALL)** +## View tasks by type + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed The **Tasks by type** chart displays the cumulative number of issues and merge requests per day for your group. @@ -371,11 +387,15 @@ To view tasks by type: 1. To add or remove labels, select the **Settings** (**{settings}**) dropdown list and select or search for a label. By default the top group-level labels (maximum 10) are selected. You can select a maximum of 15 labels. -## Create a value stream **(PREMIUM ALL)** +## Create a value stream + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed ### Create a value stream with GitLab default stages -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/221202) in GitLab 13.3 +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/221202) in GitLab 13.3 When you create a value stream, you can use GitLab default stages and hide or re-order them. You can also create custom stages in addition to those provided in the default template. @@ -432,9 +452,13 @@ In the example above, two independent value streams are set up for two teams tha The first value stream uses standard timestamp-based events for defining the stages. The second value stream uses label events. -## Edit a value stream **(PREMIUM ALL)** +## Edit a value stream -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/267537) in GitLab 13.10. +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/267537) in GitLab 13.10. After you create a value stream, you can customize it to suit your purposes. To edit a value stream: @@ -451,9 +475,13 @@ After you create a value stream, you can customize it to suit your purposes. To 1. Optional. To undo any modifications, select **Restore value stream defaults**. 1. Select **Save Value Stream**. -## Delete a value stream **(PREMIUM ALL)** +## Delete a value stream -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/221205) in GitLab 13.4. +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/221205) in GitLab 13.4. To delete a custom value stream: @@ -464,7 +492,11 @@ To delete a custom value stream: ![Delete value stream](img/delete_value_stream_v13_12.png "Deleting a custom value stream") -## View number of days for a cycle to complete **(PREMIUM ALL)** +## View number of days for a cycle to complete + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed > - Chart median line [removed](https://gitlab.com/gitlab-org/gitlab/-/issues/235455) in GitLab 13.4. > - Totals [replaced](https://gitlab.com/gitlab-org/gitlab/-/issues/262070) with averages in GitLab 13.12. diff --git a/doc/user/index.md b/doc/user/index.md index 858173a40a8..782f4710af9 100644 --- a/doc/user/index.md +++ b/doc/user/index.md @@ -4,7 +4,7 @@ group: unassigned info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Use GitLab **(FREE ALL)** +# Use GitLab Get to know the GitLab end-to-end workflow. Configure permissions, organize your work, create and secure your application, and analyze its performance. Report on team productivity throughout the process. diff --git a/doc/user/infrastructure/clusters/connect/index.md b/doc/user/infrastructure/clusters/connect/index.md index 4a8ec3d85f7..7b71d58415f 100644 --- a/doc/user/infrastructure/clusters/connect/index.md +++ b/doc/user/infrastructure/clusters/connect/index.md @@ -4,7 +4,11 @@ group: Environments info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Connect a cluster to GitLab **(FREE ALL)** +# Connect a cluster to GitLab + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed The [certificate-based Kubernetes integration with GitLab](../index.md) was [deprecated](https://gitlab.com/groups/gitlab-org/configure/-/epics/8) @@ -12,7 +16,7 @@ in GitLab 14.5. To connect your clusters, use the [GitLab agent](../../../cluste ## Cluster levels (deprecated) -> [Deprecated](https://gitlab.com/groups/gitlab-org/configure/-/epics/8) in GitLab 14.5. +> - [Deprecated](https://gitlab.com/groups/gitlab-org/configure/-/epics/8) in GitLab 14.5. WARNING: The [concept of cluster levels was deprecated](../index.md#cluster-levels) @@ -49,7 +53,7 @@ your cluster's level. ## Security implications for clusters connected with certificates -> Connecting clusters to GitLab through cluster certificates was [deprecated](https://gitlab.com/groups/gitlab-org/configure/-/epics/8) in GitLab 14.5. +> - Connecting clusters to GitLab through cluster certificates was [deprecated](https://gitlab.com/groups/gitlab-org/configure/-/epics/8) in GitLab 14.5. WARNING: The whole cluster security is based on a model where [developers](../../../permissions.md) diff --git a/doc/user/infrastructure/clusters/deploy/inventory_object.md b/doc/user/infrastructure/clusters/deploy/inventory_object.md index bd074d42efb..e5e3e586043 100644 --- a/doc/user/infrastructure/clusters/deploy/inventory_object.md +++ b/doc/user/infrastructure/clusters/deploy/inventory_object.md @@ -4,7 +4,11 @@ group: Environments info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Tracking cluster resources managed by GitLab (deprecated) **(FREE ALL)** +# Tracking cluster resources managed by GitLab (deprecated) + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/332227) in GitLab 14.0. > - [Moved](https://gitlab.com/gitlab-org/gitlab/-/issues/346567) from GitLab Premium to GitLab Free in 15.3. diff --git a/doc/user/infrastructure/clusters/index.md b/doc/user/infrastructure/clusters/index.md index 79f350b1084..b13e53ba0c3 100644 --- a/doc/user/infrastructure/clusters/index.md +++ b/doc/user/infrastructure/clusters/index.md @@ -4,7 +4,11 @@ group: Environments info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Kubernetes clusters **(FREE ALL)** +# Kubernetes clusters + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed To connect clusters to GitLab, use the [GitLab agent](../../clusters/agent/index.md). diff --git a/doc/user/infrastructure/clusters/manage/management_project_applications/certmanager.md b/doc/user/infrastructure/clusters/manage/management_project_applications/certmanager.md index 22a77ac0b5a..9bfac36d3e0 100644 --- a/doc/user/infrastructure/clusters/manage/management_project_applications/certmanager.md +++ b/doc/user/infrastructure/clusters/manage/management_project_applications/certmanager.md @@ -4,7 +4,11 @@ group: Environments info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Install cert-manager with a cluster management project **(FREE ALL)** +# Install cert-manager with a cluster management project + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed > - [Introduced](https://gitlab.com/gitlab-org/project-templates/cluster-management/-/merge_requests/5) in GitLab 14.0. > - Support for cert-manager v1.4 was [introduced](https://gitlab.com/gitlab-org/project-templates/cluster-management/-/merge_requests/69405) in GitLab 14.3. diff --git a/doc/user/infrastructure/clusters/manage/management_project_applications/ingress.md b/doc/user/infrastructure/clusters/manage/management_project_applications/ingress.md index c6bad5a9cb4..1f604bfe0e4 100644 --- a/doc/user/infrastructure/clusters/manage/management_project_applications/ingress.md +++ b/doc/user/infrastructure/clusters/manage/management_project_applications/ingress.md @@ -4,9 +4,13 @@ group: Environments info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Install Ingress with a cluster management project **(FREE ALL)** +# Install Ingress with a cluster management project -> [Introduced](https://gitlab.com/gitlab-org/project-templates/cluster-management/-/merge_requests/5) in GitLab 14.0. +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed + +> - [Introduced](https://gitlab.com/gitlab-org/project-templates/cluster-management/-/merge_requests/5) in GitLab 14.0. Assuming you already have a project created from a [management project template](../../../../../user/clusters/management_project_template.md), to install Ingress you should diff --git a/doc/user/infrastructure/clusters/manage/management_project_applications/runner.md b/doc/user/infrastructure/clusters/manage/management_project_applications/runner.md index cd8a261544b..956c39b534c 100644 --- a/doc/user/infrastructure/clusters/manage/management_project_applications/runner.md +++ b/doc/user/infrastructure/clusters/manage/management_project_applications/runner.md @@ -4,9 +4,13 @@ group: Runner info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Install GitLab Runner with a cluster management project **(FREE ALL)** +# Install GitLab Runner with a cluster management project -> [Introduced](https://gitlab.com/gitlab-org/project-templates/cluster-management/-/merge_requests/5) in GitLab 14.0. +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed + +> - [Introduced](https://gitlab.com/gitlab-org/project-templates/cluster-management/-/merge_requests/5) in GitLab 14.0. Assuming you already have a project created from a [management project template](../../../../../user/clusters/management_project_template.md), to install GitLab Runner you should diff --git a/doc/user/infrastructure/clusters/manage/management_project_applications/vault.md b/doc/user/infrastructure/clusters/manage/management_project_applications/vault.md index c58db7cd9b4..d3183da7f78 100644 --- a/doc/user/infrastructure/clusters/manage/management_project_applications/vault.md +++ b/doc/user/infrastructure/clusters/manage/management_project_applications/vault.md @@ -4,9 +4,13 @@ group: Environments info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Install Vault with a cluster management project **(FREE ALL)** +# Install Vault with a cluster management project -> [Introduced](https://gitlab.com/gitlab-org/project-templates/cluster-management/-/merge_requests/5) in GitLab 14.0. +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed + +> - [Introduced](https://gitlab.com/gitlab-org/project-templates/cluster-management/-/merge_requests/5) in GitLab 14.0. [HashiCorp Vault](https://www.vaultproject.io/) is a secrets management solution which can be used to safely manage and store passwords, credentials, certificates, and more. A Vault diff --git a/doc/user/infrastructure/clusters/migrate_to_gitlab_agent.md b/doc/user/infrastructure/clusters/migrate_to_gitlab_agent.md index 530376c1923..1202330d48c 100644 --- a/doc/user/infrastructure/clusters/migrate_to_gitlab_agent.md +++ b/doc/user/infrastructure/clusters/migrate_to_gitlab_agent.md @@ -4,7 +4,11 @@ group: Environments info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Migrate to the GitLab agent for Kubernetes **(FREE ALL)** +# Migrate to the GitLab agent for Kubernetes + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed To connect your Kubernetes cluster with GitLab, you can use: diff --git a/doc/user/infrastructure/iac/gitlab_terraform_helpers.md b/doc/user/infrastructure/iac/gitlab_terraform_helpers.md index e86f2c71d3b..a89574a5cd1 100644 --- a/doc/user/infrastructure/iac/gitlab_terraform_helpers.md +++ b/doc/user/infrastructure/iac/gitlab_terraform_helpers.md @@ -4,7 +4,11 @@ group: Environments info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# GitLab Terraform helpers **(FREE ALL)** +# GitLab Terraform helpers + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed GitLab provides two helpers to ease your integration with the [GitLab-managed Terraform State](terraform_state.md). diff --git a/doc/user/infrastructure/iac/index.md b/doc/user/infrastructure/iac/index.md index 616e15dc230..227dd916e82 100644 --- a/doc/user/infrastructure/iac/index.md +++ b/doc/user/infrastructure/iac/index.md @@ -4,7 +4,11 @@ group: Environments info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Infrastructure as Code with Terraform and GitLab **(FREE ALL)** +# Infrastructure as Code with Terraform and GitLab + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed To manage your infrastructure with GitLab, you can use the integration with Terraform to define resources that you can version, reuse, and share: @@ -19,7 +23,7 @@ Terraform to define resources that you can version, reuse, and share: ## Integrate your project with Terraform -> IaC Scanning was [introduced](https://gitlab.com/groups/gitlab-org/-/epics/6655) in GitLab 14.6. +> - IaC Scanning was [introduced](https://gitlab.com/groups/gitlab-org/-/epics/6655) in GitLab 14.6. The integration with GitLab and Terraform happens through GitLab CI/CD. Use an `include` attribute to add the Terraform template to your project and diff --git a/doc/user/infrastructure/iac/mr_integration.md b/doc/user/infrastructure/iac/mr_integration.md index beef4c4d2aa..166b52755f0 100644 --- a/doc/user/infrastructure/iac/mr_integration.md +++ b/doc/user/infrastructure/iac/mr_integration.md @@ -4,7 +4,11 @@ group: Environments info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Terraform integration in merge requests **(FREE ALL)** +# Terraform integration in merge requests + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed Collaborating around Infrastructure as Code (IaC) changes requires both code changes and expected infrastructure changes to be checked and approved. GitLab provides a solution to help collaboration around Terraform code changes and their expected effects using the merge request pages. This way users don't have to build custom tools or rely on 3rd party solutions to streamline their IaC workflows. diff --git a/doc/user/infrastructure/iac/terraform_state.md b/doc/user/infrastructure/iac/terraform_state.md index e8b8d840453..43864f6b484 100644 --- a/doc/user/infrastructure/iac/terraform_state.md +++ b/doc/user/infrastructure/iac/terraform_state.md @@ -4,7 +4,11 @@ group: Environments info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# GitLab-managed Terraform state **(FREE ALL)** +# GitLab-managed Terraform state + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed > - [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/2673) in GitLab 13.0. > - Support for state names that contain periods introduced in GitLab 15.7 [with a flag](../../../administration/feature_flags.md) named `allow_dots_on_tf_state_names`. Disabled by default. @@ -290,7 +294,7 @@ To read the Terraform state in the target project, you need at least the Develop ## Manage Terraform state files -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/273592) in GitLab 13.8. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/273592) in GitLab 13.8. To view Terraform state files: @@ -301,7 +305,7 @@ To view Terraform state files: ### Manage individual Terraform state versions -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/207347) in GitLab 13.4. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/207347) in GitLab 13.4. Individual state versions can be managed using the GitLab REST API. diff --git a/doc/user/infrastructure/iac/terraform_template_recipes.md b/doc/user/infrastructure/iac/terraform_template_recipes.md index 3036a297b0e..68febf545ea 100644 --- a/doc/user/infrastructure/iac/terraform_template_recipes.md +++ b/doc/user/infrastructure/iac/terraform_template_recipes.md @@ -4,7 +4,11 @@ group: Environments info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Terraform template recipes **(FREE ALL)** +# Terraform template recipes + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed You can customize your Terraform integration by adding the recipes on this page to your pipeline. diff --git a/doc/user/infrastructure/index.md b/doc/user/infrastructure/index.md index 6662f6a9dcb..9d6813683e1 100644 --- a/doc/user/infrastructure/index.md +++ b/doc/user/infrastructure/index.md @@ -5,7 +5,11 @@ description: Terraform and Kubernetes deployments. info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Manage your infrastructure **(FREE ALL)** +# Manage your infrastructure + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed With the rise of DevOps and SRE approaches, infrastructure management becomes codified, automatable, and software development best practices gain their place around infrastructure diff --git a/doc/user/instance/clusters/index.md b/doc/user/instance/clusters/index.md index dfd38f7daf1..a617cdaef79 100644 --- a/doc/user/instance/clusters/index.md +++ b/doc/user/instance/clusters/index.md @@ -4,7 +4,11 @@ group: unassigned info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Instance-level Kubernetes clusters (certificate-based) (deprecated) **(FREE SELF)** +# Instance-level Kubernetes clusters (certificate-based) (deprecated) + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** self-managed > - [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/issues/39840) in GitLab 11.11. > - [Deprecated](https://gitlab.com/groups/gitlab-org/configure/-/epics/8) in GitLab 14.5. @@ -35,7 +39,11 @@ GitLab tries to match clusters in the following order: To be selected, the cluster must be enabled and match the [environment selector](../../../ci/environments/index.md#limit-the-environment-scope-of-a-cicd-variable). -## Cluster environments **(PREMIUM ALL)** +## Cluster environments + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed For a consolidated view of which CI [environments](../../../ci/environments/index.md) are deployed to the Kubernetes cluster, see the documentation for diff --git a/doc/user/markdown.md b/doc/user/markdown.md index fc297317dea..8dfe43254f7 100644 --- a/doc/user/markdown.md +++ b/doc/user/markdown.md @@ -4,9 +4,13 @@ group: Project Management info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# GitLab Flavored Markdown (GLFM) **(FREE ALL)** +# GitLab Flavored Markdown (GLFM) -> The abbreviation [changed](https://gitlab.com/gitlab-org/gitlab/-/issues/24592) from `GFM` to `GLFM` in GitLab 14.10. +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed + +> - The abbreviation [changed](https://gitlab.com/gitlab-org/gitlab/-/issues/24592) from `GFM` to `GLFM` in GitLab 14.10. When you enter text in the GitLab UI, GitLab assumes the text is in the Markdown language. The text is rendered with a set of styles. These styles are called *GitLab Flavored Markdown*. @@ -165,7 +169,7 @@ In wikis, you can also add and edit diagrams created with the [diagrams.net edit ### Mermaid -> Support for Entity Relationship diagrams and mindmaps [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/384386) in GitLab 16.0. +> - Support for Entity Relationship diagrams and mindmaps [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/384386) in GitLab 16.0. [View this topic in GitLab](https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/user/markdown.md#mermaid). @@ -453,7 +457,7 @@ $$ ## Task lists -> Inapplicable checkboxes [introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/85982) in GitLab 15.3. +> - Inapplicable checkboxes [introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/85982) in GitLab 15.3. [View this topic in GitLab](https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/user/markdown.md#task-lists). @@ -616,7 +620,7 @@ This example links to `/miscellaneous.md`: ### diagrams.net editor -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/322174) in GitLab 15.10. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/322174) in GitLab 15.10. In wikis, you can use the [diagrams.net](https://www.diagrams.net/) editor to create diagrams. You can also edit diagrams created with the diagrams.net editor. The diagram editor is available in both @@ -1265,7 +1269,7 @@ Here's an example audio clip: ## Inline HTML -> Allowing `rel="license"` [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/20857) in GitLab 14.6. +> - Allowing `rel="license"` [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/20857) in GitLab 14.6. [View this topic in GitLab](https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/user/markdown.md#inline-html). @@ -1863,7 +1867,7 @@ entry and paste the spreadsheet: ### JSON -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/86353) in GitLab 15.3. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/86353) in GitLab 15.3. To render tables with JSON code blocks, use the following syntax: diff --git a/doc/user/okrs.md b/doc/user/okrs.md index 1bed94a302b..910d0650db7 100644 --- a/doc/user/okrs.md +++ b/doc/user/okrs.md @@ -4,9 +4,13 @@ group: Product Planning info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments --- -# Objectives and key results (OKR) **(ULTIMATE ALL)** +# Objectives and key results (OKR) -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/103355) in GitLab 15.6 [with a flag](../administration/feature_flags.md) named `okrs_mvc`. Disabled by default. +DETAILS: +**Tier:** Ultimate +**Offering:** SaaS, self-managed + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/103355) in GitLab 15.6 [with a flag](../administration/feature_flags.md) named `okrs_mvc`. Disabled by default. OKRs are an [Experiment](../policy/experiment-beta-support.md#experiment). For the OKR feature roadmap, see [epic 7864](https://gitlab.com/groups/gitlab-org/-/epics/7864). @@ -157,7 +161,7 @@ To add labels to an OKR: ## Add an objective to a milestone -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/367463) in GitLab 15.7. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/367463) in GitLab 15.7. You can add an objective to a [milestone](project/milestones/index.md). You can see the milestone title when you view an objective. @@ -192,7 +196,7 @@ To set progress of an objective: ## Set health status -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/381899) in GitLab 15.7. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/381899) in GitLab 15.7. To better track the risk in meeting your goals, you can assign a [health status](project/issues/managing_issues.md#health-status) to each objective and key result. @@ -227,7 +231,7 @@ Alternatively, use the `/promote_to objective` [quick action](../user/project/qu ## Copy objective or key result reference -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/396553) in GitLab 16.1. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/396553) in GitLab 16.1. To refer to an objective or key result elsewhere in GitLab, you can use its full URL or a short reference, which looks like `namespace/project-name#123`, where `namespace` is either a group or a username. @@ -244,7 +248,7 @@ Read more about objective or key result references in [GitLab-Flavored Markdown] ## Copy objective or key result email address -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/396553) in GitLab 16.1. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/396553) in GitLab 16.1. You can create a comment in an objective or key result by sending an email. Sending an email to this address creates a comment that contains the email body. @@ -333,7 +337,7 @@ To add an existing key result to an objective: ### Reorder objective and key result children -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/385887) in GitLab 16.0. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/385887) in GitLab 16.0. Prerequisites: @@ -344,7 +348,7 @@ To reorder them, drag them around. ### Schedule OKR check-in reminders -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/422761) in GitLab 16.4 [with a flag](../administration/feature_flags.md) named `okr_checkin_reminders`. Disabled by default. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/422761) in GitLab 16.4 [with a flag](../administration/feature_flags.md) named `okr_checkin_reminders`. Disabled by default. FLAG: On self-managed GitLab, by default this feature is not available. To make it available, an administrator can [enable the feature flag](../administration/feature_flags.md) named `okr_checkin_reminders`. @@ -389,7 +393,7 @@ To turn off a check-in reminder, enter: ## Set an objective as a parent -> [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/11198) in GitLab 16.6. +> - [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/11198) in GitLab 16.6. Prerequisites: @@ -407,7 +411,7 @@ next to **Parent**, select the dropdown list and then select **Unassign**. ## Confidential OKRs -> [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/8410) in GitLab 15.3. +> - [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/8410) in GitLab 15.3. Confidential OKRs are OKRs visible only to members of a project with [sufficient permissions](#who-can-see-confidential-okrs). @@ -481,7 +485,7 @@ system note in the OKR's comments, for example: ## Two-column layout -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/415077) in GitLab 16.2 [with a flag](../administration/feature_flags.md) named `work_items_mvc_2`. Disabled by default. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/415077) in GitLab 16.2 [with a flag](../administration/feature_flags.md) named `work_items_mvc_2`. Disabled by default. FLAG: On self-managed GitLab, by default this feature is not available. To make it available, an administrator can [enable the feature flag](../administration/feature_flags.md) named `work_items_mvc_2`. diff --git a/doc/user/operations_dashboard/index.md b/doc/user/operations_dashboard/index.md index 3b53195ff2b..5b5ea77dbd5 100644 --- a/doc/user/operations_dashboard/index.md +++ b/doc/user/operations_dashboard/index.md @@ -4,7 +4,11 @@ group: Environments info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Operations Dashboard **(PREMIUM ALL)** +# Operations Dashboard + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed The Operations Dashboard provides a summary of each project's operational health, including pipeline and alert status. diff --git a/doc/user/organization/index.md b/doc/user/organization/index.md index ecc62b0d510..d16c2768fc1 100644 --- a/doc/user/organization/index.md +++ b/doc/user/organization/index.md @@ -6,7 +6,7 @@ info: To determine the technical writer assigned to the Stage/Group associated w # Organization -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/409913) in GitLab 16.1 [with a flag](../../administration/feature_flags.md) named `ui_for_organizations`. Disabled by default. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/409913) in GitLab 16.1 [with a flag](../../administration/feature_flags.md) named `ui_for_organizations`. Disabled by default. FLAG: This feature is not ready for production use. diff --git a/doc/user/packages/composer_repository/index.md b/doc/user/packages/composer_repository/index.md index ffa8a8a71c5..b2f9ea8d366 100644 --- a/doc/user/packages/composer_repository/index.md +++ b/doc/user/packages/composer_repository/index.md @@ -4,7 +4,12 @@ group: Package Registry info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Composer packages in the package registry **(FREE ALL BETA)** +# Composer packages in the package registry + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed +**Status:** Beta > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/15886) in GitLab 13.2. > - [Moved](https://gitlab.com/gitlab-org/gitlab/-/issues/221259) from GitLab Premium to GitLab Free in 13.3. @@ -121,7 +126,7 @@ When you publish: ## Install a Composer package -> Authorization to [download a package archive](../../../api/packages/composer.md#download-a-package-archive) was [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/331601) in GitLab 14.10. +> - Authorization to [download a package archive](../../../api/packages/composer.md#download-a-package-archive) was [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/331601) in GitLab 14.10. Install a package from the package registry so you can use it as a dependency. diff --git a/doc/user/packages/conan_repository/index.md b/doc/user/packages/conan_repository/index.md index f3d89051efa..aa5c69ce782 100644 --- a/doc/user/packages/conan_repository/index.md +++ b/doc/user/packages/conan_repository/index.md @@ -4,7 +4,12 @@ group: Package Registry info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Conan packages in the package registry **(FREE ALL EXPERIMENT)** +# Conan packages in the package registry + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed +**Status:** Experiment > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/8248) in GitLab 12.6. > - [Moved](https://gitlab.com/gitlab-org/gitlab/-/issues/221259) from GitLab Premium to GitLab Free in 13.3. @@ -39,7 +44,7 @@ and install packages from the package registry. ### Add a remote for your project -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/11679) in GitLab 13.4. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/11679) in GitLab 13.4. Set a remote so you can work with packages in a project without having to specify the remote name in every command. diff --git a/doc/user/packages/container_registry/authenticate_with_container_registry.md b/doc/user/packages/container_registry/authenticate_with_container_registry.md index 6e1c0ded758..96b27139613 100644 --- a/doc/user/packages/container_registry/authenticate_with_container_registry.md +++ b/doc/user/packages/container_registry/authenticate_with_container_registry.md @@ -4,7 +4,11 @@ group: Container Registry info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Authenticate with the container registry **(FREE ALL)** +# Authenticate with the container registry + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed To authenticate with the container registry, you can use a: diff --git a/doc/user/packages/container_registry/build_and_push_images.md b/doc/user/packages/container_registry/build_and_push_images.md index 7187f5ef1e9..3a94390b00a 100644 --- a/doc/user/packages/container_registry/build_and_push_images.md +++ b/doc/user/packages/container_registry/build_and_push_images.md @@ -4,7 +4,11 @@ group: Container Registry info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Build and push container images to the container registry **(FREE ALL)** +# Build and push container images to the container registry + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed Before you can build and push container images, you must [authenticate](authenticate_with_container_registry.md) with the container registry. diff --git a/doc/user/packages/container_registry/delete_container_registry_images.md b/doc/user/packages/container_registry/delete_container_registry_images.md index 73ac0082058..e66cc40ebb1 100644 --- a/doc/user/packages/container_registry/delete_container_registry_images.md +++ b/doc/user/packages/container_registry/delete_container_registry_images.md @@ -4,7 +4,11 @@ group: Container Registry info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Delete container images from the container registry **(FREE ALL)** +# Delete container images from the container registry + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed You can delete container images from your container registry. diff --git a/doc/user/packages/container_registry/index.md b/doc/user/packages/container_registry/index.md index 13bdd9ad4e5..4c5438ee1ad 100644 --- a/doc/user/packages/container_registry/index.md +++ b/doc/user/packages/container_registry/index.md @@ -4,9 +4,13 @@ group: Container Registry info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# GitLab container registry **(FREE ALL)** +# GitLab container registry -> Searching by image repository name was [introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/31322) in GitLab 13.0. +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed + +> - Searching by image repository name was [introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/31322) in GitLab 13.0. You can use the integrated container registry to store container images for each GitLab project @@ -125,7 +129,7 @@ The **Deploy > Container Registry** entry is removed from the project's sidebar. ## Change visibility of the container registry -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/18792) in GitLab 14.2. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/18792) in GitLab 14.2. By default, the container registry is visible to everyone with access to the project. You can, however, change the visibility of the container registry for a project. @@ -168,7 +172,7 @@ this setting. However, disabling the container registry disables all Container R ## Supported image types -> OCI conformance [introduced](https://gitlab.com/groups/gitlab-org/-/epics/10345) in GitLab 16.6. +> - OCI conformance [introduced](https://gitlab.com/groups/gitlab-org/-/epics/10345) in GitLab 16.6. The container registry supports the [Docker V2](https://docs.docker.com/registry/spec/manifest-v2-2/) and [Open Container Initiative (OCI)](https://github.com/opencontainers/image-spec/blob/main/spec.md) diff --git a/doc/user/packages/container_registry/reduce_container_registry_data_transfer.md b/doc/user/packages/container_registry/reduce_container_registry_data_transfer.md index c2a48d1e91a..98b7290e5e6 100644 --- a/doc/user/packages/container_registry/reduce_container_registry_data_transfer.md +++ b/doc/user/packages/container_registry/reduce_container_registry_data_transfer.md @@ -4,7 +4,11 @@ group: Container Registry info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Reduce container registry data transfers **(FREE ALL)** +# Reduce container registry data transfers + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed Depending on the frequency with which images or tags are downloaded from the container registry, data transfers can exceed the GitLab.com limit. This page offers several recommendations and tips for diff --git a/doc/user/packages/container_registry/reduce_container_registry_storage.md b/doc/user/packages/container_registry/reduce_container_registry_storage.md index de24f2618d5..0e608414514 100644 --- a/doc/user/packages/container_registry/reduce_container_registry_storage.md +++ b/doc/user/packages/container_registry/reduce_container_registry_storage.md @@ -4,7 +4,11 @@ group: Container Registry info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Reduce container registry storage **(FREE ALL)** +# Reduce container registry storage + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed Container registries can grow in size over time if you don't manage your registry usage. For example, if you add a large number of images or tags: @@ -15,9 +19,13 @@ if you add a large number of images or tags: You should delete unnecessary images and tags and set up a [cleanup policy](#cleanup-policy) to automatically manage your container registry usage. -## View container registry usage **(FREE SAAS)** +## View container registry usage -> [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/5523) in GitLab 15.7 +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS + +> - [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/5523) in GitLab 15.7 To view the storage usage for the container registry: diff --git a/doc/user/packages/debian_repository/index.md b/doc/user/packages/debian_repository/index.md index 86d85b5e0ca..9503b10735b 100644 --- a/doc/user/packages/debian_repository/index.md +++ b/doc/user/packages/debian_repository/index.md @@ -4,7 +4,12 @@ group: Package Registry info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Debian packages in the package registry **(FREE SELF EXPERIMENT)** +# Debian packages in the package registry + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed +**Status:** Experiment > - Debian API [introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/42670) in GitLab 13.5. > - Debian group API [introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/66188) in GitLab 14.2. @@ -175,7 +180,7 @@ dput --config=dput.cf --unchecked --no-upload-log gitlab .changes ## Upload a package with explicit distribution and component -> Upload with explicit distribution and component [introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/101838) in GitLab 15.9. +> - Upload with explicit distribution and component [introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/101838) in GitLab 15.9. When you don't have access to `.changes` file, you can directly upload a `.deb` by passing distribution `codename` and target `component` as parameters with diff --git a/doc/user/packages/dependency_proxy/index.md b/doc/user/packages/dependency_proxy/index.md index 9037abde1cf..341853138e6 100644 --- a/doc/user/packages/dependency_proxy/index.md +++ b/doc/user/packages/dependency_proxy/index.md @@ -4,7 +4,11 @@ group: Container Registry info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Dependency Proxy **(FREE ALL)** +# Dependency Proxy + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed > - [Moved](https://gitlab.com/gitlab-org/gitlab/-/issues/273655) from GitLab Premium to GitLab Free in 13.6. > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/11582) support for private groups in GitLab 13.7. @@ -35,7 +39,7 @@ For a list of planned additions, view the ## Enable or turn off the Dependency Proxy for a group -> Required role [changed](https://gitlab.com/gitlab-org/gitlab/-/issues/350682) from Developer to Maintainer in GitLab 15.0. +> - Required role [changed](https://gitlab.com/gitlab-org/gitlab/-/issues/350682) from Developer to Maintainer in GitLab 15.0. To enable or turn off the Dependency Proxy for a group: @@ -221,7 +225,7 @@ For information on reducing your storage use on the Dependency Proxy, see ## Docker Hub rate limits and the Dependency Proxy -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/241639) in GitLab 13.7. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/241639) in GitLab 13.7. Watch how to [use the Dependency Proxy to help avoid Docker Hub rate limits](https://youtu.be/Nc4nUo7Pq08). diff --git a/doc/user/packages/dependency_proxy/reduce_dependency_proxy_storage.md b/doc/user/packages/dependency_proxy/reduce_dependency_proxy_storage.md index 3b565f3a3ad..31be9dae3a8 100644 --- a/doc/user/packages/dependency_proxy/reduce_dependency_proxy_storage.md +++ b/doc/user/packages/dependency_proxy/reduce_dependency_proxy_storage.md @@ -4,7 +4,11 @@ group: Container Registry info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Reduce Dependency Proxy Storage **(FREE ALL)** +# Reduce Dependency Proxy Storage + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed There's no automatic removal process for blobs. Unless you delete them manually, they're stored indefinitely. Since this impacts your @@ -26,11 +30,11 @@ image or tag from Docker Hub. ## Cleanup policies -> Required role [changed](https://gitlab.com/gitlab-org/gitlab/-/issues/350682) from Developer to Maintainer in GitLab 15.0. +> - Required role [changed](https://gitlab.com/gitlab-org/gitlab/-/issues/350682) from Developer to Maintainer in GitLab 15.0. ### Enable cleanup policies from within GitLab -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/340777) in GitLab 14.6 +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/340777) in GitLab 14.6 You can enable an automatic time-to-live (TTL) policy for the Dependency Proxy from the user interface. To do this, navigate to your group's **Settings > Packages and registries > Dependency Proxy** @@ -38,7 +42,7 @@ and enable the setting to automatically clear items from the cache after 90 days ### Enable cleanup policies with GraphQL -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/294187) in GitLab 14.4. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/294187) in GitLab 14.4. The cleanup policy is a scheduled job you can use to clear cached images that are no longer used, freeing up additional storage space. The policies use time-to-live (TTL) logic: diff --git a/doc/user/packages/generic_packages/index.md b/doc/user/packages/generic_packages/index.md index 6348a8b9da7..d7b8f60cb93 100644 --- a/doc/user/packages/generic_packages/index.md +++ b/doc/user/packages/generic_packages/index.md @@ -4,7 +4,11 @@ group: Package Registry info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# GitLab Generic Packages Repository **(FREE ALL)** +# GitLab Generic Packages Repository + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed > - [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/4209) in GitLab 13.5 [with a flag](../../../administration/feature_flags.md) named `generic_packages`. Enabled by default. > - [Feature flag `generic_packages`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/80886) removed in GitLab 14.8. diff --git a/doc/user/packages/go_proxy/index.md b/doc/user/packages/go_proxy/index.md index 590a3d1e949..17d8ed8fc63 100644 --- a/doc/user/packages/go_proxy/index.md +++ b/doc/user/packages/go_proxy/index.md @@ -4,7 +4,12 @@ group: Package Registry info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Go proxy for GitLab **(FREE ALL EXPERIMENT)** +# Go proxy for GitLab + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed +**Status:** Experiment > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/27376) in GitLab 13.1. > - It's deployed behind a feature flag, disabled by default. diff --git a/doc/user/packages/harbor_container_registry/index.md b/doc/user/packages/harbor_container_registry/index.md index 85e1f1b5fd1..d2cd0bf99a5 100644 --- a/doc/user/packages/harbor_container_registry/index.md +++ b/doc/user/packages/harbor_container_registry/index.md @@ -4,7 +4,11 @@ group: Container Registry info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Harbor Registry **(FREE ALL)** +# Harbor Registry + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed You can integrate the [Harbor container registry](../../../user/project/integrations/harbor.md) into GitLab and use Harbor as the container registry for your GitLab project to store images. diff --git a/doc/user/packages/helm_repository/index.md b/doc/user/packages/helm_repository/index.md index 891dc59bb80..4723fa0788c 100644 --- a/doc/user/packages/helm_repository/index.md +++ b/doc/user/packages/helm_repository/index.md @@ -4,9 +4,14 @@ group: Package Registry info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Helm charts in the package registry **(FREE ALL BETA)** +# Helm charts in the package registry -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/18997) in GitLab 14.1. +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed +**Status:** Beta + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/18997) in GitLab 14.1. WARNING: The Helm chart registry for GitLab is under development and isn't ready for production use due to diff --git a/doc/user/packages/index.md b/doc/user/packages/index.md index 3abdbfd83b3..f64eb8e4dd1 100644 --- a/doc/user/packages/index.md +++ b/doc/user/packages/index.md @@ -4,7 +4,11 @@ group: Package Registry info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Packages and Registries **(FREE ALL)** +# Packages and Registries + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed The GitLab [package registry](package_registry/index.md) acts as a private or public registry for a variety of common package managers. You can publish and share diff --git a/doc/user/packages/maven_repository/index.md b/doc/user/packages/maven_repository/index.md index 419e9c81666..7cab83e124a 100644 --- a/doc/user/packages/maven_repository/index.md +++ b/doc/user/packages/maven_repository/index.md @@ -4,7 +4,11 @@ group: Package Registry info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Maven packages in the package registry **(FREE ALL)** +# Maven packages in the package registry + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed Publish [Maven](https://maven.apache.org) artifacts in your project's package registry. Then, install the packages whenever you need to use them as a dependency. @@ -603,7 +607,7 @@ To delete older package versions, consider using the Packages API or the UI. ### Do not allow duplicate Maven packages -> Required role [changed](https://gitlab.com/gitlab-org/gitlab/-/issues/350682) from Developer to Maintainer in GitLab 15.0. +> - Required role [changed](https://gitlab.com/gitlab-org/gitlab/-/issues/350682) from Developer to Maintainer in GitLab 15.0. To prevent users from publishing duplicate Maven packages, you can use the [GraphQl API](../../../api/graphql/reference/index.md#packagesettings) or the UI. diff --git a/doc/user/packages/npm_registry/index.md b/doc/user/packages/npm_registry/index.md index b229721feab..c1fd69e277b 100644 --- a/doc/user/packages/npm_registry/index.md +++ b/doc/user/packages/npm_registry/index.md @@ -4,7 +4,11 @@ group: Package Registry info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# npm packages in the package registry **(FREE ALL)** +# npm packages in the package registry + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed For documentation of the specific API endpoints that the npm package manager client uses, see the [npm API documentation](../../../api/packages/npm.md). @@ -234,7 +238,7 @@ To install a package from the instance level, the package must have been publish ### Package forwarding to npmjs.com -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/55344) in GitLab 12.9. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/55344) in GitLab 12.9. When an npm package is not found in the package registry, GitLab responds with an HTTP redirect so the requesting client can resend the request to [npmjs.com](https://www.npmjs.com/). @@ -246,7 +250,7 @@ Improvements are tracked in [epic 3608](https://gitlab.com/groups/gitlab-org/-/e ## Deprecate a package -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/396763) in GitLab 16.0. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/396763) in GitLab 16.0. You can deprecate a package so that a deprecation warning displays when the package is fetched. @@ -331,7 +335,7 @@ npm install @scope/package@my-tag # Install a specific tag #### From CI/CD -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/258835) in GitLab 15.10. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/258835) in GitLab 15.10. You can use a [`CI_JOB_TOKEN`](../../../ci/jobs/ci_job_token.md) or [deploy token](../../project/deploy_tokens/index.md) to run `npm dist-tag` commands in a GitLab CI/CD job. For example: diff --git a/doc/user/packages/nuget_repository/index.md b/doc/user/packages/nuget_repository/index.md index 6df4f5b80c4..af0dc0c687f 100644 --- a/doc/user/packages/nuget_repository/index.md +++ b/doc/user/packages/nuget_repository/index.md @@ -4,7 +4,11 @@ group: Package Registry info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# NuGet packages in the package registry **(FREE ALL)** +# NuGet packages in the package registry + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/20050) in GitLab 12.8. > - [Moved](https://gitlab.com/gitlab-org/gitlab/-/issues/221259) from GitLab Premium to GitLab Free in 13.3. @@ -26,7 +30,7 @@ Learn how to [install NuGet](../workflows/build_packages.md#nuget). ## Use the GitLab endpoint for NuGet Packages -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/36423) group-level endpoint in GitLab 13.8. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/36423) group-level endpoint in GitLab 13.8. To use the GitLab endpoint for NuGet Packages, choose an option: @@ -333,7 +337,7 @@ nuget push -Source ### Publish a package with the .NET CLI -> Publishing a package with `--api-key` [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/214674) in GitLab 16.1. +> - Publishing a package with `--api-key` [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/214674) in GitLab 16.1. Prerequisites: @@ -372,7 +376,7 @@ dotnet nuget push MyPackage.1.0.0.nupkg --source https://gitlab.example.com/api/ ### Publish a NuGet package by using CI/CD -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/36424) in GitLab 13.3. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/36424) in GitLab 13.3. If you're using NuGet with GitLab CI/CD, a CI job token can be used instead of a personal access token or deploy token. The token inherits the permissions of the @@ -404,7 +408,7 @@ updated: ### Publish a NuGet package with Chocolatey CLI -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/416404) in GitLab 16.2. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/416404) in GitLab 16.2. Prerequisites: @@ -499,7 +503,7 @@ dotnet add package \ ### Install a package using NuGet v2 feed -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/416405) in GitLab 16.5. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/416405) in GitLab 16.5. Prerequisites: @@ -548,7 +552,7 @@ choco upgrade MyPackage -Source gitlab -Version 1.0.3 ## Delete a package -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/38275) in GitLab 16.5. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/38275) in GitLab 16.5. WARNING: Deleting a package is a permanent action that cannot be undone. @@ -578,7 +582,7 @@ nuget delete MyPackage 1.0.0 -Source gitlab -ApiKey [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/262081) in GitLab 14.1. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/262081) in GitLab 14.1. If you push a `.nupkg`, symbol package files in the `.snupkg` format are uploaded automatically. You can also push them manually: @@ -589,7 +593,7 @@ nuget push My.Package.snupkg -Source ### Use the package registry as a symbol server -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/416178) in GitLab 16.7. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/416178) in GitLab 16.7. GitLab can consume symbol files from the NuGet package registry, so you can use the package registry as a symbol server. @@ -635,7 +639,7 @@ Note that: ## Supported CLI commands -> `nuget delete` and `dotnet nuget delete` commands [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/38275) in GitLab 16.5. +> - `nuget delete` and `dotnet nuget delete` commands [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/38275) in GitLab 16.5. The GitLab NuGet repository supports the following commands for the NuGet CLI (`nuget`) and the .NET CLI (`dotnet`): diff --git a/doc/user/packages/package_registry/dependency_proxy/index.md b/doc/user/packages/package_registry/dependency_proxy/index.md index 88e424ed3ac..5acd3e76177 100644 --- a/doc/user/packages/package_registry/dependency_proxy/index.md +++ b/doc/user/packages/package_registry/dependency_proxy/index.md @@ -4,7 +4,12 @@ group: Package Registry info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Dependency proxy for packages **(PREMIUM ALL BETA)** +# Dependency proxy for packages + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed +**Status:** Beta > - [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/3610) in GitLab 16.6 [with a flag](../../../../administration/feature_flags.md) named `packages_dependency_proxy_maven`. Disabled by default. > - [Generally available](https://gitlab.com/gitlab-org/gitlab/-/issues/415218) in GitLab 16.8. Feature flag `packages_dependency_proxy_maven` removed. diff --git a/doc/user/packages/package_registry/index.md b/doc/user/packages/package_registry/index.md index 6a4e7c0d6a5..fe9b559b028 100644 --- a/doc/user/packages/package_registry/index.md +++ b/doc/user/packages/package_registry/index.md @@ -4,9 +4,13 @@ group: Package Registry info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Package registry **(FREE ALL)** +# Package registry -> [Moved](https://gitlab.com/gitlab-org/gitlab/-/issues/221259) from GitLab Premium to GitLab Free in 13.3. +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed + +> - [Moved](https://gitlab.com/gitlab-org/gitlab/-/issues/221259) from GitLab Premium to GitLab Free in 13.3. With the GitLab package registry, you can use GitLab as a private or public registry for a variety of [supported package managers](supported_package_managers.md). @@ -149,7 +153,7 @@ Registry disables all package registry operations. ### Allow anyone to pull from package registry -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/385994) in GitLab 15.7. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/385994) in GitLab 15.7. To allow anyone to pull from the package registry, regardless of project visibility: diff --git a/doc/user/packages/package_registry/reduce_package_registry_storage.md b/doc/user/packages/package_registry/reduce_package_registry_storage.md index c1d3d7d0937..496973e64dd 100644 --- a/doc/user/packages/package_registry/reduce_package_registry_storage.md +++ b/doc/user/packages/package_registry/reduce_package_registry_storage.md @@ -4,7 +4,11 @@ group: Package Registry info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Reduce package registry storage **(FREE ALL)** +# Reduce package registry storage + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed Without cleanup, package registries become large over time. When a large number of packages and their assets are added: @@ -56,7 +60,7 @@ The package assets are permanently deleted. ## Cleanup policy -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/346153) in GitLab 15.2. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/346153) in GitLab 15.2. Depending on the number of packages to remove, the process of manually deleting the packages can take a long time to finish. A cleanup policy defines a set of rules that, applied to a project, defines which package assets you can automatically delete. diff --git a/doc/user/packages/package_registry/supported_functionality.md b/doc/user/packages/package_registry/supported_functionality.md index 4b10e703127..1a266843383 100644 --- a/doc/user/packages/package_registry/supported_functionality.md +++ b/doc/user/packages/package_registry/supported_functionality.md @@ -9,7 +9,11 @@ info: To determine the technical writer assigned to the Stage/Group associated w The GitLab package registry supports different functionalities for each package type. This support includes publishing and pulling packages, request forwarding, managing duplicates, and authentication. -## Publishing packages **(FREE ALL)** +## Publishing packages + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed Packages can be published to your project, group, or instance. @@ -30,7 +34,11 @@ Packages can be published to your project, group, or instance. | [Go](../go_proxy/index.md) | Y | N | N | | [Ruby gems](../rubygems_registry/index.md) | Y | N | N | -## Pulling packages **(FREE ALL)** +## Pulling packages + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed Packages can be pulled from your project, group, or instance. @@ -51,7 +59,11 @@ Packages can be pulled from your project, group, or instance. | [Go](../go_proxy/index.md) | Y | N | Y | | [Ruby gems](../rubygems_registry/index.md) | Y | N | N | -## Forwarding requests **(PREMIUM ALL)** +## Forwarding requests + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed Requests for packages not found in your GitLab project are forwarded to the public registry. For example, Maven Central, npmjs, or PyPI. @@ -110,7 +122,11 @@ You can use GitLab pipelines to import packages from other repositories, such as | [Go](../go_proxy/index.md) | N | | [Ruby gems](../rubygems_registry/index.md) | N | -## Allow or prevent duplicates **(FREE ALL)** +## Allow or prevent duplicates + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed By default, the GitLab package registry either allows or prevents duplicates based on the default of that specific package manager format. @@ -131,7 +147,11 @@ By default, the GitLab package registry either allows or prevents duplicates bas | [Go](../go_proxy/index.md) | N | | [Ruby gems](../rubygems_registry/index.md) | Y | -## Authentication tokens **(FREE ALL)** +## Authentication tokens + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed GitLab tokens are used to authenticate with the GitLab package registry. @@ -154,7 +174,11 @@ The following tokens are supported: | [Go](../go_proxy/index.md) | Personal access, job tokens, project access | | [Ruby gems](../rubygems_registry/index.md) | Personal access, job tokens, deploy (project or group) | -## Authentication protocols **(FREE ALL)** +## Authentication protocols + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed The following authentication protocols are supported: @@ -177,7 +201,11 @@ The following authentication protocols are supported: 1. Basic authentication for Maven packages [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/212854) in GitLab 16.0. -## Supported hash types **(FREE ALL)** +## Supported hash types + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed Hash values are used to ensure you are using the correct package. You can view these values in the user interface or with the [API](../../../api/packages.md). diff --git a/doc/user/packages/package_registry/supported_package_managers.md b/doc/user/packages/package_registry/supported_package_managers.md index aa56bed78aa..96edacf8d3f 100644 --- a/doc/user/packages/package_registry/supported_package_managers.md +++ b/doc/user/packages/package_registry/supported_package_managers.md @@ -4,7 +4,11 @@ group: Package Registry info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Supported package managers **(FREE ALL)** +# Supported package managers + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed WARNING: Not all package manager formats are ready for production use. diff --git a/doc/user/packages/pypi_repository/index.md b/doc/user/packages/pypi_repository/index.md index ccd47527855..c3622d629a7 100644 --- a/doc/user/packages/pypi_repository/index.md +++ b/doc/user/packages/pypi_repository/index.md @@ -4,7 +4,11 @@ group: Package Registry info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# PyPI packages in the package registry **(FREE ALL)** +# PyPI packages in the package registry + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/208747) in GitLab 12.10. > - [Moved](https://gitlab.com/gitlab-org/gitlab/-/issues/221259) from GitLab Premium to GitLab Free in 13.3. @@ -76,7 +80,7 @@ path (for example, `group%2Fproject`), or the project's ID (for example `42`). ### Authenticate with a CI job token -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/202012) in GitLab 13.4. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/202012) in GitLab 13.4. To work with PyPI commands within [GitLab CI/CD](../../../ci/index.md), you can use `CI_JOB_TOKEN` instead of a personal access token or deploy token. diff --git a/doc/user/packages/rubygems_registry/index.md b/doc/user/packages/rubygems_registry/index.md index cb522fee2b4..87c4e4ece57 100644 --- a/doc/user/packages/rubygems_registry/index.md +++ b/doc/user/packages/rubygems_registry/index.md @@ -4,9 +4,14 @@ group: Package Registry info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Ruby gems in the package registry **(FREE ALL EXPERIMENT)** +# Ruby gems in the package registry -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/803) in GitLab 13.10. +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed +**Status:** Experiment + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/803) in GitLab 13.10. WARNING: The Ruby gems package registry for GitLab is under development and isn't ready for production use due to diff --git a/doc/user/packages/terraform_module_registry/index.md b/doc/user/packages/terraform_module_registry/index.md index b4a0597bf60..8f05fdbadd9 100644 --- a/doc/user/packages/terraform_module_registry/index.md +++ b/doc/user/packages/terraform_module_registry/index.md @@ -4,7 +4,11 @@ group: Package Registry info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Terraform Module Registry **(FREE ALL)** +# Terraform Module Registry + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed > - [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/3221) in GitLab 14.0. > - Infrastructure registry and Terraform Module Registry [merged](https://gitlab.com/gitlab-org/gitlab/-/issues/404075) into a single Terraform Module Registry feature in GitLab 15.11. @@ -97,7 +101,7 @@ Example response: ### Using a CI/CD template (recommended) -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/110493) in GitLab 15.9. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/110493) in GitLab 15.9. You can use the [`Terraform-Module.gitlab-ci.yml`](https://gitlab.com/gitlab-org/gitlab/-/blob/master/lib/gitlab/ci/templates/Terraform-Module.gitlab-ci.yml) or the advanced [`Terraform/Module-Base.gitlab-ci.yml`](https://gitlab.com/gitlab-org/gitlab/-/blob/master/lib/gitlab/ci/templates/Terraform/Module-Base.gitlab-ci.yml) @@ -159,7 +163,7 @@ For other ways to control jobs in your CI/CD pipeline, refer to the [CI/CD YAML ### Allow duplicate Terraform modules -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/368040) in GitLab 16.8. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/368040) in GitLab 16.8. By default, the Terraform Module Registry enforces uniqueness for module names in the same namespace. To allow publishing duplicate module names: diff --git a/doc/user/packages/workflows/project_registry.md b/doc/user/packages/workflows/project_registry.md index d85988a0bd7..95c9e020260 100644 --- a/doc/user/packages/workflows/project_registry.md +++ b/doc/user/packages/workflows/project_registry.md @@ -4,7 +4,11 @@ group: Package Registry info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Store all of your packages in one GitLab project **(FREE ALL)** +# Store all of your packages in one GitLab project + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed You can store all of your packages in one project's package registry. Rather than using a GitLab repository to store code, you can use the repository to store all your packages. diff --git a/doc/user/packages/workflows/working_with_monorepos.md b/doc/user/packages/workflows/working_with_monorepos.md index 11c8eab2513..c7b533da645 100644 --- a/doc/user/packages/workflows/working_with_monorepos.md +++ b/doc/user/packages/workflows/working_with_monorepos.md @@ -4,7 +4,11 @@ group: Package Registry info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Monorepo package management workflows **(FREE ALL)** +# Monorepo package management workflows + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed One project or Git repository can contain multiple different subprojects or submodules that are all packaged and published individually. diff --git a/doc/user/permissions.md b/doc/user/permissions.md index 5ac6041d09e..aa0198db8c0 100644 --- a/doc/user/permissions.md +++ b/doc/user/permissions.md @@ -4,7 +4,11 @@ group: Authentication info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Permissions and roles **(FREE ALL)** +# Permissions and roles + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed When you add a user to a project or group, you assign them a role. The role determines which actions they can take in GitLab. @@ -443,7 +447,11 @@ nested groups if you have membership in one of its parents. For more information, see [subgroup memberships](group/subgroups/index.md#subgroup-membership). -## Users with Minimal Access **(PREMIUM ALL)** +## Users with Minimal Access + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/40942) in GitLab 13.4. > - Support for inviting users with Minimal Access role [introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/106438) in GitLab 15.9. diff --git a/doc/user/product_analytics/index.md b/doc/user/product_analytics/index.md index 54120ff2330..0f426b268d3 100644 --- a/doc/user/product_analytics/index.md +++ b/doc/user/product_analytics/index.md @@ -4,7 +4,12 @@ group: Product Analytics info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Product analytics **(ULTIMATE SAAS BETA)** +# Product analytics + +DETAILS: +**Tier:** Ultimate +**Offering:** SaaS +**Status:** Beta > - Introduced in GitLab 15.4 as an [Experiment](../../policy/experiment-beta-support.md#experiment) feature [with a flag](../../administration/feature_flags.md) named `cube_api_proxy`. Disabled by default. > - `cube_api_proxy` revised to only reference the [Product Analytics API](../../api/product_analytics.md) in GitLab 15.6. @@ -134,7 +139,7 @@ Data table visualizations from `cube_analytics` have an additional configuration ### Filling missing data -- Introduced in GitLab 16.3 behind the [feature flag](../../administration/feature_flags.md) named `product_analytics_dashboards`. Disabled by default. +> - Introduced in GitLab 16.3 behind the [feature flag](../../administration/feature_flags.md) named `product_analytics_dashboards`. Disabled by default. When [exporting data](#raw-data-export) or [viewing dashboards](../analytics/analytics_dashboards.md#view-project-dashboards), if there is no data for a given day, the missing data is autofilled with `0`. diff --git a/doc/user/profile/account/create_accounts.md b/doc/user/profile/account/create_accounts.md index 4611b3a6a40..2bf46028eef 100644 --- a/doc/user/profile/account/create_accounts.md +++ b/doc/user/profile/account/create_accounts.md @@ -5,7 +5,11 @@ description: Passwords, user moderation, broadcast messages. info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Creating users **(FREE SELF)** +# Creating users + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed You can create users: diff --git a/doc/user/profile/account/delete_account.md b/doc/user/profile/account/delete_account.md index a3df0aa5460..732de999f7f 100644 --- a/doc/user/profile/account/delete_account.md +++ b/doc/user/profile/account/delete_account.md @@ -4,7 +4,11 @@ group: Authentication info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Deleting a user account **(FREE ALL)** +# Deleting a user account + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed Users can be deleted from a GitLab instance, either by: @@ -16,7 +20,7 @@ Deleting a user deletes all projects in that user namespace. ## Delete your own account -> Delay between a user deleting their own account and deletion of the user record introduced in GitLab 16.0 [with a flag](../../../administration/feature_flags.md) named `delay_delete_own_user`. Enabled by default on GitLab.com. +> - Delay between a user deleting their own account and deletion of the user record introduced in GitLab 16.0 [with a flag](../../../administration/feature_flags.md) named `delay_delete_own_user`. Enabled by default on GitLab.com. FLAG: On self-managed GitLab, by default this feature is not available. To make it available, an administrator can [enable the feature flag](../../../administration/feature_flags.md) named `delay_delete_own_user`. On GitLab.com, this feature is available. @@ -31,7 +35,11 @@ As a user, to delete your own account: NOTE: On GitLab.com, there is a seven day delay between a user deleting their own account and deletion of the user record. During this time, that user is [blocked](../../../administration/moderate_users.md#block-a-user) and a new account with the same email address or username cannot be created. Unblocking the account does not undo the deletion because the account will still be in the deletion queue, and will be deleted. Accounts with no issues, comments, notes, merge requests, or snippets are deleted immediately. Accounts under paid namespaces are deleted immediately. -## Delete users and user contributions **(FREE SELF)** +## Delete users and user contributions + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed As an administrator, to delete a user account: diff --git a/doc/user/profile/account/two_factor_authentication.md b/doc/user/profile/account/two_factor_authentication.md index 376fde66cf0..a19c23995b9 100644 --- a/doc/user/profile/account/two_factor_authentication.md +++ b/doc/user/profile/account/two_factor_authentication.md @@ -4,7 +4,11 @@ group: Authentication info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Two-factor authentication **(FREE ALL)** +# Two-factor authentication + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed Two-factor authentication (2FA) provides an additional level of security to your GitLab account. For others to access your account, they would need your username and password _and_ access to your second factor of authentication. @@ -94,7 +98,7 @@ in a safe place. ### Enable one-time password using FortiAuthenticator -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/212312) in GitLab 13.5 [with a flag](../../../administration/feature_flags.md) named `forti_authenticator`. Disabled by default. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/212312) in GitLab 13.5 [with a flag](../../../administration/feature_flags.md) named `forti_authenticator`. Disabled by default. FLAG: On self-managed GitLab, by default this feature is not available. To make it available per user, an administrator can @@ -160,7 +164,7 @@ Configure FortiAuthenticator in GitLab. On your GitLab server: ### Enable one-time password using Cisco Duo -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/15760) in GitLab 15.10. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/15760) in GitLab 15.10. FLAG: On self-managed GitLab, by default this feature is available. On GitLab.com this feature is not available. @@ -228,7 +232,7 @@ On your GitLab server: ### Enable one-time password using FortiToken Cloud -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/212313) in GitLab 13.7 [with a flag](../../../administration/feature_flags.md) named `forti_token_cloud`. Disabled by default. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/212313) in GitLab 13.7 [with a flag](../../../administration/feature_flags.md) named `forti_token_cloud`. Disabled by default. FLAG: On self-managed GitLab, by default this feature is not available. To make it available per user, an administrator can @@ -341,7 +345,7 @@ You can lose access to your account if you clear your browser data. ## Recovery codes -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/267730) in GitLab 13.7, **Copy codes** and **Print codes** buttons. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/267730) in GitLab 13.7, **Copy codes** and **Print codes** buttons. Immediately after successfully enabling 2FA with a one-time password, you're prompted to download a set of generated recovery codes. If you ever lose access to your one-time password authenticator, you can use one of @@ -466,7 +470,11 @@ If you forget to save your recovery codes when enabling 2FA, and you added an SS After signing in, immediately set up 2FA with a new device. -### Have two-factor authentication disabled on your account **(PREMIUM SAAS)** +### Have two-factor authentication disabled on your account + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS If other methods are unavailable, have a GitLab support contact submit a [support ticket](https://support.gitlab.com) to request a GitLab global administrator disable 2FA for your account: @@ -476,7 +484,11 @@ a GitLab global administrator disable 2FA for your account: - Disabling this setting temporarily leaves your account in a less secure state. You should sign in and re-enable two-factor authentication as soon as possible. -## Information for GitLab administrators **(FREE SELF)** +## Information for GitLab administrators + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed - Take care that 2FA keeps working after [restoring a GitLab backup](../../../administration/backup_restore/index.md). - To ensure 2FA authorizes correctly with a time-based one-time password (TOTP) server, synchronize your GitLab diff --git a/doc/user/profile/achievements.md b/doc/user/profile/achievements.md index 0f03868de95..91f3d0f0608 100644 --- a/doc/user/profile/achievements.md +++ b/doc/user/profile/achievements.md @@ -4,9 +4,14 @@ group: Tenant Scale info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Achievements **(FREE ALL EXPERIMENT)** +# Achievements -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/113156) in GitLab 15.10 [with a flag](../../administration/feature_flags.md) named `achievements`. Disabled by default. +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed +**Status:** Experiment + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/113156) in GitLab 15.10 [with a flag](../../administration/feature_flags.md) named `achievements`. Disabled by default. FLAG: On self-managed GitLab, by default this feature is not available. To make it available, diff --git a/doc/user/profile/active_sessions.md b/doc/user/profile/active_sessions.md index 658134be9ad..5d9b47dadce 100644 --- a/doc/user/profile/active_sessions.md +++ b/doc/user/profile/active_sessions.md @@ -4,9 +4,13 @@ group: unassigned info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Active sessions **(FREE ALL)** +# Active sessions -> [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/17867) in GitLab 10.8. +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/17867) in GitLab 10.8. GitLab lists all devices that have logged into your account. You can review the sessions, and revoke any you don't recognize. @@ -23,7 +27,7 @@ To list all active sessions: ## Active sessions limit -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/31611) in GitLab 12.6. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/31611) in GitLab 12.6. GitLab allows users to have up to 100 active sessions at once. If the number of active sessions exceeds 100, the oldest ones are deleted. diff --git a/doc/user/profile/comment_templates.md b/doc/user/profile/comment_templates.md index 126f0e1dc8c..838594b24cf 100644 --- a/doc/user/profile/comment_templates.md +++ b/doc/user/profile/comment_templates.md @@ -4,7 +4,11 @@ group: Code Review info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Comment templates **(FREE ALL)** +# Comment templates + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed > - GraphQL support [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/352956) in GitLab 14.9 [with a flag](../../administration/feature_flags.md) named `saved_replies`. Disabled by default. > - User interface [introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/113232) in GitLab 15.10 [with a flag](../../administration/feature_flags.md) named `saved_replies`. Disabled by default. Enabled for GitLab team members only. diff --git a/doc/user/profile/contributions_calendar.md b/doc/user/profile/contributions_calendar.md index ec1bb3f7771..dc5f0a6a2f4 100644 --- a/doc/user/profile/contributions_calendar.md +++ b/doc/user/profile/contributions_calendar.md @@ -4,7 +4,11 @@ group: Tenant Scale info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Contributions calendar **(FREE ALL)** +# Contributions calendar + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed The contributions calendar displays a [user's events](#user-contribution-events) from the past 12 months. This includes contributions made in forked and [private](#show-private-contributions-on-your-user-profile-page) repositories. diff --git a/doc/user/profile/index.md b/doc/user/profile/index.md index a6e49c47ce1..3f546d8cf84 100644 --- a/doc/user/profile/index.md +++ b/doc/user/profile/index.md @@ -4,7 +4,11 @@ group: Authentication info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# User account **(FREE ALL)** +# User account + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed Each GitLab account has a user profile, which contains information about you and your GitLab activity. @@ -120,7 +124,7 @@ user profiles are only visible to authenticated users. ## Add details to your profile with a README -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/232157) in GitLab 14.5. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/232157) in GitLab 14.5. You can add more information to your profile page with a README file. When you populate the README file with information, it's included on your profile page. @@ -185,7 +189,7 @@ To show private contributions: ## Add your gender pronouns -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/332405) in GitLab 14.0. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/332405) in GitLab 14.0. You can add your gender pronouns to your GitLab account to be displayed next to your name in your profile. @@ -199,7 +203,7 @@ To specify your pronouns: ## Add your name pronunciation -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/25742) in GitLab 14.2. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/25742) in GitLab 14.2. You can add your name pronunciation to your GitLab account. This is displayed in your profile, below your name. @@ -213,7 +217,7 @@ To add your name pronunciation: ## Set your current status -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/56649) in GitLab 13.10, users can schedule the clearing of their status. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/56649) in GitLab 13.10, users can schedule the clearing of their status. You can provide a custom status message for your user profile along with an emoji that describes it. This may be helpful when you are out of office or otherwise not available. @@ -355,9 +359,9 @@ When this feature is being disabled, all current followed/following connections ## Advanced code search with zoekt -### Disable searching code with zoekt +### Disable searching code with Zoekt -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/388519) as a beta feature [with a flag](../feature_flags.md) named `search_code_with_zoekt`. Enabled by default. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/388519) as a beta feature [with a flag](../feature_flags.md) named `search_code_with_zoekt`. Enabled by default. You can disable searching with Zoekt and use Elasticsearch instead. @@ -407,7 +411,7 @@ GitLab administrators can ### Stay signed in indefinitely -> Ability to turn the **Remember me** setting on and off [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/369133) in GitLab 16.0. +> - Ability to turn the **Remember me** setting on and off [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/369133) in GitLab 16.0. To remain signed in indefinitely, select the **Remember me** checkbox on the GitLab sign-in page. @@ -419,7 +423,7 @@ that require sessions to expire periodically for security or compliance purposes ### Cookies used for sign-in -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/20340) in GitLab 13.1. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/20340) in GitLab 13.1. When you sign in, three cookies are set: diff --git a/doc/user/profile/notifications.md b/doc/user/profile/notifications.md index c7b2de3ce7f..8add97e32dd 100644 --- a/doc/user/profile/notifications.md +++ b/doc/user/profile/notifications.md @@ -4,7 +4,11 @@ group: Project Management info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Notification emails **(FREE ALL)** +# Notification emails + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed > - Enhanced email styling [introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/78604) in GitLab 14.9 [with a feature flag](../../administration/feature_flags.md) named `enhanced_notify_css`. Disabled by default. > - Enhanced email styling [enabled on GitLab.com](https://gitlab.com/gitlab-org/gitlab/-/issues/355907) in GitLab 14.9. @@ -112,7 +116,7 @@ Or: #### Change email address used for group notifications -> Introduced in GitLab 12.0. +> - Introduced in GitLab 12.0. You can select an email address to receive notifications for each group you belong to. You can use group notifications, for example, if you work freelance, and want to keep email about clients' projects separate. @@ -289,7 +293,7 @@ GitLab uses several methods to identify a known sign-in. All methods must fail f ## Notifications for attempted sign-ins using incorrect verification codes -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/374740) in GitLab 15.5. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/374740) in GitLab 15.5. GitLab sends you an email notification if it detects an attempt to sign in to your account using a wrong two-factor authentication (2FA) code. This can help you detect that a bad actor gained access to your username and password, and is trying @@ -297,7 +301,7 @@ to brute force 2FA. ## Notifications on designs -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/217095) in GitLab 13.6. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/217095) in GitLab 13.6. Email notifications are sent to the participants when someone comments on a design. @@ -309,7 +313,7 @@ The participants are: ## Notifications on group or project access expiration -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/12704) in GitLab 16.3. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/12704) in GitLab 16.3. GitLab sends an email notification if a user's access to a group or project expires in seven days. This reminds group or project members to extend their access duration if they want to. @@ -372,7 +376,11 @@ For example, an email with the reason `assigned` has this sentence in the footer > You are receiving this email because you have been assigned an item on \. -#### On-call alerts notifications **(PREMIUM ALL)** +#### On-call alerts notifications + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed An [on-call alert](../../operations/incident_management/oncall_schedules.md) notification email can have one of [the alert's](../../operations/incident_management/alerts.md) statuses: @@ -382,7 +390,11 @@ notification email can have one of [the alert's](../../operations/incident_manag - `alert_resolved` - `alert_ignored` -#### Incident escalation notifications **(PREMIUM ALL)** +#### Incident escalation notifications + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed An [incident escalation](../../operations/incident_management/escalation_policies.md) notification email can have one of [the incident's](../../operations/incident_management/incidents.md) status: diff --git a/doc/user/profile/personal_access_tokens.md b/doc/user/profile/personal_access_tokens.md index 2e6bd44ff3b..eb909214027 100644 --- a/doc/user/profile/personal_access_tokens.md +++ b/doc/user/profile/personal_access_tokens.md @@ -4,7 +4,11 @@ group: Authentication info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Personal access tokens **(FREE ALL)** +# Personal access tokens + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed > - Notifications for expiring tokens [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/3649) in GitLab 12.6. > - Token lifetime limits [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/3649) in GitLab 12.6. @@ -85,7 +89,11 @@ At any time, you can revoke a personal access token. 1. In the **Active personal access tokens** area, select **Revoke** for the relevant token. 1. On the confirmation dialog, select **Revoke**. -## Disable personal access tokens **(PREMIUM SELF)** +## Disable personal access tokens + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** Self-managed Prerequisites: @@ -183,7 +191,11 @@ Prerequisites: You can now create personal access tokens for a service account user with no expiry date. -## Create a personal access token programmatically **(FREE SELF)** +## Create a personal access token programmatically + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed You can create a predetermined personal access token as part of your tests or automation. @@ -223,7 +235,11 @@ This code can be shortened into a single-line shell command by using the sudo gitlab-rails runner "token = User.find_by_username('automation-bot').personal_access_tokens.create(scopes: ['read_user', 'read_repository'], name: 'Automation token', expires_at: 365.days.from_now); token.set_token('token-string-here123'); token.save!" ``` -## Revoke a personal access token programmatically **(FREE SELF)** +## Revoke a personal access token programmatically + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed You can programmatically revoke a personal access token as part of your tests or automation. @@ -255,7 +271,11 @@ This code can be shortened into a single-line shell command using the sudo gitlab-rails runner "PersonalAccessToken.find_by_token('token-string-here123').revoke!" ``` -## Clone repository using personal access token **(FREE SELF)** +## Clone repository using personal access token + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed To clone a repository when SSH is disabled, clone it using a personal access token by running the following command: @@ -280,7 +300,11 @@ Remember this if you set up an automation pipeline that depends on authenticatio ## Troubleshooting -### Unrevoke a personal access token **(FREE SELF)** +### Unrevoke a personal access token + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed If a personal access token is revoked accidentally by any method, administrators can unrevoke that token. By default, a daily job deletes revoked tokens at 1:00 AM system time. diff --git a/doc/user/profile/preferences.md b/doc/user/profile/preferences.md index de8ab4b25e9..920cce43610 100644 --- a/doc/user/profile/preferences.md +++ b/doc/user/profile/preferences.md @@ -4,7 +4,11 @@ group: unassigned info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Profile preferences **(FREE ALL)** +# Profile preferences + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed You can update your preferences to change the look and feel of GitLab. @@ -22,7 +26,7 @@ To change the color theme: ### Dark mode -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/28252) in GitLab 13.1 as an [Experiment](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/28252). +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/28252) in GitLab 13.1 as an [Experiment](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/28252). Dark mode makes elements on the GitLab UI stand out on a dark background. @@ -32,7 +36,7 @@ Dark mode works only with the **Dark** Syntax highlighting theme. You can report ## Change the syntax highlighting theme -> Changing the default syntax highlighting theme for authenticated and unauthenticated users [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/25129) in GitLab 15.1. +> - Changing the default syntax highlighting theme for authenticated and unauthenticated users [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/25129) in GitLab 15.1. Syntax highlighting is a feature in code editors and IDEs. The highlighter assigns a color to each type of code, such as strings and comments. @@ -252,7 +256,7 @@ After you change your calendar start day, refresh your user profile page. ### Show exact times instead of relative times -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/65570) in GitLab 14.1. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/65570) in GitLab 14.1. Customize the format used to display times of activities on your group and project overview pages and user profiles. You can display times in a: @@ -269,7 +273,7 @@ To use exact times on the GitLab UI: ### Customize time format -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/15206) in GitLab 16.6. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/15206) in GitLab 16.6. You can customize the format used to display times of activities on your group and project overview pages and user profiles. You can display times as: @@ -289,7 +293,7 @@ To customize the time format: ## User identities in CI job JSON web tokens -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/387537) in GitLab 16.0. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/387537) in GitLab 16.0. CI/CD jobs generate JSON web tokens, which can include a list of your external identities. Instead of making separate API calls to get individual accounts, you can find your user identities in a single authentication token. @@ -299,7 +303,7 @@ To enable including external identities, see [Token payload](../../ci/secrets/id ## Control follower engagement -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/325558) in GitLab 16.0. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/325558) in GitLab 16.0. Turn off the ability to follow or be followed by other GitLab users. By default, your user profile, including your name and profile photo, is public in the **Following** tabs of other users. When you deactivate this setting: @@ -318,7 +322,11 @@ To access your **Followers** and **Following** tabs: - On the left sidebar, select your avatar > select your name or username. - Select **Followers** or **Following**. -## Enable Code Suggestions **(FREE SAAS)** +## Enable Code Suggestions + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/121079) in GitLab 16.1 as [Beta](../../policy/experiment-beta-support.md#beta). > - [Enabled on GitLab.com](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/139916) in GitLab 16.8. UI user setting removed. diff --git a/doc/user/profile/service_accounts.md b/doc/user/profile/service_accounts.md index 3833d844d46..701d4dd1676 100644 --- a/doc/user/profile/service_accounts.md +++ b/doc/user/profile/service_accounts.md @@ -4,7 +4,11 @@ group: Authentication info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Service accounts **(PREMIUM ALL)** +# Service accounts + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed A service account is a type of machine user that is not tied to an individual human user. diff --git a/doc/user/profile/user_passwords.md b/doc/user/profile/user_passwords.md index 97fd1081e05..7e0667248bb 100644 --- a/doc/user/profile/user_passwords.md +++ b/doc/user/profile/user_passwords.md @@ -4,7 +4,11 @@ group: Authentication info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# User passwords **(FREE ALL)** +# User passwords + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed If you use a password to sign in to GitLab, a strong password is very important. A weak or guessable password makes it easier for unauthorized people to log into your account. @@ -23,7 +27,7 @@ authorization provider, you do not need to choose a password. GitLab ## Change your password -> Password reset emails sent to any verified email address [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/16311) in GitLab 16.1. +> - Password reset emails sent to any verified email address [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/16311) in GitLab 16.1. You can change your password. GitLab enforces [password requirements](#password-requirements) when you choose your new password. diff --git a/doc/user/project/autocomplete_characters.md b/doc/user/project/autocomplete_characters.md index c341d2cef3e..33381126456 100644 --- a/doc/user/project/autocomplete_characters.md +++ b/doc/user/project/autocomplete_characters.md @@ -5,9 +5,13 @@ info: "To determine the technical writer assigned to the Stage/Group associated description: "Autocomplete characters in Markdown fields." --- -# Autocomplete characters **(FREE ALL)** +# Autocomplete characters -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/36705) in GitLab 13.9: you can search using the full name in user autocomplete. +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/36705) in GitLab 13.9: you can search using the full name in user autocomplete. The autocomplete characters provide a quick way of entering field values into Markdown fields. When you start typing a word in a Markdown field with one of diff --git a/doc/user/project/badges.md b/doc/user/project/badges.md index 4848217c468..ef5dc33c997 100644 --- a/doc/user/project/badges.md +++ b/doc/user/project/badges.md @@ -4,7 +4,11 @@ group: Tenant Scale info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Badges **(FREE ALL)** +# Badges + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed Badges are a unified way to present condensed pieces of information about your projects. A badge consists of a small image and a URL that the image points to. @@ -99,7 +103,7 @@ sets `min_acceptable` to `79` (`min_good` - `1`). ## Latest release badges -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/33368) in GitLab 14.8. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/33368) in GitLab 14.8. The latest release badge indicates the latest release tag name for your project. If there is no release, it shows `none`. @@ -221,7 +225,7 @@ Pipeline badges can be rendered in different styles by adding the `style=style_n ### Customize badge text -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/17555) in GitLab 13.1. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/17555) in GitLab 13.1. The text for a badge can be customized to differentiate between multiple coverage jobs that run in the same pipeline. Customize the badge text and width by adding the `key_text=custom_text` and `key_width=custom_key_width` parameters to the URL: diff --git a/doc/user/project/canary_deployments.md b/doc/user/project/canary_deployments.md index fe425d7420e..c02011f7927 100644 --- a/doc/user/project/canary_deployments.md +++ b/doc/user/project/canary_deployments.md @@ -4,7 +4,11 @@ group: unassigned info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Canary deployments **(FREE ALL)** +# Canary deployments + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/1659) in GitLab 9.1. > - [Moved](https://gitlab.com/gitlab-org/gitlab/-/issues/212320) from GitLab Premium to GitLab Free in 13.8. diff --git a/doc/user/project/changelogs.md b/doc/user/project/changelogs.md index df6df1653ac..4028560bd28 100644 --- a/doc/user/project/changelogs.md +++ b/doc/user/project/changelogs.md @@ -4,7 +4,11 @@ group: Source Code info: "To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments" --- -# Changelogs **(FREE ALL)** +# Changelogs + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed Changelogs are generated based on commit titles and Git trailers. To be included in a changelog, a commit must contain a specific Git trailer. Changelogs are generated @@ -67,7 +71,7 @@ in the API documentation. ### From the GitLab CLI -> [Introduced](https://gitlab.com/gitlab-org/cli/-/merge_requests/1222) in `glab` version 1.30.0. +> - [Introduced](https://gitlab.com/gitlab-org/cli/-/merge_requests/1222) in `glab` version 1.30.0. Prerequisites: @@ -279,7 +283,7 @@ corresponding merge request, no merge request is displayed. ### Customize the tag format when extracting versions -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/56889) in GitLab 13.11. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/56889) in GitLab 13.11. GitLab uses a regular expression (using the [re2](https://github.com/google/re2/) engine and syntax) to extract a semantic @@ -327,7 +331,7 @@ an error is produced when generating a changelog. ## Reverted commit handling -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/55537) in GitLab 13.10. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/55537) in GitLab 13.10. To be treated as a revert commit, the commit message must contain the string `This reverts commit `, where `SHA` is the SHA of the commit to be reverted. diff --git a/doc/user/project/clusters/add_eks_clusters.md b/doc/user/project/clusters/add_eks_clusters.md index 831e37dcf3c..e3b7488c65e 100644 --- a/doc/user/project/clusters/add_eks_clusters.md +++ b/doc/user/project/clusters/add_eks_clusters.md @@ -4,7 +4,11 @@ group: Environments info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Connect EKS clusters through cluster certificates (deprecated) **(FREE ALL)** +# Connect EKS clusters through cluster certificates (deprecated) + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/22392) in GitLab 12.5. > - [Deprecated](https://gitlab.com/groups/gitlab-org/configure/-/epics/8) in GitLab 14.5. @@ -27,7 +31,7 @@ To create a new cluster from GitLab, use [Infrastructure as Code](../../infrastr ### How to create a new cluster on EKS through cluster certificates (deprecated) -> [Deprecated](https://gitlab.com/gitlab-org/gitlab/-/issues/327908) in GitLab 14.0. +> - [Deprecated](https://gitlab.com/gitlab-org/gitlab/-/issues/327908) in GitLab 14.0. Prerequisites: @@ -221,7 +225,11 @@ GitLab displays a list of the environments and their deploy status, as well as options to browse to the app, view monitoring metrics, and even access a shell on the running pod. -## Additional requirements for self-managed instances **(FREE SELF)** +## Additional requirements for self-managed instances + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed If you are using a self-managed GitLab instance, you need to configure Amazon credentials. GitLab uses these credentials to assume an Amazon IAM role to create your cluster. @@ -258,7 +266,7 @@ IAM user in the Amazon AWS console, and follow these steps: #### EKS access key and ID -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/291015) instance profiles in GitLab 13.7. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/291015) instance profiles in GitLab 13.7. If you're using GitLab 13.7 or later, you can use instance profiles to dynamically retrieve temporary credentials from AWS when needed. diff --git a/doc/user/project/clusters/add_existing_cluster.md b/doc/user/project/clusters/add_existing_cluster.md index ea4c345a592..3b26635e894 100644 --- a/doc/user/project/clusters/add_existing_cluster.md +++ b/doc/user/project/clusters/add_existing_cluster.md @@ -4,9 +4,13 @@ group: Environments info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Connect existing clusters through cluster certificates (deprecated) **(FREE ALL)** +# Connect existing clusters through cluster certificates (deprecated) -> [Deprecated](https://gitlab.com/groups/gitlab-org/configure/-/epics/8) in GitLab 14.5. +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed + +> - [Deprecated](https://gitlab.com/groups/gitlab-org/configure/-/epics/8) in GitLab 14.5. WARNING: This feature was [deprecated](https://gitlab.com/groups/gitlab-org/configure/-/epics/8) in GitLab 14.5. diff --git a/doc/user/project/clusters/add_gke_clusters.md b/doc/user/project/clusters/add_gke_clusters.md index 96eff58c638..02e792bdf78 100644 --- a/doc/user/project/clusters/add_gke_clusters.md +++ b/doc/user/project/clusters/add_gke_clusters.md @@ -4,9 +4,13 @@ group: Environments info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Connect GKE clusters through cluster certificates (deprecated) **(FREE ALL)** +# Connect GKE clusters through cluster certificates (deprecated) -> [Deprecated](https://gitlab.com/groups/gitlab-org/configure/-/epics/8) in GitLab 14.5. +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed + +> - [Deprecated](https://gitlab.com/groups/gitlab-org/configure/-/epics/8) in GitLab 14.5. WARNING: This feature was [deprecated](https://gitlab.com/groups/gitlab-org/configure/-/epics/8) in GitLab 14.5. @@ -23,13 +27,13 @@ use the [GitLab agent](../../clusters/agent/index.md). ## Create a new GKE cluster from GitLab -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/25925) in GitLab 12.4, all the GKE clusters provisioned by GitLab are [VPC-native](https://cloud.google.com/kubernetes-engine/docs/how-to/alias-ips). +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/25925) in GitLab 12.4, all the GKE clusters provisioned by GitLab are [VPC-native](https://cloud.google.com/kubernetes-engine/docs/how-to/alias-ips). To create a new GKE cluster from GitLab, use [Infrastructure as Code](../../infrastructure/clusters/connect/new_gke_cluster.md). ## Create a new cluster on GKE through cluster certificates -> [Deprecated](https://gitlab.com/groups/gitlab-org/-/epics/6049) in GitLab 14.0. +> - [Deprecated](https://gitlab.com/groups/gitlab-org/-/epics/6049) in GitLab 14.0. Prerequisites: @@ -89,7 +93,7 @@ After a couple of minutes, your cluster is ready. ### Cloud Run for Anthos -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/16566) in GitLab 12.4. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/16566) in GitLab 12.4. You can choose to use Cloud Run for Anthos in place of installing Knative and Istio separately after the cluster has been created. This means that Cloud Run diff --git a/doc/user/project/clusters/add_remove_clusters.md b/doc/user/project/clusters/add_remove_clusters.md index 7d18ef0d1e4..904c68354e9 100644 --- a/doc/user/project/clusters/add_remove_clusters.md +++ b/doc/user/project/clusters/add_remove_clusters.md @@ -4,9 +4,13 @@ group: Environments info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Add a cluster using cluster certificates (deprecated) **(FREE ALL)** +# Add a cluster using cluster certificates (deprecated) -> [Deprecated](https://gitlab.com/gitlab-org/gitlab/-/issues/327908) in GitLab 14.0. +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed + +> - [Deprecated](https://gitlab.com/gitlab-org/gitlab/-/issues/327908) in GitLab 14.0. WARNING: This feature was [deprecated](https://gitlab.com/gitlab-org/gitlab/-/issues/327908) in GitLab 14.0. @@ -26,7 +30,7 @@ When you successfully connect an existing cluster using cluster certificates, th ## Remove a cluster -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/26815) in GitLab 12.6, you can remove cluster integrations and resources. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/26815) in GitLab 12.6, you can remove cluster integrations and resources. When you remove a cluster integration, you only remove the cluster relationship to GitLab, not the cluster. To remove the cluster itself, go to your cluster's @@ -47,7 +51,11 @@ To remove the Kubernetes cluster integration: 1. Select the **Advanced Settings** tab. 1. Select either **Remove integration** or **Remove integration and resources**. -### Remove clusters by using the Rails console **(FREE SELF)** +### Remove clusters by using the Rails console + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed [Start a Rails console session](../../../administration/operations/rails_console.md#starting-a-rails-console-session). diff --git a/doc/user/project/clusters/cluster_access.md b/doc/user/project/clusters/cluster_access.md index 74f3cb689ff..40961357cb7 100644 --- a/doc/user/project/clusters/cluster_access.md +++ b/doc/user/project/clusters/cluster_access.md @@ -4,7 +4,11 @@ group: Environments info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Access controls with cluster certificates (RBAC or ABAC) (deprecated) **(FREE ALL)** +# Access controls with cluster certificates (RBAC or ABAC) (deprecated) + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed > - Restricted service account for deployment was [introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/issues/51716) in GitLab 11.5. > - [Deprecated](https://gitlab.com/groups/gitlab-org/configure/-/epics/8) in GitLab 14.5. diff --git a/doc/user/project/clusters/deploy_to_cluster.md b/doc/user/project/clusters/deploy_to_cluster.md index e287a3b94bb..22dbcd36cac 100644 --- a/doc/user/project/clusters/deploy_to_cluster.md +++ b/doc/user/project/clusters/deploy_to_cluster.md @@ -4,9 +4,13 @@ group: Environments info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Deploy to a Kubernetes cluster with cluster certificates (deprecated) **(FREE ALL)** +# Deploy to a Kubernetes cluster with cluster certificates (deprecated) -> [Deprecated](https://gitlab.com/groups/gitlab-org/configure/-/epics/8) in GitLab 14.5. +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed + +> - [Deprecated](https://gitlab.com/groups/gitlab-org/configure/-/epics/8) in GitLab 14.5. WARNING: This feature was [deprecated](https://gitlab.com/groups/gitlab-org/configure/-/epics/8) in GitLab 14.5. @@ -99,8 +103,6 @@ combined with *one* of the following: ## Web terminals for Kubernetes clusters -> Introduced in GitLab 8.15. - The Kubernetes integration adds [web terminal](../../../ci/environments/index.md#web-terminals-deprecated) support to your [environments](../../../ci/environments/index.md). This is based on the `exec` functionality found in Docker and Kubernetes, so you get a new diff --git a/doc/user/project/clusters/gitlab_managed_clusters.md b/doc/user/project/clusters/gitlab_managed_clusters.md index cb053c8ede8..064405459db 100644 --- a/doc/user/project/clusters/gitlab_managed_clusters.md +++ b/doc/user/project/clusters/gitlab_managed_clusters.md @@ -4,7 +4,11 @@ group: Environments info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# GitLab-managed clusters (deprecated) **(FREE ALL)** +# GitLab-managed clusters (deprecated) + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed > - [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/22011) in GitLab 11.5. > - Became [optional](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/26565) in GitLab 11.11. @@ -36,7 +40,7 @@ namespaces and service accounts, can cause unexpected errors. If this occurs, tr ## Clearing the cluster cache -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/31759) in GitLab 12.6. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/31759) in GitLab 12.6. If you allow GitLab to manage your cluster, GitLab stores a cached version of the namespaces and service accounts it creates for your projects. If you @@ -51,7 +55,7 @@ To clear the cache: ## Base domain -> [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/24580) in GitLab 11.8. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/24580) in GitLab 11.8. Specifying a base domain automatically sets `KUBE_INGRESS_BASE_DOMAIN` as an deployment variable. If you are using [Auto DevOps](../../../topics/autodevops/index.md), this domain is used for the different diff --git a/doc/user/project/clusters/index.md b/doc/user/project/clusters/index.md index 1b6fab8fa34..2842feba195 100644 --- a/doc/user/project/clusters/index.md +++ b/doc/user/project/clusters/index.md @@ -4,7 +4,11 @@ group: Environments info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Project-level Kubernetes clusters (certificate-based) (deprecated) **(FREE ALL)** +# Project-level Kubernetes clusters (certificate-based) (deprecated) + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed > - [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/issues/35954) in GitLab 10.1. > - [Deprecated](https://gitlab.com/groups/gitlab-org/configure/-/epics/8) in GitLab 14.5. diff --git a/doc/user/project/clusters/multiple_kubernetes_clusters.md b/doc/user/project/clusters/multiple_kubernetes_clusters.md index 9e96438393e..084ed06132d 100644 --- a/doc/user/project/clusters/multiple_kubernetes_clusters.md +++ b/doc/user/project/clusters/multiple_kubernetes_clusters.md @@ -4,7 +4,11 @@ group: Environments info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Multiple clusters per project with cluster certificates (deprecated) **(FREE ALL)** +# Multiple clusters per project with cluster certificates (deprecated) + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed > - Introduced in GitLab 10.3 > - [Moved](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/35094) from GitLab Premium to GitLab Free in 13.2. diff --git a/doc/user/project/clusters/runbooks/index.md b/doc/user/project/clusters/runbooks/index.md index 7af3068c691..70c6a45495a 100644 --- a/doc/user/project/clusters/runbooks/index.md +++ b/doc/user/project/clusters/runbooks/index.md @@ -4,7 +4,11 @@ group: Environments info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Runbooks **(FREE ALL)** +# Runbooks + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed Runbooks are a collection of documented procedures that explain how to carry out a particular process, be it starting, stopping, debugging, @@ -23,7 +27,7 @@ pre-written code blocks or database queries against a given environment. ## Executable Runbooks -> [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/issues/45912) in GitLab 11.4. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/issues/45912) in GitLab 11.4. The JupyterHub app offered via the GitLab Kubernetes integration now ships with Nurtch's Rubix library, providing a simple way to create DevOps diff --git a/doc/user/project/code_intelligence.md b/doc/user/project/code_intelligence.md index a7f1aff9b02..9032356c722 100644 --- a/doc/user/project/code_intelligence.md +++ b/doc/user/project/code_intelligence.md @@ -4,9 +4,13 @@ group: Code Review info: "To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments" --- -# Code Intelligence **(FREE ALL)** +# Code Intelligence -> [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/1576) in GitLab 13.1. +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed + +> - [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/1576) in GitLab 13.1. Code Intelligence adds code navigation features common to interactive development environments (IDE), including: diff --git a/doc/user/project/codeowners/index.md b/doc/user/project/codeowners/index.md index 292be3848c1..869ba89eeab 100644 --- a/doc/user/project/codeowners/index.md +++ b/doc/user/project/codeowners/index.md @@ -4,7 +4,11 @@ group: Source Code info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Code Owners **(PREMIUM ALL)** +# Code Owners + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed Use the Code Owners feature to define who has expertise for specific parts of your project's codebase. Define the owners of files and directories in a repository to: @@ -353,7 +357,7 @@ section is marked as optional. ### Require multiple approvals from Code Owners -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/335451) in GitLab 15.9. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/335451) in GitLab 15.9. You can require multiple approvals for the Code Owners sections in the Approvals area in merge requests. Append the section name with a number `n` in brackets, for example, `[2]` or `[3]`. diff --git a/doc/user/project/codeowners/reference.md b/doc/user/project/codeowners/reference.md index 558ee8c3a7e..fa675ef713b 100644 --- a/doc/user/project/codeowners/reference.md +++ b/doc/user/project/codeowners/reference.md @@ -4,7 +4,11 @@ group: Source Code info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Code Owners syntax and error handling **(PREMIUM ALL)** +# Code Owners syntax and error handling + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed This page describes the syntax and error handling used in Code Owners files, and provides an example file. @@ -210,7 +214,7 @@ Users can be owners of an entry. Each entry can be owned by ## Error handling in Code Owners -> Error validation [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/216066) in GitLab 16.3. +> - Error validation [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/216066) in GitLab 16.3. ### Entries with spaces diff --git a/doc/user/project/deploy_boards.md b/doc/user/project/deploy_boards.md index e1f6bcbf5cc..5476f5dd0fe 100644 --- a/doc/user/project/deploy_boards.md +++ b/doc/user/project/deploy_boards.md @@ -4,7 +4,11 @@ group: Environments info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Deploy boards (deprecated) **(FREE ALL)** +# Deploy boards (deprecated) + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/1589) in GitLab 9.0. > - [Moved](https://gitlab.com/gitlab-org/gitlab/-/issues/212320) from GitLab Premium to GitLab Free in 13.8. diff --git a/doc/user/project/deploy_keys/index.md b/doc/user/project/deploy_keys/index.md index 6c2d4763526..8762c55bf50 100644 --- a/doc/user/project/deploy_keys/index.md +++ b/doc/user/project/deploy_keys/index.md @@ -4,7 +4,11 @@ group: Environments info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Deploy keys **(FREE ALL)** +# Deploy keys + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed Use deploy keys to access repositories that are hosted in GitLab. In most cases, you use deploy keys to access a repository from an external host, like a build server or Continuous Integration (CI) server. @@ -101,7 +105,11 @@ Prerequisites: A project deploy key is enabled when it is created. You can modify only a project deploy key's name and permissions. -## Create a public deploy key **(FREE SELF)** +## Create a public deploy key + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed Prerequisites: diff --git a/doc/user/project/deploy_tokens/index.md b/doc/user/project/deploy_tokens/index.md index c53b557a9e0..c36b35d5faf 100644 --- a/doc/user/project/deploy_tokens/index.md +++ b/doc/user/project/deploy_tokens/index.md @@ -4,7 +4,11 @@ group: Environments info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Deploy tokens **(FREE ALL)** +# Deploy tokens + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed You can use a deploy token to enable authentication of deployment tasks, independent of a user account. In most cases you use a deploy token from an external host, like a build server or CI/CD @@ -163,7 +167,7 @@ docker push $CONTAINER_TEST_IMAGE ## Pull packages from a package registry -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/213566) in GitLab 13.0. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/213566) in GitLab 13.0. You can use a deploy token to pull packages from a package registry. @@ -183,7 +187,7 @@ nuget install mypkg.nupkg ## Push packages to a package registry -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/213566) in GitLab 13.0. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/213566) in GitLab 13.0. You can use a deploy token to push packages to a GitLab package registry. @@ -203,7 +207,7 @@ nuget push mypkg.nupkg -Source GitLab ## Pull images from the dependency proxy -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/280586) in GitLab 14.2. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/280586) in GitLab 14.2. You can use a deploy token to pull images from the dependency proxy. diff --git a/doc/user/project/description_templates.md b/doc/user/project/description_templates.md index db98688497a..bb06d092d10 100644 --- a/doc/user/project/description_templates.md +++ b/doc/user/project/description_templates.md @@ -4,7 +4,11 @@ group: Project Management info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Description templates **(FREE ALL)** +# Description templates + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed You can define templates to use as descriptions for your [issues](issues/index.md) and [merge requests](merge_requests/index.md). @@ -86,7 +90,7 @@ For example: `https://gitlab.com/gitlab-org/gitlab/-/issues/new?issuable_templat ### Supported variables in merge request templates -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/89810) in GitLab 15.7. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/89810) in GitLab 15.7. NOTE: This feature is available only for @@ -104,7 +108,11 @@ your merge request template with their values: | `%{source_branch}` | The name of the branch being merged. | `my-feature-branch` | | `%{target_branch}` | The name of the branch that the changes are applied to. | `main` | -### Set instance-level description templates **(PREMIUM SELF)** +### Set instance-level description templates + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** Self-managed You can set a description template at the **instance level** for issues and merge requests by using an [instance template repository](../../administration/settings/instance_template_repository.md). @@ -113,7 +121,11 @@ You can also use the instance template repository for file templates. You might also be interested in [project templates](../../administration/custom_project_templates.md) that you can use when creating a new project in the instance. -### Set group-level description templates **(PREMIUM ALL)** +### Set group-level description templates + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/52360) in GitLab 13.9. > - [Feature flag removed](https://gitlab.com/gitlab-org/gitlab/-/issues/321247) in GitLab 14.0. @@ -142,7 +154,7 @@ You might also be interested in templates for various ### Set a default template for merge requests and issues -> `Default.md` (case insensitive) template [introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/78302) in GitLab 14.8. +> - `Default.md` (case insensitive) template [introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/78302) in GitLab 14.8. In a project, you can choose a default description template for new issues and merge requests. As a result, every time a new merge request or issue is created, it's pre-filled with the text you diff --git a/doc/user/project/file_lock.md b/doc/user/project/file_lock.md index 48a09d99c21..f6da32c576b 100644 --- a/doc/user/project/file_lock.md +++ b/doc/user/project/file_lock.md @@ -4,7 +4,11 @@ group: Source Code info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# File Locking **(FREE ALL)** +# File Locking + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed Preventing wasted work caused by unresolvable merge conflicts requires a different way of working. This means explicitly requesting write permissions, @@ -190,9 +194,13 @@ Suggested workflow for shared projects: 1. Get your changes reviewed, approved, and merged. 1. Unlock the file. -## Default branch file and directory locks **(PREMIUM ALL)** +## Default branch file and directory locks -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/440) in GitLab 8.9. +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/440) in GitLab 8.9. This process allows you to lock one file at a time through the GitLab UI and requires access to the [GitLab Premium or Ultimate tier](https://about.gitlab.com/pricing/). diff --git a/doc/user/project/git_attributes.md b/doc/user/project/git_attributes.md index 61e73fcce81..c013d6ba794 100644 --- a/doc/user/project/git_attributes.md +++ b/doc/user/project/git_attributes.md @@ -4,7 +4,11 @@ group: Source Code info: "To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments" --- -# Git attributes **(FREE ALL)** +# Git attributes + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed GitLab supports defining custom [Git attributes](https://git-scm.com/docs/gitattributes) such as what files to treat as binary, and what language to use for syntax highlighting @@ -52,9 +56,13 @@ The `.gitattributes` file can be used to define which language to use when syntax highlighting files and diffs. For more information, see [Syntax highlighting](highlighting.md). -## Custom merge drivers **(FREE SELF)** +## Custom merge drivers -> Ability to configure custom merge drivers through GitLab introduced in GitLab 15.10. +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed + +> - Ability to configure custom merge drivers through GitLab introduced in GitLab 15.10. GitLab self-managed instance administrators can define [custom merge drivers](https://git-scm.com/docs/gitattributes#_defining_a_custom_merge_driver) in a GitLab configuration file, then use the custom merge drivers in a Git `.gitattributes` file. Custom merge drivers are not supported on GitLab.com. diff --git a/doc/user/project/highlighting.md b/doc/user/project/highlighting.md index 54f529302ae..b0ea7989fc8 100644 --- a/doc/user/project/highlighting.md +++ b/doc/user/project/highlighting.md @@ -4,7 +4,11 @@ group: Source Code info: "To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments" --- -# Syntax Highlighting **(FREE ALL)** +# Syntax Highlighting + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed GitLab provides syntax highlighting on all files through [Highlight.js](https://github.com/highlightjs/highlight.js/) and the [Rouge](https://rubygems.org/gems/rouge) Ruby gem. It attempts to guess what language diff --git a/doc/user/project/import/bitbucket.md b/doc/user/project/import/bitbucket.md index 92c14347a15..89912073593 100644 --- a/doc/user/project/import/bitbucket.md +++ b/doc/user/project/import/bitbucket.md @@ -4,7 +4,11 @@ group: Import and Integrate info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Import your project from Bitbucket Cloud **(FREE ALL)** +# Import your project from Bitbucket Cloud + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed > - Parallel imports from Bitbucket Cloud [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/412614) in GitLab 16.6 [with a flag](../../../administration/feature_flags.md) named `bitbucket_parallel_importer`. Disabled by default. > - [Enabled on GitLab.com](https://gitlab.com/gitlab-org/gitlab/-/issues/423530) in GitLab 16.6. @@ -61,7 +65,7 @@ namespace that started the import process. ## Prerequisites -> Requirement for Maintainer role instead of Developer role introduced in GitLab 16.0 and backported to GitLab 15.11.1 and GitLab 15.10.5. +> - Requirement for Maintainer role instead of Developer role introduced in GitLab 16.0 and backported to GitLab 15.11.1 and GitLab 15.10.5. - [Bitbucket Cloud integration](../../../integration/bitbucket.md) must be enabled. If that integration is not enabled, ask your GitLab administrator to enable it. The Bitbucket Cloud integration is enabled by default on GitLab.com. @@ -86,7 +90,7 @@ For user contributions to be mapped, each user must complete the following befor ## Import your Bitbucket repositories -> Ability to re-import projects [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/23905) in GitLab 15.9. +> - Ability to re-import projects [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/23905) in GitLab 15.9. 1. Sign in to GitLab. 1. On the left sidebar, at the top, select **Create new** (**{plus}**) and **New project/repository**. diff --git a/doc/user/project/import/bitbucket_server.md b/doc/user/project/import/bitbucket_server.md index 94b0285c548..beea10bc05c 100644 --- a/doc/user/project/import/bitbucket_server.md +++ b/doc/user/project/import/bitbucket_server.md @@ -4,7 +4,11 @@ group: Import and Integrate info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Import your project from Bitbucket Server **(FREE ALL)** +# Import your project from Bitbucket Server + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed > - Ability to re-import projects [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/23905) in GitLab 15.9. > - Ability to import reviewers [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/416611) in GitLab 16.3. @@ -17,7 +21,7 @@ This process is different than [importing from Bitbucket Cloud](bitbucket.md). ## Prerequisites -> Requirement for Maintainer role instead of Developer role introduced in GitLab 16.0 and backported to GitLab 15.11.1 and GitLab 15.10.5. +> - Requirement for Maintainer role instead of Developer role introduced in GitLab 16.0 and backported to GitLab 15.11.1 and GitLab 15.10.5. - [Bitbucket Server import source](../../../administration/settings/import_and_export_settings.md#configure-allowed-import-sources) must be enabled. If not enabled, ask your GitLab administrator to enable it. The Bitbucket Server import source is enabled diff --git a/doc/user/project/import/clearcase.md b/doc/user/project/import/clearcase.md index 13d068a8262..0d69adfef80 100644 --- a/doc/user/project/import/clearcase.md +++ b/doc/user/project/import/clearcase.md @@ -4,7 +4,11 @@ group: Import and Integrate info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Migrating from ClearCase **(FREE ALL)** +# Migrating from ClearCase + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed [ClearCase](https://www.ibm.com/products/rational-clearcase) is a set of tools developed by IBM which also include a centralized version control system diff --git a/doc/user/project/import/cvs.md b/doc/user/project/import/cvs.md index b7f2c0229dc..5f986edbfd7 100644 --- a/doc/user/project/import/cvs.md +++ b/doc/user/project/import/cvs.md @@ -4,7 +4,11 @@ group: Import and Integrate info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Migrating from CVS **(FREE ALL)** +# Migrating from CVS + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed [CVS](https://savannah.nongnu.org/projects/cvs) is an old centralized version control system similar to [SVN](https://subversion.apache.org/). diff --git a/doc/user/project/import/fogbugz.md b/doc/user/project/import/fogbugz.md index 1e1b86224d5..f996439f1a2 100644 --- a/doc/user/project/import/fogbugz.md +++ b/doc/user/project/import/fogbugz.md @@ -4,9 +4,13 @@ group: Import and Integrate info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Import your project from FogBugz to GitLab **(FREE ALL)** +# Import your project from FogBugz to GitLab -> Ability to re-import projects [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/23905) in GitLab 15.9. +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed + +> - Ability to re-import projects [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/23905) in GitLab 15.9. Using the importer, you can import your FogBugz project to GitLab.com or to your self-managed GitLab instance. @@ -17,7 +21,7 @@ users. ## Prerequisites -> Requirement for Maintainer role instead of Developer role introduced in GitLab 16.0 and backported to GitLab 15.11.1 and GitLab 15.10.5. +> - Requirement for Maintainer role instead of Developer role introduced in GitLab 16.0 and backported to GitLab 15.11.1 and GitLab 15.10.5. - [FogBugz import source](../../../administration/settings/import_and_export_settings.md#configure-allowed-import-sources) must be enabled. If not enabled, ask your GitLab administrator to enable it. The FogBugz import source is enabled diff --git a/doc/user/project/import/gitea.md b/doc/user/project/import/gitea.md index b67f2c1bdc0..a83512f9d7a 100644 --- a/doc/user/project/import/gitea.md +++ b/doc/user/project/import/gitea.md @@ -4,9 +4,13 @@ group: Import and Integrate info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Import your project from Gitea to GitLab **(FREE ALL)** +# Import your project from Gitea to GitLab -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/381902) in GitLab 15.8, GitLab no longer automatically creates namespaces or groups that don't exist. GitLab also no longer falls back to using the user's personal namespace if the namespace or group name is taken. +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/381902) in GitLab 15.8, GitLab no longer automatically creates namespaces or groups that don't exist. GitLab also no longer falls back to using the user's personal namespace if the namespace or group name is taken. Import your projects from Gitea to GitLab. @@ -29,7 +33,7 @@ on the issue about the original Gitea author. ## Prerequisites -> Requirement for Maintainer role instead of Developer role introduced in GitLab 16.0 and backported to GitLab 15.11.1 and GitLab 15.10.5. +> - Requirement for Maintainer role instead of Developer role introduced in GitLab 16.0 and backported to GitLab 15.11.1 and GitLab 15.10.5. - Gitea version 1.0.0 or later. - [Gitea import source](../../../administration/settings/import_and_export_settings.md#configure-allowed-import-sources) diff --git a/doc/user/project/import/github.md b/doc/user/project/import/github.md index 1aeece2de4d..dc60ff330f3 100644 --- a/doc/user/project/import/github.md +++ b/doc/user/project/import/github.md @@ -4,7 +4,11 @@ group: Import and Integrate info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Import your project from GitHub to GitLab **(FREE ALL)** +# Import your project from GitHub to GitLab + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/381902) in GitLab 15.8, GitLab no longer automatically creates namespaces or groups that don't exist. GitLab also no longer falls back to using the user's personal namespace if the namespace or group name is taken. > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/388716) in GitLab 15.10, you no longer need to add any users to the parent group in GitLab to successfully import the **Require a pull request before merging - Allow specified actors to bypass required pull requests** branch protection rule. @@ -37,7 +41,7 @@ For an overview of the import process, see [How to migrate from GitHub to GitLab ## Prerequisites -> Requirement for Maintainer role instead of Developer role introduced in GitLab 16.0 and backported to GitLab 15.11.1 and GitLab 15.10.5. +> - Requirement for Maintainer role instead of Developer role introduced in GitLab 16.0 and backported to GitLab 15.11.1 and GitLab 15.10.5. To import projects from GitHub: @@ -121,7 +125,7 @@ You can also import a repository from GitHub using the ### Filter repositories list -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/385113) in GitLab 16.0. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/385113) in GitLab 16.0. After you authorize access to your GitHub repositories, GitLab redirects you to the importer page and your GitHub repositories are listed. @@ -185,7 +189,7 @@ Completed imports can be re-imported by selecting **Re-import** and specifying n ### Check status of imports -> Details of partially completed imports with a list of entities that failed to import [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/386748) in GitLab 16.1. +> - Details of partially completed imports with a list of entities that failed to import [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/386748) in GitLab 16.1. After imports are completed, they can be in one of three states: @@ -195,7 +199,11 @@ After imports are completed, they can be in one of three states: Expand **Details** to see a list of [repository entities](#imported-data) that failed to import. -## Mirror a repository and share pipeline status **(PREMIUM ALL)** +## Mirror a repository and share pipeline status + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed Depending on your GitLab tier, [repository mirroring](../repository/mirror/index.md) can be set up to keep your imported repository in sync with its GitHub copy. @@ -307,14 +315,14 @@ When they are imported, supported GitHub branch protection rules are mapped to e - GitLab branch protection rules. - Project-wide GitLab settings. -| GitHub rule | GitLab rule | Introduced in | -| :---------------------------------------------------------------------------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------- | :------------------------------------------------------------------ | -| **Require conversation resolution before merging** for the project's default branch | **All threads must be resolved** [project setting](../merge_requests/index.md#prevent-merge-unless-all-threads-are-resolved) | [GitLab 15.5](https://gitlab.com/gitlab-org/gitlab/-/issues/371110) | -| **Require a pull request before merging** | **No one** option in the **Allowed to push and merge** list of [branch protection settings](../protected_branches.md#add-protection-to-existing-branches) | [GitLab 15.5](https://gitlab.com/gitlab-org/gitlab/-/issues/370951) | -| **Require signed commits** for the project's default branch | **Reject unsigned commits** GitLab [push rule](../repository/push_rules.md#prevent-unintended-consequences) **(PREMIUM ALL)** | [GitLab 15.5](https://gitlab.com/gitlab-org/gitlab/-/issues/370949) | -| **Allow force pushes - Everyone** | **Allowed to force push** [branch protection setting](../protected_branches.md#allow-force-push-on-a-protected-branch) | [GitLab 15.6](https://gitlab.com/gitlab-org/gitlab/-/issues/370943) | -| **Require a pull request before merging - Require review from Code Owners** | **Require approval from code owners** [branch protection setting](../protected_branches.md#require-code-owner-approval-on-a-protected-branch) **(PREMIUM ALL)** | [GitLab 15.6](https://gitlab.com/gitlab-org/gitlab/-/issues/376683) | -| **Require a pull request before merging - Allow specified actors to bypass required pull requests** | List of users in the **Allowed to push and merge** list of [branch protection settings](../protected_branches.md#add-protection-to-existing-branches) **(PREMIUM ALL)**. Without a **Premium** subscription, the list of users that are allowed to push and merge is limited to roles. | [GitLab 15.8](https://gitlab.com/gitlab-org/gitlab/-/issues/384939) | +| GitHub rule | GitLab rule | Introduced in | +|:----------------------------------------------------------------------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:--------------| +| **Require conversation resolution before merging** for the project's default branch | **All threads must be resolved** [project setting](../merge_requests/index.md#prevent-merge-unless-all-threads-are-resolved) | [GitLab 15.5](https://gitlab.com/gitlab-org/gitlab/-/issues/371110) | +| **Require a pull request before merging** | **No one** option in the **Allowed to push and merge** list of [branch protection settings](../protected_branches.md#add-protection-to-existing-branches) | [GitLab 15.5](https://gitlab.com/gitlab-org/gitlab/-/issues/370951) | +| **Require signed commits** for the project's default branch | **Reject unsigned commits** GitLab [push rule](../repository/push_rules.md#prevent-unintended-consequences) | [GitLab 15.5](https://gitlab.com/gitlab-org/gitlab/-/issues/370949) | +| **Allow force pushes - Everyone** | **Allowed to force push** [branch protection setting](../protected_branches.md#allow-force-push-on-a-protected-branch) | [GitLab 15.6](https://gitlab.com/gitlab-org/gitlab/-/issues/370943) | +| **Require a pull request before merging - Require review from Code Owners** | **Require approval from code owners** [branch protection setting](../protected_branches.md#require-code-owner-approval-on-a-protected-branch) | [GitLab 15.6](https://gitlab.com/gitlab-org/gitlab/-/issues/376683) | +| **Require a pull request before merging - Allow specified actors to bypass required pull requests** | List of users in the **Allowed to push and merge** list of [branch protection settings](../protected_branches.md#add-protection-to-existing-branches). Without a **Premium** subscription, the list of users that are allowed to push and merge is limited to roles. | [GitLab 15.8](https://gitlab.com/gitlab-org/gitlab/-/issues/384939) | Mapping GitHub rule **Require status checks to pass before merging** to [external status checks](../merge_requests/status_checks.md) was considered in issue @@ -324,7 +332,7 @@ manually. ### Collaborators (members) -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/388716) in GitLab 15.10. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/388716) in GitLab 15.10. These GitHub collaborator roles are mapped to these GitLab [member roles](../../permissions.md#roles): diff --git a/doc/user/project/import/gitlab_com.md b/doc/user/project/import/gitlab_com.md index 32d5eef0d60..d37b004d3c5 100644 --- a/doc/user/project/import/gitlab_com.md +++ b/doc/user/project/import/gitlab_com.md @@ -4,7 +4,11 @@ group: Import and Integrate info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Import a project from GitLab.com to your self-managed GitLab instance (removed) **(FREE ALL)** +# Import a project from GitLab.com to your self-managed GitLab instance (removed) + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed WARNING: The GitLab.com importer was [deprecated](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/108502) in GitLab 15.8 diff --git a/doc/user/project/import/index.md b/doc/user/project/import/index.md index cebf5a93f81..a4a8e47c383 100644 --- a/doc/user/project/import/index.md +++ b/doc/user/project/import/index.md @@ -4,7 +4,11 @@ group: Import and Integrate info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Import and migrate groups and projects **(FREE ALL)** +# Import and migrate groups and projects + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed To bring existing projects to GitLab, or copy GitLab groups and projects to a different location, you can: @@ -23,7 +27,7 @@ You can also copy GitLab projects by using a GitLab file export, which is a supp ## Supported import sources -> All importers default to disabled for GitLab self-managed installations. This change was [introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/118970) in GitLab 16.0. +> - All importers default to disabled for GitLab self-managed installations. This change was [introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/118970) in GitLab 16.0. The import sources that are available to you by default depend on which GitLab you use: diff --git a/doc/user/project/import/jira.md b/doc/user/project/import/jira.md index 17ba5e5fb91..8111d7109e1 100644 --- a/doc/user/project/import/jira.md +++ b/doc/user/project/import/jira.md @@ -4,7 +4,11 @@ group: Project Management info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Import your Jira project issues to GitLab **(FREE ALL)** +# Import your Jira project issues to GitLab + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed Using GitLab Jira importer, you can import your Jira issues to GitLab.com or to your self-managed GitLab instance. diff --git a/doc/user/project/import/manifest.md b/doc/user/project/import/manifest.md index 07328c7a672..b1e936fafab 100644 --- a/doc/user/project/import/manifest.md +++ b/doc/user/project/import/manifest.md @@ -4,7 +4,11 @@ group: Import and Integrate info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Import multiple repositories by uploading a manifest file **(FREE ALL)** +# Import multiple repositories by uploading a manifest file + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed > - [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/issues/28811) in GitLab 11.2. > - Ability to re-import projects [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/23905) in GitLab 15.9. @@ -17,7 +21,7 @@ repositories like the Android Open Source Project (AOSP). ## Prerequisites -> Requirement for Maintainer role instead of Developer role introduced in GitLab 16.0 and backported to GitLab 15.11.1 and GitLab 15.10.5. +> - Requirement for Maintainer role instead of Developer role introduced in GitLab 16.0 and backported to GitLab 15.11.1 and GitLab 15.10.5. - [Manifest import source](../../../administration/settings/import_and_export_settings.md#configure-allowed-import-sources) must be enabled. If not enabled, ask your GitLab administrator to enable it. The Manifest import source is enabled diff --git a/doc/user/project/import/perforce.md b/doc/user/project/import/perforce.md index 1646c2c5578..e86b0eaffbd 100644 --- a/doc/user/project/import/perforce.md +++ b/doc/user/project/import/perforce.md @@ -4,7 +4,11 @@ group: Import and Integrate info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Migrating from Perforce Helix **(FREE ALL)** +# Migrating from Perforce Helix + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed [Perforce Helix](https://www.perforce.com/) provides a set of tools which also include a centralized, proprietary version control system similar to Git. diff --git a/doc/user/project/import/repo_by_url.md b/doc/user/project/import/repo_by_url.md index 92f1a5cbbe7..7d64105f880 100644 --- a/doc/user/project/import/repo_by_url.md +++ b/doc/user/project/import/repo_by_url.md @@ -4,7 +4,11 @@ group: Import and Integrate info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Import project from repository by URL **(FREE ALL)** +# Import project from repository by URL + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed You can import your existing repositories by providing the Git URL. You can't import GitLab issues and merge requests this way. Other methods provide more complete import methods. @@ -13,7 +17,7 @@ If the repository is too large, the import can timeout. ## Prerequisites -> Requirement for Maintainer role instead of Developer role introduced in GitLab 16.0 and backported to GitLab 15.11.1 and GitLab 15.10.5. +> - Requirement for Maintainer role instead of Developer role introduced in GitLab 16.0 and backported to GitLab 15.11.1 and GitLab 15.10.5. - [Repository by URL import source](../../../administration/settings/import_and_export_settings.md#configure-allowed-import-sources) must be enabled. If not enabled, ask your GitLab administrator to enable it. The Repository by URL import source is enabled diff --git a/doc/user/project/import/tfvc.md b/doc/user/project/import/tfvc.md index 7617dfae525..e74a9ca8f62 100644 --- a/doc/user/project/import/tfvc.md +++ b/doc/user/project/import/tfvc.md @@ -4,7 +4,11 @@ group: Import and Integrate info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Migrate from TFVC to Git **(FREE ALL)** +# Migrate from TFVC to Git + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed Team Foundation Server (TFS), renamed [Azure DevOps Server](https://azure.microsoft.com/en-us/products/devops/server/) in 2019, is a set of tools developed by Microsoft which also includes diff --git a/doc/user/project/index.md b/doc/user/project/index.md index 7a70d5dde63..609b0233955 100644 --- a/doc/user/project/index.md +++ b/doc/user/project/index.md @@ -4,7 +4,11 @@ group: Tenant Scale info: "To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments" --- -# Create a project **(FREE ALL)** +# Create a project + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed You can create a project in many ways in GitLab. @@ -62,9 +66,13 @@ A user who creates a project [from a template](#create-a-project-from-a-built-in Imported objects are labeled as `By on (imported from GitLab)`. For this reason, the creation date of imported objects can be older than the creation date of the user's account. This can lead to objects appearing to have been created by a user before they even had an account. -## Create a project from a custom template **(PREMIUM ALL)** +## Create a project from a custom template -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/6860) in GitLab 11.2. +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/6860) in GitLab 11.2. Custom project templates are available at: @@ -87,9 +95,13 @@ Custom project templates are available at: change the **Visibility Level**. 1. Select **Create project**. -## Create a project from the HIPAA Audit Protocol template **(ULTIMATE ALL)** +## Create a project from the HIPAA Audit Protocol template -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/13756) in GitLab 12.10 +DETAILS: +**Tier:** Ultimate +**Offering:** SaaS, Self-managed + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/13756) in GitLab 12.10 The HIPAA Audit Protocol template contains issues for audit inquiries in the HIPAA Audit Protocol published by the U.S Department of Health and Human Services. @@ -114,7 +126,7 @@ To create a project from the HIPAA Audit Protocol template: ## Create a new project with Git push -> [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/issues/26388) in GitLab 10.5. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/issues/26388) in GitLab 10.5. Use `git push` to push a local project repository to GitLab. After you push a repository, GitLab creates your project in your chosen namespace. diff --git a/doc/user/project/insights/index.md b/doc/user/project/insights/index.md index cc81e296e46..e635b0d86f8 100644 --- a/doc/user/project/insights/index.md +++ b/doc/user/project/insights/index.md @@ -4,9 +4,13 @@ group: Optimize info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Insights **(ULTIMATE ALL)** +# Insights -> [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/725) in GitLab 12.0. +DETAILS: +**Tier:** Ultimate +**Offering:** SaaS, Self-managed + +> - [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/725) in GitLab 12.0. Configure insights for your projects and groups to explore data such as: @@ -66,7 +70,7 @@ To exclude a dimension, from the legend below the chart, select the name of the ### Drill down on charts -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/372215/) in GitLab 16.7. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/372215/) in GitLab 16.7. You can drill down into the data of the **Bugs created per month by priority** and **Bugs created per month by severity** charts from the [default configuration file](https://gitlab.com/gitlab-org/gitlab/-/blob/master/ee/fixtures/insights/default.yml). @@ -249,7 +253,7 @@ monthlyBugsCreated: #### `query.data_source` -> [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/725) in GitLab 15.3. +> - [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/725) in GitLab 15.3. Use `data_source` to define the data source that exposes the data. @@ -382,7 +386,7 @@ you may see `created_at` in place of `merged_at`. `created_at` is used instead. #### `DORA` query parameters -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/367248) in GitLab 15.3. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/367248) in GitLab 15.3. Use DORA-specific queries with the `dora` data source to create a DORA chart definition. diff --git a/doc/user/project/integrations/apple_app_store.md b/doc/user/project/integrations/apple_app_store.md index 18022fbaeb8..9e8f6ca375f 100644 --- a/doc/user/project/integrations/apple_app_store.md +++ b/doc/user/project/integrations/apple_app_store.md @@ -4,7 +4,11 @@ group: Import and Integrate info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Apple App Store Connect **(FREE ALL)** +# Apple App Store Connect + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/104888) in GitLab 15.8 [with a flag](../../../administration/feature_flags.md) named `apple_app_store_integration`. Disabled by default. > - [Generally available](https://gitlab.com/gitlab-org/gitlab/-/issues/385335) in GitLab 15.10. Feature flag `apple_app_store_integration` removed. diff --git a/doc/user/project/integrations/asana.md b/doc/user/project/integrations/asana.md index 1ce01973b2f..31569f4340e 100644 --- a/doc/user/project/integrations/asana.md +++ b/doc/user/project/integrations/asana.md @@ -4,7 +4,11 @@ group: Import and Integrate info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Asana **(FREE ALL)** +# Asana + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed The Asana integration adds commit messages as comments to Asana tasks. Once enabled, commit messages are checked for Asana task URLs (for example, diff --git a/doc/user/project/integrations/aws_codepipeline.md b/doc/user/project/integrations/aws_codepipeline.md index ec398918fde..8163452814b 100644 --- a/doc/user/project/integrations/aws_codepipeline.md +++ b/doc/user/project/integrations/aws_codepipeline.md @@ -4,9 +4,13 @@ group: unassigned info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# AWS CodePipeline **(FREE SAAS)** +# AWS CodePipeline -> [Introduced](https://gitlab.com/gitlab-com/alliances/aws/wip/aws-cs-collab/aws-gitlab-collaboration/-/issues/25) in GitLab 16.5. +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS + +> - [Introduced](https://gitlab.com/gitlab-com/alliances/aws/wip/aws-cs-collab/aws-gitlab-collaboration/-/issues/25) in GitLab 16.5. You can use your GitLab project to build, test, and deploy code changes using [AWS CodePipeline](https://aws.amazon.com/codepipeline/). To do so, you use: diff --git a/doc/user/project/integrations/bamboo.md b/doc/user/project/integrations/bamboo.md index f2b8c9efc1c..388ff4a462b 100644 --- a/doc/user/project/integrations/bamboo.md +++ b/doc/user/project/integrations/bamboo.md @@ -4,7 +4,11 @@ group: Import and Integrate info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Atlassian Bamboo **(FREE ALL)** +# Atlassian Bamboo + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed You can automatically trigger builds in Atlassian Bamboo when you push changes to your project in GitLab. diff --git a/doc/user/project/integrations/beyond_identity.md b/doc/user/project/integrations/beyond_identity.md index 9f955ea3811..cdf0cf9d1c8 100644 --- a/doc/user/project/integrations/beyond_identity.md +++ b/doc/user/project/integrations/beyond_identity.md @@ -4,9 +4,13 @@ group: Source Code info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Beyond Identity **(FREE ALL)** +# Beyond Identity -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/431433) in GitLab 16.9. +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/431433) in GitLab 16.9. Configure GitLab to verify GPG keys issued by [Beyond Identity](https://www.beyondidentity.com/) added to a user profile. diff --git a/doc/user/project/integrations/bugzilla.md b/doc/user/project/integrations/bugzilla.md index d9971f9a5fa..53d5280ecb5 100644 --- a/doc/user/project/integrations/bugzilla.md +++ b/doc/user/project/integrations/bugzilla.md @@ -4,7 +4,11 @@ group: Import and Integrate info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Bugzilla **(FREE ALL)** +# Bugzilla + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed [Bugzilla](https://www.bugzilla.org/) is a web-based general-purpose bug tracking system and testing tool. diff --git a/doc/user/project/integrations/clickup.md b/doc/user/project/integrations/clickup.md index 53db9f22c54..f9caf5d8596 100644 --- a/doc/user/project/integrations/clickup.md +++ b/doc/user/project/integrations/clickup.md @@ -4,9 +4,13 @@ group: Import and Integrate info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# ClickUp **(FREE ALL)** +# ClickUp -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/120732) in GitLab 16.1. +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/120732) in GitLab 16.1. You can use [ClickUp](https://clickup.com/) as an external issue tracker. To enable the ClickUp integration in a project: diff --git a/doc/user/project/integrations/custom_issue_tracker.md b/doc/user/project/integrations/custom_issue_tracker.md index 4eb71f815a2..b320cb133bf 100644 --- a/doc/user/project/integrations/custom_issue_tracker.md +++ b/doc/user/project/integrations/custom_issue_tracker.md @@ -4,7 +4,11 @@ group: Import and Integrate info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Custom issue tracker **(FREE ALL)** +# Custom issue tracker + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed You can integrate an [external issue tracker](../../../integration/external-issue-tracker.md) with GitLab. If your preferred issue tracker is not listed in the diff --git a/doc/user/project/integrations/discord_notifications.md b/doc/user/project/integrations/discord_notifications.md index e8e33eade1a..c75a538c7d0 100644 --- a/doc/user/project/integrations/discord_notifications.md +++ b/doc/user/project/integrations/discord_notifications.md @@ -4,7 +4,11 @@ group: Import and Integrate info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Discord Notifications **(FREE ALL)** +# Discord Notifications + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed The Discord Notifications integration sends event notifications from GitLab to the channel for which the webhook was created. @@ -24,7 +28,7 @@ and configure it in GitLab. ## Configure created webhook in GitLab -> Event webhook overrides [introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/125621) in GitLab 16.3. +> - Event webhook overrides [introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/125621) in GitLab 16.3. With the webhook URL created in the Discord channel, you can set up the Discord Notifications integration in GitLab. diff --git a/doc/user/project/integrations/emails_on_push.md b/doc/user/project/integrations/emails_on_push.md index 029803f3cc4..ce68bc86cb7 100644 --- a/doc/user/project/integrations/emails_on_push.md +++ b/doc/user/project/integrations/emails_on_push.md @@ -4,7 +4,11 @@ group: Import and Integrate info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Emails on push **(FREE ALL)** +# Emails on push + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed When you enable emails on push, you receive email notifications for every change that is pushed to your project. diff --git a/doc/user/project/integrations/ewm.md b/doc/user/project/integrations/ewm.md index 8ec62d22a73..bb8138ea82f 100644 --- a/doc/user/project/integrations/ewm.md +++ b/doc/user/project/integrations/ewm.md @@ -4,7 +4,11 @@ group: Import and Integrate info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Engineering Workflow Management (EWM) **(FREE ALL)** +# Engineering Workflow Management (EWM) + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed The EWM integration allows you to go from GitLab to EWM work items mentioned in merge request descriptions and commit messages. diff --git a/doc/user/project/integrations/github.md b/doc/user/project/integrations/github.md index 9249ee68c04..7ff7bf78ee0 100644 --- a/doc/user/project/integrations/github.md +++ b/doc/user/project/integrations/github.md @@ -4,7 +4,11 @@ group: Import and Integrate info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# GitHub **(PREMIUM ALL)** +# GitHub + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed You can update GitHub with pipeline status updates from GitLab. The GitHub integration can help you if you use GitLab for CI/CD. @@ -44,7 +48,7 @@ to configure pipelines to run for open pull requests. ### Static or dynamic status check names -> [Changed](https://gitlab.com/gitlab-org/gitlab/-/issues/9931) in GitLab 12.4 to make static status check names the default behavior for new projects. +> - [Changed](https://gitlab.com/gitlab-org/gitlab/-/issues/9931) in GitLab 12.4 to make static status check names the default behavior for new projects. A status check name can be static or dynamic: diff --git a/doc/user/project/integrations/gitlab_slack_app_troubleshooting.md b/doc/user/project/integrations/gitlab_slack_app_troubleshooting.md index a219a9ffdd4..5ad780fac27 100644 --- a/doc/user/project/integrations/gitlab_slack_app_troubleshooting.md +++ b/doc/user/project/integrations/gitlab_slack_app_troubleshooting.md @@ -4,7 +4,11 @@ group: Import and Integrate info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Troubleshooting GitLab for Slack app **(FREE ALL)** +# Troubleshooting GitLab for Slack app + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed When working with the GitLab for Slack app, you might encounter the following issues. diff --git a/doc/user/project/integrations/gitlab_slack_application.md b/doc/user/project/integrations/gitlab_slack_application.md index b13cc3f686a..65561b43114 100644 --- a/doc/user/project/integrations/gitlab_slack_application.md +++ b/doc/user/project/integrations/gitlab_slack_application.md @@ -4,9 +4,13 @@ group: Import and Integrate info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# GitLab for Slack app **(FREE ALL)** +# GitLab for Slack app -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/358872) for self-managed in GitLab 16.2. +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/358872) for self-managed in GitLab 16.2. NOTE: This page contains user documentation for the GitLab for Slack app. For administrator documentation, see [GitLab for Slack app administration](../../../administration/settings/slack_app.md). @@ -36,7 +40,11 @@ To install the GitLab for Slack app from project integration settings: 1. Select **Install GitLab for Slack app**. 1. On the Slack confirmation page, select **Allow**. -### From the Slack App Directory **(FREE SAAS)** +### From the Slack App Directory + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS On GitLab.com, you can also install the GitLab for Slack app from the [Slack App Directory](https://slack-platform.slack.com/apps/A676ADMV5-gitlab). @@ -118,7 +126,7 @@ To create a project alias for slash commands in the GitLab for Slack app: ## Slack notifications -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/381012) in GitLab 15.9. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/381012) in GitLab 15.9. You can receive notifications to Slack channels for certain GitLab [events](#notification-events). diff --git a/doc/user/project/integrations/google_play.md b/doc/user/project/integrations/google_play.md index cfe48d11bcb..50b8de1709e 100644 --- a/doc/user/project/integrations/google_play.md +++ b/doc/user/project/integrations/google_play.md @@ -4,7 +4,11 @@ group: Import and Integrate info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Google Play **(FREE ALL)** +# Google Play + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/111621) in GitLab 15.10 [with a flag](../../../administration/feature_flags.md) named `google_play_integration`. Disabled by default. > - [Generally available](https://gitlab.com/gitlab-org/gitlab/-/issues/389611) in GitLab 15.11. Feature flag `google_play_integration` removed. diff --git a/doc/user/project/integrations/hangouts_chat.md b/doc/user/project/integrations/hangouts_chat.md index da7fbabd84e..b09c7cd6423 100644 --- a/doc/user/project/integrations/hangouts_chat.md +++ b/doc/user/project/integrations/hangouts_chat.md @@ -4,7 +4,11 @@ group: Import and Integrate info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Google Chat **(FREE ALL)** +# Google Chat + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed You can configure your project to send notifications from GitLab to a room of your choice in [Google Chat](https://chat.google.com/) (formerly Google @@ -38,7 +42,7 @@ For further details, see [the Google Chat documentation for configuring webhooks ### Enable threads in Google Chat -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/27823) in GitLab 15.4. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/27823) in GitLab 15.4. WARNING: In March 2023, Google [deprecated threaded replies in Google Chat](https://workspaceupdates.googleblog.com/2023/02/new-google-chat-spaces-will-be-in-line-threaded.html). diff --git a/doc/user/project/integrations/harbor.md b/doc/user/project/integrations/harbor.md index af81dda6ac1..86d47c51df0 100644 --- a/doc/user/project/integrations/harbor.md +++ b/doc/user/project/integrations/harbor.md @@ -4,9 +4,13 @@ group: Import and Integrate info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Harbor **(FREE ALL)** +# Harbor -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/80999) in GitLab 14.9. +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/80999) in GitLab 14.9. You can use Harbor as the container registry for your GitLab project. diff --git a/doc/user/project/integrations/index.md b/doc/user/project/integrations/index.md index 42be43bba64..225edff8125 100644 --- a/doc/user/project/integrations/index.md +++ b/doc/user/project/integrations/index.md @@ -4,7 +4,11 @@ group: Import and Integrate info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Project integrations **(FREE ALL)** +# Project integrations + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed NOTE: This page contains user documentation for project integrations. For administrator documentation, see [Project integration administration](../../../administration/settings/project_integration_management.md). diff --git a/doc/user/project/integrations/irker.md b/doc/user/project/integrations/irker.md index 4b55dda5388..fca682039e2 100644 --- a/doc/user/project/integrations/irker.md +++ b/doc/user/project/integrations/irker.md @@ -4,7 +4,11 @@ group: Import and Integrate info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# irker (IRC gateway) **(FREE ALL)** +# irker (IRC gateway) + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed GitLab provides a way to push update messages to an irker server. After you configure the integration, each push to a project triggers the integration to send data directly diff --git a/doc/user/project/integrations/mattermost.md b/doc/user/project/integrations/mattermost.md index 91c8e9ce2f1..c712d529ad7 100644 --- a/doc/user/project/integrations/mattermost.md +++ b/doc/user/project/integrations/mattermost.md @@ -4,7 +4,11 @@ group: Import and Integrate info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Mattermost notifications **(FREE ALL)** +# Mattermost notifications + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed Use the Mattermost notifications integration to send notifications for GitLab events (for example, `issue created`) to Mattermost. You must configure both [Mattermost](#configure-mattermost-to-receive-gitlab-notifications) @@ -36,7 +40,7 @@ Display name override is not enabled by default, you need to ask your administra ## Configure GitLab to send notifications to Mattermost -> [Changed](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/106760) in GitLab 15.9 to limit Mattermost channels to 10 per event. +> - [Changed](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/106760) in GitLab 15.9 to limit Mattermost channels to 10 per event. After the Mattermost instance has an incoming webhook set up, you can set up GitLab to send the notifications: diff --git a/doc/user/project/integrations/mattermost_slash_commands.md b/doc/user/project/integrations/mattermost_slash_commands.md index f78f637a4df..0ccef20ed06 100644 --- a/doc/user/project/integrations/mattermost_slash_commands.md +++ b/doc/user/project/integrations/mattermost_slash_commands.md @@ -4,7 +4,11 @@ group: Import and Integrate info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Mattermost slash commands **(FREE ALL)** +# Mattermost slash commands + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed You can use [slash commands](gitlab_slack_application.md#slash-commands) to run common GitLab operations, like creating an issue, from a [Mattermost](https://mattermost.com/) chat environment. diff --git a/doc/user/project/integrations/microsoft_teams.md b/doc/user/project/integrations/microsoft_teams.md index 889849f2182..af6ff78cbf5 100644 --- a/doc/user/project/integrations/microsoft_teams.md +++ b/doc/user/project/integrations/microsoft_teams.md @@ -4,7 +4,11 @@ group: Import and Integrate info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Microsoft Teams notifications **(FREE ALL)** +# Microsoft Teams notifications + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed You can integrate Microsoft Teams notifications with GitLab and display notifications about GitLab projects in Microsoft Teams. To integrate the services, you must: diff --git a/doc/user/project/integrations/mock_ci.md b/doc/user/project/integrations/mock_ci.md index 745e70d7d1e..01ec03aca58 100644 --- a/doc/user/project/integrations/mock_ci.md +++ b/doc/user/project/integrations/mock_ci.md @@ -4,7 +4,11 @@ group: Import and Integrate info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Mock CI **(FREE ALL)** +# Mock CI + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed NOTE: This integration is only available in a development environment. diff --git a/doc/user/project/integrations/pipeline_status_emails.md b/doc/user/project/integrations/pipeline_status_emails.md index cc9f2f468a0..0eee541fd4e 100644 --- a/doc/user/project/integrations/pipeline_status_emails.md +++ b/doc/user/project/integrations/pipeline_status_emails.md @@ -4,7 +4,11 @@ group: Import and Integrate info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Pipeline status emails **(FREE ALL)** +# Pipeline status emails + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed You can send notifications about pipeline status changes in a group or project to a list of email addresses. diff --git a/doc/user/project/integrations/pivotal_tracker.md b/doc/user/project/integrations/pivotal_tracker.md index a94391b9362..3b209dd7ebb 100644 --- a/doc/user/project/integrations/pivotal_tracker.md +++ b/doc/user/project/integrations/pivotal_tracker.md @@ -4,7 +4,11 @@ group: Import and Integrate info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Pivotal Tracker **(FREE ALL)** +# Pivotal Tracker + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed The Pivotal Tracker integration adds commit messages as comments to Pivotal Tracker stories. diff --git a/doc/user/project/integrations/pumble.md b/doc/user/project/integrations/pumble.md index d5adee65456..a5da1b1d021 100644 --- a/doc/user/project/integrations/pumble.md +++ b/doc/user/project/integrations/pumble.md @@ -4,9 +4,13 @@ group: Import and Integrate info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Pumble **(FREE ALL)** +# Pumble -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/93623) in GitLab 15.3. +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/93623) in GitLab 15.3. You can configure GitLab to send notifications to a Pumble channel: diff --git a/doc/user/project/integrations/redmine.md b/doc/user/project/integrations/redmine.md index adc362fa07b..c2c95060db0 100644 --- a/doc/user/project/integrations/redmine.md +++ b/doc/user/project/integrations/redmine.md @@ -4,7 +4,11 @@ group: Import and Integrate info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Redmine **(FREE ALL)** +# Redmine + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed You can use [Redmine](https://www.redmine.org/) as an external issue tracker. To enable the Redmine integration in a project: diff --git a/doc/user/project/integrations/servicenow.md b/doc/user/project/integrations/servicenow.md index 67613c35657..da7112411b6 100644 --- a/doc/user/project/integrations/servicenow.md +++ b/doc/user/project/integrations/servicenow.md @@ -4,7 +4,11 @@ group: Import and Integrate info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# ServiceNow **(FREE ALL)** +# ServiceNow + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed ServiceNow offers several integrations to help centralize and automate your management of GitLab workflows. diff --git a/doc/user/project/integrations/shimo.md b/doc/user/project/integrations/shimo.md index 9ed1b471101..7bd21c5bdf8 100644 --- a/doc/user/project/integrations/shimo.md +++ b/doc/user/project/integrations/shimo.md @@ -6,7 +6,11 @@ remove_date: '2024-02-13' redirect_to: 'index.md' --- -# Shimo (removed) **(FREE ALL)** +# Shimo (removed) + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed This feature was [deprecated](https://gitlab.com/gitlab-org/gitlab/-/issues/377824) in GitLab 15.7 and [removed](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/136143) in 16.7. diff --git a/doc/user/project/integrations/slack.md b/doc/user/project/integrations/slack.md index fee6de2af6d..f24a2201b62 100644 --- a/doc/user/project/integrations/slack.md +++ b/doc/user/project/integrations/slack.md @@ -5,7 +5,11 @@ info: To determine the technical writer assigned to the Stage/Group associated w --- -# Slack notifications (deprecated) **(FREE ALL)** +# Slack notifications (deprecated) + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed WARNING: This feature was [deprecated](https://gitlab.com/gitlab-org/gitlab/-/issues/372411) in GitLab 15.9 @@ -28,7 +32,7 @@ to control GitLab from Slack. Slash commands are configured separately. ## Configure GitLab -> [Changed](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/106760) in GitLab 15.9 to limit Slack channels to 10 per event. +> - [Changed](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/106760) in GitLab 15.9 to limit Slack channels to 10 per event. 1. On the left sidebar, select **Search or go to** and find your project. 1. Select **Settings > Integrations**. @@ -83,7 +87,7 @@ The following triggers are available for Slack notifications: ## Trigger notifications for group mentions -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/417751) in GitLab 16.4. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/417751) in GitLab 16.4. To trigger a [notification event](#triggers-for-slack-notifications) for a group mention, use `@` in: diff --git a/doc/user/project/integrations/slack_slash_commands.md b/doc/user/project/integrations/slack_slash_commands.md index a5a6d80e75b..db2de52b1d5 100644 --- a/doc/user/project/integrations/slack_slash_commands.md +++ b/doc/user/project/integrations/slack_slash_commands.md @@ -4,7 +4,11 @@ group: Import and Integrate info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Slack slash commands **(FREE SELF)** +# Slack slash commands + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed NOTE: This feature is only configurable on self-managed GitLab instances. diff --git a/doc/user/project/integrations/squash_tm.md b/doc/user/project/integrations/squash_tm.md index 6a1ca89f4b7..049df054a4e 100644 --- a/doc/user/project/integrations/squash_tm.md +++ b/doc/user/project/integrations/squash_tm.md @@ -4,9 +4,13 @@ group: Import and Integrate info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Squash TM **(FREE SELF)** +# Squash TM -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/337855) in GitLab 15.10. +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/337855) in GitLab 15.10. When [Squash TM](https://www.squashtest.com/squash-gitlab-integration?lang=en) (Test Management) integration is enabled and configured in GitLab, issues (typically user stories) created in GitLab diff --git a/doc/user/project/integrations/telegram.md b/doc/user/project/integrations/telegram.md index a7a0a58b922..6a04ec62fda 100644 --- a/doc/user/project/integrations/telegram.md +++ b/doc/user/project/integrations/telegram.md @@ -4,9 +4,13 @@ group: Import and Integrate info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Telegram **(FREE ALL)** +# Telegram -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/122879) in GitLab 16.1. +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/122879) in GitLab 16.1. You can configure GitLab to send notifications to a Telegram chat or channel. To set up the Telegram integration, you must: diff --git a/doc/user/project/integrations/unify_circuit.md b/doc/user/project/integrations/unify_circuit.md index e0dbf3e59aa..8f297dd2304 100644 --- a/doc/user/project/integrations/unify_circuit.md +++ b/doc/user/project/integrations/unify_circuit.md @@ -4,7 +4,11 @@ group: Import and Integrate info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Unify Circuit **(FREE ALL)** +# Unify Circuit + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed The Unify Circuit integration sends notifications from GitLab to a Circuit conversation. diff --git a/doc/user/project/integrations/webex_teams.md b/doc/user/project/integrations/webex_teams.md index 2a7ad52d9d3..5915bcc73ca 100644 --- a/doc/user/project/integrations/webex_teams.md +++ b/doc/user/project/integrations/webex_teams.md @@ -4,7 +4,11 @@ group: Import and Integrate info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Webex Teams **(FREE ALL)** +# Webex Teams + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed You can configure GitLab to send notifications to a Webex Teams space: diff --git a/doc/user/project/integrations/webhook_events.md b/doc/user/project/integrations/webhook_events.md index 11d164d68e9..f3c7d002e74 100644 --- a/doc/user/project/integrations/webhook_events.md +++ b/doc/user/project/integrations/webhook_events.md @@ -4,7 +4,11 @@ group: Import and Integrate info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Webhook events **(FREE ALL)** +# Webhook events + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed This page lists the events that are triggered for [project webhooks](webhooks.md) and [group webhooks](webhooks.md#group-webhooks). @@ -1515,7 +1519,7 @@ has not been retried. `1` means that it's the first retry. ### Pipeline name -> `commit.name` [introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/107963) in GitLab 15.8. +> - `commit.name` [introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/107963) in GitLab 15.8. You can set custom names for pipelines with [`workflow:name`](../../../ci/yaml/index.md#workflowname). If the pipeline has a name, that name is the value of `commit.name`. @@ -1584,7 +1588,11 @@ Payload example: } ``` -## Group member events **(PREMIUM ALL)** +## Group member events + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed These events are triggered for [group webhooks](webhooks.md#group-webhooks) only. @@ -1679,7 +1687,11 @@ Payload example: } ``` -## Subgroup events **(PREMIUM ALL)** +## Subgroup events + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed These events are triggered for [group webhooks](webhooks.md#group-webhooks) only. @@ -1798,7 +1810,7 @@ Payload example: ## Release events -> Delete release event [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/418113) in GitLab 16.5. +> - Delete release event [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/418113) in GitLab 16.5. Release events are triggered when a release is created, updated, or deleted. diff --git a/doc/user/project/integrations/webhooks.md b/doc/user/project/integrations/webhooks.md index ccf416fc8c6..c72c02251a5 100644 --- a/doc/user/project/integrations/webhooks.md +++ b/doc/user/project/integrations/webhooks.md @@ -5,7 +5,11 @@ description: Custom HTTP callbacks, used to send events. info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Webhooks **(FREE ALL)** +# Webhooks + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed [Webhooks](https://en.wikipedia.org/wiki/Webhook) are custom HTTP callbacks that you define. They are usually triggered by an @@ -38,7 +42,11 @@ including: - The maximum number of webhooks and their size, both per project and per group. - The number of webhook calls per minute. -## Group webhooks **(PREMIUM ALL)** +## Group webhooks + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed You can configure a group webhook, which is triggered by events that occur across all projects in the group and its subgroups. If you configure identical webhooks @@ -323,7 +331,7 @@ You can [review recently triggered webhook payloads](#troubleshooting) in GitLab ## Troubleshooting -> **Recent events** for group webhooks [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/325642) in GitLab 15.3. +> - **Recent events** for group webhooks [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/325642) in GitLab 15.3. GitLab records the history of each webhook request. You can view requests made in the last 2 days in the **Recent events** table. @@ -383,7 +391,7 @@ GitLab expects a response in [10 seconds](../../../user/gitlab_com/index.md#othe ### Webhook is not triggered -> Webhooks not triggered in Silent Mode [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/393639) in GitLab 16.3. +> - Webhooks not triggered in Silent Mode [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/393639) in GitLab 16.3. If a webhook is not triggered, check that: diff --git a/doc/user/project/integrations/youtrack.md b/doc/user/project/integrations/youtrack.md index bf0c3ff215f..ff3c8b269a6 100644 --- a/doc/user/project/integrations/youtrack.md +++ b/doc/user/project/integrations/youtrack.md @@ -4,7 +4,11 @@ group: Import and Integrate info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# YouTrack **(FREE ALL)** +# YouTrack + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed JetBrains [YouTrack](https://www.jetbrains.com/youtrack/) is a web-based issue tracking and project management platform. diff --git a/doc/user/project/integrations/zentao.md b/doc/user/project/integrations/zentao.md index d6f4816b7bb..c526950e498 100644 --- a/doc/user/project/integrations/zentao.md +++ b/doc/user/project/integrations/zentao.md @@ -4,9 +4,13 @@ group: Import and Integrate info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# ZenTao (deprecated) **(PREMIUM ALL)** +# ZenTao (deprecated) -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/338178) in GitLab 14.5. +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/338178) in GitLab 14.5. WARNING: This feature was [deprecated](https://gitlab.com/gitlab-org/gitlab/-/issues/377825) in GitLab 15.7. diff --git a/doc/user/project/issue_board.md b/doc/user/project/issue_board.md index 2af657fd9b9..888b68950e6 100644 --- a/doc/user/project/issue_board.md +++ b/doc/user/project/issue_board.md @@ -4,7 +4,11 @@ group: Project Management info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Issue boards **(FREE ALL)** +# Issue boards + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed The issue board is a software project management tool used to plan, organize, and visualize a workflow for a feature or product release. @@ -253,7 +257,11 @@ Users on GitLab Free can use a single group issue board. GitLab issue boards are available on the GitLab Free tier, but some advanced functionality is present in [higher tiers only](https://about.gitlab.com/pricing/). -### Configurable issue boards **(PREMIUM ALL)** +### Configurable issue boards + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed > - Setting current iteration as scope [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/196804) in GitLab 13.8. > - Moved to GitLab Premium in 13.9. @@ -277,9 +285,13 @@ selecting **View scope**. Watch a [video presentation](https://youtu.be/m5UTNCSqaDk) of the configurable issue board feature. -### Sum of issue weights **(PREMIUM ALL)** +### Sum of issue weights -> Moved to GitLab Premium in 13.9. +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed + +> - Moved to GitLab Premium in 13.9. The top of each list indicates the sum of issue weights for the issues that belong to that list. This is useful when using boards for capacity allocation, @@ -287,7 +299,11 @@ especially in combination with [assignee lists](#assignee-lists). ![issue board summed weights](img/issue_board_summed_weights_v13_6.png) -### Assignee lists **(PREMIUM ALL)** +### Assignee lists + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed As in a regular list showing all issues with a chosen label, you can add an assignee list that shows all issues assigned to a user. @@ -310,7 +326,11 @@ To remove an assignee list, just as with a label list, select the trash icon. ![Assignee lists](img/issue_board_assignee_lists_v14_1.png) -### Milestone lists **(PREMIUM ALL)** +### Milestone lists + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed You're also able to create lists of a milestone. These are lists that filter issues by the assigned milestone, giving you more freedom and visibility on the issue board. @@ -332,7 +352,11 @@ As in other list types, select the trash icon to remove a list. ![Milestone lists](img/issue_board_milestone_lists_v14_1.png) -### Iteration lists **(PREMIUM ALL)** +### Iteration lists + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/250479) in GitLab 13.11 [with a flag](../../administration/feature_flags.md) named `iteration_board_lists`. Enabled by default. > - [Generally available](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/75404) in GitLab 14.6. Feature flag `iteration_board_lists` removed. @@ -355,7 +379,11 @@ to and from a iteration list to manipulate the iteration of the dragged issues. ![Iteration lists](img/issue_board_iteration_lists_v13_10.png) -### Group issues in swimlanes **(PREMIUM ALL)** +### Group issues in swimlanes + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed > - Grouping by epic [introduced](https://gitlab.com/groups/gitlab-org/-/epics/3352) in GitLab 13.6. > - Editing issue titles in the issue sidebar [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/232745) in GitLab 13.8. @@ -401,9 +429,13 @@ You can also [drag issues](#move-issues-and-lists) to change their position and ![Drag issues between swimlanes](img/epics_swimlanes_drag_and_drop.png) -## Work in progress limits **(PREMIUM ALL)** +## Work in progress limits -> Moved to GitLab Premium in 13.9. +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed + +> - Moved to GitLab Premium in 13.9. You can set a work in progress (WIP) limit for each issue list on an issue board. When a limit is set, the list's header shows the number of issues in the list and the soft limit of issues. @@ -428,9 +460,13 @@ To set a WIP limit for a list, in an issue board: 1. Enter the maximum number of issues. 1. Press Enter to save. -## Blocked issues **(PREMIUM ALL)** +## Blocked issues -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/210452) in GitLab 13.10: View blocking issues when hovering over the "blocked" icon. +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/210452) in GitLab 13.10: View blocking issues when hovering over the "blocked" icon. If an issue is [blocked by another issue](issues/related_issues.md#blocking-issues), an icon appears next to its title to indicate its blocked status. @@ -454,7 +490,7 @@ When you hover over the blocked icon (**{issue-block}**), a detailed information ### Edit an issue -> Editing title, iteration, and confidentiality [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/248908) in GitLab 14.1. +> - Editing title, iteration, and confidentiality [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/248908) in GitLab 14.1. You can edit an issue without leaving the board view. To open the right sidebar, select an issue card (not its title). @@ -506,8 +542,6 @@ To remove a list from an issue board: ### Add issues to a list -> The **Add issues** button was [removed](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/57329) in GitLab 13.11. - Prerequisites: - You must have at least the Reporter role for the project. @@ -524,8 +558,6 @@ The issue should now show in the `Doing` list on your issue board. ### Remove an issue from a list -> The **Remove from board** button was [removed](https://gitlab.com/gitlab-org/gitlab/-/issues/229507) in GitLab 13.10. - When an issue should no longer belong to a list, you can remove it. Prerequisites: @@ -589,7 +621,7 @@ You can't move the **Open** and **Closed** lists, but you can hide them when edi #### Move an issue to the start of the list -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/367473) in GitLab 15.4. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/367473) in GitLab 15.4. You can move issues to the top of the list with a menu shortcut. @@ -606,7 +638,7 @@ To move an issue to the start of the list: #### Move an issue to the end of the list -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/367473) in GitLab 15.4. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/367473) in GitLab 15.4. You can move issues to the bottom of the list with a menu shortcut. @@ -637,7 +669,7 @@ and the target list. ### Multi-select issue cards -> [Moved](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/61955) behind a [feature flag](../feature_flags.md) named `board_multi_select` in GitLab 14.0. Disabled by default. +> - [Moved](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/61955) behind a [feature flag](../feature_flags.md) named `board_multi_select` in GitLab 14.0. Disabled by default. FLAG: On self-managed GitLab, by default this feature is not available. To make it available, ask an diff --git a/doc/user/project/issues/associate_zoom_meeting.md b/doc/user/project/issues/associate_zoom_meeting.md index 87611a9cda6..731d42d06ea 100644 --- a/doc/user/project/issues/associate_zoom_meeting.md +++ b/doc/user/project/issues/associate_zoom_meeting.md @@ -4,9 +4,13 @@ group: Project Management info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Associate a Zoom meeting with an issue **(FREE ALL)** +# Associate a Zoom meeting with an issue -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/16609) in GitLab 12.4. +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/16609) in GitLab 12.4. To communicate synchronously for incidents management, you can associate a Zoom meeting with an issue. diff --git a/doc/user/project/issues/confidential_issues.md b/doc/user/project/issues/confidential_issues.md index 21cdd88d701..1b28f489440 100644 --- a/doc/user/project/issues/confidential_issues.md +++ b/doc/user/project/issues/confidential_issues.md @@ -4,7 +4,11 @@ group: Project Management info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Confidential issues **(FREE ALL)** +# Confidential issues + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed Confidential issues are [issues](index.md) visible only to members of a project with [sufficient permissions](#who-can-see-confidential-issues). diff --git a/doc/user/project/issues/create_issues.md b/doc/user/project/issues/create_issues.md index a86a94fdea0..24e58806e36 100644 --- a/doc/user/project/issues/create_issues.md +++ b/doc/user/project/issues/create_issues.md @@ -4,7 +4,11 @@ group: Project Management info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Create an issue **(FREE ALL)** +# Create an issue + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed When you create an issue, you are prompted to enter the fields of the issue. If you know the values you want to assign to an issue, you can use diff --git a/doc/user/project/issues/crosslinking_issues.md b/doc/user/project/issues/crosslinking_issues.md index de321cedebd..db9f9efe7a8 100644 --- a/doc/user/project/issues/crosslinking_issues.md +++ b/doc/user/project/issues/crosslinking_issues.md @@ -4,7 +4,11 @@ group: Project Management info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Crosslinking issues **(FREE ALL)** +# Crosslinking issues + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed There are several ways to mention an issue or make [issues](index.md) appear in each other's [Linked issues](related_issues.md) section. diff --git a/doc/user/project/issues/csv_export.md b/doc/user/project/issues/csv_export.md index d87fb9e1775..36a7e0fefda 100644 --- a/doc/user/project/issues/csv_export.md +++ b/doc/user/project/issues/csv_export.md @@ -4,7 +4,11 @@ group: Project Management info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Export issues to CSV **(FREE ALL)** +# Export issues to CSV + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed You can export issues from GitLab to a plain-text CSV ([comma-separated values](https://en.wikipedia.org/wiki/Comma-separated_values)) diff --git a/doc/user/project/issues/csv_import.md b/doc/user/project/issues/csv_import.md index f2f56f5566e..e6f2317e5c1 100644 --- a/doc/user/project/issues/csv_import.md +++ b/doc/user/project/issues/csv_import.md @@ -4,7 +4,11 @@ group: Import and Integrate info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Importing issues from CSV **(FREE ALL)** +# Importing issues from CSV + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed You can import issues to a project by uploading a CSV file with the following columns: diff --git a/doc/user/project/issues/design_management.md b/doc/user/project/issues/design_management.md index 01bd840ed0e..abfe8ef8291 100644 --- a/doc/user/project/issues/design_management.md +++ b/doc/user/project/issues/design_management.md @@ -4,7 +4,11 @@ group: Product Planning info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Design management **(FREE ALL)** +# Design management + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed With Design Management you can upload design assets (including wireframes and mockups) to GitLab issues and keep them stored in a single place. Product designers, product managers, and @@ -105,7 +109,7 @@ To move around the image while zoomed in, drag the image. ## Add a design to an issue -> Ability to edit the description [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/388449) in GitLab 16.1. +> - Ability to edit the description [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/388449) in GitLab 16.1. Prerequisites: @@ -221,7 +225,7 @@ so that everyone involved can participate in the discussion. ## Delete a comment from a design -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/385100) in GitLab 15.9. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/385100) in GitLab 15.9. Prerequisites: diff --git a/doc/user/project/issues/due_dates.md b/doc/user/project/issues/due_dates.md index 8b58866c256..15fab5354b8 100644 --- a/doc/user/project/issues/due_dates.md +++ b/doc/user/project/issues/due_dates.md @@ -4,7 +4,11 @@ group: Project Management info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Due dates **(FREE ALL)** +# Due dates + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed Due dates can be used in [issues](index.md) to keep track of deadlines and make sure features are shipped on time. Users need at least the Reporter role diff --git a/doc/user/project/issues/index.md b/doc/user/project/issues/index.md index cdbf6d5b5b3..a58bfbb4ee6 100644 --- a/doc/user/project/issues/index.md +++ b/doc/user/project/issues/index.md @@ -4,7 +4,11 @@ group: Project Management info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Issues **(FREE ALL)** +# Issues + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed Use issues to collaborate on ideas, solve problems, and plan work. Share and discuss proposals with your team and with outside collaborators. diff --git a/doc/user/project/issues/issue_weight.md b/doc/user/project/issues/issue_weight.md index 234ebf4913f..e34fd14fe0d 100644 --- a/doc/user/project/issues/issue_weight.md +++ b/doc/user/project/issues/issue_weight.md @@ -4,9 +4,13 @@ group: Project Management info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Issue weight **(PREMIUM ALL)** +# Issue weight -> Moved to GitLab Premium in 13.9. +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed + +> - Moved to GitLab Premium in 13.9. When you have a lot of issues, it can be hard to get an overview. With weighted issues, you can get a better idea of how much time, diff --git a/doc/user/project/issues/managing_issues.md b/doc/user/project/issues/managing_issues.md index 62d108d3540..a332c163b7c 100644 --- a/doc/user/project/issues/managing_issues.md +++ b/doc/user/project/issues/managing_issues.md @@ -4,7 +4,11 @@ group: Project Management info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Manage issues **(FREE ALL)** +# Manage issues + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed After you create an issue, you can start working with it. @@ -26,7 +30,7 @@ To edit an issue: ### Remove a task list item -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/377307) in GitLab 15.9. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/377307) in GitLab 15.9. Prerequisites: @@ -73,7 +77,11 @@ When bulk editing issues in a project, you can edit the following attributes: - [Iteration](../../group/iterations/index.md) - [Confidentiality](confidential_issues.md) -### Bulk edit issues from a group **(PREMIUM ALL)** +### Bulk edit issues from a group + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/7249) in GitLab 12.1. > - Assigning epic [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/210470) in GitLab 13.2. @@ -123,11 +131,15 @@ To move an issue: 1. Search for a project to move the issue to. 1. Select **Move**. -### Bulk move issues **(FREE SELF)** +### Bulk move issues + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed #### From the issues list -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/15991) in GitLab 15.6. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/15991) in GitLab 15.6. You can move multiple issues at the same time when you're in a project. You can't move tasks or test cases. @@ -181,7 +193,7 @@ To do it: ## Reorder list items in the issue description -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/15260) in GitLab 15.0. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/15260) in GitLab 15.0. When you view an issue that has a list in the description, you can also reorder the list items. @@ -316,7 +328,11 @@ closed issues remain as they are. Disabling automatic issue closing only applies to issues in the project where the setting was disabled. Merge requests and commits in this project can still close another project's issues. -#### Customize the issue closing pattern **(FREE SELF)** +#### Customize the issue closing pattern + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed Prerequisites: @@ -345,7 +361,7 @@ To change issue type: ## Delete an issue -> Deleting from the vertical ellipsis menu [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/299933) in GitLab 14.6. +> - Deleting from the vertical ellipsis menu [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/299933) in GitLab 14.6. Prerequisites: @@ -365,7 +381,11 @@ Alternatively: 1. Select **Edit title and description** (**{pencil}**). 1. Select **Delete issue**. -## Promote an issue to an epic **(PREMIUM ALL)** +## Promote an issue to an epic + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed You can promote an issue to an [epic](../../group/epics/index.md) in the immediate parent group. @@ -412,7 +432,11 @@ Alternatively, you can use the `/promote` [quick action](../quick_actions.md#iss You can use the `/promote_to_incident` [quick action](../quick_actions.md) to promote the issue to an [incident](../../../operations/incident_management/incidents.md). -## Add an issue to an iteration **(PREMIUM ALL)** +## Add an issue to an iteration + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed To add an issue to an [iteration](../../group/iterations/index.md): @@ -483,7 +507,7 @@ when you [filter the list of issues](#filter-the-list-of-issues) by: ### Filter issues by ID -> [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/issues/39908) in GitLab 12.1. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/issues/39908) in GitLab 12.1. 1. On the left sidebar, select **Search or go to** and find your project. 1. Select **Plan > Issues**. @@ -512,7 +536,7 @@ enabled a feature flag for [moved actions](../merge_requests/index.md#move-sideb ## Copy issue email address -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/18816) in GitLab 13.8. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/18816) in GitLab 13.8. You can create a comment in an issue by sending an email. Sending an email to this address creates a comment that contains the email body. @@ -560,7 +584,11 @@ As you type in the title text box of the **New issue** page, GitLab searches tit across all issues in the current project. Only issues you have access to are returned. Up to five similar issues, sorted by most recently updated, are displayed below the title text box. -## Health status **(ULTIMATE ALL)** +## Health status + +DETAILS: +**Tier:** Ultimate +**Offering:** SaaS, self-managed > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/36427) in GitLab 12.10. > - Health status of closed issues [can't be edited](https://gitlab.com/gitlab-org/gitlab/-/issues/220867) in GitLab 13.4 and later. @@ -601,9 +629,13 @@ until the issue is reopened. You can also set and clear health statuses using the `/health_status` and `/clear_health_status` [quick actions](../quick_actions.md#issues-merge-requests-and-epics). -## Publish an issue **(ULTIMATE ALL)** +## Publish an issue -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/30906) in GitLab 13.1. +DETAILS: +**Tier:** Ultimate +**Offering:** SaaS, self-managed + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/30906) in GitLab 13.1. If a status page application is associated with the project, you can use the `/publish` [quick action](../quick_actions.md) to publish the issue. diff --git a/doc/user/project/issues/multiple_assignees_for_issues.md b/doc/user/project/issues/multiple_assignees_for_issues.md index ea0149db8f7..bda613279f0 100644 --- a/doc/user/project/issues/multiple_assignees_for_issues.md +++ b/doc/user/project/issues/multiple_assignees_for_issues.md @@ -4,9 +4,13 @@ group: Project Management info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Multiple assignees for issues **(PREMIUM ALL)** +# Multiple assignees for issues -> Moved from Starter to Premium in GitLab 13.9. +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed + +> - Moved from Starter to Premium in GitLab 13.9. In large teams with shared ownership, it can be difficult to track who is working on an issue, who's already done, or who hasn't started yet. diff --git a/doc/user/project/issues/related_issues.md b/doc/user/project/issues/related_issues.md index 517d289b282..94d7d4aa9be 100644 --- a/doc/user/project/issues/related_issues.md +++ b/doc/user/project/issues/related_issues.md @@ -4,9 +4,13 @@ group: Product Planning info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Linked issues **(FREE ALL)** +# Linked issues -> The simple "relates to" relationship [moved](https://gitlab.com/gitlab-org/gitlab/-/issues/212329) from GitLab Premium to GitLab Free in 13.4. +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed + +> - The simple "relates to" relationship [moved](https://gitlab.com/gitlab-org/gitlab/-/issues/212329) from GitLab Premium to GitLab Free in 13.4. Linked issues are a bi-directional relationship between any two issues and appear in a block below the issue description. You can link issues in different projects. @@ -70,7 +74,11 @@ Due to the bi-directional relationship, the relationship no longer appears in ei Access our [permissions](../../permissions.md) page for more information. -## Blocking issues **(PREMIUM ALL)** +## Blocking issues + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed When you [add a linked issue](#add-a-linked-issue), you can show that it **blocks** or **is blocked by** another issue. diff --git a/doc/user/project/issues/sorting_issue_lists.md b/doc/user/project/issues/sorting_issue_lists.md index 74b106335fc..daf43fed8fd 100644 --- a/doc/user/project/issues/sorting_issue_lists.md +++ b/doc/user/project/issues/sorting_issue_lists.md @@ -4,14 +4,22 @@ group: Project Management info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Sorting and ordering issue lists **(FREE ALL)** +# Sorting and ordering issue lists + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed You can sort a list of issues several ways. The available sorting options can change based on the context of the list. -## Sorting by blocking issues **(PREMIUM ALL)** +## Sorting by blocking issues -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/34247/) in GitLab 13.7. +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/34247/) in GitLab 13.7. When you sort by **Blocking**, the issue list changes to sort descending by the number of issues each issue is [blocking](related_issues.md#blocking-issues). @@ -45,7 +53,7 @@ update. Issues changed the most recently are shown first. ## Manual sorting -> [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/issues/62178) in GitLab 12.2. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/issues/62178) in GitLab 12.2. When you sort by **Manual** order, you can change the order by dragging and dropping the issues. The changed order persists, and @@ -95,7 +103,7 @@ To learn how to change label priority, see [Label priority](../labels.md#set-lab ## Sorting by title -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/67234) in GitLab 14.3. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/67234) in GitLab 14.3. When you sort by **Title**, the issue order changes to sort alphabetically by the issue title in this order: @@ -105,9 +113,13 @@ title in this order: - Numbers - Letters: first Latin, then accented (for example, `ö`) -## Sorting by health status **(ULTIMATE ALL)** +## Sorting by health status -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/377841) in GitLab 15.7. +DETAILS: +**Tier:** Ultimate +**Offering:** SaaS, self-managed + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/377841) in GitLab 15.7. When you sort by **Health**, the issue list changes to sort by the [health status](managing_issues.md#health-status) of the issues diff --git a/doc/user/project/labels.md b/doc/user/project/labels.md index f064d867e0f..4857aba3839 100644 --- a/doc/user/project/labels.md +++ b/doc/user/project/labels.md @@ -4,7 +4,11 @@ group: Project Management info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Labels **(FREE ALL)** +# Labels + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed As your count of issues, merge requests, and epics grows in GitLab, it gets more challenging to keep track of those items. Especially as your organization grows from just a few people to @@ -150,7 +154,11 @@ To create a group label: a specific color in the **Background color** field. 1. Select **Create label**. -### Create a group label from an epic **(PREMIUM ALL)** +### Create a group label from an epic + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed You can also create a new group label from an epic. Labels you create this way belong to the same group as the epic. @@ -309,7 +317,11 @@ The following labels are created: - `suggestion` - `support` -## Scoped labels **(PREMIUM ALL)** +## Scoped labels + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed Teams can use scoped labels to annotate issues, merge requests, and epics with mutually exclusive labels. By preventing certain labels from being used together, you can create more complex workflows. @@ -331,7 +343,7 @@ the previous `key` label is replaced with the new label. ### Filter by scoped labels -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/12285) in GitLab 14.4. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/12285) in GitLab 14.4. To filter issue, merge request, or epic lists by a given scope, enter `::*` in the searched label name. @@ -451,9 +463,14 @@ The labels higher in the list get higher priority. To learn what happens when you sort by priority or label priority, see [Sorting and ordering issue lists](issues/sorting_issue_lists.md). -## Lock labels when a merge request is merged **(FREE SAAS BETA)** +## Lock labels when a merge request is merged -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/408676) in GitLab 16.3 [with a flag](../../administration/feature_flags.md) named `enforce_locked_labels_on_merge`. This feature is [Beta](../../policy/experiment-beta-support.md). +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS +**Status:** Beta + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/408676) in GitLab 16.3 [with a flag](../../administration/feature_flags.md) named `enforce_locked_labels_on_merge`. This feature is [Beta](../../policy/experiment-beta-support.md). FLAG: On self-managed GitLab, this feature is not available. diff --git a/doc/user/project/members/index.md b/doc/user/project/members/index.md index 66258c3873e..455d737820a 100644 --- a/doc/user/project/members/index.md +++ b/doc/user/project/members/index.md @@ -4,7 +4,11 @@ group: Tenant Scale info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Members of a project **(FREE ALL)** +# Members of a project + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed Members are the users and groups who have access to your project. diff --git a/doc/user/project/members/share_project_with_groups.md b/doc/user/project/members/share_project_with_groups.md index 420e51f580b..bdcfa9124a8 100644 --- a/doc/user/project/members/share_project_with_groups.md +++ b/doc/user/project/members/share_project_with_groups.md @@ -4,7 +4,11 @@ group: Tenant Scale info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Share a project with a group **(FREE ALL)** +# Share a project with a group + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed When you want a group to have access to your project, you can invite [a group](../../group/index.md) to the project. diff --git a/doc/user/project/merge_requests/ai_in_merge_requests.md b/doc/user/project/merge_requests/ai_in_merge_requests.md index 8be2d45f06b..bc8a8602be7 100644 --- a/doc/user/project/merge_requests/ai_in_merge_requests.md +++ b/doc/user/project/merge_requests/ai_in_merge_requests.md @@ -4,7 +4,12 @@ group: Code Review info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# GitLab Duo in merge requests **(ULTIMATE SAAS EXPERIMENT)** +# GitLab Duo in merge requests + +DETAILS: +**Tier:** Ultimate +**Offering:** SaaS +**Status**: Experiment AI-assisted features in merge requests are designed to provide contextually relevant information during the lifecycle of a merge request. @@ -12,7 +17,7 @@ Additional information on enabling these features and maturity can be found in o ## Fill in merge request templates -> [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/10591) in GitLab 16.3 as an [Experiment](../../../policy/experiment-beta-support.md#experiment). +> - [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/10591) in GitLab 16.3 as an [Experiment](../../../policy/experiment-beta-support.md#experiment). This feature is an [Experiment](../../../policy/experiment-beta-support.md) on GitLab.com. @@ -38,7 +43,7 @@ Provide feedback on this experimental feature in [issue 416537](https://gitlab.c ## Summarize merge request changes -> [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/10401) in GitLab 16.2 as an [Experiment](../../../policy/experiment-beta-support.md#experiment). +> - [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/10401) in GitLab 16.2 as an [Experiment](../../../policy/experiment-beta-support.md#experiment). This feature is an [Experiment](../../../policy/experiment-beta-support.md) on GitLab.com. @@ -54,7 +59,7 @@ Provide feedback on this experimental feature in [issue 408726](https://gitlab.c ## Summarize my merge request review -> [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/10466) in GitLab 16.0 as an [Experiment](../../../policy/experiment-beta-support.md#experiment). +> - [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/10466) in GitLab 16.0 as an [Experiment](../../../policy/experiment-beta-support.md#experiment). This feature is an [Experiment](../../../policy/experiment-beta-support.md) on GitLab.com. @@ -75,7 +80,7 @@ Provide feedback on this experimental feature in [issue 408991](https://gitlab.c ## Generate messages for merge or squash commits -> [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/10453) in GitLab 16.2 as an [Experiment](../../../policy/experiment-beta-support.md#experiment). +> - [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/10453) in GitLab 16.2 as an [Experiment](../../../policy/experiment-beta-support.md#experiment). This feature is an [Experiment](../../../policy/experiment-beta-support.md) on GitLab.com. diff --git a/doc/user/project/merge_requests/allow_collaboration.md b/doc/user/project/merge_requests/allow_collaboration.md index 225ca0cc10d..cc4b5f5011f 100644 --- a/doc/user/project/merge_requests/allow_collaboration.md +++ b/doc/user/project/merge_requests/allow_collaboration.md @@ -4,7 +4,11 @@ group: Code Review info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Collaborate on merge requests across forks **(FREE ALL)** +# Collaborate on merge requests across forks + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed When you open a merge request from your [fork](../repository/forking_workflow.md), you can allow upstream members to collaborate with you on your branch. @@ -19,7 +23,7 @@ This feature is available for merge requests across forked projects that are ## Allow commits from upstream members -> Enabled by default in [GitLab 13.7 and later](https://gitlab.com/gitlab-org/gitlab/-/issues/23308). +> - Enabled by default in [GitLab 13.7 and later](https://gitlab.com/gitlab-org/gitlab/-/issues/23308). As the author of a merge request, you can allow commit edits from upstream members of the project you're contributing to: diff --git a/doc/user/project/merge_requests/approvals/index.md b/doc/user/project/merge_requests/approvals/index.md index bf4e2e8334e..9039f6fdc0d 100644 --- a/doc/user/project/merge_requests/approvals/index.md +++ b/doc/user/project/merge_requests/approvals/index.md @@ -4,7 +4,11 @@ group: Source Code info: "To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments" --- -# Merge request approvals **(FREE ALL)** +# Merge request approvals + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed You can configure your merge requests so that they must be approved before they can be merged. While [GitLab Free](https://about.gitlab.com/pricing/) allows @@ -83,9 +87,13 @@ GitLab allows all users with Developer or greater [permissions](../../../permiss to approve merge requests. Approvals in GitLab Free are optional, and don't prevent a merge request from merging without approval. -## Required approvals **(PREMIUM ALL)** +## Required approvals -> Moved to GitLab Premium in 13.9. +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed + +> - Moved to GitLab Premium in 13.9. Required approvals enforce code reviews by the number and type of users you specify. Without the approvals, the work cannot merge. Required approvals enable multiple use cases: diff --git a/doc/user/project/merge_requests/approvals/rules.md b/doc/user/project/merge_requests/approvals/rules.md index 2f1e2a96295..67215219c61 100644 --- a/doc/user/project/merge_requests/approvals/rules.md +++ b/doc/user/project/merge_requests/approvals/rules.md @@ -4,7 +4,11 @@ group: Source Code info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Merge request approval rules **(PREMIUM ALL)** +# Merge request approval rules + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed Approval rules define how many [approvals](index.md) a merge request must receive before it can be merged, and which users should do the approving. They can be used in conjunction @@ -176,7 +180,7 @@ to use a single license. ### Code owners as eligible approvers -> Moved to GitLab Premium in 13.9. +> - Moved to GitLab Premium in 13.9. If you add [code owners](../../codeowners/index.md) to your repository, the owners of files become eligible approvers in the project. To enable this merge request approval rule: @@ -256,7 +260,7 @@ appreciated, but not required. To make an approval rule optional: ## Approvals for protected branches -> **All protected branches** target branch option [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/360930) in GitLab 15.3. +> - **All protected branches** target branch option [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/360930) in GitLab 15.3. Approval rules are often relevant only to specific branches, like your [default branch](../../repository/branches/default.md). To configure an @@ -279,7 +283,11 @@ coverage. For more information, see [Coverage check approval rule](../../../../ci/testing/code_coverage.md#coverage-check-approval-rule). -## Security Approvals **(ULTIMATE ALL)** +## Security Approvals + +DETAILS: +**Tier:** Ultimate +**Offering:** SaaS, self-managed > - Security approvals moved to merge request approvals settings [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/357021) in GitLab 15.0. > - Bot comment for approvals [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/411656) in GitLab 16.2 [with a flag](../../../../administration/feature_flags.md) named `security_policy_approval_notification`. Enabled by default. diff --git a/doc/user/project/merge_requests/approvals/settings.md b/doc/user/project/merge_requests/approvals/settings.md index 0120be0cf17..4c33f6eb371 100644 --- a/doc/user/project/merge_requests/approvals/settings.md +++ b/doc/user/project/merge_requests/approvals/settings.md @@ -4,7 +4,11 @@ group: Source Code info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Merge request approval settings **(PREMIUM ALL)** +# Merge request approval settings + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed You can configure the settings for [merge request approvals](index.md) to ensure the approval rules meet your use case. You can also configure @@ -42,7 +46,7 @@ These settings limit who can approve merge requests: ## Prevent approval by author -> Moved to GitLab Premium in 13.9. +> - Moved to GitLab Premium in 13.9. By default, the author of a merge request cannot approve it. To change this setting: @@ -162,7 +166,7 @@ However, approvals are reset if the target branch is changed. ## Remove approvals by Code Owners if their files changed -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/90578) in GitLab 15.3. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/90578) in GitLab 15.3. If you only want to remove approvals by Code Owners whose files have been changed when a commit is added: diff --git a/doc/user/project/merge_requests/authorization_for_merge_requests.md b/doc/user/project/merge_requests/authorization_for_merge_requests.md index f0f2d3777f1..1cfd66f5b2b 100644 --- a/doc/user/project/merge_requests/authorization_for_merge_requests.md +++ b/doc/user/project/merge_requests/authorization_for_merge_requests.md @@ -4,7 +4,11 @@ group: Code Review info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Merge request workflows **(FREE ALL)** +# Merge request workflows + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed There are two main ways to have a merge request flow with GitLab: diff --git a/doc/user/project/merge_requests/changes.md b/doc/user/project/merge_requests/changes.md index b7b6db0d22a..890503eacbe 100644 --- a/doc/user/project/merge_requests/changes.md +++ b/doc/user/project/merge_requests/changes.md @@ -4,7 +4,11 @@ group: Code Review info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Changes in merge requests **(FREE ALL)** +# Changes in merge requests + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed A [merge request](index.md) proposes a set of changes to files in a branch in your repository. These changes are shown as a _diff_ (difference) between the current state and the proposed @@ -34,9 +38,13 @@ To view the diff of changes included in a merge request: Files with many changes are collapsed to improve performance. GitLab displays the message: **Some changes are not shown**. To view the changes for that file, select **Expand file**. -### Collapse generated files **(FREE SELF)** +### Collapse generated files -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/140180) in GitLab 16.8 [with a flag](../../../administration/feature_flags.md) named `collapse_generated_diff_files`. Disabled by default. +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/140180) in GitLab 16.8 [with a flag](../../../administration/feature_flags.md) named `collapse_generated_diff_files`. Disabled by default. FLAG: On self-managed GitLab, by default this feature is not available. To make it available, @@ -222,7 +230,11 @@ per conflicted file on the merge request diff: ![Example of a conflict alert shown in a merge request diff](img/conflict_ui_v15_6.png) -## Show scanner findings in diff **(ULTIMATE ALL)** +## Show scanner findings in diff + +DETAILS: +**Tier:** Ultimate +**Offering:** SaaS, self-managed You can show scanner findings in the diff. For details, see: diff --git a/doc/user/project/merge_requests/cherry_pick_changes.md b/doc/user/project/merge_requests/cherry_pick_changes.md index 069e3cc5ebd..a1a184953f2 100644 --- a/doc/user/project/merge_requests/cherry_pick_changes.md +++ b/doc/user/project/merge_requests/cherry_pick_changes.md @@ -4,7 +4,11 @@ group: Source Code info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Cherry-pick changes **(FREE ALL)** +# Cherry-pick changes + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed > Feature flag `pick_into_project` [removed](https://gitlab.com/gitlab-org/gitlab/-/issues/324154) in GitLab 14.0. diff --git a/doc/user/project/merge_requests/commit_templates.md b/doc/user/project/merge_requests/commit_templates.md index 2f4dae5178a..05605771d9d 100644 --- a/doc/user/project/merge_requests/commit_templates.md +++ b/doc/user/project/merge_requests/commit_templates.md @@ -4,7 +4,11 @@ group: Code Review info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Commit message templates **(FREE ALL)** +# Commit message templates + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/20263) in GitLab 14.5. > - Squash commit templates [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/345275) in GitLab 14.6. diff --git a/doc/user/project/merge_requests/commits.md b/doc/user/project/merge_requests/commits.md index f446750352e..ce3dbd46734 100644 --- a/doc/user/project/merge_requests/commits.md +++ b/doc/user/project/merge_requests/commits.md @@ -4,7 +4,11 @@ group: Code Review info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Merge request commits **(FREE ALL)** +# Merge request commits + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed Each merge request has a history of the commits made to the source branch after the merge request was created. diff --git a/doc/user/project/merge_requests/confidential.md b/doc/user/project/merge_requests/confidential.md index 1067beef909..75a8a970165 100644 --- a/doc/user/project/merge_requests/confidential.md +++ b/doc/user/project/merge_requests/confidential.md @@ -4,9 +4,13 @@ group: Code Review info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Merge requests for confidential issues **(FREE ALL)** +# Merge requests for confidential issues -> [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/issues/58583) in GitLab 12.1. +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/issues/58583) in GitLab 12.1. Merge requests in a public repository are also public, even when the merge request is created for a [confidential issue](../issues/confidential_issues.md). diff --git a/doc/user/project/merge_requests/conflicts.md b/doc/user/project/merge_requests/conflicts.md index 53d1269a940..0424e5b8772 100644 --- a/doc/user/project/merge_requests/conflicts.md +++ b/doc/user/project/merge_requests/conflicts.md @@ -4,7 +4,11 @@ group: Code Review info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Merge conflicts **(FREE ALL)** +# Merge conflicts + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed Merge conflicts happen when the two branches in a merge request (the source and target) each have different changes, and you must decide which change to accept. In a merge request, Git compares diff --git a/doc/user/project/merge_requests/creating_merge_requests.md b/doc/user/project/merge_requests/creating_merge_requests.md index d2c5b0af339..2d973f4b52b 100644 --- a/doc/user/project/merge_requests/creating_merge_requests.md +++ b/doc/user/project/merge_requests/creating_merge_requests.md @@ -5,7 +5,11 @@ info: To determine the technical writer assigned to the Stage/Group associated w description: "How to create merge requests in GitLab." --- -# Creating merge requests **(FREE ALL)** +# Creating merge requests + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed GitLab provides many different ways to create a merge request. @@ -30,7 +34,7 @@ already exists for this branch, a link to the existing merge request is shown. ## From an issue -> [Changed](https://gitlab.com/gitlab-org/gitlab/-/issues/349566) the behavior of the **Create merge request** button to open the merge request creation form in GitLab 14.8. +> - [Changed](https://gitlab.com/gitlab-org/gitlab/-/issues/349566) the behavior of the **Create merge request** button to open the merge request creation form in GitLab 14.8. If your development workflow requires an issue for every merge request, you can create a branch directly from the issue to speed the process up. diff --git a/doc/user/project/merge_requests/csv_export.md b/doc/user/project/merge_requests/csv_export.md index 4f22b2ab273..e417ec72f66 100644 --- a/doc/user/project/merge_requests/csv_export.md +++ b/doc/user/project/merge_requests/csv_export.md @@ -4,9 +4,13 @@ group: Compliance info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Export merge requests to CSV **(FREE ALL)** +# Export merge requests to CSV -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/3619) in GitLab 13.6. +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/3619) in GitLab 13.6. Export all the data collected from a project's merge requests into a comma-separated values (CSV) file. diff --git a/doc/user/project/merge_requests/dependencies.md b/doc/user/project/merge_requests/dependencies.md index 25e967a8f86..8667c76316c 100644 --- a/doc/user/project/merge_requests/dependencies.md +++ b/doc/user/project/merge_requests/dependencies.md @@ -4,7 +4,11 @@ group: Code Review info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Merge request dependencies **(PREMIUM ALL)** +# Merge request dependencies + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed > - Support for complex merge dependencies [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/11393) in GitLab 16.6 [with a flag](../../../administration/feature_flags.md) named `remove_mr_blocking_constraints`. Disabled by default. > - Support for complex merge dependencies [generally available](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/136775) in GitLab 16.7. Feature flag `remove_mr_blocking_constraints` removed. diff --git a/doc/user/project/merge_requests/drafts.md b/doc/user/project/merge_requests/drafts.md index 67d24e72fed..0ca1b509d48 100644 --- a/doc/user/project/merge_requests/drafts.md +++ b/doc/user/project/merge_requests/drafts.md @@ -4,7 +4,11 @@ group: Code Review info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Draft merge requests **(FREE ALL)** +# Draft merge requests + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed If a merge request isn't ready to merge, you can block it from merging until you [mark it as ready](#mark-merge-requests-as-ready). Merge requests marked as **Draft** @@ -15,7 +19,7 @@ cannot merge until the **Draft** flag is removed, even if all other merge criter ## Mark merge requests as drafts > - [Removed](https://gitlab.com/gitlab-org/gitlab/-/issues/228685) all support for the term **WIP** in GitLab 14.8. -> `/draft` quick action as a toggle [deprecated](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/92654) in GitLab 15.4. +> - `/draft` quick action as a toggle [deprecated](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/92654) in GitLab 15.4. > - [Changed](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/108073) the draft status to use a checkbox in GitLab 15.8. You can flag a merge request as a draft in several ways: diff --git a/doc/user/project/merge_requests/index.md b/doc/user/project/merge_requests/index.md index 345d937ed8c..67032f804d1 100644 --- a/doc/user/project/merge_requests/index.md +++ b/doc/user/project/merge_requests/index.md @@ -4,7 +4,11 @@ group: Code Review info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Merge requests **(FREE ALL)** +# Merge requests + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed A merge request (MR) is a proposal to incorporate changes from a source branch to a target branch. @@ -93,9 +97,9 @@ To filter the list of merge requests: - [**By environment or deployment date**](#by-environment-or-deployment-date). - **ID**: Enter filter `#30` to return only merge request 30. - User filters: Type (or select from the dropdown list) any of these filters to display a list of users: - - **Approved-By**, for merge requests already approved by a user. **(PREMIUM ALL)**. + - **Approved-By**, for merge requests already approved by a user. Premium and Ultimate only. - **Approver**, for merge requests that this user is eligible to approve. - (For more information, read about [Code owners](../codeowners/index.md)). **(PREMIUM ALL)** + (For more information, read about [Code owners](../codeowners/index.md)). Premium and Ultimate only. - **Merged-By**, for merge requests merged by this user. - **Reviewer**, for merge requests reviewed by this user. 1. Select or type the operator to use for filtering the attribute. The following operators are @@ -111,7 +115,7 @@ To filter the list of merge requests: ### By environment or deployment date -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/44041) in GitLab 13.6. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/44041) in GitLab 13.6. To filter merge requests by deployment data, such as the environment or a date, you can type (or select from the dropdown list) the following: @@ -166,9 +170,13 @@ a merge request, or: The merge request is added to the user's assigned merge request list. -### Assign multiple users **(PREMIUM ALL)** +### Assign multiple users -> Moved to GitLab Premium in 13.9. +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed + +> - Moved to GitLab Premium in 13.9. GitLab enables multiple assignees for merge requests, if multiple people are accountable for it: @@ -224,7 +232,11 @@ You can delete the source branch for a merge request: An administrator can make this option the default in the project's settings. -### Update merge requests when target branch merges **(FREE SELF)** +### Update merge requests when target branch merges + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/320902) in GitLab 13.9. > - [Disabled on self-managed](https://gitlab.com/gitlab-org/gitlab/-/issues/320902) in GitLab 13.9. @@ -339,7 +351,7 @@ sort order by clicking the sort button on the right. ## Resolve a thread -> Resolving comments individually was [removed](https://gitlab.com/gitlab-org/gitlab/-/issues/28750) in GitLab 13.6. +> - Resolving comments individually was [removed](https://gitlab.com/gitlab-org/gitlab/-/issues/28750) in GitLab 13.6. In a merge request, you can [resolve a thread](../../discussions/index.md#resolve-a-thread) when you want to finish a conversation. @@ -394,7 +406,11 @@ with a new push. Threads are now resolved if a push makes a diff section outdated. Threads on lines that don't change and top-level resolvable threads are not resolved. -## Move notifications and to-dos **(FREE SELF)** +## Move notifications and to-dos + +DETAILs: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/132678) in GitLab 16.5 [with a flag](../../../administration/feature_flags.md) named `notifications_todos_buttons`. Disabled by default. > - [Issues, incidents](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/133474), and [epics](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/133881) also updated. @@ -422,7 +438,11 @@ When this feature flag is enabled, the notifications and to-do item buttons are ## Troubleshooting -### Rebase a merge request from the Rails console **(FREE SELF)** +### Rebase a merge request from the Rails console + +DETAILS: +**tier:** Free, Premium, Ultimate +**Offering:** Self-managed In addition to the `/rebase` [quick action](../quick_actions.md#issues-merge-requests-and-epics), users with access to the [Rails console](../../../administration/operations/rails_console.md) @@ -441,7 +461,11 @@ m = p.merge_requests.find_by(iid: ) MergeRequests::RebaseService.new(project: m.target_project, current_user: u).execute(m) ``` -### Fix incorrect merge request status **(FREE SELF)** +### Fix incorrect merge request status + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed If a merge request remains **Open** after its changes are merged, users with access to the [Rails console](../../../administration/operations/rails_console.md) @@ -463,7 +487,11 @@ MergeRequests::PostMergeService.new(project: p, current_user: u).execute(m) Running this command against a merge request with unmerged changes causes the merge request to display an incorrect message: `merged into `. -### Close a merge request from the Rails console **(FREE SELF)** +### Close a merge request from the Rails console + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed If closing a merge request doesn't work through the UI or API, you might want to attempt to close it in a [Rails console session](../../../administration/operations/rails_console.md#starting-a-rails-console-session): @@ -477,7 +505,11 @@ m = p.merge_requests.find_by(iid: ) MergeRequests::CloseService.new(project: p, current_user: u).execute(m) ``` -### Delete a merge request from the Rails console **(FREE SELF)** +### Delete a merge request from the Rails console + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed If deleting a merge request doesn't work through the UI or API, you might want to attempt to delete it in a [Rails console session](../../../administration/operations/rails_console.md#starting-a-rails-console-session): diff --git a/doc/user/project/merge_requests/merge_when_pipeline_succeeds.md b/doc/user/project/merge_requests/merge_when_pipeline_succeeds.md index 3a2729bd64b..8b1538e8205 100644 --- a/doc/user/project/merge_requests/merge_when_pipeline_succeeds.md +++ b/doc/user/project/merge_requests/merge_when_pipeline_succeeds.md @@ -4,9 +4,13 @@ group: Code Review info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Auto-merge **(FREE ALL)** +# Auto-merge -> **Merge when pipeline succeeds** and **Add to merge train when pipeline succeeds** [renamed](https://gitlab.com/gitlab-org/gitlab/-/issues/409530) to **Auto-merge** in GitLab 16.0 [with a flag](../../../administration/feature_flags.md) named `auto_merge_labels_mr_widget`. Enabled by default. +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed + +> - **Merge when pipeline succeeds** and **Add to merge train when pipeline succeeds** [renamed](https://gitlab.com/gitlab-org/gitlab/-/issues/409530) to **Auto-merge** in GitLab 16.0 [with a flag](../../../administration/feature_flags.md) named `auto_merge_labels_mr_widget`. Enabled by default. If you review a merge request and it's ready to merge, but the pipeline hasn't completed yet, you can set it to auto-merge. You don't @@ -106,7 +110,7 @@ despite a newer but failed branch pipeline. ### Allow merge after skipped pipelines -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/211482) in GitLab 13.1. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/211482) in GitLab 13.1. When the **Pipelines must succeed** checkbox is checked, [skipped pipelines](../../../ci/pipelines/index.md#skip-a-pipeline) prevent diff --git a/doc/user/project/merge_requests/methods/index.md b/doc/user/project/merge_requests/methods/index.md index dd70052cd31..1ace3605c87 100644 --- a/doc/user/project/merge_requests/methods/index.md +++ b/doc/user/project/merge_requests/methods/index.md @@ -4,7 +4,11 @@ group: Source Code info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Merge methods **(FREE ALL)** +# Merge methods + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed The merge method you select for your project determines how the changes in your merge requests are merged into an existing branch. diff --git a/doc/user/project/merge_requests/revert_changes.md b/doc/user/project/merge_requests/revert_changes.md index 96bf071cf02..4385bdfbbac 100644 --- a/doc/user/project/merge_requests/revert_changes.md +++ b/doc/user/project/merge_requests/revert_changes.md @@ -4,7 +4,11 @@ group: Code Review info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Revert changes **(FREE ALL)** +# Revert changes + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed You can revert individual commits or an entire merge request in GitLab. When you revert a commit in Git, you create a new commit that reverses all actions diff --git a/doc/user/project/merge_requests/reviews/data_usage.md b/doc/user/project/merge_requests/reviews/data_usage.md index 0499e5a0bb7..9931ebd2ca5 100644 --- a/doc/user/project/merge_requests/reviews/data_usage.md +++ b/doc/user/project/merge_requests/reviews/data_usage.md @@ -4,7 +4,11 @@ group: AI Model Validation info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Suggested Reviewers Data Usage **(ULTIMATE SAAS)** +# Suggested Reviewers Data Usage + +DETAILS: +**Tier:** Ultimate +**Offering:** SaaS ## How it works diff --git a/doc/user/project/merge_requests/reviews/index.md b/doc/user/project/merge_requests/reviews/index.md index 78e4c19dd57..acf833cc815 100644 --- a/doc/user/project/merge_requests/reviews/index.md +++ b/doc/user/project/merge_requests/reviews/index.md @@ -4,7 +4,11 @@ group: Code Review info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Merge request reviews **(FREE ALL)** +# Merge request reviews + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed [Merge requests](../index.md) are the primary method of making changes to files in a GitLab project. [Create and submit a merge request](../creating_merge_requests.md) @@ -21,7 +25,11 @@ review merge requests in Visual Studio Code. For an overview, see [Merge request review](https://www.youtube.com/watch?v=2MayfXKpU08&list=PLFGfElNsQthYDx0A_FaNNfUm9NHsK6zED&index=183). -## GitLab Duo Suggested Reviewers **(ULTIMATE SAAS)** +## GitLab Duo Suggested Reviewers + +DETAILS: +**Tier:** Ultimate +**Offering:** SaaS > - [Introduced](https://gitlab.com/groups/gitlab-org/modelops/applied-ml/review-recommender/-/epics/3) in GitLab 15.4 as a [Beta](../../../../policy/experiment-beta-support.md#beta) feature [with a flag](../../../../administration/feature_flags.md) named `suggested_reviewers_control`. Disabled by default. > - [Enabled on GitLab.com](https://gitlab.com/gitlab-org/gitlab/-/issues/368356) in GitLab 15.6. @@ -98,9 +106,13 @@ the merge request, use the `/assign_reviewer @user` The merge request is added to the user's review requests. -#### From multiple users **(PREMIUM ALL)** +#### From multiple users -> Moved to GitLab Premium in 13.9. +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed + +> - Moved to GitLab Premium in 13.9. To assign multiple reviewers to a merge request, in a text area in the merge request, use the `/assign_reviewer @user` @@ -200,7 +212,11 @@ If you have a review in progress, you can also add a comment from the **Overview ![New thread](img/mr_review_new_comment_v16_6.png) -### Approval Rule information for Reviewers **(PREMIUM ALL)** +### Approval Rule information for Reviewers + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed When editing the **Reviewers** field in a new or existing merge request, GitLab displays the name of the matching [approval rule](../approvals/rules.md) @@ -266,7 +282,11 @@ To update multiple project merge requests at the same time: 1. Select the appropriate fields and their values from the sidebar. 1. Select **Update all**. -## Bulk edit merge requests at the group level **(PREMIUM ALL)** +## Bulk edit merge requests at the group level + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed Users with at least the Developer role can manage merge requests. diff --git a/doc/user/project/merge_requests/reviews/suggestions.md b/doc/user/project/merge_requests/reviews/suggestions.md index 908e8c67c3b..752a24e6729 100644 --- a/doc/user/project/merge_requests/reviews/suggestions.md +++ b/doc/user/project/merge_requests/reviews/suggestions.md @@ -4,7 +4,11 @@ group: Code Review info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Suggest changes **(FREE ALL)** +# Suggest changes + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed Reviewers can suggest code changes with a Markdown syntax in merge request diff threads. The merge request author (or other users with the appropriate role) can apply any or @@ -171,7 +175,7 @@ For example, to customize the commit message to output ## Batch suggestions -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/326168) custom commit messages for batch suggestions in GitLab 14.4. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/326168) custom commit messages for batch suggestions in GitLab 14.4. Prerequisites: diff --git a/doc/user/project/merge_requests/squash_and_merge.md b/doc/user/project/merge_requests/squash_and_merge.md index d7635763f9e..91baef1cac3 100644 --- a/doc/user/project/merge_requests/squash_and_merge.md +++ b/doc/user/project/merge_requests/squash_and_merge.md @@ -4,7 +4,11 @@ group: Source Code info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Squash and merge **(FREE ALL)** +# Squash and merge + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed As you work on a feature branch, you often create small, self-contained commits. These small commits help describe the process of building a feature, but can clutter your Git history after the feature diff --git a/doc/user/project/merge_requests/status_checks.md b/doc/user/project/merge_requests/status_checks.md index b13f0a70295..30f36d8165d 100644 --- a/doc/user/project/merge_requests/status_checks.md +++ b/doc/user/project/merge_requests/status_checks.md @@ -4,7 +4,11 @@ group: Compliance info: "To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments" --- -# External status checks **(ULTIMATE ALL)** +# External status checks + +DETAILS: +**Tier:** Ultimate +**Offering:** SaaS, self-managed > - [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/3869) in GitLab 14.0, disabled behind the `:ff_external_status_checks` feature flag. > - [Feature flag removed](https://gitlab.com/gitlab-org/gitlab/-/issues/320783) in GitLab 14.1. diff --git a/doc/user/project/merge_requests/versions.md b/doc/user/project/merge_requests/versions.md index 62cee897b49..ca4e1e81087 100644 --- a/doc/user/project/merge_requests/versions.md +++ b/doc/user/project/merge_requests/versions.md @@ -4,7 +4,11 @@ group: Code Review info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Merge request diff versions **(FREE ALL)** +# Merge request diff versions + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed When you create a merge request, you select two branches to compare. The differences between the two branches are shown as a **diff** in the merge request. Each time diff --git a/doc/user/project/merge_requests/widgets.md b/doc/user/project/merge_requests/widgets.md index a6680e5e4f4..a79b6df12e7 100644 --- a/doc/user/project/merge_requests/widgets.md +++ b/doc/user/project/merge_requests/widgets.md @@ -4,7 +4,11 @@ group: Code Review info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Merge request widgets **(FREE ALL)** +# Merge request widgets + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed The **Overview** page of a merge request displays status updates from services that perform actions on your merge request. All subscription levels display a @@ -62,13 +66,21 @@ faster to preview proposed modifications. [Read more about Review Apps](../../../ci/review_apps/index.md). -## License compliance **(ULTIMATE ALL)** +## License compliance + +DETAILS: +**Tier:** Ultimate +**Offering:** SaaS, self-managed If you have configured [License Compliance](../../compliance/license_scanning_of_cyclonedx_files/index.md) for your project, then you can view a list of licenses that are detected for your project's dependencies. ![Merge request pipeline](img/license_compliance_widget_v15_3.png) -## External status checks **(ULTIMATE ALL)** +## External status checks + +DETAILS: +**Tier:** Ultimate +**Offering:** SaaS, self-managed If you have configured [external status checks](status_checks.md) you can see the status of these checks in merge requests diff --git a/doc/user/project/milestones/burndown_and_burnup_charts.md b/doc/user/project/milestones/burndown_and_burnup_charts.md index b67078614a8..73f896bca3f 100644 --- a/doc/user/project/milestones/burndown_and_burnup_charts.md +++ b/doc/user/project/milestones/burndown_and_burnup_charts.md @@ -4,7 +4,11 @@ group: Project Management info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Burndown and burnup charts **(PREMIUM ALL)** +# Burndown and burnup charts + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed [Burndown](#burndown-charts) and [burnup](#burnup-charts) charts show the progress of completing a milestone. diff --git a/doc/user/project/milestones/index.md b/doc/user/project/milestones/index.md index f4df178794d..938074d9423 100644 --- a/doc/user/project/milestones/index.md +++ b/doc/user/project/milestones/index.md @@ -4,7 +4,11 @@ group: Project Management info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Milestones **(FREE ALL)** +# Milestones + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed Milestones in GitLab are a way to track issues and merge requests created to achieve a broader goal in a certain period of time. @@ -110,7 +114,7 @@ The milestone sidebar on the milestone view shows the following: ## Create a milestone -> [Changed](https://gitlab.com/gitlab-org/gitlab/-/issues/343889) the minimum user role from Developer to Reporter in GitLab 15.0. +> - [Changed](https://gitlab.com/gitlab-org/gitlab/-/issues/343889) the minimum user role from Developer to Reporter in GitLab 15.0. You can create a milestone either in a project or a group. @@ -131,7 +135,7 @@ To create a milestone: ## Edit a milestone -> [Changed](https://gitlab.com/gitlab-org/gitlab/-/issues/343889) the minimum user role from Developer to Reporter in GitLab 15.0. +> - [Changed](https://gitlab.com/gitlab-org/gitlab/-/issues/343889) the minimum user role from Developer to Reporter in GitLab 15.0. Prerequisites: @@ -148,7 +152,7 @@ To edit a milestone: ## Delete a milestone -> [Changed](https://gitlab.com/gitlab-org/gitlab/-/issues/343889) the minimum user role from Developer to Reporter in GitLab 15.0. +> - [Changed](https://gitlab.com/gitlab-org/gitlab/-/issues/343889) the minimum user role from Developer to Reporter in GitLab 15.0. Prerequisites: diff --git a/doc/user/project/ml/experiment_tracking/index.md b/doc/user/project/ml/experiment_tracking/index.md index 0aad9a69743..86860083bef 100644 --- a/doc/user/project/ml/experiment_tracking/index.md +++ b/doc/user/project/ml/experiment_tracking/index.md @@ -4,7 +4,11 @@ group: Incubation info: Machine Learning Experiment Tracking is a GitLab Incubation Engineering program. No technical writer assigned to this group. --- -# Machine learning model experiments **(FREE ALL)** +# Machine learning model experiments + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed > - [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/9341) in GitLab 15.11 as an [Experiment](../../../../policy/experiment-beta-support.md#experiment) release [with a flag](../../../../administration/feature_flags.md) named `ml_experiment_tracking`. Disabled by default. To enable the feature, an administrator can [enable the feature flag](../../../../administration/feature_flags.md) named `ml_experiment_tracking`. > - [Generally available](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/95373) in GitLab 16.2. @@ -84,7 +88,7 @@ IID. The link to the artifacts can also be accessed from the **Experiment Candid ## View CI information -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/119788) in 16.1 +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/119788) in 16.1 Candidates can be associated to the CI job that created them, allowing quick links to the merge request, pipeline, and user that triggered the pipeline: diff --git a/doc/user/project/ml/experiment_tracking/mlflow_client.md b/doc/user/project/ml/experiment_tracking/mlflow_client.md index 1522fd8e4fc..d52e2c2fae1 100644 --- a/doc/user/project/ml/experiment_tracking/mlflow_client.md +++ b/doc/user/project/ml/experiment_tracking/mlflow_client.md @@ -4,9 +4,14 @@ group: MLOps info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# MLflow client compatibility **(FREE ALL EXPERIMENT)** +# MLflow client compatibility -> [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/8560) in GitLab 15.11 as an [Experiment](../../../../policy/experiment-beta-support.md#experiment) release [with a flag](../../../../administration/feature_flags.md) named `ml_experiment_tracking`. Disabled by default. +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed +**Status:** Experiment + +> - [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/8560) in GitLab 15.11 as an [Experiment](../../../../policy/experiment-beta-support.md#experiment) release [with a flag](../../../../administration/feature_flags.md) named `ml_experiment_tracking`. Disabled by default. NOTE: Model registry and model experiment tracking are [Experiments](../../../../policy/experiment-beta-support.md). @@ -53,7 +58,7 @@ Runs are registered as candidates, which can be explored by selecting an experim ### Associating a candidate to a CI/CD job -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/119454) in GitLab 16.1. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/119454) in GitLab 16.1. If your training code is being run from a CI/CD job, GitLab can use that information to enhance candidate metadata. To associate a candidate to a CI/CD job: diff --git a/doc/user/project/ml/model_registry/index.md b/doc/user/project/ml/model_registry/index.md index 026afc01f22..d9110cb2cb6 100644 --- a/doc/user/project/ml/model_registry/index.md +++ b/doc/user/project/ml/model_registry/index.md @@ -4,9 +4,14 @@ group: MLOps info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Model registry **(FREE ALL EXPERIMENT)** +# Model registry -> [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/9423) in GitLab 16.8 as an [Experiment](../../../../policy/experiment-beta-support.md#experiment) release [with a flag](../../../../administration/feature_flags.md) named `ml_experiment_tracking`. Disabled by default. To enable the feature, an administrator can [enable the feature flag](../../../../administration/feature_flags.md) named `model_registry`. +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed +**Status:** Experiment + +> - [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/9423) in GitLab 16.8 as an [Experiment](../../../../policy/experiment-beta-support.md#experiment) release [with a flag](../../../../administration/feature_flags.md) named `ml_experiment_tracking`. Disabled by default. To enable the feature, an administrator can [enable the feature flag](../../../../administration/feature_flags.md) named `model_registry`. NOTE: Model registry is an [Experiment](../../../../policy/experiment-beta-support.md). [Provide feedback](https://gitlab.com/groups/gitlab-org/-/epics/9423). diff --git a/doc/user/project/organize_work_with_projects.md b/doc/user/project/organize_work_with_projects.md index 1371f5e77d0..89cc2196adc 100644 --- a/doc/user/project/organize_work_with_projects.md +++ b/doc/user/project/organize_work_with_projects.md @@ -5,7 +5,11 @@ description: Project visibility, search, badges, layout. info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Organize work with projects **(FREE ALL)** +# Organize work with projects + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed In GitLab, you can create projects to host your codebase. You can also use projects to track issues, plan work, diff --git a/doc/user/project/pages/custom_domains_ssl_tls_certification/dns_concepts.md b/doc/user/project/pages/custom_domains_ssl_tls_certification/dns_concepts.md index 5f55aca93b0..677c1af47cb 100644 --- a/doc/user/project/pages/custom_domains_ssl_tls_certification/dns_concepts.md +++ b/doc/user/project/pages/custom_domains_ssl_tls_certification/dns_concepts.md @@ -4,7 +4,11 @@ group: Knowledge info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# GitLab Pages DNS records **(FREE ALL)** +# GitLab Pages DNS records + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed A Domain Name System (DNS) web service routes visitors to websites by translating domain names (such as `www.example.com`) into the diff --git a/doc/user/project/pages/custom_domains_ssl_tls_certification/index.md b/doc/user/project/pages/custom_domains_ssl_tls_certification/index.md index b34369cb3b7..25722e18fcf 100644 --- a/doc/user/project/pages/custom_domains_ssl_tls_certification/index.md +++ b/doc/user/project/pages/custom_domains_ssl_tls_certification/index.md @@ -4,9 +4,13 @@ group: Knowledge info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# GitLab Pages custom domains **(FREE ALL)** +# GitLab Pages custom domains -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/238461) in GitLab 15.4, you can use verified domains to [bypass user email confirmation for SAML- or SCIM-provisioned users](../../../group/saml_sso/index.md#bypass-user-email-confirmation-with-verified-domains). +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/238461) in GitLab 15.4, you can use verified domains to [bypass user email confirmation for SAML- or SCIM-provisioned users](../../../group/saml_sso/index.md#bypass-user-email-confirmation-with-verified-domains). You can use custom domains: diff --git a/doc/user/project/pages/custom_domains_ssl_tls_certification/lets_encrypt_integration.md b/doc/user/project/pages/custom_domains_ssl_tls_certification/lets_encrypt_integration.md index 6ccd3033b57..9481317b682 100644 --- a/doc/user/project/pages/custom_domains_ssl_tls_certification/lets_encrypt_integration.md +++ b/doc/user/project/pages/custom_domains_ssl_tls_certification/lets_encrypt_integration.md @@ -5,9 +5,13 @@ group: Knowledge info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# GitLab Pages Let's Encrypt certificates **(FREE ALL)** +# GitLab Pages Let's Encrypt certificates -> [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/issues/28996) in GitLab 12.1. +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/issues/28996) in GitLab 12.1. The GitLab Pages integration with Let's Encrypt (LE) allows you to use LE certificates for your Pages website with custom domains @@ -18,7 +22,9 @@ GitLab does it for you, out-of-the-box. open source Certificate Authority. WARNING: -This feature covers only certificates for **custom domains**, not the wildcard certificate required to run [Pages daemon](../../../../administration/pages/index.md) **(FREE SELF)**. Wildcard certificate generation is tracked in [this issue](https://gitlab.com/gitlab-org/omnibus-gitlab/-/issues/3342). +This feature covers only certificates for **custom domains**, not the wildcard certificate required to run +[Pages daemon](../../../../administration/pages/index.md) (Self-managed, Free, Premium, and Ultimate only). Wildcard +certificate generation is tracked in [this issue](https://gitlab.com/gitlab-org/omnibus-gitlab/-/issues/3342). ## Prerequisites @@ -64,7 +70,7 @@ associated Pages domain. GitLab also renews it automatically. ### Error "Something went wrong while obtaining the Let's Encrypt certificate" -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/30146) in GitLab 13.0. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/30146) in GitLab 13.0. If you get an error **Something went wrong while obtaining the Let's Encrypt certificate**, first, make sure that your pages site is set to "Everyone" in your project's **Settings > General > Visibility**. This allows the Let's Encrypt Servers reach your pages site. Once this is confirmed, you can try obtaining the certificate again by following these steps: diff --git a/doc/user/project/pages/custom_domains_ssl_tls_certification/ssl_tls_concepts.md b/doc/user/project/pages/custom_domains_ssl_tls_certification/ssl_tls_concepts.md index 50ccc885bcb..b535f5c8ba5 100644 --- a/doc/user/project/pages/custom_domains_ssl_tls_certification/ssl_tls_concepts.md +++ b/doc/user/project/pages/custom_domains_ssl_tls_certification/ssl_tls_concepts.md @@ -4,7 +4,11 @@ group: Knowledge info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# GitLab Pages SSL/TLS certificates **(FREE ALL)** +# GitLab Pages SSL/TLS certificates + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed Every GitLab Pages project on GitLab.com is available under HTTPS for the default Pages domain (`*.gitlab.io`). Once you set diff --git a/doc/user/project/pages/getting_started/pages_ci_cd_template.md b/doc/user/project/pages/getting_started/pages_ci_cd_template.md index 07b400710f0..0e56872198a 100644 --- a/doc/user/project/pages/getting_started/pages_ci_cd_template.md +++ b/doc/user/project/pages/getting_started/pages_ci_cd_template.md @@ -4,7 +4,11 @@ group: Knowledge info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Create a GitLab Pages website from a CI/CD template **(FREE ALL)** +# Create a GitLab Pages website from a CI/CD template + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed GitLab provides `.gitlab-ci.yml` templates for the most popular Static Site Generators (SSGs). You can create your own `.gitlab-ci.yml` file from one of these templates, and run diff --git a/doc/user/project/pages/getting_started/pages_forked_sample_project.md b/doc/user/project/pages/getting_started/pages_forked_sample_project.md index e3c374eaacc..d8740a48e9c 100644 --- a/doc/user/project/pages/getting_started/pages_forked_sample_project.md +++ b/doc/user/project/pages/getting_started/pages_forked_sample_project.md @@ -4,7 +4,11 @@ group: Knowledge info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Create a GitLab Pages website from a forked sample project **(FREE ALL)** +# Create a GitLab Pages website from a forked sample project + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed GitLab provides [sample projects for the most popular Static Site Generators (SSG)](https://gitlab.com/pages). You can fork one of the sample projects and run the CI/CD pipeline to generate a Pages website. diff --git a/doc/user/project/pages/getting_started/pages_from_scratch.md b/doc/user/project/pages/getting_started/pages_from_scratch.md index 73583eefdda..ccbe683fac3 100644 --- a/doc/user/project/pages/getting_started/pages_from_scratch.md +++ b/doc/user/project/pages/getting_started/pages_from_scratch.md @@ -4,7 +4,11 @@ group: Knowledge info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Tutorial: Create a GitLab Pages website from scratch **(FREE ALL)** +# Tutorial: Create a GitLab Pages website from scratch + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed This tutorial shows you how to create a Pages site from scratch using the [Jekyll](https://jekyllrb.com/) Static Site Generator (SSG). You start with diff --git a/doc/user/project/pages/getting_started/pages_new_project_template.md b/doc/user/project/pages/getting_started/pages_new_project_template.md index b931d2d3911..9e7bdb8d6e6 100644 --- a/doc/user/project/pages/getting_started/pages_new_project_template.md +++ b/doc/user/project/pages/getting_started/pages_new_project_template.md @@ -4,7 +4,11 @@ group: Knowledge info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Create a GitLab Pages website from a project template **(FREE ALL)** +# Create a GitLab Pages website from a project template + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed GitLab provides templates for the most popular Static Site Generators (SSGs). You can create a new project from a template and run the CI/CD pipeline to generate a Pages website. diff --git a/doc/user/project/pages/getting_started/pages_ui.md b/doc/user/project/pages/getting_started/pages_ui.md index 25f91880d5a..9cb5db3b454 100644 --- a/doc/user/project/pages/getting_started/pages_ui.md +++ b/doc/user/project/pages/getting_started/pages_ui.md @@ -4,7 +4,11 @@ group: Knowledge info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Create a GitLab Pages deployment for a static site **(FREE ALL)** +# Create a GitLab Pages deployment for a static site + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed If you already have a GitLab project that contains your static site or framework, you can generate a GitLab Pages website from it. diff --git a/doc/user/project/pages/getting_started_part_one.md b/doc/user/project/pages/getting_started_part_one.md index e9e8d5d69de..25e34193d29 100644 --- a/doc/user/project/pages/getting_started_part_one.md +++ b/doc/user/project/pages/getting_started_part_one.md @@ -4,7 +4,11 @@ group: Knowledge info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# GitLab Pages default domain names and URLs **(FREE ALL)** +# GitLab Pages default domain names and URLs + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed On this document, learn how to name your project for GitLab Pages according to your intended website's URL. diff --git a/doc/user/project/pages/index.md b/doc/user/project/pages/index.md index 00dfe0c66d9..e16bc4c430b 100644 --- a/doc/user/project/pages/index.md +++ b/doc/user/project/pages/index.md @@ -5,7 +5,11 @@ group: Knowledge info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# GitLab Pages **(FREE ALL)** +# GitLab Pages + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed With GitLab Pages, you can publish static websites directly from a repository in GitLab. @@ -155,9 +159,14 @@ By default, every project in a group shares the same domain, for example, `group To ensure each project uses different cookies, enable the Pages [unique domains](introduction.md#enable-unique-domains) feature for your project. -## Create multiple deployments **(PREMIUM ALL EXPERIMENT)** +## Create multiple deployments -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/129534) in GitLab 16.7 as an [Experiment](../../../policy/experiment-beta-support.md) [with a flag](../../feature_flags.md) named `pages_multiple_versions_setting`, disabled by default. +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed +**Status:** Experiment + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/129534) in GitLab 16.7 as an [Experiment](../../../policy/experiment-beta-support.md) [with a flag](../../feature_flags.md) named `pages_multiple_versions_setting`, disabled by default. FLAG: On self-managed GitLab, by default this feature is not available. To make it available, diff --git a/doc/user/project/pages/introduction.md b/doc/user/project/pages/introduction.md index 9f40b4d64af..0082040c28d 100644 --- a/doc/user/project/pages/introduction.md +++ b/doc/user/project/pages/introduction.md @@ -4,7 +4,11 @@ group: Knowledge info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# GitLab Pages settings **(FREE ALL)** +# GitLab Pages settings + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed This document is a user guide to explore the options and settings GitLab Pages offers. diff --git a/doc/user/project/pages/pages_access_control.md b/doc/user/project/pages/pages_access_control.md index 07b41f391ba..ef3d1bfe048 100644 --- a/doc/user/project/pages/pages_access_control.md +++ b/doc/user/project/pages/pages_access_control.md @@ -4,7 +4,11 @@ group: Knowledge info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# GitLab Pages access control **(FREE ALL)** +# GitLab Pages access control + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed You can enable Pages access control on your project if your administrator has [enabled the access control feature](../../../administration/pages/index.md#access-control) diff --git a/doc/user/project/pages/public_folder.md b/doc/user/project/pages/public_folder.md index 4f8549c1589..02253347b59 100644 --- a/doc/user/project/pages/public_folder.md +++ b/doc/user/project/pages/public_folder.md @@ -6,9 +6,13 @@ group: Knowledge info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# GitLab Pages public folder **(FREE ALL)** +# GitLab Pages public folder -> With GitLab 16.1 we introduced the ability to configure the published folder in `.gitlab-ci.yml`, so you longer need to change your framework config. For more information, see how to [set a custom folder to be deployed with Pages](introduction.md#customize-the-default-folder). +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed + +> - With GitLab 16.1 we introduced the ability to configure the published folder in `.gitlab-ci.yml`, so you longer need to change your framework config. For more information, see how to [set a custom folder to be deployed with Pages](introduction.md#customize-the-default-folder). Follow these instructions to configure the `public` folder for the following frameworks. diff --git a/doc/user/project/pages/redirects.md b/doc/user/project/pages/redirects.md index b88e7d2d376..3fefeea3882 100644 --- a/doc/user/project/pages/redirects.md +++ b/doc/user/project/pages/redirects.md @@ -4,7 +4,11 @@ group: Knowledge info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# GitLab Pages redirects **(FREE ALL)** +# GitLab Pages redirects + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed > - [Introduced](https://gitlab.com/gitlab-org/gitlab-pages/-/issues/24) in GitLab Pages 1.25.0 and GitLab 13.4 behind a feature flag, disabled by default. > - [Became enabled by default](https://gitlab.com/gitlab-org/gitlab-pages/-/merge_requests/367) in GitLab 13.5. @@ -121,7 +125,7 @@ rewrite the URL. ## Domain-level redirects -> [Introduced](https://gitlab.com/gitlab-org/gitlab-pages/-/merge_requests/936) in GitLab 16.8 [with a flag](../../../administration/feature_flags.md) named `FF_ENABLE_DOMAIN_REDIRECT`. Disabled by default. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab-pages/-/merge_requests/936) in GitLab 16.8 [with a flag](../../../administration/feature_flags.md) named `FF_ENABLE_DOMAIN_REDIRECT`. Disabled by default. To create a domain-level redirect, add a domain-level path (beginning with `http://` or `https://`) to either: @@ -146,7 +150,7 @@ to dynamically rewrite the URL path. ## Splats -> [Introduced](https://gitlab.com/gitlab-org/gitlab-pages/-/merge_requests/458) in GitLab 14.3. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab-pages/-/merge_requests/458) in GitLab 14.3. A rule with an asterisk (`*`) in its `from` path, known as a splat, matches anything at the start, middle, or end of the requested path. This example @@ -204,7 +208,7 @@ rule like: ## Placeholders -> [Introduced](https://gitlab.com/gitlab-org/gitlab-pages/-/merge_requests/458) in GitLab 14.3. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab-pages/-/merge_requests/458) in GitLab 14.3. Use placeholders in rules to match portions of the requested URL and use these matches when rewriting or redirecting to a new URL. diff --git a/doc/user/project/protected_branches.md b/doc/user/project/protected_branches.md index 60b862a4d3b..131dc1041aa 100644 --- a/doc/user/project/protected_branches.md +++ b/doc/user/project/protected_branches.md @@ -4,7 +4,11 @@ group: Source Code info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Protected branches **(FREE ALL)** +# Protected branches + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed In GitLab, [permissions](../permissions.md) are fundamentally defined around the idea of having read or write permission to the repository and branches. To impose @@ -23,7 +27,7 @@ The [default branch](repository/branches/default.md) for your repository is prot ## Who can modify a protected branch -> Branch push permission [changed](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/118532) to require GitLab administrators to also have the **allowed** permission in GitLab 16.0. +> - Branch push permission [changed](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/118532) to require GitLab administrators to also have the **allowed** permission in GitLab 16.0. When a branch is protected, the default behavior enforces these restrictions on the branch. @@ -115,9 +119,13 @@ To protect a branch: The protected branch displays in the list of protected branches. -### For all projects in a group **(PREMIUM ALL)** +### For all projects in a group -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/106532) in GitLab 15.9 [with a flag](../../administration/feature_flags.md) named `group_protected_branches`. Disabled by default. +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/106532) in GitLab 15.9 [with a flag](../../administration/feature_flags.md) named `group_protected_branches`. Disabled by default. FLAG: On self-managed GitLab, by default this feature is not available. @@ -317,9 +325,13 @@ Force push settings for a branch at the project level are overridden by group le if the `group_protected_branches` feature flag is enabled and a group owner has set [group level protection for the same branch](#for-all-projects-in-a-group). -## Require Code Owner approval on a protected branch **(PREMIUM ALL)** +## Require Code Owner approval on a protected branch -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/35097) in GitLab 13.5, users and groups who can push to protected branches do not have to use a merge request to merge their feature branches. This means they can skip merge request approval rules. +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/35097) in GitLab 13.5, users and groups who can push to protected branches do not have to use a merge request to merge their feature branches. This means they can skip merge request approval rules. For a protected branch, you can require at least one approval by a [Code Owner](codeowners/index.md). If a branch is protected by multiple rules, code owner approval is required if _any_ of diff --git a/doc/user/project/protected_tags.md b/doc/user/project/protected_tags.md index 104433be2dc..3e446a8a1b6 100644 --- a/doc/user/project/protected_tags.md +++ b/doc/user/project/protected_tags.md @@ -4,7 +4,11 @@ group: Source Code info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Protected tags **(FREE ALL)** +# Protected tags + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed Protected [tags](repository/tags/index.md): @@ -96,7 +100,7 @@ Users can still create branches, but not tags, with the protected names. ## Allow deploy keys to create protected tags -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/325415) in GitLab 15.11. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/325415) in GitLab 15.11. You can permit the owner of a [deploy key](deploy_keys/index.md) to create protected tags. The deploy key works, even if the user isn't a member of the related project. However, the owner of the deploy diff --git a/doc/user/project/push_options.md b/doc/user/project/push_options.md index bf5bf856631..4bf4e588fd3 100644 --- a/doc/user/project/push_options.md +++ b/doc/user/project/push_options.md @@ -4,7 +4,11 @@ group: Source Code info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Push options **(FREE ALL)** +# Push options + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed When you push changes to a branch, you can use client-side [Git push options](https://git-scm.com/docs/git-push#Documentation/git-push.txt--oltoptiongt). diff --git a/doc/user/project/quick_actions.md b/doc/user/project/quick_actions.md index c5b6babe369..4f5ed444ae3 100644 --- a/doc/user/project/quick_actions.md +++ b/doc/user/project/quick_actions.md @@ -4,7 +4,11 @@ group: Project Management info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# GitLab quick actions **(FREE ALL)** +# GitLab quick actions + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed Quick actions are text-based shortcuts for common actions that are usually done by selecting buttons or dropdowns in the GitLab user interface. You can enter @@ -132,7 +136,7 @@ To auto-format this table, use the VS Code Markdown Table formatter: `https://do ## Work items -> Executing quick actions from comments [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/391282) in GitLab 15.10. +> - Executing quick actions from comments [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/391282) in GitLab 15.10. Work items in GitLab include [tasks](../tasks.md) and [OKRs](../okrs.md). The following quick actions can be applied through the description field when editing or commenting on work items. diff --git a/doc/user/project/releases/index.md b/doc/user/project/releases/index.md index 1d721d71444..3e5f8cd1d88 100644 --- a/doc/user/project/releases/index.md +++ b/doc/user/project/releases/index.md @@ -4,7 +4,11 @@ group: Environments info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Releases **(FREE ALL)** +# Releases + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed In GitLab, a release enables you to create a snapshot of your project for your users, including installation packages and release notes. You can create a GitLab release on any branch. Creating a @@ -165,7 +169,7 @@ project. ## Upcoming releases -> [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/issues/38105) in GitLab 12.1. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/issues/38105) in GitLab 12.1. You can create a release ahead of time by using the [Releases API](../../../api/releases/index.md#upcoming-releases). When you set a future `released_at` date, an **Upcoming Release** badge is displayed next to the @@ -175,7 +179,7 @@ release tag. When the `released_at` date and time has passed, the badge is autom ## Historical releases -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/199429) in GitLab 15.2. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/199429) in GitLab 15.2. You can create a release in the past using either the [Releases API](../../../api/releases/index.md#historical-releases) or the UI. When you set @@ -201,7 +205,7 @@ In the UI: ## Delete a release -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/213862) in GitLab 15.2 +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/213862) in GitLab 15.2 When you delete a release, its assets are also deleted. However, the associated Git tag is not deleted. @@ -260,7 +264,7 @@ more, read issue #328054, ## Get notified when a release is created -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/26001) in GitLab 12.4. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/26001) in GitLab 12.4. You can be notified by email when a new release is created for your project. @@ -337,11 +341,11 @@ For more information, see [Deployment safety](../../../ci/environments/deploymen ## Release permissions -> Fixes to the permission model for create, update and delete actions [were introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/327505) in GitLab 14.1. +> - Fixes to the permission model for create, update and delete actions [were introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/327505) in GitLab 14.1. ### View a release and download assets -> Changes to the Guest role [were introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/335209) in GitLab 14.5. +> - Changes to the Guest role [were introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/335209) in GitLab 14.5. - Users with at least the Reporter role have read and download access to the project releases. @@ -353,7 +357,7 @@ For more information, see [Deployment safety](../../../ci/environments/deploymen ### Publish releases without giving access to source code -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/216485) in GitLab 15.6. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/216485) in GitLab 15.6. Releases can be made accessible to non-project members while keeping repository-related information such as [source code](release_fields.md#source-code) and [release evidence](release_evidence.md) private. Use this for @@ -377,9 +381,13 @@ users with at least the Maintainer role to create, update, and delete releases by protecting the tag with a wildcard (`*`), and set **Maintainer** in the **Allowed to create** column. -## Release Metrics **(ULTIMATE ALL)** +## Release Metrics -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/259703) in GitLab Premium 13.9. +DETAILS: +**Tier:** Ultimate +**Offering:** SaaS, Self-managed + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/259703) in GitLab Premium 13.9. Group-level release metrics are available by navigating to **Group > Analytics > CI/CD**. These metrics include: diff --git a/doc/user/project/releases/release_cli.md b/doc/user/project/releases/release_cli.md index 1770b7b0931..72d457d39e2 100644 --- a/doc/user/project/releases/release_cli.md +++ b/doc/user/project/releases/release_cli.md @@ -4,7 +4,6 @@ group: Environments info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- - # GitLab Release CLI tool The [GitLab Release CLI (`release-cli`)](https://gitlab.com/gitlab-org/release-cli) @@ -26,7 +25,11 @@ release-cli create --name "Release $CI_COMMIT_SHA" --description \ --assets-link "{\"name\":\"asset1\",\"url\":\"https://example.com/assets/1\",\"link_type\":\"other\"}" ``` -## Install the `release-cli` for the Shell executor **(FREE ALL)** +## Install the `release-cli` for the Shell executor + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed > - [Introduced](https://gitlab.com/gitlab-org/release-cli/-/issues/21) in GitLab 13.8. > - [Changed](https://gitlab.com/gitlab-org/release-cli/-/merge_requests/108) in GitLab 14.2, the `release-cli` binaries are also [available in the package registry](https://gitlab.com/gitlab-org/release-cli/-/packages). diff --git a/doc/user/project/releases/release_evidence.md b/doc/user/project/releases/release_evidence.md index 83865b95c1f..6236793c93b 100644 --- a/doc/user/project/releases/release_evidence.md +++ b/doc/user/project/releases/release_evidence.md @@ -4,9 +4,13 @@ group: Compliance info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Release evidence **(FREE ALL)** +# Release evidence -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/26019) in GitLab 12.6. +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/26019) in GitLab 12.6. Each time a release is created, GitLab takes a snapshot of data that's related to it. This data is saved in a JSON file and called *release evidence*. The feature @@ -83,17 +87,25 @@ Here is an example of a release evidence object: } ``` -## Collect release evidence **(PREMIUM SELF)** +## Collect release evidence -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/199065) in GitLab 12.10. +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** Self-managed + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/199065) in GitLab 12.10. When a release is created, release evidence is automatically collected. To initiate evidence collection any other time, use an [API call](../../../api/releases/index.md#collect-release-evidence). You can collect release evidence multiple times for one release. Evidence collection snapshots are visible on the Releases page, along with the timestamp the evidence was collected. -## Include report artifacts as release evidence **(ULTIMATE ALL)** +## Include report artifacts as release evidence -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/32773) in GitLab 13.2. +DETAILS: +**Tier:** Ultimate +**Offering:** SaaS, Self-managed + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/32773) in GitLab 13.2. When you create a release, if [job artifacts](../../../ci/yaml/index.md#artifactsreports) are included in the last pipeline that ran, they are automatically included in the release as release evidence. @@ -127,7 +139,7 @@ keyword. For more information, see [issue 222351](https://gitlab.com/gitlab-org/ ## Schedule release evidence collection -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/23697) in GitLab 12.8. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/23697) in GitLab 12.8. In the API: diff --git a/doc/user/project/releases/release_fields.md b/doc/user/project/releases/release_fields.md index 7c45a510877..8fc1667f999 100644 --- a/doc/user/project/releases/release_fields.md +++ b/doc/user/project/releases/release_fields.md @@ -69,7 +69,7 @@ Each link as an asset has the following attributes: #### Permanent link to latest release -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/16821) in GitLab 14.9. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/16821) in GitLab 14.9. Latest release page is accessible through a permanent URL. GitLab redirects to the latest release page URL when it is visited. @@ -91,7 +91,7 @@ By default, GitLab fetches the release using `released_at` time. The use of the #### Permanent links to release assets -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/375489) in GitLab 15.9, links for private releases can be accessed using a Personal Access Token. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/375489) in GitLab 15.9, links for private releases can be accessed using a Personal Access Token. The assets associated with a release are accessible through a permanent URL. GitLab always redirects this URL to the actual asset @@ -134,7 +134,7 @@ curl --location --output filename --header "PRIVATE-TOKEN: " #### Permanent links to latest release assets -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/16821) in GitLab 14.9. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/16821) in GitLab 14.9. The `filepath` from [permanent links to release assets](#permanent-links-to-release-assets) can be used in combination with [permanent link to the latest release](#permanent-link-to-latest-release). It is useful when we want to link a permanent URL to download an asset from the *latest release*. @@ -164,7 +164,7 @@ https://gitlab.com/gitlab-org/gitlab-runner/-/releases/permalink/latest/download #### Link Types -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/207257) in GitLab 13.1. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/207257) in GitLab 13.1. The four types of links are "Runbook," "Package," "Image," and "Other." The `link_type` parameter accepts one of the following four values: @@ -261,9 +261,13 @@ links to a release is not recommended, because artifacts are ephemeral and are used to pass data in the same pipeline. This means there's a risk that they could either expire or someone might manually delete them. -### Number of new and total features **(FREE SAAS)** +### Number of new and total features -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/235618) in GitLab 13.5. +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/235618) in GitLab 13.5. On [GitLab.com](https://gitlab.com/gitlab-org/gitlab/-/releases), you can view the number of new and total features in the project. diff --git a/doc/user/project/remote_development/connect_machine.md b/doc/user/project/remote_development/connect_machine.md index b37a2c5fc0f..a680dce53c7 100644 --- a/doc/user/project/remote_development/connect_machine.md +++ b/doc/user/project/remote_development/connect_machine.md @@ -4,7 +4,11 @@ group: IDE info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Tutorial: Connect a remote machine to the Web IDE **(FREE ALL)** +# Tutorial: Connect a remote machine to the Web IDE + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/95169) in GitLab 15.4 [with a flag](../../../administration/feature_flags.md) named `vscode_web_ide`. Disabled by default. > - [Enabled on GitLab.com](https://gitlab.com/gitlab-org/gitlab/-/issues/371084) in GitLab 15.7. diff --git a/doc/user/project/remote_development/index.md b/doc/user/project/remote_development/index.md index 65445e54949..ec50bed4f1f 100644 --- a/doc/user/project/remote_development/index.md +++ b/doc/user/project/remote_development/index.md @@ -4,7 +4,11 @@ group: IDE info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Remote development **(FREE ALL)** +# Remote development + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/95169) in GitLab 15.4 [with a flag](../../../administration/feature_flags.md) named `vscode_web_ide`. Disabled by default. > - [Enabled on GitLab.com](https://gitlab.com/gitlab-org/gitlab/-/issues/371084) in GitLab 15.7. @@ -33,7 +37,11 @@ With remote development, you can use: For a complete IDE experience, connect the Web IDE to a development environment configured to run as a remote host. You can create this environment [inside](../../workspace/configuration.md) or [outside](connect_machine.md) of GitLab. -## Workspaces **(PREMIUM ALL)** +## Workspaces + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed A [workspace](../../workspace/index.md) is a virtual sandbox environment for your code in GitLab that includes: diff --git a/doc/user/project/repository/branches/default.md b/doc/user/project/repository/branches/default.md index 4fc83cf77ea..7baa5e6a0a2 100644 --- a/doc/user/project/repository/branches/default.md +++ b/doc/user/project/repository/branches/default.md @@ -4,7 +4,11 @@ group: Source Code info: "To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments" --- -# Default branch **(FREE ALL)** +# Default branch + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed When you create a new [project](../../index.md), GitLab creates a default branch in the repository. A default branch has special configuration options not shared @@ -58,7 +62,11 @@ GitLab administrators can configure a new default branch name at the [instance level](#instance-level-custom-initial-branch-name) or [group level](#group-level-custom-initial-branch-name). -### Instance-level custom initial branch name **(FREE SELF)** +### Instance-level custom initial branch name + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/221013) in GitLab 13.2 [with a flag](../../../../administration/feature_flags.md) named `global_default_branch_name`. Enabled by default. > - [Generally available](https://gitlab.com/gitlab-org/gitlab/-/issues/325163) in GitLab 13.12. Feature flag `global_default_branch_name` removed. @@ -79,7 +87,7 @@ overrides it. ### Group-level custom initial branch name -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/221014) in GitLab 13.6. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/221014) in GitLab 13.6. Users with the Owner role of groups and subgroups can configure the default branch name for a group: @@ -92,9 +100,13 @@ Users with the Owner role of groups and subgroups can configure the default bran Projects created in this group after you change the setting use the custom branch name, unless a subgroup configuration overrides it. -## Protect initial default branches **(FREE ALL)** +## Protect initial default branches -> Full protection after initial push [introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/118729) in GitLab 16.0. +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed + +> - Full protection after initial push [introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/118729) in GitLab 16.0. GitLab administrators and group owners can define [branch protections](../../../project/protected_branches.md) to apply to every repository's default branch @@ -115,7 +127,11 @@ at the [instance level](#instance-level-default-branch-protection) and WARNING: Unless **Fully protected** is chosen, a malicious developer could attempt to steal your sensitive data. For example, a malicious `.gitlab-ci.yml` file could be committed to a protected branch and later, if a pipeline is run against that branch, result in exfiltration of group CI/CD variables. -### Instance-level default branch protection **(FREE SELF)** +### Instance-level default branch protection + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed This setting applies only to each repository's default branch. To protect other branches, you must either: @@ -134,9 +150,13 @@ groups and subgroups can override this instance-wide setting for their projects. [**Allow owners to manage default branch protection per group**](#prevent-overrides-of-default-branch-protection). 1. Select **Save changes**. -#### Prevent overrides of default branch protection **(PREMIUM SELF)** +#### Prevent overrides of default branch protection -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/211944) in GitLab 13.0. +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** Self-managed + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/211944) in GitLab 13.0. Instance-level protections for default branches can be overridden on a per-group basis by the group's owner. In @@ -152,7 +172,11 @@ disable this privilege for group owners, enforcing the instance-level protection NOTE: GitLab administrators can still update the default branch protection of a group. -### Group-level default branch protection **(PREMIUM ALL)** +### Group-level default branch protection + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/7583) in GitLab 12.9. > - [Settings moved and renamed](https://gitlab.com/gitlab-org/gitlab/-/issues/340403) in GitLab 14.9. @@ -236,7 +260,7 @@ renames a Git repository's (`example`) default branch. ## Default branch rename redirect -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/329100) in GitLab 14.1 +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/329100) in GitLab 14.1 URLs for specific files or directories in a project embed the project's default branch name, and are often found in documentation or browser bookmarks. When you diff --git a/doc/user/project/repository/branches/index.md b/doc/user/project/repository/branches/index.md index 5efa834d74a..817d0d48137 100644 --- a/doc/user/project/repository/branches/index.md +++ b/doc/user/project/repository/branches/index.md @@ -4,7 +4,11 @@ group: Source Code info: "To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments" --- -# Branches **(FREE ALL)** +# Branches + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed Branches are versions of a project's working tree. When you create a new [project](../../index.md), GitLab creates a [default branch](default.md) (which @@ -290,7 +294,11 @@ To do this: 1. Select **Delete merged branches**. 1. In the dialog, enter the word `delete` to confirm, then select **Delete merged branches**. -## Configure workflows for target branches **(PREMIUM ALL)** +## Configure workflows for target branches + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/127115) in GitLab 16.4 [with a flag](../../../../administration/feature_flags.md) named `target_branch_rules_flag`. Enabled by default. > - [Feature flag removed](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/136431) in GitLab 16.7. diff --git a/doc/user/project/repository/code_suggestions/index.md b/doc/user/project/repository/code_suggestions/index.md index 8f995dc6508..2c0037deb30 100644 --- a/doc/user/project/repository/code_suggestions/index.md +++ b/doc/user/project/repository/code_suggestions/index.md @@ -4,7 +4,11 @@ group: Code Creation info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Code Suggestions **(FREE ALL)** +# Code Suggestions + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed > - [Introduced support for Google Vertex AI Codey APIs](https://gitlab.com/groups/gitlab-org/-/epics/10562) in GitLab 16.1. > - [Removed support for GitLab native model](https://gitlab.com/groups/gitlab-org/-/epics/10752) in GitLab 16.2. diff --git a/doc/user/project/repository/code_suggestions/repository_xray.md b/doc/user/project/repository/code_suggestions/repository_xray.md index 356b0958344..8cf71736d44 100644 --- a/doc/user/project/repository/code_suggestions/repository_xray.md +++ b/doc/user/project/repository/code_suggestions/repository_xray.md @@ -4,9 +4,13 @@ group: Code Creation info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Repository X-Ray **(PREMIUM ALL)** +# Repository X-Ray -> [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/12060) in GitLab 16.7. +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed + +> - [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/12060) in GitLab 16.7. NOTE: Starting in February 2024, Code Suggestions will be part of diff --git a/doc/user/project/repository/code_suggestions/saas.md b/doc/user/project/repository/code_suggestions/saas.md index a0556d00822..cc821b8b549 100644 --- a/doc/user/project/repository/code_suggestions/saas.md +++ b/doc/user/project/repository/code_suggestions/saas.md @@ -4,7 +4,11 @@ group: Code Creation info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Code Suggestions on GitLab SaaS **(FREE SAAS)** +# Code Suggestions on GitLab SaaS + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS > - [Introduced](https://about.gitlab.com/releases/2023/02/22/gitlab-15-9-released/#code-suggestions-available-in-closed-beta) in GitLab 15.9 as [Beta](../../../../policy/experiment-beta-support.md#beta) for early access Ultimate customers on GitLab.com. > - [Enabled](https://gitlab.com/gitlab-org/gitlab/-/issues/408104) as opt-in with GitLab 15.11 as [Beta](../../../../policy/experiment-beta-support.md#beta). @@ -50,7 +54,7 @@ To use Code Suggestions: 1. Describe the requirements in natural language. Code Suggestions generates functions and code snippets based on the context provided. To get the best results from code generation: - Be as specific as possible while remaining concise. State the outcome you want to generate (for example, a function) and provide details on what you want to achieve. Add additional information, such as the framework or library you want to use when applicable. For example, to create a Python web service with some specific requirements, you might write something similar to the following: - + ```plaintext # Create a web service using Tornado that allows a user to log in, run a security scan, and review the scan results. # Each action (log in, run a scan, and review results) should be its own resource in the web service diff --git a/doc/user/project/repository/code_suggestions/self_managed.md b/doc/user/project/repository/code_suggestions/self_managed.md index e14d4197cd9..1297e98807b 100644 --- a/doc/user/project/repository/code_suggestions/self_managed.md +++ b/doc/user/project/repository/code_suggestions/self_managed.md @@ -4,7 +4,11 @@ group: Code Creation info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Code Suggestions on self-managed GitLab **(PREMIUM SELF)** +# Code Suggestions on self-managed GitLab + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** Self-managed > - [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/10653) in GitLab 16.1 as [Beta](../../../../policy/experiment-beta-support.md#beta) on self-managed GitLab. > - [Introduced support for Google Vertex AI Codey APIs](https://gitlab.com/groups/gitlab-org/-/epics/10562) in GitLab 16.1. @@ -23,10 +27,10 @@ GitLab Duo Code Suggestions are available on GitLab Enterprise Edition. Code Suggestions are not available for GitLab Community Edition. -> In GitLab 16.3 and later, to participate in the free trial of Code Suggestions on self-managed GitLab, you must: -> -> - Be a Premium or Ultimate customer. -> - Have activated cloud licensing. +In GitLab 16.3 and later, to participate in the free trial of Code Suggestions on self-managed GitLab, you must: + +- Be a Premium or Ultimate customer. +- Have activated cloud licensing. Usage of Code Suggestions is governed by the [GitLab Testing Agreement](https://about.gitlab.com/handbook/legal/testing-agreement/). Learn about [data usage when using Code Suggestions](index.md#code-suggestions-data-usage). diff --git a/doc/user/project/repository/code_suggestions/troubleshooting.md b/doc/user/project/repository/code_suggestions/troubleshooting.md index 47327d7a28f..5461bf5a8e7 100644 --- a/doc/user/project/repository/code_suggestions/troubleshooting.md +++ b/doc/user/project/repository/code_suggestions/troubleshooting.md @@ -4,7 +4,11 @@ group: Code Creation info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Troubleshooting Code Suggestions **(FREE ALL)** +# Troubleshooting Code Suggestions + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed When working with GitLab Duo Code Suggestions, you might encounter the following issues. diff --git a/doc/user/project/repository/csv.md b/doc/user/project/repository/csv.md index 8f0596bddeb..b36568f8ef4 100644 --- a/doc/user/project/repository/csv.md +++ b/doc/user/project/repository/csv.md @@ -4,9 +4,13 @@ group: Source Code info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# CSV files **(FREE ALL)** +# CSV files -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/14174) in GitLab 14.1. +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/14174) in GitLab 14.1. A comma-separated values (CSV) file is a delimited text file that uses a comma to separate values. Each line of the file is a data record. Each record consists of one or more fields, separated by diff --git a/doc/user/project/repository/file_finder.md b/doc/user/project/repository/file_finder.md index a2084d8a157..9dc2a750ce7 100644 --- a/doc/user/project/repository/file_finder.md +++ b/doc/user/project/repository/file_finder.md @@ -4,7 +4,11 @@ group: IDE info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# File finder **(FREE ALL)** +# File finder + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed With file finder, you can search for a file in a repository directly from the GitLab UI. diff --git a/doc/user/project/repository/forking_workflow.md b/doc/user/project/repository/forking_workflow.md index a1efb7b1ea6..7eda7658976 100644 --- a/doc/user/project/repository/forking_workflow.md +++ b/doc/user/project/repository/forking_workflow.md @@ -4,7 +4,11 @@ group: Source Code info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Forks **(FREE ALL)** +# Forks + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed Whenever possible, it's recommended to work in a common Git repository and use branching strategies to manage your work. However, @@ -150,7 +154,11 @@ an `upstream` remote repository for your fork: git push origin main ``` -### With repository mirroring **(PREMIUM ALL)** +### With repository mirroring + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed A fork can be configured as a mirror of the upstream if all these conditions are met: diff --git a/doc/user/project/repository/geojson.md b/doc/user/project/repository/geojson.md index e454387b7f1..16ca76309be 100644 --- a/doc/user/project/repository/geojson.md +++ b/doc/user/project/repository/geojson.md @@ -4,9 +4,13 @@ group: Source Code info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# GeoJSON files **(FREE ALL)** +# GeoJSON files -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/14134) in GitLab 16.1. +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/14134) in GitLab 16.1. A GeoJSON file is a format for encoding geographical data structures using JavaScript Object Notation (JSON). It is commonly used for representing geographic features, such as points, lines, and polygons, along with their associated attributes. diff --git a/doc/user/project/repository/git_blame.md b/doc/user/project/repository/git_blame.md index ddf0d65bd0b..c2ab00210fd 100644 --- a/doc/user/project/repository/git_blame.md +++ b/doc/user/project/repository/git_blame.md @@ -5,7 +5,11 @@ info: To determine the technical writer assigned to the Stage/Group associated w description: "Documentation on Git file blame." --- -# Git file blame **(FREE ALL)** +# Git file blame + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed [Git blame](https://git-scm.com/docs/git-blame) provides more information about every line in a file, including the last modified time, author, and diff --git a/doc/user/project/repository/git_history.md b/doc/user/project/repository/git_history.md index 45c59a02f8b..1a0f4203b19 100644 --- a/doc/user/project/repository/git_history.md +++ b/doc/user/project/repository/git_history.md @@ -5,7 +5,11 @@ info: To determine the technical writer assigned to the Stage/Group associated w description: "Documentation on Git file history." --- -# Git file history **(FREE ALL)** +# Git file history + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed Git file History provides information about the commit history associated with a file. To use it: diff --git a/doc/user/project/repository/index.md b/doc/user/project/repository/index.md index 550ff25e0b1..271f0ea1553 100644 --- a/doc/user/project/repository/index.md +++ b/doc/user/project/repository/index.md @@ -4,7 +4,11 @@ group: Source Code info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Repository **(FREE ALL)** +# Repository + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed A [repository](https://git-scm.com/book/en/v2/Git-Basics-Getting-a-Git-Repository) is where you store your code and make changes to it. Your changes are tracked with version control. @@ -93,7 +97,7 @@ prompted to open Xcode. ### Clone and open in Visual Studio Code -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/220957) in GitLab 13.10. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/220957) in GitLab 13.10. All projects can be cloned into Visual Studio Code from the GitLab user interface, but you can also install the [GitLab Workflow VS Code extension](../../../editor_extensions/visual_studio_code/index.md) to clone from @@ -206,7 +210,7 @@ These files can either be plain text or have the extension of a ### OpenAPI viewer -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/19515) in GitLab 12.6. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/19515) in GitLab 12.6. GitLab can render OpenAPI specification files. The file name must include `openapi` or `swagger` and the extension must be `yaml`, `yml`, or `json`. The following examples are all correct: @@ -238,7 +242,7 @@ evaluates to `true`. This behavior matches the default behavior of Swagger. ## Repository size -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/368150) in GitLab 15.3, feature flags `gitaly_revlist_for_repo_size` and `gitaly_catfile_repo_size` for alternative repository size calculations. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/368150) in GitLab 15.3, feature flags `gitaly_revlist_for_repo_size` and `gitaly_catfile_repo_size` for alternative repository size calculations. FLAG: On self-managed GitLab, by default GitLab uses the `du -sk` command to determine the size of a repository. GitLab can use either diff --git a/doc/user/project/repository/jupyter_notebooks/index.md b/doc/user/project/repository/jupyter_notebooks/index.md index 2e14c52d2a7..51e5a136d91 100644 --- a/doc/user/project/repository/jupyter_notebooks/index.md +++ b/doc/user/project/repository/jupyter_notebooks/index.md @@ -3,7 +3,11 @@ stage: Create group: Source Code info: "To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments" --- -# Jupyter Notebook files **(FREE ALL)** +# Jupyter Notebook files + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed [Jupyter Notebook](https://jupyter.org/) (previously, IPython Notebook) files are used for interactive computing in many fields. They contain a complete record of the diff --git a/doc/user/project/repository/mirror/bidirectional.md b/doc/user/project/repository/mirror/bidirectional.md index dc789d28a4f..fded410d25b 100644 --- a/doc/user/project/repository/mirror/bidirectional.md +++ b/doc/user/project/repository/mirror/bidirectional.md @@ -4,9 +4,13 @@ group: Source Code info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Bidirectional mirroring **(PREMIUM ALL)** +# Bidirectional mirroring -> Moved to GitLab Premium in 13.9. +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed + +> - Moved to GitLab Premium in 13.9. WARNING: Bidirectional mirroring may cause conflicts. @@ -138,9 +142,13 @@ This sample has a few limitations: - The script circumvents the Git hook quarantine environment because the update of `$TARGET_REPO` is seen as a ref update, and Git displays warnings about it. -## Mirror with Perforce Helix with Git Fusion **(PREMIUM ALL)** +## Mirror with Perforce Helix with Git Fusion -> Moved to GitLab Premium in 13.9. +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed + +> - Moved to GitLab Premium in 13.9. WARNING: Bidirectional mirroring should not be used as a permanent configuration. Refer to diff --git a/doc/user/project/repository/mirror/index.md b/doc/user/project/repository/mirror/index.md index 9d5048a4fed..314f1723324 100644 --- a/doc/user/project/repository/mirror/index.md +++ b/doc/user/project/repository/mirror/index.md @@ -4,7 +4,11 @@ group: Source Code info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Repository mirroring **(FREE ALL)** +# Repository mirroring + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed You can _mirror_ a repository to and from external sources. You can select which repository serves as the source. Branches, tags, and commits are synced automatically. @@ -77,7 +81,11 @@ non-protected branches in the mirroring project are not mirrored and can diverge To use this option, select **Only mirror protected branches** when you create a repository mirror. -### Mirror specific branches **(PREMIUM ALL)** +### Mirror specific branches + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed > - Mirroring branches matching a regex [introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/102608) in GitLab 15.8 [with a flag](../../../../administration/feature_flags.md) named `mirror_only_branches_match_regex`. Disabled by default. > - [Enabled by default](https://gitlab.com/gitlab-org/gitlab/-/issues/381667) in GitLab 16.0. diff --git a/doc/user/project/repository/mirror/pull.md b/doc/user/project/repository/mirror/pull.md index 0a57681c90d..95576743390 100644 --- a/doc/user/project/repository/mirror/pull.md +++ b/doc/user/project/repository/mirror/pull.md @@ -4,9 +4,13 @@ group: Source Code info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Pull from a remote repository **(PREMIUM ALL)** +# Pull from a remote repository -> Moved to GitLab Premium in 13.9. +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed + +> - Moved to GitLab Premium in 13.9. You can use the GitLab interface to browse the content and activity of a repository, even if it isn't hosted on GitLab. Create a pull [mirror](index.md) to copy the @@ -84,7 +88,7 @@ Prerequisites: ### Overwrite diverged branches -> Moved to GitLab Premium in 13.9. +> - Moved to GitLab Premium in 13.9. To always update your local branches with remote versions, even if they have diverged from the remote, select **Overwrite diverged branches** when you @@ -95,7 +99,7 @@ For mirrored branches, enabling this option results in the loss of local changes ### Trigger pipelines for mirror updates -> Moved to GitLab Premium in 13.9. +> - Moved to GitLab Premium in 13.9. If this option is enabled, pipelines trigger when branches or tags are updated from the remote repository. Depending on the activity of the remote @@ -105,7 +109,7 @@ assigned when you set up pull mirroring. ## Trigger an update by using the API -> Moved to GitLab Premium in 13.9. +> - moved to GitLab Premium in 13.9. Pull mirroring uses polling to detect new branches and commits added upstream, often minutes afterwards. You can notify GitLab using an @@ -117,7 +121,7 @@ For more information, read ## Fix hard failures when mirroring -> Moved to GitLab Premium in 13.9. +> - Moved to GitLab Premium in 13.9. After 14 consecutive unsuccessful retries, the mirroring process is marked as a hard failure and mirroring attempts stop. This failure is visible in either the: diff --git a/doc/user/project/repository/mirror/push.md b/doc/user/project/repository/mirror/push.md index babe99441ef..7f69017daf6 100644 --- a/doc/user/project/repository/mirror/push.md +++ b/doc/user/project/repository/mirror/push.md @@ -4,9 +4,13 @@ group: Source Code info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Push mirroring **(FREE ALL)** +# Push mirroring -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/40137) in GitLab 13.5: LFS support over HTTPS. +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/40137) in GitLab 13.5: LFS support over HTTPS. A _push mirror_ is a downstream repository that [mirrors](index.md) the commits made to the upstream repository. Push mirrors passively receive copies of the commits made to the @@ -55,7 +59,7 @@ You can also create and modify project push mirrors through the ## Keep divergent refs -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/208828) in GitLab 13.0. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/208828) in GitLab 13.0. By default, if any ref (branch or tag) on the remote (downstream) mirror diverges from the local repository, the upstream repository overwrites any changes on the remote: diff --git a/doc/user/project/repository/mirror/troubleshooting.md b/doc/user/project/repository/mirror/troubleshooting.md index 3cb192800ea..9f8b42ea9f7 100644 --- a/doc/user/project/repository/mirror/troubleshooting.md +++ b/doc/user/project/repository/mirror/troubleshooting.md @@ -4,7 +4,11 @@ group: Source Code info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Troubleshooting repository mirroring **(FREE ALL)** +# Troubleshooting repository mirroring + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed When mirroring fails, project maintainers can see a link similar to **{warning-solid}** **Pull mirroring failed 1 hour ago.** on the project details page. Select this link to go directly to the mirroring settings, diff --git a/doc/user/project/repository/push_rules.md b/doc/user/project/repository/push_rules.md index b15d66e27fb..ff533cd28cc 100644 --- a/doc/user/project/repository/push_rules.md +++ b/doc/user/project/repository/push_rules.md @@ -4,9 +4,13 @@ group: Source Code info: "To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments" --- -# Push rules **(PREMIUM ALL)** +# Push rules -> Maximum regular expression length for push rules [changed](https://gitlab.com/gitlab-org/gitlab/-/issues/411901) from 255 to 511 characters in GitLab 16.3. +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed + +> - Maximum regular expression length for push rules [changed](https://gitlab.com/gitlab-org/gitlab/-/issues/411901) from 255 to 511 characters in GitLab 16.3. Push rules are [pre-receive Git hooks](https://git-scm.com/book/en/v2/Customizing-Git-Git-Hooks) you can enable in a user-friendly interface. Push rules give you more control over what @@ -98,7 +102,7 @@ Use these rules for your commit messages. ## Reject commits that aren't DCO certified -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/98810) in GitLab 15.5. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/98810) in GitLab 15.5. Commits signed with the [Developer Certificate of Origin](https://developercertificate.org/) (DCO) certify the contributor wrote, or has the right to submit, the code contributed in that commit. @@ -156,7 +160,7 @@ Use these rules to validate files contained in the commit. ### Prevent pushing secrets to the repository -> Moved to GitLab Premium in 13.9. +> - Moved to GitLab Premium in 13.9. Never commit secrets, such as credential files and SSH private keys, to a version control system. In GitLab, you can use a predefined list of files to block those files from a @@ -231,7 +235,7 @@ Files blocked by this rule are listed below. For a complete list of criteria, re ### Prohibit files by name -> Moved to GitLab Premium in 13.9. +> - Moved to GitLab Premium in 13.9. In Git, filenames include both the file's name, and all directories preceding the name. When you `git push`, each filename in the push is compared to the regular expression diff --git a/doc/user/project/repository/reducing_the_repo_size_using_git.md b/doc/user/project/repository/reducing_the_repo_size_using_git.md index 528e9eefa44..c521e74c497 100644 --- a/doc/user/project/repository/reducing_the_repo_size_using_git.md +++ b/doc/user/project/repository/reducing_the_repo_size_using_git.md @@ -4,7 +4,11 @@ group: Source Code info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Reduce repository size **(FREE ALL)** +# Reduce repository size + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed Git repositories become larger over time. When large files are added to a Git repository: @@ -325,7 +329,11 @@ are accurate. To expedite this process, see the ['Prune Unreachable Objects' housekeeping task](../../../administration/housekeeping.md). -### Sidekiq process fails to export a project **(FREE SELF)** +### Sidekiq process fails to export a project + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed Occasionally the Sidekiq process can fail to export a project, for example if it is terminated during execution. diff --git a/doc/user/project/repository/signed_commits/gpg.md b/doc/user/project/repository/signed_commits/gpg.md index 4b644a79c71..962e386b33b 100644 --- a/doc/user/project/repository/signed_commits/gpg.md +++ b/doc/user/project/repository/signed_commits/gpg.md @@ -4,7 +4,11 @@ group: Source Code info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Sign commits with GPG **(FREE ALL)** +# Sign commits with GPG + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed You can sign the commits you make in a GitLab repository with a GPG ([GNU Privacy Guard](https://gnupg.org/)) key. diff --git a/doc/user/project/repository/signed_commits/index.md b/doc/user/project/repository/signed_commits/index.md index cbea5e4e2f5..4e4f9ca7be8 100644 --- a/doc/user/project/repository/signed_commits/index.md +++ b/doc/user/project/repository/signed_commits/index.md @@ -4,7 +4,11 @@ group: Source Code info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Signed commits **(FREE ALL)** +# Signed commits + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed When you add a cryptographic signature to your commit, you provide extra assurance that a commit originated from you, rather than an impersonator. If GitLab can verify a commit diff --git a/doc/user/project/repository/signed_commits/ssh.md b/doc/user/project/repository/signed_commits/ssh.md index 1d3fca6d681..84e5fde3fa8 100644 --- a/doc/user/project/repository/signed_commits/ssh.md +++ b/doc/user/project/repository/signed_commits/ssh.md @@ -4,7 +4,11 @@ group: Source Code info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments --- -# Sign commits with SSH keys **(FREE ALL)** +# Sign commits with SSH keys + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/343879) in GitLab 15.7 [with a flag](../../../../administration/feature_flags.md) named `ssh_commit_signatures`. Enabled by default. > - [Generally available](https://gitlab.com/gitlab-org/gitlab/-/issues/384202) in GitLab 15.8. Feature flag `ssh_commit_signatures` removed. @@ -145,7 +149,7 @@ for Git to associate SSH public keys with users: ## Revoke an SSH key for signing commits -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/108344) in GitLab 15.9. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/108344) in GitLab 15.9. If an SSH key becomes compromised, revoke it. Revoking a key changes both future and past commits: diff --git a/doc/user/project/repository/signed_commits/x509.md b/doc/user/project/repository/signed_commits/x509.md index 18c967698fa..399273bc79f 100644 --- a/doc/user/project/repository/signed_commits/x509.md +++ b/doc/user/project/repository/signed_commits/x509.md @@ -4,7 +4,11 @@ group: Source Code info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Sign commits and tags with X.509 certificates **(FREE ALL)** +# Sign commits and tags with X.509 certificates + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed [X.509](https://en.wikipedia.org/wiki/X.509) is a standard format for public key certificates issued by a public or private Public Key Infrastructure (PKI). diff --git a/doc/user/project/repository/tags/index.md b/doc/user/project/repository/tags/index.md index 232f2e387d1..369d12bdbd4 100644 --- a/doc/user/project/repository/tags/index.md +++ b/doc/user/project/repository/tags/index.md @@ -4,7 +4,11 @@ group: Source Code info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Tags **(FREE ALL)** +# Tags + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed In Git, a tag marks an important point in a repository's history. Git supports two types of tags: @@ -49,7 +53,7 @@ To view all existing tags for a project: ## View tagged commits in the commits list -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/18795) in GitLab 15.10. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/18795) in GitLab 15.10. 1. On the left sidebar, select **Search or go to** and find your project. 1. Select **Code > Commits**. @@ -110,7 +114,11 @@ GitLab enforces these additional rules on all tags: - Tag names cannot start with `-`, `refs/heads`, `refs/tags`, or `refs/remotes` - Tag names are case-sensitive. -## Prevent tag deletion **(PREMIUM ALL)** +## Prevent tag deletion + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed To prevent users from removing a tag with `git push`, create a [push rule](../push_rules.md). diff --git a/doc/user/project/repository/web_editor.md b/doc/user/project/repository/web_editor.md index d2df9cc18ae..fcac83ed19a 100644 --- a/doc/user/project/repository/web_editor.md +++ b/doc/user/project/repository/web_editor.md @@ -4,7 +4,11 @@ group: IDE info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Web Editor **(FREE ALL)** +# Web Editor + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed You can use the Web Editor to make changes to a single file directly from the GitLab UI. To make changes to multiple files, see [Web IDE](../web_ide/index.md). @@ -56,7 +60,7 @@ To edit a text file in the Web Editor: ### Preview Markdown -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/378966) in GitLab 15.6. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/378966) in GitLab 15.6. To preview a Markdown file in the Web Editor: diff --git a/doc/user/project/requirements/index.md b/doc/user/project/requirements/index.md index e489f19585c..66175147923 100644 --- a/doc/user/project/requirements/index.md +++ b/doc/user/project/requirements/index.md @@ -4,7 +4,11 @@ group: Product Planning info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Requirements management **(ULTIMATE ALL)** +# Requirements management + +DETAILS: +**Tier:** Ultimate +**Offering:** SaaS, Self-managed NOTE: In 14.4, Requirements was moved under **Issues**. @@ -68,7 +72,7 @@ next to the requirement title. ## Edit a requirement -> The ability to mark a requirement as Satisfied [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/218607) in GitLab 13.5. +> - The ability to mark a requirement as Satisfied [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/218607) in GitLab 13.5. You can edit a requirement from the requirements list page. @@ -219,7 +223,7 @@ requirements_confirmation: ## Import requirements from a CSV file -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/246857) in GitLab 13.7. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/246857) in GitLab 13.7. You must have at least the Reporter role. diff --git a/doc/user/project/service_desk/configure.md b/doc/user/project/service_desk/configure.md index 95c15ef42b7..fc904a62177 100644 --- a/doc/user/project/service_desk/configure.md +++ b/doc/user/project/service_desk/configure.md @@ -4,7 +4,11 @@ group: Respond info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Configure Service Desk **(FREE ALL)** +# Configure Service Desk + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed By default, Service Desk is active in new projects. If it's not active, you can do it in the project's settings. @@ -97,9 +101,13 @@ To keep your emails on brand, you can create a custom new note email template. T email. Be sure to include the `%{NOTE_TEXT}` in the template to make sure the email recipient can read the contents of the comment. -### Instance-level email header, footer, and additional text **(FREE SELF)** +### Instance-level email header, footer, and additional text -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/344819) in GitLab 15.9. +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/344819) in GitLab 15.9. Instance administrators can add a header, footer or additional text to the GitLab instance and apply them to all emails sent from GitLab. If you're using a custom `thank_you.md` or `new_note.md`, to include @@ -157,7 +165,7 @@ To edit the custom email display name: ## Reopen issues when an external participant comments -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/8549) in GitLab 16.7 +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/8549) in GitLab 16.7 You can configure GitLab to reopen closed issues when an external participant adds a new comment on an issue by email. This also adds an internal comment that mentions @@ -179,7 +187,10 @@ To enable this setting: 1. Select the **Reopen issues on a new note from an external participant** checkbox. 1. Select **Save changes**. -## Custom email address **(BETA)** +## Custom email address + +DETAILS: +**Status**: Beta > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/329990) in GitLab 16.3 [with a flag](../../../administration/feature_flags.md) named `service_desk_custom_email`. Disabled by default. > - [Enabled on GitLab.com and self-managed](https://gitlab.com/gitlab-org/gitlab/-/issues/387003) in GitLab 16.4. @@ -443,7 +454,11 @@ In GitLab: - On GitLab self-managed, use a subdomain or a different domain from another service provider for the custom email address or the GitLab instance `incoming_email` or `service_desk_email`. -## Use an additional Service Desk alias email **(FREE SELF)** +## Use an additional Service Desk alias email + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/2201) in GitLab 13.0. > - [Feature flag removed](https://gitlab.com/gitlab-org/gitlab/-/issues/284656) in GitLab 13.8. @@ -527,7 +542,7 @@ The configuration options are the same as for configuring #### Use encrypted credentials -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/108279) in GitLab 15.9. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/108279) in GitLab 15.9. Instead of having the Service Desk email credentials stored in plaintext in the configuration files, you can optionally use an encrypted file for the incoming email credentials. diff --git a/doc/user/project/service_desk/index.md b/doc/user/project/service_desk/index.md index 6a15b9798f7..566d719dac8 100644 --- a/doc/user/project/service_desk/index.md +++ b/doc/user/project/service_desk/index.md @@ -4,7 +4,11 @@ group: Respond info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Service Desk **(FREE ALL)** +# Service Desk + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed With Service Desk, your customers can email you bug reports, feature requests, or general feedback. diff --git a/doc/user/project/service_desk/using_service_desk.md b/doc/user/project/service_desk/using_service_desk.md index 7db84f6988b..0680d92cda7 100644 --- a/doc/user/project/service_desk/using_service_desk.md +++ b/doc/user/project/service_desk/using_service_desk.md @@ -4,7 +4,11 @@ group: Respond info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Use Service Desk **(FREE ALL)** +# Use Service Desk + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed You can use Service Desk to [create an issue](#as-an-end-user-issue-creator) or [respond to one](#as-a-responder-to-the-issue). In these issues, you can also see our friendly neighborhood [Support Bot](configure.md#support-bot-user). @@ -20,7 +24,7 @@ The email address is available at the top of the issue list. ## As an end user (issue creator) -> Support for additional email headers [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/346600) in GitLab 14.6. In earlier versions, the Service Desk email address had to be in the "To" field. +> - Support for additional email headers [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/346600) in GitLab 14.6. In earlier versions, the Service Desk email address had to be in the "To" field. To create a Service Desk issue, an end user does not need to know anything about the GitLab instance. They just send an email to the address they are given, and @@ -147,7 +151,7 @@ In GitLab 15.9 and earlier, uploads to a comment are sent as links in the email. ## Privacy considerations -> [Changed](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/108901) the minimum required role to view the creator's and participant's email in GitLab 15.9. +> - [Changed](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/108901) the minimum required role to view the creator's and participant's email in GitLab 15.9. Service Desk issues are [confidential](../issues/confidential_issues.md), so they are only visible to project members. The project owner can @@ -168,7 +172,7 @@ displayed in the information note. ### Moving a Service Desk issue -> [Changed](https://gitlab.com/gitlab-org/gitlab/-/issues/372246) in GitLab 15.7: customers continue receiving notifications when a Service Desk issue is moved. +> - [Changed](https://gitlab.com/gitlab-org/gitlab/-/issues/372246) in GitLab 15.7: customers continue receiving notifications when a Service Desk issue is moved. You can move a Service Desk issue the same way you [move a regular issue](../issues/managing_issues.md#move-an-issue) in GitLab. diff --git a/doc/user/project/settings/import_export.md b/doc/user/project/settings/import_export.md index 39bbdd4bd42..0620e5e9d9e 100644 --- a/doc/user/project/settings/import_export.md +++ b/doc/user/project/settings/import_export.md @@ -4,7 +4,11 @@ group: Import and Integrate info: "To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments" --- -# Migrate projects and groups by using file exports **(FREE ALL)** +# Migrate projects and groups by using file exports + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed Migrating groups and projects by using [direct transfer](../../group/import/index.md) is recommended. However, in some situations, you might need to migrate groups and project by using file exports. @@ -66,7 +70,7 @@ You can also make sure that all members were exported by checking the `project_m ### Compatibility -> Support for JSON-formatted project file exports [removed](https://gitlab.com/gitlab-org/gitlab/-/issues/389888) in GitLab 15.11. +> - Support for JSON-formatted project file exports [removed](https://gitlab.com/gitlab-org/gitlab/-/issues/389888) in GitLab 15.11. Project file exports are in NDJSON format. @@ -80,7 +84,11 @@ For example: | 13.0 | 13.0, 12.10, 12.9 | | 13.1 | 13.1, 13.0, 12.10 | -### Configure file exports as an import source **(FREE SELF)** +### Configure file exports as an import source + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed Before you can migrate projects on a self-managed GitLab instance using file exports, GitLab administrators must: @@ -196,7 +204,7 @@ Migrating projects with file exports uses the same export and import mechanisms ### Import a project and its data -> Default maximum import file size [changed](https://gitlab.com/gitlab-org/gitlab/-/issues/251106) from 50 MB to unlimited in GitLab 13.8. Administrators of self-managed instances can [set maximum import file size](#set-maximum-import-file-size). On GitLab.com, the value is [set to 5 GB](../../gitlab_com/index.md#account-and-limit-settings). +> - Default maximum import file size [changed](https://gitlab.com/gitlab-org/gitlab/-/issues/251106) from 50 MB to unlimited in GitLab 13.8. Administrators of self-managed instances can [set maximum import file size](#set-maximum-import-file-size). On GitLab.com, the value is [set to 5 GB](../../gitlab_com/index.md#account-and-limit-settings). You can import a project and its data. @@ -206,7 +214,7 @@ may be possible for an attacker to steal your sensitive data. #### Prerequisites -> Requirement for Maintainer role instead of Developer role introduced in GitLab 16.0 and backported to GitLab 15.11.1 and GitLab 15.10.5. +> - Requirement for Maintainer role instead of Developer role introduced in GitLab 16.0 and backported to GitLab 15.11.1 and GitLab 15.10.5. - You must have [exported the project and its data](#export-a-project-and-its-data). - Compare GitLab versions and ensure you are importing to a GitLab version that is the same or later @@ -240,11 +248,19 @@ Exported items are imported with the following changes: Deploy keys aren't imported. To use deploy keys, you must enable them in your imported project and update protected branches. -#### Import large projects **(FREE SELF)** +#### Import large projects + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed If you have a larger project, consider [using a Rake task](../../../administration/raketasks/project_import_export.md#import-large-projects). -### Set maximum import file size **(FREE SELF)** +### Set maximum import file size + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed Administrators can set the maximum import file size one of two ways: @@ -303,7 +319,7 @@ Note the following: ### Compatibility -> Support for JSON-formatted project file exports [removed](https://gitlab.com/gitlab-org/gitlab/-/issues/383682) in GitLab 15.8. +> - Support for JSON-formatted project file exports [removed](https://gitlab.com/gitlab-org/gitlab/-/issues/383682) in GitLab 15.8. Group file exports are in NDJSON format. diff --git a/doc/user/project/settings/migrate_projects.md b/doc/user/project/settings/migrate_projects.md index 70e6ff5da28..967d9da1c3d 100644 --- a/doc/user/project/settings/migrate_projects.md +++ b/doc/user/project/settings/migrate_projects.md @@ -4,7 +4,11 @@ group: Tenant Scale info: 'To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments' --- -# Migrate projects **(FREE ALL)** +# Migrate projects + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed ## Export a project @@ -86,7 +90,11 @@ Prerequisites: 1. In the **Unarchive project** section, select **Unarchive project**. 1. To confirm, select **OK**. -## Restore a project **(PREMIUM ALL)** +## Restore a project + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed Prerequisites: diff --git a/doc/user/project/settings/project_access_tokens.md b/doc/user/project/settings/project_access_tokens.md index f22fe603f81..eb211a35b96 100644 --- a/doc/user/project/settings/project_access_tokens.md +++ b/doc/user/project/settings/project_access_tokens.md @@ -101,7 +101,7 @@ See the warning in [create a project access token](#create-a-project-access-toke ## Enable or disable project access token creation -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/287707) in GitLab 13.11. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/287707) in GitLab 13.11. To enable or disable project access token creation for all projects in a top-level group: diff --git a/doc/user/project/settings/project_features_permissions.md b/doc/user/project/settings/project_features_permissions.md index c1fe9045ea5..5825707e073 100644 --- a/doc/user/project/settings/project_features_permissions.md +++ b/doc/user/project/settings/project_features_permissions.md @@ -4,7 +4,11 @@ group: Tenant Scale info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Project features and permissions **(FREE ALL)** +# Project features and permissions + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed ## Configure project features and permissions @@ -65,9 +69,13 @@ To disable this feature and remove the **Analyze** item from the left sidebar: 1. Turn off the **Analytics** toggle. 1. Select **Save changes**. -## Disable CVE identifier request in issues **(FREE SAAS)** +## Disable CVE identifier request in issues -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/41203) in GitLab 13.4, only for public projects on GitLab.com. +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/41203) in GitLab 13.4, only for public projects on GitLab.com. In some environments, users can submit a [CVE identifier request](../../application_security/cve_id_request.md) in an issue. diff --git a/doc/user/project/system_notes.md b/doc/user/project/system_notes.md index 22ecf9833ac..9a70eb04a25 100644 --- a/doc/user/project/system_notes.md +++ b/doc/user/project/system_notes.md @@ -4,7 +4,11 @@ group: Source Code info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# System notes **(FREE ALL)** +# System notes + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed System notes are short descriptions that help you understand the history of events that occur during the life cycle of a GitLab object, such as: diff --git a/doc/user/project/time_tracking.md b/doc/user/project/time_tracking.md index 5f06098f8f6..5f8f3c584e3 100644 --- a/doc/user/project/time_tracking.md +++ b/doc/user/project/time_tracking.md @@ -4,7 +4,11 @@ group: Project Management info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Time tracking **(FREE ALL)** +# Time tracking + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed You can estimate and track the time you spend on [issues](issues/index.md) and [merge requests](merge_requests/index.md). @@ -78,7 +82,7 @@ Prerequisites: #### Using the user interface -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/101563) in GitLab 15.7. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/101563) in GitLab 15.7. To add a time entry using the user interface: @@ -165,7 +169,10 @@ To view a time tracking report of time spent on an issue or merge request: The breakdown of spent time displayed is limited to a maximum of 100 entries. -### Global time tracking report **(EXPERIMENT)** +### Global time tracking report + +DETAILS: +**Status**: Experiment > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/344002) in GitLab 15.11 [with a flag](../../administration/feature_flags.md) named `global_time_tracking_report`. Disabled by default. > - Enabled on GitLab.com in GitLab 16.5. @@ -203,7 +210,11 @@ The following time units are available: | Hour | `h`, `hour`, or `hours` | 60 m | | Minute | `m`, `minute`, or `minutes` | | -### Limit displayed units to hours **(FREE SELF)** +### Limit displayed units to hours + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed In GitLab self-managed instances, you can limit the display of time units to hours. To do so: diff --git a/doc/user/project/use_project_as_go_package.md b/doc/user/project/use_project_as_go_package.md index bf11cd784cb..eef3bac77e9 100644 --- a/doc/user/project/use_project_as_go_package.md +++ b/doc/user/project/use_project_as_go_package.md @@ -4,7 +4,11 @@ group: Tenant Scale info: "To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments" --- -# Use a project as a Go package **(FREE ALL)** +# Use a project as a Go package + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed Prerequisites: diff --git a/doc/user/project/web_ide/index.md b/doc/user/project/web_ide/index.md index 4aaf7f27229..e79e30251b8 100644 --- a/doc/user/project/web_ide/index.md +++ b/doc/user/project/web_ide/index.md @@ -4,7 +4,11 @@ group: IDE info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Web IDE **(FREE ALL)** +# Web IDE + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/95169) in GitLab 15.7 [with a flag](../../../administration/feature_flags.md) named `vscode_web_ide`. Disabled by default. > - [Enabled on GitLab.com](https://gitlab.com/gitlab-org/gitlab/-/issues/371084) in GitLab 15.7. @@ -212,7 +216,10 @@ To protect your privacy and data: - Carefully review the permissions requested by an extension before you install the extension. - Keep your extensions up to date to ensure that any security or privacy vulnerabilities are addressed promptly. --> -## Interactive web terminals **(BETA)** +## Interactive web terminals + +DETAILS: +**Status**: Beta WARNING: This feature is in [Beta](../../../policy/experiment-beta-support.md#beta) and subject to change without notice. diff --git a/doc/user/project/wiki/group.md b/doc/user/project/wiki/group.md index 59e949c5218..a7fa5c45d7d 100644 --- a/doc/user/project/wiki/group.md +++ b/doc/user/project/wiki/group.md @@ -4,9 +4,13 @@ group: Knowledge info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Group wikis **(PREMIUM ALL)** +# Group wikis -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/13195) in GitLab 13.5. +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/13195) in GitLab 13.5. If you use GitLab groups to manage multiple projects, some of your documentation might span multiple groups. You can create group wikis, instead of [project wikis](index.md), @@ -34,7 +38,7 @@ To access a group wiki: ## Export a group wiki -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/53247) in GitLab 13.9. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/53247) in GitLab 13.9. Users with the Owner role in a group can [import or export a group wiki](../../project/settings/import_export.md#migrate-groups-by-uploading-an-export-file-deprecated) when they @@ -59,7 +63,7 @@ All files in the wiki are available in this Git repository. ## Configure group wiki visibility -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/208412) in GitLab 15.0. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/208412) in GitLab 15.0. Wikis are enabled by default in GitLab. Group [administrators](../../permissions.md) can enable or disable a group wiki through the group settings. diff --git a/doc/user/project/wiki/index.md b/doc/user/project/wiki/index.md index 07c5ce73470..253e47a3052 100644 --- a/doc/user/project/wiki/index.md +++ b/doc/user/project/wiki/index.md @@ -4,7 +4,11 @@ group: Knowledge info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Wiki **(FREE ALL)** +# Wiki + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed > - Page loading [changed](https://gitlab.com/gitlab-org/gitlab/-/issues/336792) to asynchronous in GitLab 14.9. > - Page slug encoding method [changed](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/71753) to `ERB::Util.url_encode` in GitLab 14.9. @@ -42,7 +46,7 @@ has [disabled it](#enable-or-disable-a-project-wiki). ## Configure a default branch for your wiki -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/221159) in GitLab 14.1. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/221159) in GitLab 14.1. The default branch for your wiki repository depends on your version of GitLab: @@ -122,7 +126,7 @@ Wiki pages are stored as files in a Git repository, so certain characters have a ### Length restrictions for file and directory names -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/24364) in GitLab 12.8. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/24364) in GitLab 12.8. Many common file systems have a [limit of 255 bytes](https://en.wikipedia.org/wiki/Comparison_of_file_systems#Limits) for file and directory names. Git and GitLab both support paths exceeding @@ -222,7 +226,7 @@ To view the changes for a wiki page: ### View changes between page versions -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/15242) in GitLab 13.2. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/15242) in GitLab 13.2. You can see the changes made in a version of a wiki page, similar to versioned diff file views: @@ -251,7 +255,7 @@ Commits to wikis are not counted in [repository analytics](../../analytics/repos ## Customize sidebar -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/23109) in GitLab 13.8, the sidebar can be customized by selecting the **Edit sidebar** button. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/23109) in GitLab 13.8, the sidebar can be customized by selecting the **Edit sidebar** button. Prerequisites: @@ -395,7 +399,11 @@ In GitLab 14.9 and later, page slugs are now encoded using the If you use an Apache reverse proxy, you can add a `nocanon` argument to the `ProxyPass` line of your Apache configuration to ensure your page slugs render correctly. -### Recreate a project wiki with the Rails console **(FREE SELF)** +### Recreate a project wiki with the Rails console + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed WARNING: This operation deletes all data in the wiki. diff --git a/doc/user/project/working_with_projects.md b/doc/user/project/working_with_projects.md index 4a6684a72a3..1ba72d2e9ca 100644 --- a/doc/user/project/working_with_projects.md +++ b/doc/user/project/working_with_projects.md @@ -4,7 +4,11 @@ group: Tenant Scale info: "To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments" --- -# Manage projects **(FREE ALL)** +# Manage projects + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed Most work in GitLab is done in a [project](../../user/project/index.md). Files and code are saved in projects, and most features are in the scope of projects. @@ -102,7 +106,11 @@ This action deletes the project and all associated resources (such as issues and You can also [delete projects using the Rails console](#delete-a-project-using-console). -### Delayed project deletion **(PREMIUM ALL)** +### Delayed project deletion + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed > - [Enabled for projects in personal namespaces](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/89466) in GitLab 15.1. > - [Disabled for projects in personal namespaces](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/95495) in GitLab 15.3. @@ -121,7 +129,11 @@ You can [view projects that are pending deletion](#view-projects-pending-deletio and use the Rails console to [find projects that are pending deletion](#find-projects-that-are-pending-deletion). -### Delete a project immediately **(PREMIUM ALL)** +### Delete a project immediately + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/191367) in GitLab 14.1. > - Option to delete projects immediately from the Admin Area and as a group setting removed [on GitLab.com](https://gitlab.com/gitlab-org/gitlab/-/issues/393622) and [on self-managed](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/119606) in GitLab 16.0. @@ -144,7 +156,11 @@ To immediately delete a project marked for deletion: 1. In the **Delete this project** section, select **Delete project**. 1. On the confirmation dialog, enter the project name and select **Yes, delete project**. -### View projects pending deletion **(PREMIUM ALL)** +### View projects pending deletion + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/37014) in GitLab 13.3 for Administrators. > - [Tab renamed](https://gitlab.com/gitlab-org/gitlab/-/issues/347468) from **Deleted projects** in GitLab 14.6. @@ -238,7 +254,7 @@ To rename a repository: ## Access the project overview page by using the project ID -> Project ID [moved](https://gitlab.com/gitlab-org/gitlab/-/issues/431539) to the Actions menu in GitLab 16.7. +> - Project ID [moved](https://gitlab.com/gitlab-org/gitlab/-/issues/431539) to the Actions menu in GitLab 16.7. To access a project by using the project ID instead of its name, go to `https://gitlab.example.com/projects/`. @@ -272,7 +288,7 @@ For users without permission to view the project's code, the landing page shows: ## Leave a project -> The button to leave a project [moved](https://gitlab.com/gitlab-org/gitlab/-/issues/431539) to the Actions menu in GitLab 16.7. +> - The button to leave a project [moved](https://gitlab.com/gitlab-org/gitlab/-/issues/431539) to the Actions menu in GitLab 16.7. When you leave a project: @@ -291,7 +307,11 @@ To leave a project: 1. On the project overview page, in the upper-right corner, select **Actions** (**{ellipsis_v}**). 1. Select **Leave project**, then **Leave project** again. -## Add a compliance framework to a project **(PREMIUM)** +## Add a compliance framework to a project + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed You can add compliance frameworks to projects in a group that has a [compliance framework](../group/compliance_frameworks.md). @@ -311,7 +331,11 @@ Prerequisites: 1. To use LDAP groups to manage access to a project, [add the LDAP-synchronized group as a member](../group/manage.md) to the project. -## Project aliases **(PREMIUM SELF)** +## Project aliases + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** Self-managed GitLab repositories are usually accessed with a namespace and a project name. When migrating frequently accessed repositories to GitLab, however, you can use project aliases to access those diff --git a/doc/user/public_access.md b/doc/user/public_access.md index 826f9548982..6511df3d8c6 100644 --- a/doc/user/public_access.md +++ b/doc/user/public_access.md @@ -4,7 +4,11 @@ group: Tenant Scale info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Project and group visibility **(FREE ALL)** +# Project and group visibility + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed Projects and groups in GitLab can be private, internal, or public. @@ -25,7 +29,11 @@ Users with the Guest role cannot clone the project. Private groups can have only private subgroups. -## Internal projects and groups **(FREE SELF)** +## Internal projects and groups + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed For internal projects, **any authenticated user**, including users with the Guest role, can: @@ -101,7 +109,11 @@ Prerequisites: as the visibility of its parent group. 1. Select **Save changes**. -## Restrict use of public or internal projects **(FREE SELF)** +## Restrict use of public or internal projects + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed Administrators can restrict which visibility levels users can choose when they create a project or a snippet. This setting can help prevent users from publicly exposing their repositories by accident. diff --git a/doc/user/read_only_namespaces.md b/doc/user/read_only_namespaces.md index ee89a84e3a9..65e2165b181 100644 --- a/doc/user/read_only_namespaces.md +++ b/doc/user/read_only_namespaces.md @@ -4,7 +4,11 @@ group: Acquisition info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Read-only namespaces **(FREE SAAS)** +# Read-only namespaces + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS In GitLab SaaS, a top-level namespace is placed in a read-only state when it either: diff --git a/doc/user/report_abuse.md b/doc/user/report_abuse.md index 1eb02b2f263..cc277194cc7 100644 --- a/doc/user/report_abuse.md +++ b/doc/user/report_abuse.md @@ -4,7 +4,11 @@ group: Anti-Abuse info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Report abuse **(FREE ALL)** +# Report abuse + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed You can report abuse from other GitLab users to GitLab administrators. @@ -38,7 +42,7 @@ To report abuse from a user's profile page: ## Report abuse from a user's comment -> Reporting abuse from comments in epics [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/389992) in GitLab 15.10. +> - Reporting abuse from comments in epics [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/389992) in GitLab 15.10. To report abuse from a user's comment: diff --git a/doc/user/reserved_names.md b/doc/user/reserved_names.md index 24610e25542..8f9d631c7c5 100644 --- a/doc/user/reserved_names.md +++ b/doc/user/reserved_names.md @@ -4,7 +4,11 @@ group: Tenant Scale info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Reserved project and group names **(FREE ALL)** +# Reserved project and group names + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed To not conflict with existing routes used by GitLab, some words cannot be used as project or group names. These words are listed in the diff --git a/doc/user/rich_text_editor.md b/doc/user/rich_text_editor.md index 24293b9f3b1..d9d3d56c3af 100644 --- a/doc/user/rich_text_editor.md +++ b/doc/user/rich_text_editor.md @@ -4,7 +4,11 @@ group: Knowledge info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Rich text editor **(FREE ALL)** +# Rich text editor + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed > - [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/5643) for [wikis](project/wiki/index.md#rich-text-editor) in GitLab 14.0. > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/371931) for editing issue descriptions in GitLab 15.5 [with a flag](../administration/feature_flags.md) named `content_editor_on_issues`. Disabled by default. diff --git a/doc/user/search/advanced_search.md b/doc/user/search/advanced_search.md index 757231ffb80..d063d54d2d4 100644 --- a/doc/user/search/advanced_search.md +++ b/doc/user/search/advanced_search.md @@ -4,9 +4,13 @@ group: Global Search info: "To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments" --- -# Advanced search **(PREMIUM ALL)** +# Advanced search -> Moved to GitLab Premium in 13.9. +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed + +> - Moved to GitLab Premium in 13.9. You can use advanced search for faster, more efficient search across the entire GitLab instance. Advanced search is based on Elasticsearch, a purpose-built full-text search @@ -53,7 +57,7 @@ Advanced search uses [Elasticsearch syntax](https://www.elastic.co/guide/en/elas ### User search -> Ability to refine user search [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/388409) in GitLab 15.10. +> - Ability to refine user search [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/388409) in GitLab 15.10. When you search for a user, a [fuzzy query](https://www.elastic.co/guide/en/elasticsearch/reference/7.2/query-dsl-fuzzy-query.html) is used by default. You can refine user search with [Elasticsearch syntax](#syntax). diff --git a/doc/user/search/command_palette.md b/doc/user/search/command_palette.md index 21c0a915e3d..b557c869ff8 100644 --- a/doc/user/search/command_palette.md +++ b/doc/user/search/command_palette.md @@ -4,7 +4,11 @@ group: Foundations info: "To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments" --- -# Command palette **(FREE ALL)** +# Command palette + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed > - Introduced in GitLab 16.2 [with a flag](../../administration/feature_flags.md) named `command_palette`. Enabled by default. > - Feature flag `command_palette` removed in GitLab 16.4. diff --git a/doc/user/search/exact_code_search.md b/doc/user/search/exact_code_search.md index f3554804397..92f1a7dd18a 100644 --- a/doc/user/search/exact_code_search.md +++ b/doc/user/search/exact_code_search.md @@ -4,9 +4,13 @@ group: Global Search info: "To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments" --- -# Exact Code Search **(PREMIUM ALL)** +# Exact Code Search -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/105049) in GitLab 15.9 [with a flag](../../administration/feature_flags.md) named `index_code_with_zoekt` for indexing and `search_code_with_zoekt` for searching. Both are disabled by default. +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/105049) in GitLab 15.9 [with a flag](../../administration/feature_flags.md) named `index_code_with_zoekt` for indexing and `search_code_with_zoekt` for searching. Both are disabled by default. WARNING: We are still actively making changes to the Exact Code Search feature. GitLab will dogfood it first, and roll it out only to specific customers on GitLab.com who request access to it. We will make an announcement when it's available for GitLab.com customers to tryout. You can follow our development progress by checking [the Exact Code Search feature roadmap](https://gitlab.com/groups/gitlab-org/-/epics/9404). diff --git a/doc/user/search/index.md b/doc/user/search/index.md index 6faf45cbc3d..07079932c49 100644 --- a/doc/user/search/index.md +++ b/doc/user/search/index.md @@ -4,7 +4,11 @@ group: Global Search info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Searching in GitLab **(FREE ALL)** +# Searching in GitLab + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed GitLab has two types of searches available: **basic** and **advanced**. @@ -13,9 +17,13 @@ Both types of search are the same, except when you are searching through code. - When you use basic search to search code, your search includes one project at a time. - When you use [advanced search](advanced_search.md) to search code, your search includes all projects at once. -## Global search scopes **(FREE SELF)** +## Global search scopes -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/68640) in GitLab 14.3. +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/68640) in GitLab 14.3. To improve the performance of your instance's global search, an administrator can limit the search scope by disabling one or more [`ops` feature flags](../../development/feature_flags/index.md#ops-type). @@ -125,7 +133,7 @@ To search for code in all GitLab, ask your administrator to enable [advanced sea ### View Git blame from code search -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/327052) in GitLab 14.7. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/327052) in GitLab 14.7. After you find search results, you can view who made the last change to the line where the results were found. @@ -135,7 +143,7 @@ where the results were found. ### Filter code search results by language -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/342651) in GitLab 15.10. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/342651) in GitLab 15.10. To filter code search results by one or more languages: diff --git a/doc/user/shortcuts.md b/doc/user/shortcuts.md index ff1e065de65..e0b4d52e3cc 100644 --- a/doc/user/shortcuts.md +++ b/doc/user/shortcuts.md @@ -4,7 +4,11 @@ group: Foundations info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# GitLab keyboard shortcuts **(FREE ALL)** +# GitLab keyboard shortcuts + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed GitLab has several keyboard shortcuts you can use to access its different features. @@ -312,7 +316,11 @@ These shortcuts are available when using a [filtered search input](search/index. | Command | Delete | Clear entire search filter. | | Option | Control + Delete | Clear one token at a time. | -## Epics **(PREMIUM ALL)** +## Epics + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed These shortcuts are available when viewing [epics](group/epics/index.md): @@ -325,7 +333,7 @@ These shortcuts are available when viewing [epics](group/epics/index.md): ## Disable keyboard shortcuts -> [Moved](https://gitlab.com/gitlab-org/gitlab/-/issues/202494) from the shortcuts page to user preferences in GitLab 16.4. +> - [Moved](https://gitlab.com/gitlab-org/gitlab/-/issues/202494) from the shortcuts page to user preferences in GitLab 16.4. To disable keyboard shortcuts: @@ -336,7 +344,7 @@ To disable keyboard shortcuts: ## Enable keyboard shortcuts -> [Moved](https://gitlab.com/gitlab-org/gitlab/-/issues/202494) from the shortcuts page to user preferences in GitLab 16.4. +> - [Moved](https://gitlab.com/gitlab-org/gitlab/-/issues/202494) from the shortcuts page to user preferences in GitLab 16.4. To enable keyboard shortcuts: diff --git a/doc/user/snippets.md b/doc/user/snippets.md index e1d6b857b31..5a3dfd32b12 100644 --- a/doc/user/snippets.md +++ b/doc/user/snippets.md @@ -4,7 +4,11 @@ group: Source Code info: "To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments" --- -# Snippets **(FREE ALL)** +# Snippets + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed With GitLab snippets, you can store and share bits of code and text with other users. You can [comment on](#comment-on-snippets), [clone](#clone-snippets), and @@ -93,7 +97,7 @@ default visibility: ## Versioned snippets -> [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/239) in GitLab 13.0. +> - [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/239) in GitLab 13.0. In GitLab 13.0 and later, snippets (both personal and project snippets) have version control enabled by default. @@ -128,7 +132,7 @@ direct or embedded links to the snippet. ## Add or remove multiple files -> [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/2829) in GitLab 13.5. +> - [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/2829) in GitLab 13.5. A single snippet can support up to 10 files, which helps keep related files together, such as: @@ -220,7 +224,11 @@ snippet was created using the GitLab web interface the original line ending is W With snippets, you engage in a conversation about that piece of code, which can encourage user collaboration. -## Mark snippet as spam **(FREE SELF)** +## Mark snippet as spam + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed Administrators on self-managed GitLab instances can mark snippets as spam. diff --git a/doc/user/ssh.md b/doc/user/ssh.md index 6a75411a48e..ad8049d5cb0 100644 --- a/doc/user/ssh.md +++ b/doc/user/ssh.md @@ -4,7 +4,11 @@ group: Authentication info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Use SSH keys to communicate with GitLab **(FREE ALL)** +# Use SSH keys to communicate with GitLab + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed Git is a distributed version control system, which means you can work locally, then share or *push* your changes to a server. In this case, the server you push to is GitLab. @@ -60,21 +64,21 @@ operating systems. ### ED25519_SK SSH keys -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/78934) in GitLab 14.8. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/78934) in GitLab 14.8. To use ED25519_SK SSH keys on GitLab, your local client and GitLab server must have [OpenSSH 8.2](https://www.openssh.com/releasenotes.html#8.2) or later installed. ### ECDSA_SK SSH keys -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/78934) in GitLab 14.8. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/78934) in GitLab 14.8. To use ECDSA_SK SSH keys on GitLab, your local client and GitLab server must have [OpenSSH 8.2](https://www.openssh.com/releasenotes.html#8.2) or later installed. ### RSA SSH keys -> Maximum RSA key length [changed](https://gitlab.com/groups/gitlab-org/-/epics/11186) in GitLab 16.3. +> - Maximum RSA key length [changed](https://gitlab.com/groups/gitlab-org/-/epics/11186) in GitLab 16.3. Available documentation suggests ED25519 is more secure than RSA. diff --git a/doc/user/storage_management_automation.md b/doc/user/storage_management_automation.md index e04a7f1bdee..b4c56e63241 100644 --- a/doc/user/storage_management_automation.md +++ b/doc/user/storage_management_automation.md @@ -4,7 +4,11 @@ group: Utilization info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Automate storage management **(FREE ALL)** +# Automate storage management + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed This page describes how to automate storage analysis and cleanup to manage your storage usage with the GitLab REST API. @@ -756,7 +760,7 @@ python3 get_all_cicd_config_artifacts_expiry.py The `get_all_cicd_config_artifacts_expiry.py` script is located in the [GitLab API with Python project](https://gitlab.com/gitlab-de/use-cases/gitlab-api/gitlab-api-python/). -Alternatively, you can use [advanced search](search/advanced_search.md) with API requests. The following example uses the [scope: blobs](../api/search.md#scope-blobs-premium-all-2) to searches for the string `artifacts` in all `*.yml` files: +Alternatively, you can use [advanced search](search/advanced_search.md) with API requests. The following example uses the [scope: blobs](../api/search.md#scope-blobs) to searches for the string `artifacts` in all `*.yml` files: ```shell # https://gitlab.com/gitlab-de/playground/artifact-gen-group/gen-job-artifacts-expiry-included-jobs diff --git a/doc/user/tasks.md b/doc/user/tasks.md index 3f26329485b..d1e483219ad 100644 --- a/doc/user/tasks.md +++ b/doc/user/tasks.md @@ -4,7 +4,11 @@ group: Project Management info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Tasks **(FREE ALL)** +# Tasks + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/334812) in GitLab 14.5 [with a flag](../administration/feature_flags.md) named `work_items`. Disabled by default. > - [Creating, editing, and deleting tasks](https://gitlab.com/groups/gitlab-org/-/epics/7169) introduced in GitLab 15.0. @@ -62,7 +66,7 @@ To create a task: ### From a task list item -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/377307) in GitLab 15.9. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/377307) in GitLab 15.9. Prerequisites: @@ -78,7 +82,7 @@ Any nested task list items are moved up a nested level. ## Add existing tasks to an issue -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/381868) in GitLab 15.6. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/381868) in GitLab 15.6. Prerequisites: @@ -140,7 +144,7 @@ To edit the description of a task: ## Promote a task to an issue -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/412534) in GitLab 16.1. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/412534) in GitLab 16.1. Prerequisites: @@ -183,7 +187,7 @@ To delete a task: ## Reorder tasks -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/385887) in GitLab 16.0. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/385887) in GitLab 16.0. Prerequisites: @@ -194,7 +198,7 @@ To reorder them, drag them around. ## Assign users to a task -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/334810) in GitLab 15.4. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/334810) in GitLab 15.4. To show who is responsible for a task, you can assign users to it. @@ -218,7 +222,7 @@ To change the assignee on a task: ## Assign labels to a task -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/339756) in GitLab 15.5. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/339756) in GitLab 15.5. Prerequisites: @@ -290,7 +294,11 @@ To add a task to a milestone: If a task already belongs to a milestone, the dropdown list shows the current milestone. 1. From the dropdown list, select the milestone to be associated with the task. -## Set task weight **(PREMIUM ALL)** +## Set task weight + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/362550) in GitLab 15.3. > - Edit button [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/429137) in GitLab 16.7. @@ -312,7 +320,11 @@ To set issue weight of a task: 1. Enter a whole, positive number. 1. Select **Apply** or press Enter. -## Add a task to an iteration **(PREMIUM ALL)** +## Add a task to an iteration + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/367456) in GitLab 15.5 [with a flag](../administration/feature_flags.md) named `work_items_mvc_2`. Disabled by default. > - [Moved](https://gitlab.com/gitlab-org/gitlab/-/issues/367456) to feature flag named `work_items_mvc` in GitLab 15.7. Disabled by default. @@ -356,7 +368,7 @@ You can add [comments](discussions/index.md) and reply to threads in tasks. ## Copy task reference -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/396553) in GitLab 16.1. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/396553) in GitLab 16.1. To refer to a task elsewhere in GitLab, you can use its full URL or a short reference, which looks like `namespace/project-name#123`, where `namespace` is either a group or a username. @@ -374,7 +386,7 @@ For more information about task references, see [GitLab-Flavored Markdown](markd ## Copy task email address -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/396553) in GitLab 16.1. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/396553) in GitLab 16.1. You can create a comment in a task by sending an email. Sending an email to this address creates a comment that contains the email body. @@ -390,7 +402,7 @@ To copy the task's email address: ## Set an issue as a parent -> [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/11198) in GitLab 16.5. +> - [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/11198) in GitLab 16.5. Prerequisites: @@ -411,7 +423,7 @@ next to **Parent**, select the dropdown list and then select **Unassign**. ## Confidential tasks -> [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/8410) in GitLab 15.3. +> - [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/8410) in GitLab 15.3. Confidential tasks are tasks visible only to members of a project with [sufficient permissions](#who-can-see-confidential-tasks). @@ -480,7 +492,7 @@ system note in the task's comments, for example: ## Two-column layout -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/415077) in GitLab 16.2 [with a flag](../administration/feature_flags.md) named `work_items_mvc_2`. Disabled by default. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/415077) in GitLab 16.2 [with a flag](../administration/feature_flags.md) named `work_items_mvc_2`. Disabled by default. FLAG: On self-managed GitLab, by default this feature is not available. To make it available, an administrator can [enable the feature flag](../administration/feature_flags.md) named `work_items_mvc_2`. diff --git a/doc/user/todos.md b/doc/user/todos.md index 9de15480a5c..5bc8c9919d2 100644 --- a/doc/user/todos.md +++ b/doc/user/todos.md @@ -4,7 +4,11 @@ group: Project Management info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# To-Do List **(FREE ALL)** +# To-Do List + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed Your *To-Do List* is a chronological list of items waiting for your input. The items are known as *to-do items*. @@ -60,7 +64,11 @@ To change this behavior, enable To-do items aren't affected by [GitLab notification email settings](profile/notifications.md). -### Multiple to-do items per object **(FREE SELF)** +### Multiple to-do items per object + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** Self-managed @@ -82,7 +90,7 @@ When you enable this feature: ## Create a to-do item -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/390549) in objectives, key results, and tasks in GitLab 16.0. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/390549) in objectives, key results, and tasks in GitLab 16.0. You can manually add an item to your To-Do List. diff --git a/doc/user/usage_quotas.md b/doc/user/usage_quotas.md index 2dc5c1ef819..5ea632c022e 100644 --- a/doc/user/usage_quotas.md +++ b/doc/user/usage_quotas.md @@ -4,7 +4,11 @@ group: Utilization info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Storage **(FREE SAAS)** +# Storage + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS All projects on GitLab SaaS have 10 GiB of free storage for their Git repository and Large File Storage (LFS). @@ -15,7 +19,11 @@ you must [purchase more storage](../subscriptions/gitlab_com/index.md#purchase-m GitLab plans to introduce storage limits for namespaces on GitLab SaaS. After these storage limits have been applied, storage usage will be calculated across the entire namespace and project storage limits will no longer apply. -## View storage **(FREE ALL)** +## View storage + +DETAILS: +**Tier:** Free, Premium, Ultimate +**Offering:** SaaS, self-managed You can view the following statistics for storage usage in projects and namespaces: diff --git a/doc/user/workspace/configuration.md b/doc/user/workspace/configuration.md index 7c365611742..ae9df8f8c93 100644 --- a/doc/user/workspace/configuration.md +++ b/doc/user/workspace/configuration.md @@ -4,7 +4,11 @@ group: IDE info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Workspace configuration **(PREMIUM ALL)** +# Workspace configuration + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/112397) in GitLab 15.11 [with a flag](../../administration/feature_flags.md) named `remote_development_feature_flag`. Disabled by default. > - [Enabled on GitLab.com and self-managed](https://gitlab.com/gitlab-org/gitlab/-/issues/391543) in GitLab 16.0. @@ -16,7 +20,7 @@ which you can customize to meet the specific needs of each project. ## Set up a workspace -> Support for private projects [introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/124273) in GitLab 16.4. +> - Support for private projects [introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/124273) in GitLab 16.4. ### Prerequisites @@ -60,7 +64,7 @@ You also have access to the terminal and can install any necessary dependencies. ## Connect to a workspace with SSH -> [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/10478) in GitLab 16.3. +> - [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/10478) in GitLab 16.3. Prerequisites: diff --git a/doc/user/workspace/create_image.md b/doc/user/workspace/create_image.md index 6da12b2f70a..b04af8d8d68 100644 --- a/doc/user/workspace/create_image.md +++ b/doc/user/workspace/create_image.md @@ -4,7 +4,11 @@ group: IDE info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Tutorial: Create a custom workspace image that supports arbitrary user IDs **(PREMIUM ALL)** +# Tutorial: Create a custom workspace image that supports arbitrary user IDs + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/112397) in GitLab 15.11 [with a flag](../../administration/feature_flags.md) named `remote_development_feature_flag`. Disabled by default. > - [Enabled on GitLab.com and self-managed](https://gitlab.com/gitlab-org/gitlab/-/issues/391543) in GitLab 16.0. diff --git a/doc/user/workspace/gitlab_agent_configuration.md b/doc/user/workspace/gitlab_agent_configuration.md index 1bba00b4d0e..7d5498150df 100644 --- a/doc/user/workspace/gitlab_agent_configuration.md +++ b/doc/user/workspace/gitlab_agent_configuration.md @@ -4,7 +4,11 @@ group: IDE info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# GitLab agent configuration **(PREMIUM ALL)** +# GitLab agent configuration + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/112397) in GitLab 15.11 [with a flag](../../administration/feature_flags.md) named `remote_development_feature_flag`. Disabled by default. > - [Enabled on GitLab.com and self-managed](https://gitlab.com/gitlab-org/gitlab/-/issues/391543) in GitLab 16.0. @@ -114,7 +118,7 @@ The default value for `network_policy.enabled` is `true`. #### `network_policy.egress` -> [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/11629) in GitLab 16.7. +> - [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/11629) in GitLab 16.7. Use this setting to define a list of IP CIDR ranges to allow as egress destinations from a workspace. @@ -148,7 +152,7 @@ In this example, traffic from the workspace is allowed if: ### `default_resources_per_workspace_container` -> [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/11625) in GitLab 16.8. +> - [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/11625) in GitLab 16.8. Use this setting to define the default [requests and limits](https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/#requests-and-limits) for CPU and memory per workspace container. @@ -174,7 +178,7 @@ remote_development: ### `max_resources_per_workspace` -> [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/11625) in GitLab 16.8. +> - [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/11625) in GitLab 16.8. Use this setting to define the maximum [requests and limits](https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/#requests-and-limits) for CPU and memory per workspace. @@ -206,7 +210,7 @@ to perform bootstrapping operations such as cloning the project repository. ### `workspaces_quota` -> [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/11586) in GitLab 16.9. +> - [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/11586) in GitLab 16.9. Use this setting to set the maximum number of workspaces for the GitLab agent. @@ -229,7 +233,7 @@ remote_development: ### `workspaces_per_user_quota` -> [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/11586) in GitLab 16.9. +> - [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/11586) in GitLab 16.9. Use this setting to set the maximum number of workspaces per user. diff --git a/doc/user/workspace/index.md b/doc/user/workspace/index.md index 35ad46d5385..d83337df20f 100644 --- a/doc/user/workspace/index.md +++ b/doc/user/workspace/index.md @@ -4,7 +4,11 @@ group: IDE info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Workspaces **(PREMIUM ALL)** +# Workspaces + +DETAILS: +**Tier:** Premium, Ultimate +**Offering:** SaaS, self-managed > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/112397) in GitLab 15.11 [with a flag](../../administration/feature_flags.md) named `remote_development_feature_flag`. Disabled by default. > - [Enabled on GitLab.com and self-managed](https://gitlab.com/gitlab-org/gitlab/-/issues/391543) in GitLab 16.0. @@ -31,7 +35,7 @@ A running workspace remains accessible even if user permissions are later revoke ### Open and manage workspaces from a project -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/125331) in GitLab 16.2. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/125331) in GitLab 16.2. To open a workspace from a file or the repository file list: @@ -169,7 +173,7 @@ For more information, see [Web IDE](../project/web_ide/index.md). ## Personal access token -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/129715) in GitLab 16.4. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/129715) in GitLab 16.4. When you [create a workspace](configuration.md#set-up-a-workspace), you get a personal access token with `write_repository` permission. This token is used to initially clone the project while starting the workspace. diff --git a/lib/gitlab/background_migration/backfill_catalog_resource_versions_released_at.rb b/lib/gitlab/background_migration/backfill_catalog_resource_versions_released_at.rb new file mode 100644 index 00000000000..37927af98c8 --- /dev/null +++ b/lib/gitlab/background_migration/backfill_catalog_resource_versions_released_at.rb @@ -0,0 +1,18 @@ +# frozen_string_literal: true + +module Gitlab + module BackgroundMigration + class BackfillCatalogResourceVersionsReleasedAt < BatchedMigrationJob + operation_name :backfill_catalog_resource_versions_released_at + feature_category :pipeline_composition + + def perform + each_sub_batch do |sub_batch| + sub_batch + .where('release_id = releases.id') + .update_all('released_at = releases.released_at FROM releases') + end + end + end + end +end diff --git a/lib/gitlab/database/postgres_index.rb b/lib/gitlab/database/postgres_index.rb index f52785c1e56..c8d487d921e 100644 --- a/lib/gitlab/database/postgres_index.rb +++ b/lib/gitlab/database/postgres_index.rb @@ -27,7 +27,7 @@ module Gitlab .not_match("#{Gitlab::Database::Reindexing::ReindexConcurrently::TEMPORARY_INDEX_PATTERN}$") end - scope :reindexing_leftovers, -> { match("#{Gitlab::Database::Reindexing::ReindexConcurrently::TEMPORARY_INDEX_PATTERN}$") } + scope :reindexing_leftovers, -> { match("#{Gitlab::Database::Reindexing::ReindexConcurrently::TEMPORARY_INDEX_PATTERN}$").order(:name) } scope :not_match, ->(regex) { where("name !~ ?", regex) } diff --git a/lib/gitlab/gitaly_client/blobs_stitcher.rb b/lib/gitlab/gitaly_client/blobs_stitcher.rb index 95053207d1a..af5bc3728f5 100644 --- a/lib/gitlab/gitaly_client/blobs_stitcher.rb +++ b/lib/gitlab/gitaly_client/blobs_stitcher.rb @@ -33,6 +33,12 @@ module Gitlab def new_blob(blob_data) data = blob_data[:data_parts].join + binary = if Feature.enabled?(:stop_precalling_binary_for_blobs, type: :experiment) + {} + else + { binary: Gitlab::Git::Blob.binary?(data) } + end + Gitlab::Git::Blob.new( id: blob_data[:oid], mode: blob_data[:mode]&.to_s(8), @@ -41,7 +47,7 @@ module Gitlab size: blob_data[:size], commit_id: blob_data[:revision], data: data, - binary: Gitlab::Git::Blob.binary?(data) + **binary ) end end diff --git a/locale/gitlab.pot b/locale/gitlab.pot index d5d92d16208..6189f6397d1 100644 --- a/locale/gitlab.pot +++ b/locale/gitlab.pot @@ -10484,6 +10484,9 @@ msgstr "" msgid "CiCatalog|Components" msgstr "" +msgid "CiCatalog|Components:" +msgstr "" + msgid "CiCatalog|Create a pipeline component repository and make reusing pipeline configurations faster and easier." msgstr "" @@ -38194,11 +38197,6 @@ msgstr "" msgid "ProjectCreationLevel|Roles allowed to create projects" msgstr "" -msgid "ProjectExceededSize|Here is the project exceeding the storage quota:%{projects_list}" -msgid_plural "ProjectExceededSize|From the %{repository_size_excess_project_count} projects exceeding the quota, below are the projects using the most storage:%{projects_list}" -msgstr[0] "" -msgstr[1] "" - msgid "ProjectFileTree|Name" msgstr "" diff --git a/qa/qa/tools/reliable_report.rb b/qa/qa/tools/reliable_report.rb index 4f9d166cac6..9f58c1b8a20 100644 --- a/qa/qa/tools/reliable_report.rb +++ b/qa/qa/tools/reliable_report.rb @@ -12,6 +12,7 @@ module QA include Support::API RELIABLE_REPORT_LABEL = "reliable test report" + PROMOTION_BATCH_LIMIT = 10 ALLOWED_EXCEPTION_PATTERNS = [ /Couldn't find option named/, @@ -132,8 +133,10 @@ module QA end def write_specs_json - File.write('tmp/unstable_specs.json', JSON.pretty_generate(specs_attributes(stable: false))) - File.write('tmp/stable_specs.json', JSON.pretty_generate(specs_attributes(stable: true))) + # 'unstable_specs.json' contain unstable specs tagged reliable + # 'stable_specs.json' contain stable specs not tagged reliable + File.write('tmp/unstable_specs.json', JSON.pretty_generate(specs_attributes(reliable: true))) + File.write('tmp/stable_specs.json', JSON.pretty_generate(specs_attributes(reliable: false))) end private @@ -180,13 +183,19 @@ module QA issue = [] issue << "[[_TOC_]]" - issue << "# Candidates for promotion to reliable #{execution_interval}" + issue << "# Candidates for promotion to reliable/blocking #{execution_interval}" + issue << "**Note: MRs will be auto-created for promoting the top #{PROMOTION_BATCH_LIMIT} " \ + "specs sorted by most number of successful runs**" issue << "Total amount: **#{test_count(stable_test_runs)}**" issue << summary_table(markdown: true, stable: true).to_s issue << results_markdown(:stable) return issue.join("\n\n") if unstable_reliable_test_runs.empty? issue << "# Reliable specs with failures #{execution_interval}" + issue << "**Note:**" + issue << "* Only failures from the nightly, e2e-package-and-test and e2e-test-on-gdk pipelines are considered" + issue << "* Only specs that have a failure rate of equal or greater than 1 percent are considered" + issue << "* Quarantine MRs will be created for all specs listed below" issue << "Total amount: **#{test_count(unstable_reliable_test_runs)}**" issue << summary_table(markdown: true, stable: false).to_s issue << results_markdown(:unstable) @@ -396,8 +405,8 @@ module QA puts("Fetching data on #{reliable ? 'reliable ' : ''}test execution for past #{range} days\n".colorize(:green)) end - def specs_attributes(stable:) - all_runs = stable ? api_query_unreliable : api_query_reliable + def specs_attributes(reliable:) + all_runs = query_for(reliable: reliable) specs_array = all_runs.each_with_object([]) do |table, arr| records = table.records.sort_by { |record| record.values["_time"] } @@ -406,25 +415,41 @@ module QA result = spec_attributes_per_run(records) - next if !stable && result[:failed] == 0 + # When collecting specs not in reliable bucket for promotion, skip specs with failures + next if !reliable && result[:failed] != 0 - next if stable && result[:failed] != 0 - - # A failure issue does not exist - next if !stable && result[:failure_issue].exclude?('issues') + next if reliable && skip_reliable_spec_record?(failed_count: result[:failed], + failure_issue: result[:failure_issue], + failed_run_type: result[:failed_run_type], + failure_rate: result[:failure_rate]) arr << result end + specs_array = specs_array.sort_by { |item| item[:runs] }.reverse.first(PROMOTION_BATCH_LIMIT) unless reliable + { - type: stable ? 'Stable Specs' : 'Unstable Specs', + type: reliable ? 'Unstable Specs' : 'Stable Specs', report_issue: report_web_url, specs: specs_array } end + def skip_reliable_spec_record?(failed_count:, failure_issue:, failed_run_type:, failure_rate:) + # For unstable reliable specs, skip if no failures or + return true if failed_count == 0 || + # skip if a failure issue does not exist or + failure_issue&.exclude?('issues') || + # skip if run type is other than nightly and non-MR e2e-package-and-test pipeline or + (failed_run_type & %w[e2e-package-and-test e2e-test-on-gdk nightly]).empty? || + # skip if failure rate of tests is less than or equal to 1 percent + failure_rate <= 1 + + false + end + def spec_attributes_per_run(records) - failed = records.count do |r| + failed_records = records.select do |r| r.values["status"] == "failed" && !allowed_failure?(r.values["failure_exception"]) end @@ -436,10 +461,11 @@ module QA file_path = FEATURES_DIR + last_record["file_path"] stage = last_record["stage"] || "unknown" testcase = last_record["testcase"] - run_type = last_record["run_type"] + run_type = records.map { |record| record.values['run_type'] }.uniq + failed_run_type = failed_records.map { |record| record.values['run_type'] }.uniq product_group = last_record["product_group"] || "unknown" runs = records.count - failure_rate = (failed.to_f / runs) * 100 + failure_rate = (failed_records.count.to_f / runs) * 100 { stage: stage, @@ -448,22 +474,27 @@ module QA file: file, link: link, runs: runs, - failed: failed, + failed: failed_records.count, failure_issue: failure_issue || '', failure_rate: failure_rate == 0 ? failure_rate.round(0) : failure_rate.round(2), testcase: testcase, file_path: file_path, - run_type: run_type + all_run_type: run_type, + failed_run_type: failed_run_type } end + def query_for(reliable:) + reliable ? api_query_reliable : api_query_unreliable + end + # rubocop:disable Metrics/AbcSize # Test executions grouped by name # # @param [Boolean] reliable # @return [Hash] def test_runs(reliable:) - all_runs = reliable ? api_query_reliable : api_query_unreliable + all_runs = query_for(reliable: reliable) all_runs.each_with_object(Hash.new { |hsh, key| hsh[key] = {} }) do |table, result| records = table.records.sort_by { |record| record.values["_time"] } @@ -477,21 +508,27 @@ module QA link = BLOB_MASTER + FEATURES_DIR + last_record["file_path"] stage = last_record["stage"] || "unknown" product_group = last_record["product_group"] || "unknown" + failure_issue = exceptions_and_related_urls(records).values.last runs = records.count - failed = records.count do |r| + failed_records = records.select do |r| r.values["status"] == "failed" && !allowed_failure?(r.values["failure_exception"]) end - failure_rate = (failed.to_f / runs) * 100 + failed_run_type = failed_records.map { |record| record.values['run_type'] }.uniq + + failure_rate = (failed_records.count.to_f / runs) * 100 + + next if reliable && skip_reliable_spec_record?(failed_count: failed_records.count, + failure_issue: failure_issue, failed_run_type: failed_run_type, failure_rate: failure_rate) result[stage][product_group] ||= {} result[stage][product_group][name] = { file: file, link: link, runs: runs, - failed: failed, + failed: failed_records.count, exceptions_and_related_urls: exceptions_and_related_urls(records), failure_rate: failure_rate == 0 ? failure_rate.round(0) : failure_rate.round(2) } @@ -544,11 +581,11 @@ module QA r.run_type == "staging-sanity" or r.run_type == "production-full" or r.run_type == "production-sanity" or - r.run_type == "package-and-qa" or + r.run_type == "e2e-package-and-test" or + r.run_type == "e2e-test-on-gdk" or r.run_type == "nightly" ) |> filter(fn: (r) => r.job_name != "airgapped" and - r.job_name != "instance-image-slow-network" and r.job_name != "nplus1-instance-image" ) |> filter(fn: (r) => r.status != "pending" and diff --git a/qa/spec/tools/reliable_report_spec.rb b/qa/spec/tools/reliable_report_spec.rb index 9fc94894bcd..bf5c4b1b839 100644 --- a/qa/spec/tools/reliable_report_spec.rb +++ b/qa/spec/tools/reliable_report_spec.rb @@ -36,7 +36,7 @@ describe QA::Tools::ReliableReport do "stage" => "create", "product_group" => "code_review", "testcase" => "https://testcase/url", - "run_type" => "staging", + "run_type" => "e2e-package-and-test", "_time" => time } end @@ -49,7 +49,7 @@ describe QA::Tools::ReliableReport do "stage" => "manage", "product_group" => "import_and_integrate", "testcase" => "https://testcase/url", - "run_type" => "staging", + "run_type" => "e2e-package-and-test", "_time" => time } end @@ -86,7 +86,7 @@ describe QA::Tools::ReliableReport do "job_url" => "https://job/url", "testcase" => "https://testcase/url", "failure_issue" => "https://issues/url", - "run_type" => "staging", + "run_type" => "e2e-package-and-test", "_time" => time } end @@ -102,7 +102,7 @@ describe QA::Tools::ReliableReport do "job_url" => "https://job/url", "testcase" => "https://testcase/url", "failure_issue" => "https://issues/url", - "run_type" => "staging", + "run_type" => "e2e-package-and-test", "_time" => time } end @@ -137,11 +137,11 @@ describe QA::Tools::ReliableReport do r.run_type == "staging-sanity" or r.run_type == "production-full" or r.run_type == "production-sanity" or - r.run_type == "package-and-qa" or + r.run_type == "e2e-package-and-test" or + r.run_type == "e2e-test-on-gdk" or r.run_type == "nightly" ) |> filter(fn: (r) => r.job_name != "airgapped" and - r.job_name != "instance-image-slow-network" and r.job_name != "nplus1-instance-image" ) |> filter(fn: (r) => r.status != "pending" and @@ -300,7 +300,9 @@ describe QA::Tools::ReliableReport do <<~TXT.strip [[_TOC_]] - # Candidates for promotion to reliable (#{Date.today - range} - #{Date.today}) + # Candidates for promotion to reliable/blocking (#{Date.today - range} - #{Date.today}) + + **Note: MRs will be auto-created for promoting the top #{QA::Tools::ReliableReport::PROMOTION_BATCH_LIMIT} specs sorted by most number of successful runs** Total amount: **2** @@ -312,6 +314,14 @@ describe QA::Tools::ReliableReport do # Reliable specs with failures (#{Date.today - range} - #{Date.today}) + **Note:** + + * Only failures from the nightly, e2e-package-and-test and e2e-test-on-gdk pipelines are considered + + * Only specs that have a failure rate of equal or greater than 1 percent are considered + + * Quarantine MRs will be created for all specs listed below + Total amount: **2** #{expected_summary_table([['create', 1], ['manage', 1]], :unstable, true)} @@ -341,7 +351,9 @@ describe QA::Tools::ReliableReport do <<~TXT.strip [[_TOC_]] - # Candidates for promotion to reliable (#{Date.today - range} - #{Date.today}) + # Candidates for promotion to reliable/blocking (#{Date.today - range} - #{Date.today}) + + **Note: MRs will be auto-created for promoting the top #{QA::Tools::ReliableReport::PROMOTION_BATCH_LIMIT} specs sorted by most number of successful runs** Total amount: **2** @@ -455,19 +467,23 @@ describe QA::Tools::ReliableReport do describe "#specs_attributes" do subject(:reliable_report) { described_class.new(14) } + let(:promotion_batch_limit) { 10 } + let(:report_web_url) { 'https://report/url' } before do allow(reliable_report).to receive(:report_web_url).and_return(report_web_url) end - shared_examples "spec attributes" do |stable| - it "returns #{stable} spec attributes" do - expect(reliable_report.send(:specs_attributes, stable: stable)).to eq(expected_specs_attributes) + shared_examples "spec attributes" do |reliable| + it "returns #{reliable} spec attributes" do + stub_const("QA::Tools::ReliableReport::PROMOTION_BATCH_LIMIT", promotion_batch_limit) + + expect(reliable_report.send(:specs_attributes, reliable: reliable)).to eq(expected_specs_attributes) end end - context "with stable false" do + context "with reliable true" do let(:expected_specs_attributes) do { type: "Unstable Specs", report_issue: "https://report/url", @@ -484,7 +500,8 @@ describe QA::Tools::ReliableReport do failure_rate: 66.67, testcase: "https://testcase/url", file_path: "/qa/qa/specs/features/some/spec.rb", - run_type: "staging" }, + all_run_type: ["e2e-package-and-test"], + failed_run_type: ["e2e-package-and-test"] }, { stage: "manage", product_group: "import_and_integrate", name: "unstable spec", @@ -496,32 +513,21 @@ describe QA::Tools::ReliableReport do failure_rate: 66.67, testcase: "https://testcase/url", file_path: "/qa/qa/specs/features/some/spec.rb", - run_type: "staging" } + all_run_type: ["e2e-package-and-test"], + failed_run_type: ["e2e-package-and-test"] } ] } end - it_behaves_like "spec attributes", false + it_behaves_like "spec attributes", true end - context "with stable true" do + context "with reliable false" do let(:expected_specs_attributes) do { type: "Stable Specs", report_issue: "https://report/url", specs: [ - { stage: "create", - product_group: "code_review", - name: "stable spec1", - file: "spec.rb", - link: "https://gitlab.com/gitlab-org/gitlab/-/blob/master/qa/qa/specs/features/some/spec.rb", - runs: 3, - failed: 0, - failure_issue: "", - failure_rate: 0, - testcase: "https://testcase/url", - file_path: "/qa/qa/specs/features/some/spec.rb", - run_type: "staging" }, { stage: "manage", product_group: "import_and_integrate", name: "stable spec2", @@ -533,12 +539,99 @@ describe QA::Tools::ReliableReport do failure_rate: 0, testcase: "https://testcase/url", file_path: "/qa/qa/specs/features/some/spec.rb", - run_type: "staging" } + all_run_type: ["e2e-package-and-test"], + failed_run_type: [] }, + { stage: "create", + product_group: "code_review", + name: "stable spec1", + file: "spec.rb", + link: "https://gitlab.com/gitlab-org/gitlab/-/blob/master/qa/qa/specs/features/some/spec.rb", + runs: 3, + failed: 0, + failure_issue: "", + failure_rate: 0, + testcase: "https://testcase/url", + file_path: "/qa/qa/specs/features/some/spec.rb", + all_run_type: ["e2e-package-and-test"], + failed_run_type: [] } ] } end - it_behaves_like "spec attributes", true + it_behaves_like "spec attributes", false + + context "with specific PROMOTION_BATCH_LIMIT" do + let(:promotion_batch_limit) { 1 } + + let(:runs) do + [ + instance_double( + "InfluxDB2::FluxTable", + records: [ + instance_double("InfluxDB2::FluxRecord", values: run_values), + instance_double("InfluxDB2::FluxRecord", values: run_values), + instance_double("InfluxDB2::FluxRecord", values: run_values.merge({ "_time" => Time.now.to_s })) + ] + ), + instance_double( + "InfluxDB2::FluxTable", + records: [ + instance_double("InfluxDB2::FluxRecord", values: run_more_values), + instance_double("InfluxDB2::FluxRecord", values: run_more_values) + ] + ) + ] + end + + let(:expected_specs_attributes) do + { + type: "Stable Specs", + report_issue: "https://report/url", + specs: + [ + { stage: "create", + product_group: "code_review", + name: "stable spec1", + file: "spec.rb", + link: "https://gitlab.com/gitlab-org/gitlab/-/blob/master/qa/qa/specs/features/some/spec.rb", + runs: 3, + failed: 0, + failure_issue: "", + failure_rate: 0, + testcase: "https://testcase/url", + file_path: "/qa/qa/specs/features/some/spec.rb", + all_run_type: ["e2e-package-and-test"], + failed_run_type: [] } + ] + } + end + + it_behaves_like "spec attributes", false + end + end + end + + describe "#skip_reliable_spec_record?" do + subject(:reliable_report) { described_class.new(14) } + + using RSpec::Parameterized::TableSyntax + + where(:failed_count, :failure_issue, :failed_run_type, :failure_rate, :result) do + 1 | 'https://failure/issues/url' | ['e2e-package-and-test'] | 2 | false + 1 | 'https://failure/issues/url' | ['e2e-test-on-gdk'] | 2 | false + 1 | 'https://failure/issues/url' | ['nightly'] | 2 | false + 0 | 'https://failure/issues/url' | ['e2e-test-on-gdk'] | 2 | true + 1 | 'https://failure/issue/url' | ['e2e-test-on-gdk'] | 2 | true + 1 | 'https://failure/issues/url' | ['abc'] | 2 | true + 1 | 'https://failure/issues/url' | ['e2e-test-on-gdk'] | 0 | true + end + + with_them do + it do + expect(reliable_report.send(:skip_reliable_spec_record?, failed_count: failed_count, + failure_issue: failure_issue, failed_run_type: failed_run_type, failure_rate: failure_rate)) + .to eq result + end end end end diff --git a/spec/frontend/ci/catalog/components/list/ci_resources_list_item_spec.js b/spec/frontend/ci/catalog/components/list/ci_resources_list_item_spec.js index 15add3f307f..67d12b88b6a 100644 --- a/spec/frontend/ci/catalog/components/list/ci_resources_list_item_spec.js +++ b/spec/frontend/ci/catalog/components/list/ci_resources_list_item_spec.js @@ -18,6 +18,20 @@ describe('CiResourcesListItem', () => { const router = createRouter(); const resource = catalogSinglePageResponse.data.ciCatalogResources.nodes[0]; + const componentList = { + components: { + nodes: [ + { + id: 'gid://gitlab/Ci::Catalog::Resources::Component/2', + name: 'test-component', + }, + { + id: 'gid://gitlab/Ci::Catalog::Resources::Component/1', + name: 'component_two', + }, + ], + }, + }; const release = { author: { name: 'author', webUrl: '/user/1' }, releasedAt: Date.now(), @@ -42,6 +56,7 @@ describe('CiResourcesListItem', () => { const findAvatar = () => wrapper.findComponent(GlAvatar); const findBadge = () => wrapper.findComponent(GlBadge); + const findComponentNames = () => wrapper.findByTestId('ci-resource-component-names'); const findResourceName = () => wrapper.findByTestId('ci-resource-link'); const findResourceDescription = () => wrapper.findByText(defaultProps.resource.description); const findUserLink = () => wrapper.findByTestId('user-link'); @@ -82,6 +97,35 @@ describe('CiResourcesListItem', () => { }); }); + describe('components', () => { + describe('when there are no components', () => { + beforeEach(() => { + createComponent({ props: { resource: { ...resource, latestVersion: null } } }); + }); + + it('does not render the component names', () => { + expect(findComponentNames().exists()).toBe(false); + }); + }); + + describe('when there are components', () => { + beforeEach(() => { + createComponent({ + props: { resource: { ...resource, latestVersion: { ...componentList, ...release } } }, + }); + }); + + it('renders the component name template', () => { + expect(findComponentNames().exists()).toBe(true); + }); + + it('renders the correct component names', () => { + expect(findComponentNames().text()).toContain(componentList.components.nodes[0].name); + expect(findComponentNames().text()).toContain(componentList.components.nodes[1].name); + }); + }); + }); + describe('release time', () => { describe('when there is no release data', () => { beforeEach(() => { diff --git a/spec/frontend/ci/catalog/mock.js b/spec/frontend/ci/catalog/mock.js index c9256435990..2aac033b529 100644 --- a/spec/frontend/ci/catalog/mock.js +++ b/spec/frontend/ci/catalog/mock.js @@ -1,3 +1,49 @@ +const componentsDetailsMockData = { + __typename: 'CiComponentConnection', + nodes: [ + { + id: 'gid://gitlab/Ci::Component/1', + name: 'Ruby gal', + description: 'This is a pretty amazing component that does EVERYTHING ruby.', + includePath: 'gitlab.com/gitlab-org/ruby-gal@~latest', + inputs: [{ name: 'version', default: '1.0.0', required: true }], + }, + { + id: 'gid://gitlab/Ci::Component/2', + name: 'Javascript madness', + description: 'Adds some spice to your life.', + includePath: 'gitlab.com/gitlab-org/javascript-madness@~latest', + inputs: [ + { name: 'isFun', default: 'true', required: true }, + { name: 'RandomNumber', default: '10', required: false }, + ], + }, + { + id: 'gid://gitlab/Ci::Component/3', + name: 'Go go go', + description: 'When you write Go, you gotta go go go.', + includePath: 'gitlab.com/gitlab-org/go-go-go@~latest', + inputs: [{ name: 'version', default: '1.0.0', required: true }], + }, + ], +}; + +const componentsListMockData = { + nodes: [ + { + id: 'gid://gitlab/Ci::Catalog::Resources::Component/2', + name: 'test-component', + __typename: 'CiCatalogResourceComponent', + }, + { + id: 'gid://gitlab/Ci::Catalog::Resources::Component/1', + name: 'component_two', + __typename: 'CiCatalogResourceComponent', + }, + ], + __typename: 'CiCatalogResourceComponentConnection', +}; + export const emptyCatalogResponseBody = { data: { ciCatalogResources: { @@ -268,7 +314,13 @@ export const catalogSinglePageResponse = { name: 'Project-45 Name', description: 'A simple component', starCount: 0, - latestVersion: null, + latestVersion: { + id: 'gid://gitlab/Ci::Catalog::Resources::Version/2', + components: { + ...componentsListMockData, + }, + __typename: 'CiCatalogResourceVersion', + }, webPath: '/frontend-fixtures/project-45', __typename: 'CiCatalogResource', }, @@ -310,6 +362,7 @@ export const catalogSharedDataMock = { latestVersion: { __typename: 'Release', id: '3', + components: componentsListMockData, name: '1.0.0', path: 'path/to/release', releasedAt: Date.now(), @@ -378,6 +431,9 @@ const generateResourcesNodes = (count = 20, startId = 0) => { latestVersion: { __typename: 'Release', id: '3', + components: { + ...componentsListMockData, + }, name: '1.0.0', path: 'path/to/release', releasedAt: Date.now(), @@ -392,36 +448,6 @@ const generateResourcesNodes = (count = 20, startId = 0) => { export const mockCatalogResourceItem = generateResourcesNodes(1)[0]; -const componentsMockData = { - __typename: 'CiComponentConnection', - nodes: [ - { - id: 'gid://gitlab/Ci::Component/1', - name: 'Ruby gal', - description: 'This is a pretty amazing component that does EVERYTHING ruby.', - includePath: 'gitlab.com/gitlab-org/ruby-gal@~latest', - inputs: [{ name: 'version', default: '1.0.0', required: true }], - }, - { - id: 'gid://gitlab/Ci::Component/2', - name: 'Javascript madness', - description: 'Adds some spice to your life.', - includePath: 'gitlab.com/gitlab-org/javascript-madness@~latest', - inputs: [ - { name: 'isFun', default: 'true', required: true }, - { name: 'RandomNumber', default: '10', required: false }, - ], - }, - { - id: 'gid://gitlab/Ci::Component/3', - name: 'Go go go', - description: 'When you write Go, you gotta go go go.', - includePath: 'gitlab.com/gitlab-org/go-go-go@~latest', - inputs: [{ name: 'version', default: '1.0.0', required: true }], - }, - ], -}; - export const mockComponents = { data: { ciCatalogResource: { @@ -431,7 +457,7 @@ export const mockComponents = { latestVersion: { id: 'gid://gitlab/Version/1', components: { - ...componentsMockData, + ...componentsDetailsMockData, }, }, }, diff --git a/spec/lib/gitlab/background_migration/backfill_catalog_resource_versions_released_at_spec.rb b/spec/lib/gitlab/background_migration/backfill_catalog_resource_versions_released_at_spec.rb new file mode 100644 index 00000000000..f4ab3203cd7 --- /dev/null +++ b/spec/lib/gitlab/background_migration/backfill_catalog_resource_versions_released_at_spec.rb @@ -0,0 +1,50 @@ +# frozen_string_literal: true + +require 'spec_helper' + +RSpec.describe Gitlab::BackgroundMigration::BackfillCatalogResourceVersionsReleasedAt, + feature_category: :pipeline_composition do + let(:namespace) { table(:namespaces).create!(name: 'name', path: 'path') } + let(:project) { table(:projects).create!(namespace_id: namespace.id, project_namespace_id: namespace.id) } + let(:resource) { table(:catalog_resources).create!(project_id: project.id) } + + let(:releases_table) { table(:releases) } + let(:versions_table) { table(:catalog_resource_versions) } + + let(:release1) { releases_table.create!(tag: 'v1', released_at: '2024-01-01T00:00:00Z') } + let(:release2) { releases_table.create!(tag: 'v2', released_at: '2024-02-02T00:00:00Z') } + let(:release3) { releases_table.create!(tag: 'v3', released_at: '2025-03-03T00:00:00Z') } + + let(:version1) do + versions_table.create!(release_id: release1.id, catalog_resource_id: resource.id, project_id: project.id) + end + + let(:version2) do + versions_table.create!(release_id: release2.id, catalog_resource_id: resource.id, project_id: project.id) + end + + let(:version3) do + versions_table.create!(release_id: release3.id, catalog_resource_id: resource.id, project_id: project.id) + end + + subject(:perform_migration) do + described_class.new( + start_id: versions_table.minimum(:id), + end_id: versions_table.maximum(:id), + batch_table: :catalog_resource_versions, + batch_column: :id, + sub_batch_size: 2, + pause_ms: 0, + connection: ActiveRecord::Base.connection + ).perform + end + + it 'updates catalog_resource_versions.released_at with the corresponding value from releases.released_at' do + expect { perform_migration } + .to change { version1.reload.released_at }.to(release1.released_at) + .and change { version2.reload.released_at }.to(release2.released_at) + .and change { version3.reload.released_at }.to(release3.released_at) + + perform_migration + end +end diff --git a/spec/lib/gitlab/database/reindexing_spec.rb b/spec/lib/gitlab/database/reindexing_spec.rb index 2321f5d933d..74868ff97f7 100644 --- a/spec/lib/gitlab/database/reindexing_spec.rb +++ b/spec/lib/gitlab/database/reindexing_spec.rb @@ -238,6 +238,19 @@ RSpec.describe Gitlab::Database::Reindexing, feature_category: :database, time_t describe '.cleanup_leftovers!' do subject(:cleanup_leftovers) { described_class.cleanup_leftovers! } + let(:expected_queries) do + [ + "SET lock_timeout TO '60000ms'", + "DROP INDEX CONCURRENTLY IF EXISTS \"public\".\"foobar_ccnew\"", + "RESET idle_in_transaction_session_timeout; RESET lock_timeout", + "SET lock_timeout TO '60000ms'", + "DROP INDEX CONCURRENTLY IF EXISTS \"public\".\"foobar_ccnew1\"", + "RESET idle_in_transaction_session_timeout; RESET lock_timeout" + ] + end + + let(:actual_queries) { [] } + let(:model) { Gitlab::Database.database_base_models[Gitlab::Database::PRIMARY_DATABASE_NAME] } let(:connection) { model.connection } @@ -255,20 +268,15 @@ RSpec.describe Gitlab::Database::Reindexing, feature_category: :database, time_t end it 'drops both leftover indexes' do - expect_query("SET lock_timeout TO '60000ms'") - expect_query("DROP INDEX CONCURRENTLY IF EXISTS \"public\".\"foobar_ccnew\"") - expect_query("RESET idle_in_transaction_session_timeout; RESET lock_timeout") - expect_query("SET lock_timeout TO '60000ms'") - expect_query("DROP INDEX CONCURRENTLY IF EXISTS \"public\".\"foobar_ccnew1\"") - expect_query("RESET idle_in_transaction_session_timeout; RESET lock_timeout") - - cleanup_leftovers - end - - def expect_query(sql) - expect(connection).to receive(:execute).ordered.with(sql).and_wrap_original do |method, sql| + allow(connection).to receive(:execute).and_wrap_original do |method, sql| + actual_queries << sql method.call(sql.sub(/CONCURRENTLY/, '')) end + + cleanup_leftovers + + # Ordering matters here, we're making sure the query order matched what we expect. + expect(expected_queries).to eq(actual_queries) end end end diff --git a/spec/lib/gitlab/gitaly_client/blobs_stitcher_spec.rb b/spec/lib/gitlab/gitaly_client/blobs_stitcher_spec.rb index e0c3e8d4b40..1ab0e040c10 100644 --- a/spec/lib/gitlab/gitaly_client/blobs_stitcher_spec.rb +++ b/spec/lib/gitlab/gitaly_client/blobs_stitcher_spec.rb @@ -4,35 +4,78 @@ require 'spec_helper' RSpec.describe Gitlab::GitalyClient::BlobsStitcher do describe 'enumeration' do - it 'combines segregated blob messages together' do - messages = [ - OpenStruct.new(oid: 'abcdef1', path: 'path/to/file', size: 1642, revision: 'f00ba7', mode: 0100644, data: "first-line\n"), - OpenStruct.new(oid: '', data: 'second-line'), - OpenStruct.new(oid: '', data: '', revision: 'f00ba7', path: 'path/to/non-existent/file'), - OpenStruct.new(oid: 'abcdef2', path: 'path/to/another-file', size: 2461, revision: 'f00ba8', mode: 0100644, data: "GIF87a\x90\x01".b) - ] + context 'when increase_diff_file_performance is on' do + before do + stub_feature_flags(stop_precalling_binary_for_blobs: true) + end - blobs = described_class.new(messages).to_a + it 'combines segregated blob messages together' do + messages = [ + OpenStruct.new(oid: 'abcdef1', path: 'path/to/file', size: 1642, revision: 'f00ba7', mode: 0100644, data: "first-line\n"), + OpenStruct.new(oid: '', data: 'second-line'), + OpenStruct.new(oid: '', data: '', revision: 'f00ba7', path: 'path/to/non-existent/file'), + OpenStruct.new(oid: 'abcdef2', path: 'path/to/another-file', size: 2461, revision: 'f00ba8', mode: 0100644, data: "GIF87a\x90\x01".b) + ] - expect(blobs.size).to be(2) + blobs = described_class.new(messages).to_a - expect(blobs[0].id).to eq('abcdef1') - expect(blobs[0].mode).to eq('100644') - expect(blobs[0].name).to eq('file') - expect(blobs[0].path).to eq('path/to/file') - expect(blobs[0].size).to eq(1642) - expect(blobs[0].commit_id).to eq('f00ba7') - expect(blobs[0].data).to eq("first-line\nsecond-line") - expect(blobs[0].binary_in_repo?).to be false + expect(blobs.size).to be(2) - expect(blobs[1].id).to eq('abcdef2') - expect(blobs[1].mode).to eq('100644') - expect(blobs[1].name).to eq('another-file') - expect(blobs[1].path).to eq('path/to/another-file') - expect(blobs[1].size).to eq(2461) - expect(blobs[1].commit_id).to eq('f00ba8') - expect(blobs[1].data).to eq("GIF87a\x90\x01".b) - expect(blobs[1].binary_in_repo?).to be true + expect(blobs[0].id).to eq('abcdef1') + expect(blobs[0].mode).to eq('100644') + expect(blobs[0].name).to eq('file') + expect(blobs[0].path).to eq('path/to/file') + expect(blobs[0].size).to eq(1642) + expect(blobs[0].commit_id).to eq('f00ba7') + expect(blobs[0].data).to eq("first-line\nsecond-line") + expect(blobs[0].binary_in_repo?).to be false + + expect(blobs[1].id).to eq('abcdef2') + expect(blobs[1].mode).to eq('100644') + expect(blobs[1].name).to eq('another-file') + expect(blobs[1].path).to eq('path/to/another-file') + expect(blobs[1].size).to eq(2461) + expect(blobs[1].commit_id).to eq('f00ba8') + expect(blobs[1].data).to eq("GIF87a\x90\x01".b) + expect(blobs[1].binary_in_repo?).to be true + end + end + + context 'when increase_diff_file_performance is off' do + before do + stub_feature_flags(stop_precalling_binary_for_blobs: false) + end + + it 'combines segregated blob messages together' do + messages = [ + OpenStruct.new(oid: 'abcdef1', path: 'path/to/file', size: 1642, revision: 'f00ba7', mode: 0100644, data: "first-line\n"), + OpenStruct.new(oid: '', data: 'second-line'), + OpenStruct.new(oid: '', data: '', revision: 'f00ba7', path: 'path/to/non-existent/file'), + OpenStruct.new(oid: 'abcdef2', path: 'path/to/another-file', size: 2461, revision: 'f00ba8', mode: 0100644, data: "GIF87a\x90\x01".b) + ] + + blobs = described_class.new(messages).to_a + + expect(blobs.size).to be(2) + + expect(blobs[0].id).to eq('abcdef1') + expect(blobs[0].mode).to eq('100644') + expect(blobs[0].name).to eq('file') + expect(blobs[0].path).to eq('path/to/file') + expect(blobs[0].size).to eq(1642) + expect(blobs[0].commit_id).to eq('f00ba7') + expect(blobs[0].data).to eq("first-line\nsecond-line") + expect(blobs[0].binary_in_repo?).to be false + + expect(blobs[1].id).to eq('abcdef2') + expect(blobs[1].mode).to eq('100644') + expect(blobs[1].name).to eq('another-file') + expect(blobs[1].path).to eq('path/to/another-file') + expect(blobs[1].size).to eq(2461) + expect(blobs[1].commit_id).to eq('f00ba8') + expect(blobs[1].data).to eq("GIF87a\x90\x01".b) + expect(blobs[1].binary_in_repo?).to be true + end end end end diff --git a/spec/migrations/20240118225727_queue_backfill_catalog_resource_versions_released_at_spec.rb b/spec/migrations/20240118225727_queue_backfill_catalog_resource_versions_released_at_spec.rb new file mode 100644 index 00000000000..5b07e6eb2d5 --- /dev/null +++ b/spec/migrations/20240118225727_queue_backfill_catalog_resource_versions_released_at_spec.rb @@ -0,0 +1,26 @@ +# frozen_string_literal: true + +require 'spec_helper' +require_migration! + +RSpec.describe QueueBackfillCatalogResourceVersionsReleasedAt, feature_category: :pipeline_composition do + let!(:batched_migration) { described_class::MIGRATION } + + it 'schedules a new batched migration' do + reversible_migration do |migration| + migration.before -> { + expect(batched_migration).not_to have_scheduled_batched_migration + } + + migration.after -> { + expect(batched_migration).to have_scheduled_batched_migration( + table_name: :catalog_resource_versions, + column_name: :id, + interval: described_class::DELAY_INTERVAL, + batch_size: described_class::BATCH_SIZE, + sub_batch_size: described_class::SUB_BATCH_SIZE + ) + } + end + end +end diff --git a/spec/models/concerns/pg_full_text_searchable_spec.rb b/spec/models/concerns/pg_full_text_searchable_spec.rb index f3289408643..df7669d0822 100644 --- a/spec/models/concerns/pg_full_text_searchable_spec.rb +++ b/spec/models/concerns/pg_full_text_searchable_spec.rb @@ -112,9 +112,11 @@ RSpec.describe PgFullTextSearchable, feature_category: :global_search do expect(model_class.pg_full_text_search('"description english"')).to contain_exactly(english) end - it 'ignores accents' do - expect(model_class.pg_full_text_search('jurgen')).to contain_exactly(with_accent) - expect(model_class.pg_full_text_search('Jürgen')).to contain_exactly(with_accent) + it 'ignores accents regardless of user locale' do + with_accent_in_german = Gitlab::I18n.with_locale(:de) { model_class.create!(project: project, namespace: project.project_namespace, title: 'Jürgen') } + + expect(model_class.pg_full_text_search('jurgen')).to contain_exactly(with_accent, with_accent_in_german) + expect(model_class.pg_full_text_search('Jürgen')).to contain_exactly(with_accent, with_accent_in_german) end it 'does not support searching by non-Latin characters' do diff --git a/tooling/danger/analytics_instrumentation.rb b/tooling/danger/analytics_instrumentation.rb index d49c0f9e6ba..47078f1cb31 100644 --- a/tooling/danger/analytics_instrumentation.rb +++ b/tooling/danger/analytics_instrumentation.rb @@ -27,7 +27,7 @@ module Tooling CHANGED_USAGE_DATA_MESSAGE = <<~MSG Notice that implementing metrics directly in usage_data.rb has been deprecated. - Please use [Instrumentation Classes](https://docs.gitlab.com/ee/development/service_ping/metrics_instrumentation.html) instead. + Please use [Instrumentation Classes](https://docs.gitlab.com/ee/development/internal_analytics/metrics/metrics_instrumentation.html) instead. MSG CHANGE_DEPRECATED_DATA_SOURCE_MESSAGE = <<~MSG