Commit 416e2032 authored by Suzanne Selhorn's avatar Suzanne Selhorn

Merge branch 'caution-to-warning' into 'master'

Change CAUTION to WARNING in documentation alerts

See merge request gitlab-org/gitlab!49252
parents 1588893c d240d530
...@@ -615,7 +615,7 @@ By default, GitLab runs a group sync process every hour, on the hour. ...@@ -615,7 +615,7 @@ By default, GitLab runs a group sync process every hour, on the hour.
The values shown are in cron format. If needed, you can use a The values shown are in cron format. If needed, you can use a
[Crontab Generator](http://www.crontabgenerator.com). [Crontab Generator](http://www.crontabgenerator.com).
CAUTION: **Important:** WARNING:
Do not start the sync process too frequently as this Do not start the sync process too frequently as this
could lead to multiple syncs running concurrently. This is primarily a concern could lead to multiple syncs running concurrently. This is primarily a concern
for installations with a large number of LDAP users. Please review the for installations with a large number of LDAP users. Please review the
......
...@@ -673,7 +673,7 @@ adfind -h ad.example.org:636 -ssl -u "CN=GitLabSRV,CN=Users,DC=GitLab,DC=org" -u ...@@ -673,7 +673,7 @@ adfind -h ad.example.org:636 -ssl -u "CN=GitLabSRV,CN=Users,DC=GitLab,DC=org" -u
### Rails console ### Rails console
CAUTION: **Caution:** WARNING:
It is very easy to create, read, modify, and destroy data with the rails It is very easy to create, read, modify, and destroy data with the rails
console. Be sure to run commands exactly as listed. console. Be sure to run commands exactly as listed.
......
...@@ -30,7 +30,7 @@ GitLab supports two authentication methods: ...@@ -30,7 +30,7 @@ GitLab supports two authentication methods:
> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/726) in [GitLab Premium](https://about.gitlab.com/pricing/) 11.6 as an experimental feature. > [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/726) in [GitLab Premium](https://about.gitlab.com/pricing/) 11.6 as an experimental feature.
CAUTION: **Caution:** WARNING:
Smartcard authentication against local databases may change or be removed completely in future Smartcard authentication against local databases may change or be removed completely in future
releases. releases.
......
...@@ -9,7 +9,7 @@ type: reference, howto ...@@ -9,7 +9,7 @@ type: reference, howto
You can use an external service for validating a pipeline before it's created. You can use an external service for validating a pipeline before it's created.
CAUTION: **Warning:** WARNING:
This is an experimental feature and subject to change without notice. This is an experimental feature and subject to change without notice.
## Usage ## Usage
......
...@@ -36,7 +36,7 @@ error, it's very important that you [**provide feedback**](https://gitlab.com/gi ...@@ -36,7 +36,7 @@ error, it's very important that you [**provide feedback**](https://gitlab.com/gi
as possible so we can improve or fix it while behind a flag. When you upgrade as possible so we can improve or fix it while behind a flag. When you upgrade
GitLab to an earlier version, the feature flag status may change. GitLab to an earlier version, the feature flag status may change.
CAUTION: **Caution:** WARNING:
Features deployed behind feature flags may not be ready for Features deployed behind feature flags may not be ready for
production use. However, disabling features behind flags that were deployed production use. However, disabling features behind flags that were deployed
enabled by default may also present a risk. If they're enabled, we recommend enabled by default may also present a risk. If they're enabled, we recommend
......
...@@ -13,7 +13,7 @@ restore your original configuration. This process consists of two steps: ...@@ -13,7 +13,7 @@ restore your original configuration. This process consists of two steps:
1. Making the old **primary** node a **secondary** node. 1. Making the old **primary** node a **secondary** node.
1. Promoting a **secondary** node to a **primary** node. 1. Promoting a **secondary** node to a **primary** node.
CAUTION: **Caution:** WARNING:
If you have any doubts about the consistency of the data on this node, we recommend setting it up from scratch. If you have any doubts about the consistency of the data on this node, we recommend setting it up from scratch.
## Configure the former **primary** node to be a **secondary** node ## Configure the former **primary** node to be a **secondary** node
......
...@@ -13,7 +13,7 @@ failover with minimal effort, in a disaster situation. ...@@ -13,7 +13,7 @@ failover with minimal effort, in a disaster situation.
See [Geo limitations](../index.md#limitations) for more information. See [Geo limitations](../index.md#limitations) for more information.
CAUTION: **Warning:** WARNING:
Disaster recovery for multi-secondary configurations is in **Alpha**. Disaster recovery for multi-secondary configurations is in **Alpha**.
For the latest updates, check the [Disaster Recovery epic for complete maturity](https://gitlab.com/groups/gitlab-org/-/epics/590). For the latest updates, check the [Disaster Recovery epic for complete maturity](https://gitlab.com/groups/gitlab-org/-/epics/590).
Multi-secondary configurations require the complete re-synchronization and re-configuration of all non-promoted secondaries and Multi-secondary configurations require the complete re-synchronization and re-configuration of all non-promoted secondaries and
...@@ -36,7 +36,7 @@ order to avoid unnecessary data loss. ...@@ -36,7 +36,7 @@ order to avoid unnecessary data loss.
### Step 2. Permanently disable the **primary** node ### Step 2. Permanently disable the **primary** node
CAUTION: **Warning:** WARNING:
If the **primary** node goes offline, there may be data saved on the **primary** node If the **primary** node goes offline, there may be data saved on the **primary** node
that has not been replicated to the **secondary** node. This data should be treated that has not been replicated to the **secondary** node. This data should be treated
as lost if you proceed. as lost if you proceed.
...@@ -140,7 +140,7 @@ Note the following when promoting a secondary: ...@@ -140,7 +140,7 @@ Note the following when promoting a secondary:
secondary. If the node is paused, be sure to resume before promoting. This secondary. If the node is paused, be sure to resume before promoting. This
issue has been fixed in GitLab 13.4 and later. issue has been fixed in GitLab 13.4 and later.
CAUTION: **Caution:** WARNING:
If the secondary node [has been paused](../../geo/index.md#pausing-and-resuming-replication), this performs If the secondary node [has been paused](../../geo/index.md#pausing-and-resuming-replication), this performs
a point-in-time recovery to the last known state. a point-in-time recovery to the last known state.
Data that was created on the primary while the secondary was paused will be lost. Data that was created on the primary while the secondary was paused will be lost.
...@@ -180,7 +180,7 @@ secondary is paused fails. Do not pause replication before promoting a ...@@ -180,7 +180,7 @@ secondary is paused fails. Do not pause replication before promoting a
secondary. If the node is paused, be sure to resume before promoting. This secondary. If the node is paused, be sure to resume before promoting. This
issue has been fixed in GitLab 13.4 and later. issue has been fixed in GitLab 13.4 and later.
CAUTION: **Caution:** WARNING:
If the secondary node [has been paused](../../geo/index.md#pausing-and-resuming-replication), this performs If the secondary node [has been paused](../../geo/index.md#pausing-and-resuming-replication), this performs
a point-in-time recovery to the last known state. a point-in-time recovery to the last known state.
Data that was created on the primary while the secondary was paused will be lost. Data that was created on the primary while the secondary was paused will be lost.
......
...@@ -5,7 +5,7 @@ info: To determine the technical writer assigned to the Stage/Group associated w ...@@ -5,7 +5,7 @@ info: To determine the technical writer assigned to the Stage/Group associated w
type: howto type: howto
--- ---
CAUTION: **Caution:** WARNING:
This runbook is in **alpha**. For complete, production-ready documentation, see the This runbook is in **alpha**. For complete, production-ready documentation, see the
[disaster recovery documentation](../index.md). [disaster recovery documentation](../index.md).
...@@ -134,7 +134,7 @@ follow these steps to avoid unnecessary data loss: ...@@ -134,7 +134,7 @@ follow these steps to avoid unnecessary data loss:
1. Finish replicating and verifying all data: 1. Finish replicating and verifying all data:
CAUTION: **Caution:** WARNING:
Not all data is automatically replicated. Read more about Not all data is automatically replicated. Read more about
[what is excluded](../planned_failover.md#not-all-data-is-automatically-replicated). [what is excluded](../planned_failover.md#not-all-data-is-automatically-replicated).
...@@ -163,7 +163,7 @@ follow these steps to avoid unnecessary data loss: ...@@ -163,7 +163,7 @@ follow these steps to avoid unnecessary data loss:
1. In this final step, you need to permanently disable the **primary** node. 1. In this final step, you need to permanently disable the **primary** node.
CAUTION: **Caution:** WARNING:
When the **primary** node goes offline, there may be data saved on the **primary** node When the **primary** node goes offline, there may be data saved on the **primary** node
that has not been replicated to the **secondary** node. This data should be treated that has not been replicated to the **secondary** node. This data should be treated
as lost if you proceed. as lost if you proceed.
...@@ -218,7 +218,7 @@ A new **secondary** should not be added at this time. If you want to add a new ...@@ -218,7 +218,7 @@ A new **secondary** should not be added at this time. If you want to add a new
**secondary**, do this after you have completed the entire process of promoting **secondary**, do this after you have completed the entire process of promoting
the **secondary** to the **primary**. the **secondary** to the **primary**.
CAUTION: **Caution:** WARNING:
If you encounter an `ActiveRecord::RecordInvalid: Validation failed: Name has already been taken` error during this process, read If you encounter an `ActiveRecord::RecordInvalid: Validation failed: Name has already been taken` error during this process, read
[the troubleshooting advice](../../replication/troubleshooting.md#fixing-errors-during-a-failover-or-when-promoting-a-secondary-to-a-primary-node). [the troubleshooting advice](../../replication/troubleshooting.md#fixing-errors-during-a-failover-or-when-promoting-a-secondary-to-a-primary-node).
...@@ -233,7 +233,7 @@ secondary is paused fails. Do not pause replication before promoting a ...@@ -233,7 +233,7 @@ secondary is paused fails. Do not pause replication before promoting a
secondary. If the node is paused, be sure to resume before promoting. This secondary. If the node is paused, be sure to resume before promoting. This
issue has been fixed in GitLab 13.4 and later. issue has been fixed in GitLab 13.4 and later.
CAUTION: **Caution:** WARNING:
If the secondary node [has been paused](../../../geo/index.md#pausing-and-resuming-replication), this performs If the secondary node [has been paused](../../../geo/index.md#pausing-and-resuming-replication), this performs
a point-in-time recovery to the last known state. a point-in-time recovery to the last known state.
Data that was created on the primary while the secondary was paused will be lost. Data that was created on the primary while the secondary was paused will be lost.
......
...@@ -5,7 +5,7 @@ info: To determine the technical writer assigned to the Stage/Group associated w ...@@ -5,7 +5,7 @@ info: To determine the technical writer assigned to the Stage/Group associated w
type: howto type: howto
--- ---
CAUTION: **Caution:** WARNING:
This runbook is in **alpha**. For complete, production-ready documentation, see the This runbook is in **alpha**. For complete, production-ready documentation, see the
[disaster recovery documentation](../index.md). [disaster recovery documentation](../index.md).
...@@ -122,7 +122,7 @@ follow these steps to avoid unnecessary data loss: ...@@ -122,7 +122,7 @@ follow these steps to avoid unnecessary data loss:
1. Finish replicating and verifying all data: 1. Finish replicating and verifying all data:
CAUTION: **Caution:** WARNING:
Not all data is automatically replicated. Read more about Not all data is automatically replicated. Read more about
[what is excluded](../planned_failover.md#not-all-data-is-automatically-replicated). [what is excluded](../planned_failover.md#not-all-data-is-automatically-replicated).
...@@ -151,7 +151,7 @@ follow these steps to avoid unnecessary data loss: ...@@ -151,7 +151,7 @@ follow these steps to avoid unnecessary data loss:
1. In this final step, you need to permanently disable the **primary** node. 1. In this final step, you need to permanently disable the **primary** node.
CAUTION: **Caution:** WARNING:
When the **primary** node goes offline, there may be data saved on the **primary** node When the **primary** node goes offline, there may be data saved on the **primary** node
that has not been replicated to the **secondary** node. This data should be treated that has not been replicated to the **secondary** node. This data should be treated
as lost if you proceed. as lost if you proceed.
......
...@@ -17,7 +17,7 @@ Geo is the solution for widely distributed development teams and for providing a ...@@ -17,7 +17,7 @@ Geo is the solution for widely distributed development teams and for providing a
## Overview ## Overview
CAUTION: **Caution:** WARNING:
Geo undergoes significant changes from release to release. Upgrades **are** supported and [documented](#updating-geo), but you should ensure that you're using the right version of the documentation for your installation. Geo undergoes significant changes from release to release. Upgrades **are** supported and [documented](#updating-geo), but you should ensure that you're using the right version of the documentation for your installation.
Fetching large repositories can take a long time for teams located far from a single GitLab instance. Fetching large repositories can take a long time for teams located far from a single GitLab instance.
...@@ -207,7 +207,7 @@ secondary is paused fails. Do not pause replication before promoting a ...@@ -207,7 +207,7 @@ secondary is paused fails. Do not pause replication before promoting a
secondary. If the node is paused, be sure to resume before promoting. This secondary. If the node is paused, be sure to resume before promoting. This
issue has been fixed in GitLab 13.4 and later. issue has been fixed in GitLab 13.4 and later.
CAUTION: **Caution:** WARNING:
Pausing and resuming of replication is currently only supported for Geo installations using an Pausing and resuming of replication is currently only supported for Geo installations using an
Omnibus GitLab-managed database. External databases are currently not supported. Omnibus GitLab-managed database. External databases are currently not supported.
...@@ -267,7 +267,7 @@ To find out how to disable Geo, see [Disabling Geo](replication/disable_geo.md). ...@@ -267,7 +267,7 @@ To find out how to disable Geo, see [Disabling Geo](replication/disable_geo.md).
## Limitations ## Limitations
CAUTION: **Caution:** WARNING:
This list of limitations only reflects the latest version of GitLab. If you are using an older version, extra limitations may be in place. This list of limitations only reflects the latest version of GitLab. If you are using an older version, extra limitations may be in place.
- Pushing directly to a **secondary** node redirects (for HTTP) or proxies (for SSH) the request to the **primary** node instead of [handling it directly](https://gitlab.com/gitlab-org/gitlab/-/issues/1381), except when using Git over HTTP with credentials embedded within the URI. For example, `https://user:password@secondary.tld`. - Pushing directly to a **secondary** node redirects (for HTTP) or proxies (for SSH) the request to the **primary** node instead of [handling it directly](https://gitlab.com/gitlab-org/gitlab/-/issues/1381), except when using Git over HTTP with credentials embedded within the URI. For example, `https://user:password@secondary.tld`.
......
...@@ -25,7 +25,7 @@ To have: ...@@ -25,7 +25,7 @@ To have:
> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/10586) in GitLab 12.4. > [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/10586) in GitLab 12.4.
CAUTION: **Caution:** WARNING:
This is a [**beta** feature](https://about.gitlab.com/handbook/product/#beta) and is not ready yet for production use at any scale. The main limitations are a lack of testing at scale and no verification of any replicated data. This is a [**beta** feature](https://about.gitlab.com/handbook/product/#beta) and is not ready yet for production use at any scale. The main limitations are a lack of testing at scale and no verification of any replicated data.
**Secondary** nodes can replicate files stored on the **primary** node regardless of **Secondary** nodes can replicate files stored on the **primary** node regardless of
......
...@@ -467,7 +467,7 @@ to start again from scratch, there are a few steps that can help you: ...@@ -467,7 +467,7 @@ to start again from scratch, there are a few steps that can help you:
1. _(Optional)_ Rename other data folders and create new ones 1. _(Optional)_ Rename other data folders and create new ones
CAUTION: **Caution:** WARNING:
You may still have files on the **secondary** node that have been removed from **primary** node but You may still have files on the **secondary** node that have been removed from **primary** node but
removal have not been reflected. If you skip this step, they will never be removed removal have not been reflected. If you skip this step, they will never be removed
from this Geo node. from this Geo node.
......
...@@ -7,7 +7,7 @@ type: howto ...@@ -7,7 +7,7 @@ type: howto
# Updating the Geo nodes **(PREMIUM ONLY)** # Updating the Geo nodes **(PREMIUM ONLY)**
CAUTION: **Warning:** WARNING:
Read these sections carefully before updating your Geo nodes. Not following Read these sections carefully before updating your Geo nodes. Not following
version-specific update steps may result in unexpected downtime. If you have version-specific update steps may result in unexpected downtime. If you have
any specific questions, [contact Support](https://about.gitlab.com/support/#contact-support). any specific questions, [contact Support](https://about.gitlab.com/support/#contact-support).
......
...@@ -54,7 +54,7 @@ the recommended procedure, see the ...@@ -54,7 +54,7 @@ the recommended procedure, see the
## Updating to GitLab 12.9 ## Updating to GitLab 12.9
CAUTION: **Warning:** WARNING:
GitLab 12.9.0 through GitLab 12.9.3 are affected by [a bug that stops GitLab 12.9.0 through GitLab 12.9.3 are affected by [a bug that stops
repository verification](https://gitlab.com/gitlab-org/gitlab/-/issues/213523). repository verification](https://gitlab.com/gitlab-org/gitlab/-/issues/213523).
The issue is fixed in GitLab 12.9.4. Upgrade to GitLab 12.9.4 or later. The issue is fixed in GitLab 12.9.4. Upgrade to GitLab 12.9.4 or later.
...@@ -203,14 +203,14 @@ For the recommended procedure, see the ...@@ -203,14 +203,14 @@ For the recommended procedure, see the
## Updating to GitLab 12.0 ## Updating to GitLab 12.0
CAUTION: **Warning:** WARNING:
This version is affected by a [bug that results in new LFS objects not being This version is affected by a [bug that results in new LFS objects not being
replicated to Geo secondary nodes](https://gitlab.com/gitlab-org/gitlab/-/issues/32696). replicated to Geo secondary nodes](https://gitlab.com/gitlab-org/gitlab/-/issues/32696).
The issue is fixed in GitLab 12.1; be sure to upgrade to GitLab 12.1 or later. The issue is fixed in GitLab 12.1; be sure to upgrade to GitLab 12.1 or later.
## Updating to GitLab 11.11 ## Updating to GitLab 11.11
CAUTION: **Warning:** WARNING:
This version is affected by a [bug that results in new LFS objects not being This version is affected by a [bug that results in new LFS objects not being
replicated to Geo secondary nodes](https://gitlab.com/gitlab-org/gitlab/-/issues/32696). replicated to Geo secondary nodes](https://gitlab.com/gitlab-org/gitlab/-/issues/32696).
The issue is fixed in GitLab 12.1; be sure to upgrade to GitLab 12.1 or later. The issue is fixed in GitLab 12.1; be sure to upgrade to GitLab 12.1 or later.
...@@ -376,7 +376,7 @@ the now-unused SSH keys from your secondaries, as they may cause problems if the ...@@ -376,7 +376,7 @@ the now-unused SSH keys from your secondaries, as they may cause problems if the
### Hashed Storage ### Hashed Storage
CAUTION: **Warning:** WARNING:
Hashed storage is in **Alpha**. It is considered experimental and not Hashed storage is in **Alpha**. It is considered experimental and not
production-ready. See [Hashed Storage](../../repository_storage_types.md) for more detail. production-ready. See [Hashed Storage](../../repository_storage_types.md) for more detail.
...@@ -387,7 +387,7 @@ migrated we recommend leaving Hashed Storage enabled. ...@@ -387,7 +387,7 @@ migrated we recommend leaving Hashed Storage enabled.
## Updating to GitLab 10.1 ## Updating to GitLab 10.1
CAUTION: **Warning:** WARNING:
Hashed storage is in **Alpha**. It is considered experimental and not Hashed storage is in **Alpha**. It is considered experimental and not
production-ready. See [Hashed Storage](../../repository_storage_types.md) for more detail. production-ready. See [Hashed Storage](../../repository_storage_types.md) for more detail.
......
...@@ -44,7 +44,7 @@ The following guide assumes that: ...@@ -44,7 +44,7 @@ The following guide assumes that:
you have a new **secondary** server set up with the same versions of the OS, you have a new **secondary** server set up with the same versions of the OS,
PostgreSQL, and GitLab on all nodes. PostgreSQL, and GitLab on all nodes.
CAUTION: **Warning:** WARNING:
Geo works with streaming replication. Logical replication is not supported at this time. Geo works with streaming replication. Logical replication is not supported at this time.
There is an [issue where support is being discussed](https://gitlab.com/gitlab-org/gitlab/-/issues/7420). There is an [issue where support is being discussed](https://gitlab.com/gitlab-org/gitlab/-/issues/7420).
...@@ -404,7 +404,7 @@ needed files for streaming replication. ...@@ -404,7 +404,7 @@ needed files for streaming replication.
The directories used are the defaults that are set up in Omnibus. If you have The directories used are the defaults that are set up in Omnibus. If you have
changed any defaults, configure it as you see fit replacing the directories and paths. changed any defaults, configure it as you see fit replacing the directories and paths.
CAUTION: **Warning:** WARNING:
Make sure to run this on the **secondary** server as it removes all PostgreSQL's Make sure to run this on the **secondary** server as it removes all PostgreSQL's
data before running `pg_basebackup`. data before running `pg_basebackup`.
...@@ -421,7 +421,7 @@ data before running `pg_basebackup`. ...@@ -421,7 +421,7 @@ data before running `pg_basebackup`.
1. Execute the command below to start a backup/restore and begin the replication 1. Execute the command below to start a backup/restore and begin the replication
CAUTION: **Warning:** WARNING:
Each Geo **secondary** node must have its own unique replication slot name. Each Geo **secondary** node must have its own unique replication slot name.
Using the same slot name between two secondaries will break PostgreSQL replication. Using the same slot name between two secondaries will break PostgreSQL replication.
......
...@@ -12,7 +12,7 @@ These instructions assume you have a working instance of GitLab. They guide you ...@@ -12,7 +12,7 @@ These instructions assume you have a working instance of GitLab. They guide you
1. Making your existing instance the **primary** node. 1. Making your existing instance the **primary** node.
1. Adding **secondary** nodes. 1. Adding **secondary** nodes.
CAUTION: **Caution:** WARNING:
The steps below should be followed in the order they appear. **Make sure the GitLab version is the same on all nodes.** The steps below should be followed in the order they appear. **Make sure the GitLab version is the same on all nodes.**
## Using Omnibus GitLab ## Using Omnibus GitLab
......
...@@ -8,7 +8,7 @@ disqus_identifier: 'https://docs.gitlab.com/ee/workflow/git_annex.html' ...@@ -8,7 +8,7 @@ disqus_identifier: 'https://docs.gitlab.com/ee/workflow/git_annex.html'
# Git annex # Git annex
CAUTION: **Warning:** WARNING:
[Git Annex support was removed](https://gitlab.com/gitlab-org/gitlab/-/issues/1648) [Git Annex support was removed](https://gitlab.com/gitlab-org/gitlab/-/issues/1648)
in GitLab 9.0. Read through the [migration guide from git-annex to Git LFS](../topics/git/lfs/migrate_from_git_annex_to_git_lfs.md). in GitLab 9.0. Read through the [migration guide from git-annex to Git LFS](../topics/git/lfs/migrate_from_git_annex_to_git_lfs.md).
......
...@@ -22,7 +22,7 @@ In the Gitaly documentation: ...@@ -22,7 +22,7 @@ In the Gitaly documentation:
GitLab end users do not have direct access to Gitaly. Gitaly only manages Git GitLab end users do not have direct access to Gitaly. Gitaly only manages Git
repository access for GitLab. Other types of GitLab data aren't accessed using Gitaly. repository access for GitLab. Other types of GitLab data aren't accessed using Gitaly.
CAUTION: **Caution:** WARNING:
From GitLab 13.0, Gitaly support for NFS is deprecated. As of GitLab 14.0, NFS-related issues From GitLab 13.0, Gitaly support for NFS is deprecated. As of GitLab 14.0, NFS-related issues
with Gitaly will no longer be addressed. Upgrade to [Gitaly Cluster](praefect.md) as soon as with Gitaly will no longer be addressed. Upgrade to [Gitaly Cluster](praefect.md) as soon as
possible. Watch for [tools to enable bulk move](https://gitlab.com/groups/gitlab-org/-/epics/4916) possible. Watch for [tools to enable bulk move](https://gitlab.com/groups/gitlab-org/-/epics/4916)
...@@ -915,7 +915,7 @@ your Gitaly servers as follows: ...@@ -915,7 +915,7 @@ your Gitaly servers as follows:
gitaly['auth_transitioning'] = false gitaly['auth_transitioning'] = false
``` ```
CAUTION: **Caution:** WARNING:
Without completing this step, you have **no Gitaly authentication**. Without completing this step, you have **no Gitaly authentication**.
### Verify authentication is enforced ### Verify authentication is enforced
......
...@@ -398,7 +398,7 @@ application server, or a Gitaly node. ...@@ -398,7 +398,7 @@ application server, or a Gitaly node.
so we use `default` here as well. This cluster has three Gitaly nodes `gitaly-1`, so we use `default` here as well. This cluster has three Gitaly nodes `gitaly-1`,
`gitaly-2`, and `gitaly-3`, which are intended to be replicas of each other. `gitaly-2`, and `gitaly-3`, which are intended to be replicas of each other.
CAUTION: **Caution:** WARNING:
If you have data on an already existing storage called If you have data on an already existing storage called
`default`, you should configure the virtual storage with another name and `default`, you should configure the virtual storage with another name and
[migrate the data to the Gitaly Cluster storage](#migrate-existing-repositories-to-gitaly-cluster) [migrate the data to the Gitaly Cluster storage](#migrate-existing-repositories-to-gitaly-cluster)
...@@ -817,7 +817,7 @@ Particular attention should be shown to: ...@@ -817,7 +817,7 @@ Particular attention should be shown to:
1. Disable the default Gitaly service running on the GitLab host. It isn't needed 1. Disable the default Gitaly service running on the GitLab host. It isn't needed
because GitLab connects to the configured cluster. because GitLab connects to the configured cluster.
CAUTION: **Caution:** WARNING:
If you have existing data stored on the default Gitaly storage, If you have existing data stored on the default Gitaly storage,
you should [migrate the data your Gitaly Cluster storage](#migrate-existing-repositories-to-gitaly-cluster) you should [migrate the data your Gitaly Cluster storage](#migrate-existing-repositories-to-gitaly-cluster)
first. first.
...@@ -1214,7 +1214,7 @@ Praefect provides the following subcommands to re-enable writes: ...@@ -1214,7 +1214,7 @@ Praefect provides the following subcommands to re-enable writes:
sudo /opt/gitlab/embedded/bin/praefect -config /var/opt/gitlab/praefect/config.toml accept-dataloss -virtual-storage <virtual-storage> -repository <relative-path> -authoritative-storage <storage-name> sudo /opt/gitlab/embedded/bin/praefect -config /var/opt/gitlab/praefect/config.toml accept-dataloss -virtual-storage <virtual-storage> -repository <relative-path> -authoritative-storage <storage-name>
``` ```
CAUTION: **Caution:** WARNING:
`accept-dataloss` causes permanent data loss by overwriting other versions of the repository. Data `accept-dataloss` causes permanent data loss by overwriting other versions of the repository. Data
[recovery efforts](#data-recovery) must be performed before using it. [recovery efforts](#data-recovery) must be performed before using it.
......
...@@ -66,7 +66,7 @@ token = "the secret token" ...@@ -66,7 +66,7 @@ token = "the secret token"
transitioning = true transitioning = true
``` ```
CAUTION: **Warning:** WARNING:
Remember to disable `transitioning` when you are done Remember to disable `transitioning` when you are done
changing your token settings. changing your token settings.
......
...@@ -85,7 +85,7 @@ To set up a basic Postfix mail server with IMAP access on Ubuntu, follow the ...@@ -85,7 +85,7 @@ To set up a basic Postfix mail server with IMAP access on Ubuntu, follow the
### Security concerns ### Security concerns
CAUTION: **Caution:** WARNING:
Be careful when choosing the domain used for receiving incoming email. Be careful when choosing the domain used for receiving incoming email.
For example, suppose your top-level company domain is `hooli.com`. For example, suppose your top-level company domain is `hooli.com`.
...@@ -112,7 +112,7 @@ Alternatively, use a dedicated domain for GitLab email communications such as ...@@ -112,7 +112,7 @@ Alternatively, use a dedicated domain for GitLab email communications such as
See GitLab issue [#30366](https://gitlab.com/gitlab-org/gitlab-foss/-/issues/30366) See GitLab issue [#30366](https://gitlab.com/gitlab-org/gitlab-foss/-/issues/30366)
for a real-world example of this exploit. for a real-world example of this exploit.
CAUTION: **Caution:** WARNING:
Use a mail server that has been configured to reduce Use a mail server that has been configured to reduce
spam. spam.
A Postfix mail server that is running on a default configuration, for example, A Postfix mail server that is running on a default configuration, for example,
......
...@@ -219,7 +219,7 @@ information useful for troubleshooting, but if you are experiencing trouble with ...@@ -219,7 +219,7 @@ information useful for troubleshooting, but if you are experiencing trouble with
GitLab instance, you should check your [support options](https://about.gitlab.com/support/) GitLab instance, you should check your [support options](https://about.gitlab.com/support/)
before referring to these documents. before referring to these documents.
CAUTION: **Warning:** WARNING:
Using the commands listed in the documentation below could result in data loss or Using the commands listed in the documentation below could result in data loss or
other damage to a GitLab instance, and should only be used by experienced administrators other damage to a GitLab instance, and should only be used by experienced administrators
who are aware of the risks. who are aware of the risks.
......
...@@ -190,7 +190,7 @@ _The artifacts are stored by default in ...@@ -190,7 +190,7 @@ _The artifacts are stored by default in
In some cases, you may need to run the [orphan artifact file cleanup Rake task](../raketasks/cleanup.md#remove-orphan-artifact-files) In some cases, you may need to run the [orphan artifact file cleanup Rake task](../raketasks/cleanup.md#remove-orphan-artifact-files)
to clean up orphaned artifacts. to clean up orphaned artifacts.
CAUTION: **Caution:** WARNING:
JUnit test report artifact (`junit.xml.gz`) migration JUnit test report artifact (`junit.xml.gz`) migration
[was not supported until GitLab 12.8](https://gitlab.com/gitlab-org/gitlab/-/issues/27698#note_317190991) [was not supported until GitLab 12.8](https://gitlab.com/gitlab-org/gitlab/-/issues/27698#note_317190991)
by the `gitlab:artifacts:migrate` script. by the `gitlab:artifacts:migrate` script.
...@@ -243,7 +243,7 @@ _The artifacts are stored by default in ...@@ -243,7 +243,7 @@ _The artifacts are stored by default in
In some cases, you may need to run the [orphan artifact file cleanup Rake task](../raketasks/cleanup.md#remove-orphan-artifact-files) In some cases, you may need to run the [orphan artifact file cleanup Rake task](../raketasks/cleanup.md#remove-orphan-artifact-files)
to clean up orphaned artifacts. to clean up orphaned artifacts.
CAUTION: **Caution:** WARNING:
JUnit test report artifact (`junit.xml.gz`) migration JUnit test report artifact (`junit.xml.gz`) migration
[was not supported until GitLab 12.8](https://gitlab.com/gitlab-org/gitlab/-/issues/27698#note_317190991) [was not supported until GitLab 12.8](https://gitlab.com/gitlab-org/gitlab/-/issues/27698#note_317190991)
by the `gitlab:artifacts:migrate` script. by the `gitlab:artifacts:migrate` script.
...@@ -481,7 +481,7 @@ the number you want. ...@@ -481,7 +481,7 @@ the number you want.
#### Delete job artifacts from jobs completed before a specific date #### Delete job artifacts from jobs completed before a specific date
CAUTION: **Caution:** WARNING:
These commands remove data permanently from the database and from disk. We These commands remove data permanently from the database and from disk. We
highly recommend running them only under the guidance of a Support Engineer, or highly recommend running them only under the guidance of a Support Engineer, or
running them in a test environment with a backup of the instance ready to be running them in a test environment with a backup of the instance ready to be
...@@ -528,7 +528,7 @@ If you need to manually remove job artifacts associated with multiple jobs while ...@@ -528,7 +528,7 @@ If you need to manually remove job artifacts associated with multiple jobs while
#### Delete job artifacts and logs from jobs completed before a specific date #### Delete job artifacts and logs from jobs completed before a specific date
CAUTION: **Caution:** WARNING:
These commands remove data permanently from the database and from disk. We These commands remove data permanently from the database and from disk. We
highly recommend running them only under the guidance of a Support Engineer, or highly recommend running them only under the guidance of a Support Engineer, or
running them in a test environment with a backup of the instance ready to be running them in a test environment with a backup of the instance ready to be
......
...@@ -67,7 +67,7 @@ that only [stores outdated diffs](#alternative-in-database-storage) outside of d ...@@ -67,7 +67,7 @@ that only [stores outdated diffs](#alternative-in-database-storage) outside of d
## Using object storage ## Using object storage
CAUTION: **Warning:** WARNING:
Currently migrating to object storage is **non-reversible** Currently migrating to object storage is **non-reversible**
Instead of storing the external diffs on disk, we recommended the use of an object Instead of storing the external diffs on disk, we recommended the use of an object
......
...@@ -38,7 +38,7 @@ metrics exposed by the [GitLab exporter](../prometheus/gitlab_metrics.md#metrics ...@@ -38,7 +38,7 @@ metrics exposed by the [GitLab exporter](../prometheus/gitlab_metrics.md#metrics
## Deleting the self monitoring project ## Deleting the self monitoring project
CAUTION: **Warning:** WARNING:
Deleting the self monitoring project removes any changes made to the project. If Deleting the self monitoring project removes any changes made to the project. If
you create the project again, it's created in its default state. you create the project again, it's created in its default state.
......
...@@ -53,7 +53,7 @@ To disable Prometheus and all of its exporters, as well as any added in the futu ...@@ -53,7 +53,7 @@ To disable Prometheus and all of its exporters, as well as any added in the futu
### Changing the port and address Prometheus listens on ### Changing the port and address Prometheus listens on
CAUTION: **Caution:** WARNING:
The following change was added in [Omnibus GitLab 8.17](https://gitlab.com/gitlab-org/omnibus-gitlab/-/merge_requests/1261). Although possible, The following change was added in [Omnibus GitLab 8.17](https://gitlab.com/gitlab-org/omnibus-gitlab/-/merge_requests/1261). Although possible,
it's not recommended to change the port Prometheus listens it's not recommended to change the port Prometheus listens
on, as this might affect or conflict with other services running on the GitLab on, as this might affect or conflict with other services running on the GitLab
...@@ -183,7 +183,7 @@ ensure that `prometheus['scrape_configs']` is not set in `/etc/gitlab/gitlab.rb` ...@@ -183,7 +183,7 @@ ensure that `prometheus['scrape_configs']` is not set in `/etc/gitlab/gitlab.rb`
### Using an external Prometheus server ### Using an external Prometheus server
CAUTION: **Caution:** WARNING:
Prometheus and most exporters don't support authentication. We don't recommend exposing them outside the local network. Prometheus and most exporters don't support authentication. We don't recommend exposing them outside the local network.
A few configuration changes are required to allow GitLab to be monitored by an external Prometheus server. External servers are recommended for [GitLab deployments with multiple nodes](../../reference_architectures/index.md). A few configuration changes are required to allow GitLab to be monitored by an external Prometheus server. External servers are recommended for [GitLab deployments with multiple nodes](../../reference_architectures/index.md).
......
...@@ -14,7 +14,7 @@ Pages](https://gitlab.com/gitlab-org/gitlab-pages/-/issues/196). ...@@ -14,7 +14,7 @@ Pages](https://gitlab.com/gitlab-org/gitlab-pages/-/issues/196).
For data objects such as LFS, Uploads, Artifacts, etc., an [Object Storage service](object_storage.md) For data objects such as LFS, Uploads, Artifacts, etc., an [Object Storage service](object_storage.md)
is recommended over NFS where possible, due to better performance. is recommended over NFS where possible, due to better performance.
CAUTION: **Caution:** WARNING:
From GitLab 13.0, using NFS for Git repositories is deprecated. In GitLab 14.0, From GitLab 13.0, using NFS for Git repositories is deprecated. In GitLab 14.0,
support for NFS for Git repositories is scheduled to be removed. Upgrade to support for NFS for Git repositories is scheduled to be removed. Upgrade to
[Gitaly Cluster](gitaly/praefect.md) as soon as possible. [Gitaly Cluster](gitaly/praefect.md) as soon as possible.
...@@ -344,7 +344,7 @@ sudo ufw allow from <client_ip_address> to any port nfs ...@@ -344,7 +344,7 @@ sudo ufw allow from <client_ip_address> to any port nfs
### Upgrade to Gitaly Cluster or disable caching if experiencing data loss ### Upgrade to Gitaly Cluster or disable caching if experiencing data loss
CAUTION: **Caution:** WARNING:
From GitLab 13.0, using NFS for Git repositories is deprecated. In GitLab 14.0, From GitLab 13.0, using NFS for Git repositories is deprecated. In GitLab 14.0,
support for NFS for Git repositories is scheduled to be removed. Upgrade to support for NFS for Git repositories is scheduled to be removed. Upgrade to
[Gitaly Cluster](gitaly/praefect.md) as soon as possible. [Gitaly Cluster](gitaly/praefect.md) as soon as possible.
...@@ -358,7 +358,7 @@ For example, we have seen [inconsistent updates after a push](https://gitlab.com ...@@ -358,7 +358,7 @@ For example, we have seen [inconsistent updates after a push](https://gitlab.com
| `actimeo=0` | Sets the time to zero that the NFS client caches files and directories before requesting fresh information from a server. | | `actimeo=0` | Sets the time to zero that the NFS client caches files and directories before requesting fresh information from a server. |
| `noac` | Tells the NFS client not to cache file attributes and forces application writes to become synchronous so that local changes to a file become visible on the server immediately. | | `noac` | Tells the NFS client not to cache file attributes and forces application writes to become synchronous so that local changes to a file become visible on the server immediately. |
CAUTION: **Caution:** WARNING:
The `actimeo=0` and `noac` options both result in a significant reduction in performance, possibly leading to timeouts. The `actimeo=0` and `noac` options both result in a significant reduction in performance, possibly leading to timeouts.
You may be able to avoid timeouts and data loss using `actimeo=0` and `lookupcache=positive` _without_ `noac`, however You may be able to avoid timeouts and data loss using `actimeo=0` and `lookupcache=positive` _without_ `noac`, however
we expect the performance reduction will still be significant. As noted above, we strongly recommend upgrading to we expect the performance reduction will still be significant. As noted above, we strongly recommend upgrading to
......
...@@ -209,7 +209,7 @@ sidekiq['queue_groups'] = [ ...@@ -209,7 +209,7 @@ sidekiq['queue_groups'] = [
### Disable Sidekiq cluster ### Disable Sidekiq cluster
CAUTION: **Warning:** WARNING:
Sidekiq cluster is [scheduled](https://gitlab.com/gitlab-com/gl-infra/scalability/-/issues/240) Sidekiq cluster is [scheduled](https://gitlab.com/gitlab-com/gl-infra/scalability/-/issues/240)
to be the only way to start Sidekiq in GitLab 14.0. to be the only way to start Sidekiq in GitLab 14.0.
...@@ -341,7 +341,7 @@ being equal to `max_concurrency`. ...@@ -341,7 +341,7 @@ being equal to `max_concurrency`.
Running a single Sidekiq process is the default in GitLab 12.10 and earlier. Running a single Sidekiq process is the default in GitLab 12.10 and earlier.
CAUTION: **Warning:** WARNING:
Running Sidekiq directly is scheduled to be removed in GitLab Running Sidekiq directly is scheduled to be removed in GitLab
[14.0](https://gitlab.com/gitlab-com/gl-infra/scalability/-/issues/240). [14.0](https://gitlab.com/gitlab-com/gl-infra/scalability/-/issues/240).
...@@ -376,7 +376,7 @@ This tells the additional processes how often to check for enqueued jobs. ...@@ -376,7 +376,7 @@ This tells the additional processes how often to check for enqueued jobs.
## Troubleshoot using the CLI ## Troubleshoot using the CLI
CAUTION: **Warning:** WARNING:
It's recommended to use `/etc/gitlab/gitlab.rb` to configure the Sidekiq processes. It's recommended to use `/etc/gitlab/gitlab.rb` to configure the Sidekiq processes.
If you experience a problem, you should contact GitLab support. Use the command If you experience a problem, you should contact GitLab support. Use the command
line at your own risk. line at your own risk.
......
...@@ -91,7 +91,7 @@ You might want to consider creating a wrapper script somewhere else since this c ...@@ -91,7 +91,7 @@ You might want to consider creating a wrapper script somewhere else since this c
owned by `root` and not be writable by group or others. You could also consider changing the ownership of this command owned by `root` and not be writable by group or others. You could also consider changing the ownership of this command
as required, but that might require temporary ownership changes during `gitlab-shell` upgrades. as required, but that might require temporary ownership changes during `gitlab-shell` upgrades.
CAUTION: **Caution:** WARNING:
Do not disable writes until SSH is confirmed to be working Do not disable writes until SSH is confirmed to be working
perfectly, because the file will quickly become out-of-date. perfectly, because the file will quickly become out-of-date.
......
...@@ -9,7 +9,7 @@ info: To determine the technical writer assigned to the Stage/Group associated w ...@@ -9,7 +9,7 @@ info: To determine the technical writer assigned to the Stage/Group associated w
The [Rails console](https://guides.rubyonrails.org/command_line.html#rails-console). The [Rails console](https://guides.rubyonrails.org/command_line.html#rails-console).
provides a way to interact with your GitLab instance from the command line. provides a way to interact with your GitLab instance from the command line.
CAUTION: **Caution:** WARNING:
The Rails console interacts directly with GitLab. In many cases, The Rails console interacts directly with GitLab. In many cases,
there are no handrails to prevent you from permanently modifying, corrupting there are no handrails to prevent you from permanently modifying, corrupting
or destroying production data. If you would like to explore the Rails console or destroying production data. If you would like to explore the Rails console
......
...@@ -93,7 +93,7 @@ auth: ...@@ -93,7 +93,7 @@ auth:
rootcertbundle: /root/certs/certbundle rootcertbundle: /root/certs/certbundle
``` ```
CAUTION: **Caution:** WARNING:
If `auth` is not set up, users can pull Docker images without authentication. If `auth` is not set up, users can pull Docker images without authentication.
## Container Registry domain configuration ## Container Registry domain configuration
...@@ -374,7 +374,7 @@ driver for the Container Registry. ...@@ -374,7 +374,7 @@ driver for the Container Registry.
[Read more about using object storage with GitLab](../object_storage.md). [Read more about using object storage with GitLab](../object_storage.md).
CAUTION: **Warning:** WARNING:
GitLab does not back up Docker images that are not stored on the GitLab does not back up Docker images that are not stored on the
file system. Enable backups with your object storage provider if file system. Enable backups with your object storage provider if
desired. desired.
......
...@@ -395,7 +395,7 @@ To do that: ...@@ -395,7 +395,7 @@ To do that:
1. Check the **Disable public access to Pages sites** checkbox. 1. Check the **Disable public access to Pages sites** checkbox.
1. Click **Save changes**. 1. Click **Save changes**.
CAUTION: **Warning:** WARNING:
For self-managed installations, all public websites remain private until they are For self-managed installations, all public websites remain private until they are
redeployed. This issue will be resolved by redeployed. This issue will be resolved by
[sourcing domain configuration from the GitLab API](https://gitlab.com/gitlab-org/gitlab/-/issues/218357). [sourcing domain configuration from the GitLab API](https://gitlab.com/gitlab-org/gitlab/-/issues/218357).
......
...@@ -985,7 +985,7 @@ after it has been restored to service. ...@@ -985,7 +985,7 @@ after it has been restored to service.
gitlab-ctl restart repmgrd gitlab-ctl restart repmgrd
``` ```
CAUTION: **Warning:** WARNING:
When the server is brought back online, and before When the server is brought back online, and before
you switch it to a standby node, repmgr will report that there are two masters. you switch it to a standby node, repmgr will report that there are two masters.
If there are any clients that are still attempting to write to the old master, If there are any clients that are still attempting to write to the old master,
...@@ -1326,7 +1326,7 @@ For further details, see [Patroni documentation on this subject](https://patroni ...@@ -1326,7 +1326,7 @@ For further details, see [Patroni documentation on this subject](https://patroni
### Switching from repmgr to Patroni ### Switching from repmgr to Patroni
CAUTION: **Warning:** WARNING:
Although switching from repmgr to Patroni is fairly straightforward the other way around is not. Rolling back from Although switching from repmgr to Patroni is fairly straightforward the other way around is not. Rolling back from
Patroni to repmgr can be complicated and may involve deletion of data directory. If you need to do that, please contact Patroni to repmgr can be complicated and may involve deletion of data directory. If you need to do that, please contact
GitLab support. GitLab support.
...@@ -1367,7 +1367,7 @@ As of GitLab 13.3, PostgreSQL 11.7 and 12.3 are both shipped with Omnibus GitLab ...@@ -1367,7 +1367,7 @@ As of GitLab 13.3, PostgreSQL 11.7 and 12.3 are both shipped with Omnibus GitLab
uses PostgreSQL 11 by default. Therefore `gitlab-ctl pg-upgrade` does not automatically upgrade uses PostgreSQL 11 by default. Therefore `gitlab-ctl pg-upgrade` does not automatically upgrade
to PostgreSQL 12. If you want to upgrade to PostgreSQL 12, you must ask for it explicitly. to PostgreSQL 12. If you want to upgrade to PostgreSQL 12, you must ask for it explicitly.
CAUTION: **Warning:** WARNING:
The procedure for upgrading PostgreSQL in a Patroni cluster is different than when upgrading using repmgr. The procedure for upgrading PostgreSQL in a Patroni cluster is different than when upgrading using repmgr.
The following outlines the key differences and important considerations that need to be accounted for when The following outlines the key differences and important considerations that need to be accounted for when
upgrading PostgreSQL. upgrading PostgreSQL.
......
...@@ -12,7 +12,7 @@ As GitLab's database hosts sensitive information, using it unfiltered for analyt ...@@ -12,7 +12,7 @@ As GitLab's database hosts sensitive information, using it unfiltered for analyt
implies high security requirements. To help alleviate this constraint, the Pseudonymizer implies high security requirements. To help alleviate this constraint, the Pseudonymizer
service is used to export GitLab's data in a pseudonymized way. service is used to export GitLab's data in a pseudonymized way.
CAUTION: **Warning:** WARNING:
This process is not impervious. If the source data is available, it's possible for This process is not impervious. If the source data is available, it's possible for
a user to correlate data to the pseudonymized version. a user to correlate data to the pseudonymized version.
......
...@@ -131,7 +131,7 @@ sudo -u git -H bundle exec rake "gitlab:uploads:migrate[DesignManagement::Design ...@@ -131,7 +131,7 @@ sudo -u git -H bundle exec rake "gitlab:uploads:migrate[DesignManagement::Design
If you need to disable [object storage](../../object_storage.md) for any reason, you must first If you need to disable [object storage](../../object_storage.md) for any reason, you must first
migrate your data out of object storage and back into your local storage. migrate your data out of object storage and back into your local storage.
CAUTION: **Warning:** WARNING:
**Extended downtime is required** so no new files are created in object storage during **Extended downtime is required** so no new files are created in object storage during
the migration. A configuration setting is planned to allow migrating the migration. A configuration setting is planned to allow migrating
from object storage to local files with only a brief moment of downtime for configuration changes. from object storage to local files with only a brief moment of downtime for configuration changes.
......
...@@ -6,7 +6,7 @@ info: To determine the technical writer assigned to the Stage/Group associated w ...@@ -6,7 +6,7 @@ info: To determine the technical writer assigned to the Stage/Group associated w
# Place GitLab into a read-only state **(CORE ONLY)** # Place GitLab into a read-only state **(CORE ONLY)**
CAUTION: **Warning:** WARNING:
This document should be used as a temporary solution. This document should be used as a temporary solution.
There's work in progress to make this There's work in progress to make this
[possible with Geo](https://gitlab.com/groups/gitlab-org/-/epics/2149). [possible with Geo](https://gitlab.com/groups/gitlab-org/-/epics/2149).
......
...@@ -26,7 +26,7 @@ files must be provided: ...@@ -26,7 +26,7 @@ files must be provided:
Optionally, you can also provide a bundle of CA certs (PEM-encoded) to be Optionally, you can also provide a bundle of CA certs (PEM-encoded) to be
included on each signature. This will typically be an intermediate CA. included on each signature. This will typically be an intermediate CA.
CAUTION: **Caution:** WARNING:
Be mindful of the access levels for your private keys and visibility to Be mindful of the access levels for your private keys and visibility to
third parties. third parties.
......
...@@ -14,13 +14,13 @@ having an issue with GitLab, it is highly recommended that you check your ...@@ -14,13 +14,13 @@ having an issue with GitLab, it is highly recommended that you check your
[support options](https://about.gitlab.com/support/) first, before attempting to use [support options](https://about.gitlab.com/support/) first, before attempting to use
this information. this information.
CAUTION: **Caution:** WARNING:
Please note that some of these scripts could be damaging if not run correctly, Please note that some of these scripts could be damaging if not run correctly,
or under the right conditions. We highly recommend running them under the or under the right conditions. We highly recommend running them under the
guidance of a Support Engineer, or running them in a test environment with a guidance of a Support Engineer, or running them in a test environment with a
backup of the instance ready to be restored, just in case. backup of the instance ready to be restored, just in case.
CAUTION: **Caution:** WARNING:
Please also note that as GitLab changes, changes to the code are inevitable, Please also note that as GitLab changes, changes to the code are inevitable,
and so some scripts may not work as they once used to. These are not kept and so some scripts may not work as they once used to. These are not kept
up-to-date as these scripts/commands were added as they were found/needed. As up-to-date as these scripts/commands were added as they were found/needed. As
...@@ -308,7 +308,7 @@ pp p.statistics # compare with earlier values ...@@ -308,7 +308,7 @@ pp p.statistics # compare with earlier values
### Recreate ### Recreate
CAUTION: **Caution:** WARNING:
This is a destructive operation, the Wiki will be empty. This is a destructive operation, the Wiki will be empty.
A Projects Wiki can be recreated by this command: A Projects Wiki can be recreated by this command:
......
...@@ -22,7 +22,7 @@ This section includes relevant screenshots of the following example configuratio ...@@ -22,7 +22,7 @@ This section includes relevant screenshots of the following example configuratio
- [Azure Active Directory](#azure-active-directory) - [Azure Active Directory](#azure-active-directory)
- [OneLogin](#onelogin) - [OneLogin](#onelogin)
CAUTION: **Caution:** WARNING:
These screenshots are updated only as needed by GitLab Support. They are **not** official documentation. These screenshots are updated only as needed by GitLab Support. They are **not** official documentation.
If you are currently having an issue with GitLab, you may want to check your [support options](https://about.gitlab.com/support/). If you are currently having an issue with GitLab, you may want to check your [support options](https://about.gitlab.com/support/).
......
...@@ -11,7 +11,7 @@ This is a list of useful information regarding Kubernetes that the GitLab Suppor ...@@ -11,7 +11,7 @@ This is a list of useful information regarding Kubernetes that the GitLab Suppor
Team sometimes uses while troubleshooting. GitLab is making this public, so that anyone Team sometimes uses while troubleshooting. GitLab is making this public, so that anyone
can make use of the Support team's collected knowledge can make use of the Support team's collected knowledge
CAUTION: **Caution:** WARNING:
These commands **can alter or break** your Kubernetes components so use these at your own risk. These commands **can alter or break** your Kubernetes components so use these at your own risk.
If you are on a [paid tier](https://about.gitlab.com/pricing/) and are not sure how If you are on a [paid tier](https://about.gitlab.com/pricing/) and are not sure how
......
...@@ -13,7 +13,7 @@ and it may be useful for users with experience with Linux. If you are currently ...@@ -13,7 +13,7 @@ and it may be useful for users with experience with Linux. If you are currently
having an issue with GitLab, you may want to check your [support options](https://about.gitlab.com/support/) having an issue with GitLab, you may want to check your [support options](https://about.gitlab.com/support/)
first, before attempting to use this information. first, before attempting to use this information.
CAUTION: **Caution:** WARNING:
If you are administering GitLab you are expected to know these commands for your distribution If you are administering GitLab you are expected to know these commands for your distribution
of choice. If you are a GitLab Support Engineer, consider this a cross-reference to of choice. If you are a GitLab Support Engineer, consider this a cross-reference to
translate `yum` -> `apt-get` and the like. translate `yum` -> `apt-get` and the like.
......
...@@ -12,7 +12,7 @@ Thanks to this, we also get access to the amazing tools built right into Rails. ...@@ -12,7 +12,7 @@ Thanks to this, we also get access to the amazing tools built right into Rails.
In this guide, we'll introduce the [Rails console](../operations/rails_console.md#starting-a-rails-console-session) In this guide, we'll introduce the [Rails console](../operations/rails_console.md#starting-a-rails-console-session)
and the basics of interacting with your GitLab instance from the command line. and the basics of interacting with your GitLab instance from the command line.
CAUTION: **Caution:** WARNING:
The Rails console interacts directly with your GitLab instance. In many cases, The Rails console interacts directly with your GitLab instance. In many cases,
there are no handrails to prevent you from permanently modifying, corrupting there are no handrails to prevent you from permanently modifying, corrupting
or destroying production data. If you would like to explore the Rails console or destroying production data. If you would like to explore the Rails console
......
...@@ -11,7 +11,7 @@ This page contains information about PostgreSQL the GitLab Support team uses ...@@ -11,7 +11,7 @@ This page contains information about PostgreSQL the GitLab Support team uses
when troubleshooting. GitLab makes this information public, so that anyone can when troubleshooting. GitLab makes this information public, so that anyone can
make use of the Support team's collected knowledge. make use of the Support team's collected knowledge.
CAUTION: **Caution:** WARNING:
Some procedures documented here may break your GitLab instance. Use at your Some procedures documented here may break your GitLab instance. Use at your
own risk. own risk.
......
...@@ -478,7 +478,7 @@ Status: 200 OK ...@@ -478,7 +478,7 @@ Status: 200 OK
... ...
``` ```
CAUTION: **Deprecation:** WARNING:
The `Links` header is scheduled to be removed in GitLab 14.0 to be aligned with the The `Links` header is scheduled to be removed in GitLab 14.0 to be aligned with the
[W3C `Link` specification](https://www.w3.org/wiki/LinkHeader). The `Link` [W3C `Link` specification](https://www.w3.org/wiki/LinkHeader). The `Link`
header was [added in GitLab 13.1](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/33714) header was [added in GitLab 13.1](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/33714)
......
...@@ -6,7 +6,7 @@ info: To determine the technical writer assigned to the Stage/Group associated w ...@@ -6,7 +6,7 @@ info: To determine the technical writer assigned to the Stage/Group associated w
# Dependencies API **(ULTIMATE)** # Dependencies API **(ULTIMATE)**
CAUTION: **Caution:** WARNING:
This API is in an alpha stage and considered unstable. This API is in an alpha stage and considered unstable.
The response payload may be subject to change or breakage The response payload may be subject to change or breakage
across GitLab releases. across GitLab releases.
......
...@@ -13,7 +13,7 @@ info: To determine the technical writer assigned to the Stage/Group associated w ...@@ -13,7 +13,7 @@ info: To determine the technical writer assigned to the Stage/Group associated w
Deletes the cached blobs for a group. This endpoint requires group admin access. Deletes the cached blobs for a group. This endpoint requires group admin access.
CAUTION: **Warning:** WARNING:
[A bug exists](https://gitlab.com/gitlab-org/gitlab/-/issues/277161) for this API. [A bug exists](https://gitlab.com/gitlab-org/gitlab/-/issues/277161) for this API.
```plaintext ```plaintext
......
...@@ -38,7 +38,7 @@ are paginated. ...@@ -38,7 +38,7 @@ are paginated.
Read more on [pagination](README.md#pagination). Read more on [pagination](README.md#pagination).
CAUTION: **Deprecation:** WARNING:
> `reference` attribute in response is deprecated in favour of `references`. > `reference` attribute in response is deprecated in favour of `references`.
> Introduced [GitLab 12.6](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/20354) > Introduced [GitLab 12.6](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/20354)
......
...@@ -8,7 +8,7 @@ info: To determine the technical writer assigned to the Stage/Group associated w ...@@ -8,7 +8,7 @@ info: To determine the technical writer assigned to the Stage/Group associated w
> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/9566) in [GitLab Premium](https://about.gitlab.com/pricing/) 12.5. > [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/9566) in [GitLab Premium](https://about.gitlab.com/pricing/) 12.5.
CAUTION: **Deprecation:** WARNING:
This API is deprecated and [scheduled for removal in GitLab 14.0](https://gitlab.com/gitlab-org/gitlab/-/issues/213369). This API is deprecated and [scheduled for removal in GitLab 14.0](https://gitlab.com/gitlab-org/gitlab/-/issues/213369).
The API for creating, updating, reading and deleting Feature Flag Specs. The API for creating, updating, reading and deleting Feature Flag Specs.
......
...@@ -10,7 +10,7 @@ info: To determine the technical writer assigned to the Stage/Group associated w ...@@ -10,7 +10,7 @@ info: To determine the technical writer assigned to the Stage/Group associated w
> - [Moved](https://gitlab.com/gitlab-org/gitlab/-/issues/212318) to [GitLab Starter](https://about.gitlab.com/pricing/) in 13.4. > - [Moved](https://gitlab.com/gitlab-org/gitlab/-/issues/212318) to [GitLab Starter](https://about.gitlab.com/pricing/) in 13.4.
> - [Moved](https://gitlab.com/gitlab-org/gitlab/-/issues/212318) to [GitLab Core](https://about.gitlab.com/pricing/) in 13.5. > - [Moved](https://gitlab.com/gitlab-org/gitlab/-/issues/212318) to [GitLab Core](https://about.gitlab.com/pricing/) in 13.5.
CAUTION: **Deprecation:** WARNING:
This API is deprecated and [scheduled for removal in GitLab 14.0](https://gitlab.com/gitlab-org/gitlab/-/issues/213369). Use [this API](feature_flags.md) instead. This API is deprecated and [scheduled for removal in GitLab 14.0](https://gitlab.com/gitlab-org/gitlab/-/issues/213369). Use [this API](feature_flags.md) instead.
API for accessing resources of [GitLab Feature Flags](../operations/feature_flags.md). API for accessing resources of [GitLab Feature Flags](../operations/feature_flags.md).
......
...@@ -21,7 +21,7 @@ levels are defined in the `Gitlab::Access` module. Currently, these levels are v ...@@ -21,7 +21,7 @@ levels are defined in the `Gitlab::Access` module. Currently, these levels are v
- Maintainer (`40`) - Maintainer (`40`)
- Owner (`50`) - Only valid to set for groups - Owner (`50`) - Only valid to set for groups
CAUTION: **Caution:** WARNING:
Due to [an issue](https://gitlab.com/gitlab-org/gitlab/-/issues/219299), Due to [an issue](https://gitlab.com/gitlab-org/gitlab/-/issues/219299),
projects in personal namespaces don't show owner (`50`) permission. projects in personal namespaces don't show owner (`50`) permission.
......
...@@ -17,7 +17,7 @@ The access levels are defined in the `Gitlab::Access` module. Currently, these l ...@@ -17,7 +17,7 @@ The access levels are defined in the `Gitlab::Access` module. Currently, these l
- Maintainer (`40`) - Maintainer (`40`)
- Owner (`50`) - Only valid to set for groups - Owner (`50`) - Only valid to set for groups
CAUTION: **Caution:** WARNING:
Due to [an issue](https://gitlab.com/gitlab-org/gitlab/-/issues/219299), Due to [an issue](https://gitlab.com/gitlab-org/gitlab/-/issues/219299),
projects in personal namespaces don't show owner (`50`) permission projects in personal namespaces don't show owner (`50`) permission
for owner. for owner.
...@@ -89,7 +89,7 @@ Example response: ...@@ -89,7 +89,7 @@ Example response:
Gets a list of group or project members viewable by the authenticated user, including inherited members and permissions through ancestor groups. Gets a list of group or project members viewable by the authenticated user, including inherited members and permissions through ancestor groups.
CAUTION: **Caution:** WARNING:
Due to [an issue](https://gitlab.com/gitlab-org/gitlab/-/issues/249523), the users effective `access_level` may actually be higher than returned value when listing group members. Due to [an issue](https://gitlab.com/gitlab-org/gitlab/-/issues/249523), the users effective `access_level` may actually be higher than returned value when listing group members.
This function takes pagination parameters `page` and `per_page` to restrict the list of users. This function takes pagination parameters `page` and `per_page` to restrict the list of users.
......
...@@ -9,7 +9,7 @@ type: reference, api ...@@ -9,7 +9,7 @@ type: reference, api
Every API call to merge requests must be authenticated. Every API call to merge requests must be authenticated.
CAUTION: **Deprecation:** WARNING:
> `reference` attribute in response is deprecated in favour of `references`. > `reference` attribute in response is deprecated in favour of `references`.
> Introduced [GitLab 12.6](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/20354) > Introduced [GitLab 12.6](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/20354)
......
...@@ -117,7 +117,7 @@ NOTE: **Note:** ...@@ -117,7 +117,7 @@ NOTE: **Note:**
Check the [RFC spec](https://tools.ietf.org/html/rfc6749#section-4.2) for a Check the [RFC spec](https://tools.ietf.org/html/rfc6749#section-4.2) for a
detailed flow description. detailed flow description.
CAUTION: **Important:** WARNING:
Avoid using this flow for applications that store data outside of the GitLab Avoid using this flow for applications that store data outside of the GitLab
instance. If you do, make sure to verify `application id` associated with the instance. If you do, make sure to verify `application id` associated with the
access token before granting access to the data access token before granting access to the data
...@@ -169,7 +169,7 @@ The credentials should only be used when: ...@@ -169,7 +169,7 @@ The credentials should only be used when:
privileged application. privileged application.
- Other authorization grant types are not available (such as an authorization code). - Other authorization grant types are not available (such as an authorization code).
CAUTION: **Important:** WARNING:
Never store the user's credentials and only use this grant type when your client Never store the user's credentials and only use this grant type when your client
is deployed to a trusted environment, in 99% of cases is deployed to a trusted environment, in 99% of cases
[personal access tokens](../user/profile/personal_access_tokens.md) are a better [personal access tokens](../user/profile/personal_access_tokens.md) are a better
......
...@@ -197,7 +197,7 @@ Example response: ...@@ -197,7 +197,7 @@ Example response:
> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/34119) in GitLab 13.1. > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/34119) in GitLab 13.1.
> - [Introduced](https://gitlab.com/gitlab-org/gitaly/-/issues/2618) in GitLab 13.3, original repository is automatically removed after successful move and integrity check. > - [Introduced](https://gitlab.com/gitlab-org/gitaly/-/issues/2618) in GitLab 13.3, original repository is automatically removed after successful move and integrity check.
CAUTION: **Caution:** WARNING:
Before GitLab 13.3, a repository move worked more like a repository copy as the Before GitLab 13.3, a repository move worked more like a repository copy as the
original repository was not deleted from the original storage disk location and original repository was not deleted from the original storage disk location and
had to be manually cleaned up. had to be manually cleaned up.
......
...@@ -9,7 +9,7 @@ type: reference, api ...@@ -9,7 +9,7 @@ type: reference, api
> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/10242) in [GitLab Ultimate](https://about.gitlab.com/pricing/) 12.6. > [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/10242) in [GitLab Ultimate](https://about.gitlab.com/pricing/) 12.6.
CAUTION: **Caution:** WARNING:
This API is in an alpha stage and considered unstable. This API is in an alpha stage and considered unstable.
The response payload may be subject to change or breakage The response payload may be subject to change or breakage
across GitLab releases. across GitLab releases.
......
...@@ -1862,7 +1862,7 @@ This endpoint: ...@@ -1862,7 +1862,7 @@ This endpoint:
actual deletion happens after the number of days specified in the actual deletion happens after the number of days specified in the
[default deletion delay](../user/admin_area/settings/visibility_and_access_controls.md#default-deletion-delay). [default deletion delay](../user/admin_area/settings/visibility_and_access_controls.md#default-deletion-delay).
CAUTION: **Warning:** WARNING:
The default behavior of [Delayed Project deletion](https://gitlab.com/gitlab-org/gitlab/-/issues/32935) The default behavior of [Delayed Project deletion](https://gitlab.com/gitlab-org/gitlab/-/issues/32935)
in GitLab 12.6 was changed to [Immediate deletion](https://gitlab.com/gitlab-org/gitlab/-/issues/220382) in GitLab 12.6 was changed to [Immediate deletion](https://gitlab.com/gitlab-org/gitlab/-/issues/220382)
in GitLab 13.2, as discussed in [Enabling delayed project removal](../user/group/index.md#enabling-delayed-project-removal). in GitLab 13.2, as discussed in [Enabling delayed project removal](../user/group/index.md#enabling-delayed-project-removal).
......
...@@ -202,7 +202,7 @@ authentication if the repository is publicly accessible. ...@@ -202,7 +202,7 @@ authentication if the repository is publicly accessible.
GET /projects/:id/repository/contributors GET /projects/:id/repository/contributors
``` ```
CAUTION: **Deprecation:** WARNING:
The `additions` and `deletions` attributes are deprecated [as of GitLab 13.4](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/39653) because they [always return `0`](https://gitlab.com/gitlab-org/gitlab/-/issues/233119). The `additions` and `deletions` attributes are deprecated [as of GitLab 13.4](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/39653) because they [always return `0`](https://gitlab.com/gitlab-org/gitlab/-/issues/233119).
Parameters: Parameters:
......
...@@ -1486,7 +1486,7 @@ Parameters: ...@@ -1486,7 +1486,7 @@ Parameters:
> - It's [deployed behind a feature flag](../user/feature_flags.md), disabled by default. > - It's [deployed behind a feature flag](../user/feature_flags.md), disabled by default.
> - To use it in GitLab self-managed instances, ask a GitLab administrator to [enable it](#enable-or-disable-an-administrators-ability-to-use-the-api-to-create-personal-access-tokens). **(CORE)** > - To use it in GitLab self-managed instances, ask a GitLab administrator to [enable it](#enable-or-disable-an-administrators-ability-to-use-the-api-to-create-personal-access-tokens). **(CORE)**
CAUTION: **Warning:** WARNING:
This feature might not be available to you. Check the **version history** note above for details. This feature might not be available to you. Check the **version history** note above for details.
> Requires admin permissions. > Requires admin permissions.
......
...@@ -14,7 +14,7 @@ and its documentation was moved to [a different location](vulnerability_findings ...@@ -14,7 +14,7 @@ and its documentation was moved to [a different location](vulnerability_findings
This document now describes the new Vulnerabilities API that provides access to This document now describes the new Vulnerabilities API that provides access to
[Vulnerabilities](https://gitlab.com/groups/gitlab-org/-/epics/634). [Vulnerabilities](https://gitlab.com/groups/gitlab-org/-/epics/634).
CAUTION: **Caution:** WARNING:
This API is in an alpha stage and considered unstable. This API is in an alpha stage and considered unstable.
The response payload may be subject to change or breakage The response payload may be subject to change or breakage
across GitLab releases. across GitLab releases.
......
...@@ -8,7 +8,7 @@ info: To determine the technical writer assigned to the Stage/Group associated w ...@@ -8,7 +8,7 @@ info: To determine the technical writer assigned to the Stage/Group associated w
> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/197494) in [GitLab Ultimate](https://about.gitlab.com/pricing/) 12.10. [Updated](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/30397) in [GitLab Ultimate](https://about.gitlab.com/pricing/) 13.0. > [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/197494) in [GitLab Ultimate](https://about.gitlab.com/pricing/) 12.10. [Updated](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/30397) in [GitLab Ultimate](https://about.gitlab.com/pricing/) 13.0.
CAUTION: **Caution:** WARNING:
This API is in an alpha stage and considered unstable. This API is in an alpha stage and considered unstable.
The response payload may be subject to change or breakage The response payload may be subject to change or breakage
across GitLab releases. across GitLab releases.
......
...@@ -24,7 +24,7 @@ If a user is able to access the project but does not have permission to ...@@ -24,7 +24,7 @@ If a user is able to access the project but does not have permission to
[use the Project Security Dashboard](../user/permissions.md#project-members-permissions), [use the Project Security Dashboard](../user/permissions.md#project-members-permissions),
any request for vulnerability findings of this project results in a `403` status code. any request for vulnerability findings of this project results in a `403` status code.
CAUTION: **Caution:** WARNING:
This API is in an alpha stage and considered unstable. This API is in an alpha stage and considered unstable.
The response payload may be subject to change or breakage The response payload may be subject to change or breakage
across GitLab releases. across GitLab releases.
...@@ -53,7 +53,7 @@ GET /projects/:id/vulnerability_findings?scanner=bandit,find_sec_bugs ...@@ -53,7 +53,7 @@ GET /projects/:id/vulnerability_findings?scanner=bandit,find_sec_bugs
GET /projects/:id/vulnerability_findings?pipeline_id=42 GET /projects/:id/vulnerability_findings?pipeline_id=42
``` ```
CAUTION: **Deprecation:** WARNING:
Beginning with GitLab 12.9, the `undefined` severity and confidence level is no longer reported. Beginning with GitLab 12.9, the `undefined` severity and confidence level is no longer reported.
| Attribute | Type | Required | Description | | Attribute | Type | Required | Description |
......
...@@ -149,7 +149,7 @@ After you have these prerequisites ready, follow these steps: ...@@ -149,7 +149,7 @@ After you have these prerequisites ready, follow these steps:
In both cases, make sure that the value for the `containerDefinitions[].name` attribute is In both cases, make sure that the value for the `containerDefinitions[].name` attribute is
the same as the `Container name` defined in your targeted ECS service. the same as the `Container name` defined in your targeted ECS service.
CAUTION: **Warning:** WARNING:
`CI_AWS_ECS_TASK_DEFINITION_FILE` takes precedence over `CI_AWS_ECS_TASK_DEFINITION` if both these environment `CI_AWS_ECS_TASK_DEFINITION_FILE` takes precedence over `CI_AWS_ECS_TASK_DEFINITION` if both these environment
variables are defined within your project. variables are defined within your project.
...@@ -181,7 +181,7 @@ After you have these prerequisites ready, follow these steps: ...@@ -181,7 +181,7 @@ After you have these prerequisites ready, follow these steps:
task definition, making the cluster pull the newest version of your task definition, making the cluster pull the newest version of your
application. application.
CAUTION: **Warning:** WARNING:
The [`AWS/Deploy-ECS.gitlab-ci.yml`](https://gitlab.com/gitlab-org/gitlab/-/blob/master/lib/gitlab/ci/templates/AWS/Deploy-ECS.gitlab-ci.yml) The [`AWS/Deploy-ECS.gitlab-ci.yml`](https://gitlab.com/gitlab-org/gitlab/-/blob/master/lib/gitlab/ci/templates/AWS/Deploy-ECS.gitlab-ci.yml)
template includes both the [`Jobs/Build.gitlab-ci.yml`](https://gitlab.com/gitlab-org/gitlab/-/blob/master/lib/gitlab/ci/templates/Jobs/Build.gitlab-ci.yml) template includes both the [`Jobs/Build.gitlab-ci.yml`](https://gitlab.com/gitlab-org/gitlab/-/blob/master/lib/gitlab/ci/templates/Jobs/Build.gitlab-ci.yml)
and [`Jobs/Deploy/ECS.gitlab-ci.yml`](https://gitlab.com/gitlab-org/gitlab/-/blob/master/lib/gitlab/ci/templates/Jobs/Deploy/ECS.gitlab-ci.yml) and [`Jobs/Deploy/ECS.gitlab-ci.yml`](https://gitlab.com/gitlab-org/gitlab/-/blob/master/lib/gitlab/ci/templates/Jobs/Deploy/ECS.gitlab-ci.yml)
......
...@@ -121,7 +121,7 @@ Note that the `environment` keyword defines where the app is deployed. The envir ...@@ -121,7 +121,7 @@ Note that the `environment` keyword defines where the app is deployed. The envir
`url` is exposed in various places within GitLab. Each time a job that has an environment specified `url` is exposed in various places within GitLab. Each time a job that has an environment specified
succeeds, a deployment is recorded along with the Git SHA and environment name. succeeds, a deployment is recorded along with the Git SHA and environment name.
CAUTION: **Caution:** WARNING:
Some characters are not allowed in environment names. Use only letters, Some characters are not allowed in environment names. Use only letters,
numbers, spaces, and `-`, `_`, `/`, `{`, `}`, or `.`. Also, it must not start nor end with `/`. numbers, spaces, and `-`, `_`, `/`, `{`, `}`, or `.`. Also, it must not start nor end with `/`.
......
...@@ -66,7 +66,7 @@ To communicate with Vault, you can use either its CLI client or perform API requ ...@@ -66,7 +66,7 @@ To communicate with Vault, you can use either its CLI client or perform API requ
## Example ## Example
CAUTION: **Caution:** WARNING:
JWTs are credentials, which can grant access to resources. Be careful where you paste them! JWTs are credentials, which can grant access to resources. Be careful where you paste them!
Let's say you have the passwords for your staging and production databases stored in a Vault server that is running on `http://vault.example.com:8200`. Your staging password is `pa$$w0rd` and your production password is `real-pa$$w0rd`. Let's say you have the passwords for your staging and production databases stored in a Vault server that is running on `http://vault.example.com:8200`. Your staging password is `pa$$w0rd` and your production password is `real-pa$$w0rd`.
...@@ -162,7 +162,7 @@ Combined with GitLab's [protected branches](../../../user/project/protected_bran ...@@ -162,7 +162,7 @@ Combined with GitLab's [protected branches](../../../user/project/protected_bran
For the full list of options, see Vault's [Create Role documentation](https://www.vaultproject.io/api/auth/jwt#create-role). For the full list of options, see Vault's [Create Role documentation](https://www.vaultproject.io/api/auth/jwt#create-role).
CAUTION: **Caution:** WARNING:
Always restrict your roles to project or namespace by using one of the provided claims (e.g. `project_id` or `namespace_id`). Otherwise any JWT generated by this instance may be allowed to authenticate using this role. Always restrict your roles to project or namespace by using one of the provided claims (e.g. `project_id` or `namespace_id`). Otherwise any JWT generated by this instance may be allowed to authenticate using this role.
Now, configure the JWT Authentication method: Now, configure the JWT Authentication method:
......
...@@ -116,7 +116,7 @@ After set up, GitLab CI/CD deploys your app to CF at every push to your ...@@ -116,7 +116,7 @@ After set up, GitLab CI/CD deploys your app to CF at every push to your
repository's default branch. To review the build logs or watch your builds repository's default branch. To review the build logs or watch your builds
running live, navigate to **CI/CD > Pipelines**. running live, navigate to **CI/CD > Pipelines**.
CAUTION: **Caution:** WARNING:
It's considered best practice for security to create a separate deploy user for It's considered best practice for security to create a separate deploy user for
your application and add its credentials to GitLab instead of using a your application and add its credentials to GitLab instead of using a
developer's credentials. developer's credentials.
......
...@@ -188,7 +188,7 @@ can create pipelines in the parent project for merge requests ...@@ -188,7 +188,7 @@ can create pipelines in the parent project for merge requests
from a forked project. In the merge request, go to the **Pipelines** and click from a forked project. In the merge request, go to the **Pipelines** and click
**Run Pipeline** button. **Run Pipeline** button.
CAUTION: **Caution:** WARNING:
Fork merge requests could contain malicious code that tries to steal secrets in the Fork merge requests could contain malicious code that tries to steal secrets in the
parent project when the pipeline runs, even before merge. Reviewers must carefully parent project when the pipeline runs, even before merge. Reviewers must carefully
check the changes in the merge request before triggering the pipeline. GitLab shows check the changes in the merge request before triggering the pipeline. GitLab shows
......
...@@ -59,7 +59,7 @@ To enable pipelines for merged results for your project: ...@@ -59,7 +59,7 @@ To enable pipelines for merged results for your project:
1. Check **Enable merged results pipelines.**. 1. Check **Enable merged results pipelines.**.
1. Click **Save changes**. 1. Click **Save changes**.
CAUTION: **Caution:** WARNING:
If you select the check box but don't configure your CI/CD to use If you select the check box but don't configure your CI/CD to use
pipelines for merge requests, your merge requests may become stuck in an pipelines for merge requests, your merge requests may become stuck in an
unresolved state or your pipelines may be dropped. unresolved state or your pipelines may be dropped.
......
...@@ -90,7 +90,7 @@ To enable merge trains for your project: ...@@ -90,7 +90,7 @@ To enable merge trains for your project:
In GitLab 13.5 and earlier, there is only one checkbox, named In GitLab 13.5 and earlier, there is only one checkbox, named
**Enable merge trains and pipelines for merged results**. **Enable merge trains and pipelines for merged results**.
CAUTION: **Caution:** WARNING:
If you select the check box but don't configure your CI/CD to use If you select the check box but don't configure your CI/CD to use
pipelines for merge requests, your merge requests may become stuck in an pipelines for merge requests, your merge requests may become stuck in an
unresolved state or your pipelines may be dropped. unresolved state or your pipelines may be dropped.
...@@ -143,7 +143,7 @@ This is the fastest option to get the change merged into the target branch. ...@@ -143,7 +143,7 @@ This is the fastest option to get the change merged into the target branch.
![Merge Immediately](img/merge_train_immediate_merge_v12_6.png) ![Merge Immediately](img/merge_train_immediate_merge_v12_6.png)
CAUTION: **Caution:** WARNING:
Each time you merge a merge request immediately, the current merge train Each time you merge a merge request immediately, the current merge train
is recreated and all pipelines restart. is recreated and all pipelines restart.
......
...@@ -213,7 +213,7 @@ page, then using the **Delete** button. ...@@ -213,7 +213,7 @@ page, then using the **Delete** button.
![Pipeline Delete Button](img/pipeline-delete.png) ![Pipeline Delete Button](img/pipeline-delete.png)
CAUTION: **Warning:** WARNING:
Deleting a pipeline expires all pipeline caches, and deletes all related objects, Deleting a pipeline expires all pipeline caches, and deletes all related objects,
such as builds, logs, artifacts, and triggers. **This action cannot be undone.** such as builds, logs, artifacts, and triggers. **This action cannot be undone.**
......
...@@ -229,7 +229,7 @@ requests and the pipeline view. It's also used to provide data for security dash ...@@ -229,7 +229,7 @@ requests and the pipeline view. It's also used to provide data for security dash
> - Introduced in GitLab 11.5. > - Introduced in GitLab 11.5.
> - Requires GitLab Runner 11.5 and above. > - Requires GitLab Runner 11.5 and above.
CAUTION: **Warning:** WARNING:
This artifact is still valid but is **deprecated** in favor of the This artifact is still valid but is **deprecated** in favor of the
[artifacts:reports:license_scanning](../pipelines/job_artifacts.md#artifactsreportslicense_scanning) [artifacts:reports:license_scanning](../pipelines/job_artifacts.md#artifactsreportslicense_scanning)
introduced in GitLab 12.8. introduced in GitLab 12.8.
......
...@@ -155,7 +155,7 @@ $ vault write auth/jwt/role/myproject-production - <<EOF ...@@ -155,7 +155,7 @@ $ vault write auth/jwt/role/myproject-production - <<EOF
EOF EOF
``` ```
CAUTION: **Caution:** WARNING:
Always restrict your roles to a project or namespace by using one of the provided Always restrict your roles to a project or namespace by using one of the provided
claims like `project_id` or `namespace_id`. Without these restrictions, any JWT claims like `project_id` or `namespace_id`. Without these restrictions, any JWT
generated by this GitLab instance may be allowed to authenticate using this role. generated by this GitLab instance may be allowed to authenticate using this role.
......
...@@ -243,7 +243,7 @@ Some variables are listed in the UI so you can choose them more quickly. ...@@ -243,7 +243,7 @@ Some variables are listed in the UI so you can choose them more quickly.
| `AWS_DEFAULT_REGION` | Any | 12.10 | | `AWS_DEFAULT_REGION` | Any | 12.10 |
| `AWS_SECRET_ACCESS_KEY` | Any | 12.10 | | `AWS_SECRET_ACCESS_KEY` | Any | 12.10 |
CAUTION: **Caution:** WARNING:
When you store credentials, there are security implications. If you are using AWS keys, When you store credentials, there are security implications. If you are using AWS keys,
for example, follow their [best practices](https://docs.aws.amazon.com/general/latest/gr/aws-access-keys-best-practices.html). for example, follow their [best practices](https://docs.aws.amazon.com/general/latest/gr/aws-access-keys-best-practices.html).
...@@ -590,7 +590,7 @@ variables](../../topics/autodevops/customize.md#application-secret-variables) ar ...@@ -590,7 +590,7 @@ variables](../../topics/autodevops/customize.md#application-secret-variables) ar
then available as environment variables on the running application then available as environment variables on the running application
container. container.
CAUTION: **Caution:** WARNING:
Variables with multi-line values are not supported due to Variables with multi-line values are not supported due to
limitations with the Auto DevOps scripting environment. limitations with the Auto DevOps scripting environment.
...@@ -825,7 +825,7 @@ testvariable: ...@@ -825,7 +825,7 @@ testvariable:
> Introduced in GitLab Runner 1.7. > Introduced in GitLab Runner 1.7.
CAUTION: **Warning:** WARNING:
Enabling debug tracing can have severe security implications. The Enabling debug tracing can have severe security implications. The
output **will** contain the content of all your variables and any other output **will** contain the content of all your variables and any other
secrets! The output **will** be uploaded to the GitLab server and made visible secrets! The output **will** be uploaded to the GitLab server and made visible
......
...@@ -1079,7 +1079,7 @@ job: ...@@ -1079,7 +1079,7 @@ job:
- If the pipeline is a scheduled pipeline, the job is **not** be added to the pipeline. - If the pipeline is a scheduled pipeline, the job is **not** be added to the pipeline.
- In **all other cases**, the job is added to the pipeline, with `when: on_success`. - In **all other cases**, the job is added to the pipeline, with `when: on_success`.
CAUTION: **Caution:** WARNING:
If you use a `when:` clause as the final rule (not including `when: never`), two If you use a `when:` clause as the final rule (not including `when: never`), two
simultaneous pipelines may start. Both push pipelines and merge request pipelines can simultaneous pipelines may start. Both push pipelines and merge request pipelines can
be triggered by the same event (a push to the source branch for an open merge request). be triggered by the same event (a push to the source branch for an open merge request).
...@@ -1330,7 +1330,7 @@ rules: ...@@ -1330,7 +1330,7 @@ rules:
To implement a rule similar to [`except:changes`](#onlychangesexceptchanges), To implement a rule similar to [`except:changes`](#onlychangesexceptchanges),
use `when: never`. use `when: never`.
CAUTION: **Caution:** WARNING:
You can use `rules: changes` with other pipeline types, but it is not recommended You can use `rules: changes` with other pipeline types, but it is not recommended
because `rules: changes` always evaluates to true when there is no Git `push` event. because `rules: changes` always evaluates to true when there is no Git `push` event.
Tag pipelines, scheduled pipelines, and so on do **not** have a Git `push` event Tag pipelines, scheduled pipelines, and so on do **not** have a Git `push` event
...@@ -1450,7 +1450,7 @@ job1: ...@@ -1450,7 +1450,7 @@ job1:
if: ($CI_COMMIT_BRANCH == "master" || $CI_COMMIT_BRANCH == "develop") && $MY_VARIABLE if: ($CI_COMMIT_BRANCH == "master" || $CI_COMMIT_BRANCH == "develop") && $MY_VARIABLE
``` ```
CAUTION: **Caution:** WARNING:
[Before GitLab 13.3](https://gitlab.com/gitlab-org/gitlab/-/issues/230938), [Before GitLab 13.3](https://gitlab.com/gitlab-org/gitlab/-/issues/230938),
rules that use both `||` and `&&` may evaluate with an unexpected order of operations. rules that use both `||` and `&&` may evaluate with an unexpected order of operations.
...@@ -1758,7 +1758,7 @@ refs only: ...@@ -1758,7 +1758,7 @@ refs only:
- `external_pull_requests` - `external_pull_requests`
- `merge_requests` (see additional details about [using `only:changes` with pipelines for merge requests](#using-onlychanges-with-pipelines-for-merge-requests)) - `merge_requests` (see additional details about [using `only:changes` with pipelines for merge requests](#using-onlychanges-with-pipelines-for-merge-requests))
CAUTION: **Caution:** WARNING:
In pipelines with [sources other than the three above](../variables/predefined_variables.md) In pipelines with [sources other than the three above](../variables/predefined_variables.md)
`changes` can't determine if a given file is new or old and always returns `true`. `changes` can't determine if a given file is new or old and always returns `true`.
You can configure jobs to use `only: changes` with other `only: refs` keywords. However, You can configure jobs to use `only: changes` with other `only: refs` keywords. However,
...@@ -1787,7 +1787,7 @@ the `docker build` job is created, but only if changes were made to any of the f ...@@ -1787,7 +1787,7 @@ the `docker build` job is created, but only if changes were made to any of the f
- Any of the files and subdirectories in the `dockerfiles` directory. - Any of the files and subdirectories in the `dockerfiles` directory.
- Any of the files with `rb`, `py`, `sh` extensions in the `more_scripts` directory. - Any of the files with `rb`, `py`, `sh` extensions in the `more_scripts` directory.
CAUTION: **Warning:** WARNING:
If you use `only:changes` with [only allow merge requests to be merged if the pipeline succeeds](../../user/project/merge_requests/merge_when_pipeline_succeeds.md#only-allow-merge-requests-to-be-merged-if-the-pipeline-succeeds), If you use `only:changes` with [only allow merge requests to be merged if the pipeline succeeds](../../user/project/merge_requests/merge_when_pipeline_succeeds.md#only-allow-merge-requests-to-be-merged-if-the-pipeline-succeeds),
you should [also use `only:merge_requests`](#using-onlychanges-with-pipelines-for-merge-requests). Otherwise it may not work as expected. you should [also use `only:merge_requests`](#using-onlychanges-with-pipelines-for-merge-requests). Otherwise it may not work as expected.
...@@ -3423,7 +3423,7 @@ test: ...@@ -3423,7 +3423,7 @@ test:
- bundle exec rspec_booster --job $CI_NODE_INDEX/$CI_NODE_TOTAL - bundle exec rspec_booster --job $CI_NODE_INDEX/$CI_NODE_TOTAL
``` ```
CAUTION: **Caution:** WARNING:
Test Boosters reports usage statistics to the author. Test Boosters reports usage statistics to the author.
You can then navigate to the **Jobs** tab of a new pipeline build and see your RSpec You can then navigate to the **Jobs** tab of a new pipeline build and see your RSpec
......
...@@ -19,7 +19,7 @@ You can use special syntax in [`script`](README.md#script) sections to: ...@@ -19,7 +19,7 @@ You can use special syntax in [`script`](README.md#script) sections to:
You can split long commands into multiline commands to improve readability with You can split long commands into multiline commands to improve readability with
`|` (literal) and `>` (folded) [YAML multiline block scalar indicators](https://yaml-multiline.info/). `|` (literal) and `>` (folded) [YAML multiline block scalar indicators](https://yaml-multiline.info/).
CAUTION: **Warning:** WARNING:
If multiple commands are combined into one command string, only the last command's If multiple commands are combined into one command string, only the last command's
failure or success is reported. failure or success is reported.
[Failures from earlier commands are ignored due to a bug](https://gitlab.com/gitlab-org/gitlab-runner/-/issues/25394). [Failures from earlier commands are ignored due to a bug](https://gitlab.com/gitlab-org/gitlab-runner/-/issues/25394).
......
...@@ -12,7 +12,7 @@ info: To determine the technical writer assigned to the Stage/Group associated w ...@@ -12,7 +12,7 @@ info: To determine the technical writer assigned to the Stage/Group associated w
> - It's not recommended for production use. > - It's not recommended for production use.
> - To use it in GitLab self-managed instances, ask a GitLab administrator to [enable it](#enable-or-disable-cicd-configuration-visualization). **(CORE ONLY)** > - To use it in GitLab self-managed instances, ask a GitLab administrator to [enable it](#enable-or-disable-cicd-configuration-visualization). **(CORE ONLY)**
CAUTION: **Warning:** WARNING:
This feature might not be available to you. Check the **version history** note above for details. This feature might not be available to you. Check the **version history** note above for details.
To see a visualization of your `gitlab-ci.yml` configuration, navigate to any CI/CD To see a visualization of your `gitlab-ci.yml` configuration, navigate to any CI/CD
......
...@@ -353,7 +353,7 @@ when the flag is disabled. ...@@ -353,7 +353,7 @@ when the flag is disabled.
A description is [appended](https://gitlab.com/gitlab-org/gitlab/-/blob/497b556/app/graphql/types/base_field.rb#L44-53) A description is [appended](https://gitlab.com/gitlab-org/gitlab/-/blob/497b556/app/graphql/types/base_field.rb#L44-53)
to the field indicating that it is behind a feature flag. to the field indicating that it is behind a feature flag.
CAUTION: **Caution:** WARNING:
If a client queries for the field when the feature flag is disabled, the query If a client queries for the field when the feature flag is disabled, the query
fails. Consider this when toggling the visibility of the feature on or off on fails. Consider this when toggling the visibility of the feature on or off on
production. production.
......
...@@ -8,7 +8,7 @@ info: To determine the technical writer assigned to the Stage/Group associated w ...@@ -8,7 +8,7 @@ info: To determine the technical writer assigned to the Stage/Group associated w
[Introduced](https://gitlab.com/groups/gitlab-org/-/epics/2771) in GitLab 13.7. [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/2771) in GitLab 13.7.
CAUTION: **Caution:** WARNING:
This feature is [under construction](https://gitlab.com/groups/gitlab-org/-/epics/2771) and its API/Architecture might change in the future. This feature is [under construction](https://gitlab.com/groups/gitlab-org/-/epics/2771) and its API/Architecture might change in the future.
GitLab Group Migration is the evolution of Project and Group Import functionality. The GitLab Group Migration is the evolution of Project and Group Import functionality. The
......
...@@ -79,7 +79,7 @@ class AddNotValidForeignKeyToEmailsUser < ActiveRecord::Migration[5.2] ...@@ -79,7 +79,7 @@ class AddNotValidForeignKeyToEmailsUser < ActiveRecord::Migration[5.2]
end end
``` ```
CAUTION: **Caution:** WARNING:
Avoid using the `add_foreign_key` constraint more than once per migration file, unless the source and target tables are identical. Avoid using the `add_foreign_key` constraint more than once per migration file, unless the source and target tables are identical.
#### Data migration to fix existing records #### Data migration to fix existing records
......
...@@ -65,7 +65,7 @@ be enabled for a single project, and is not ready for production use: ...@@ -65,7 +65,7 @@ be enabled for a single project, and is not ready for production use:
> - It's not recommended for production use. > - It's not recommended for production use.
> - To use it in GitLab self-managed instances, ask a GitLab administrator to [enable it](#anchor-to-section). **(CORE ONLY)** > - To use it in GitLab self-managed instances, ask a GitLab administrator to [enable it](#anchor-to-section). **(CORE ONLY)**
CAUTION: **Warning:** WARNING:
This feature might not be available to you. Check the **version history** note above for details. This feature might not be available to you. Check the **version history** note above for details.
(...Regular content goes here...) (...Regular content goes here...)
...@@ -124,7 +124,7 @@ use: ...@@ -124,7 +124,7 @@ use:
> - It's recommended for production use. > - It's recommended for production use.
> - For GitLab self-managed instances, GitLab administrators can opt to [disable it](#anchor-to-section). **(CORE ONLY)** > - For GitLab self-managed instances, GitLab administrators can opt to [disable it](#anchor-to-section). **(CORE ONLY)**
CAUTION: **Warning:** WARNING:
This feature might not be available to you. Check the **version history** note above for details. This feature might not be available to you. Check the **version history** note above for details.
(...Regular content goes here...) (...Regular content goes here...)
...@@ -180,7 +180,7 @@ cannot be enabled for a single project, and is ready for production use: ...@@ -180,7 +180,7 @@ cannot be enabled for a single project, and is ready for production use:
> - It's recommended for production use. > - It's recommended for production use.
> - For GitLab self-managed instances, GitLab administrators can opt to [disable it](#anchor-to-section). **(CORE ONLY)** > - For GitLab self-managed instances, GitLab administrators can opt to [disable it](#anchor-to-section). **(CORE ONLY)**
CAUTION: **Warning:** WARNING:
This feature might not be available to you. Check the **version history** note above for details. This feature might not be available to you. Check the **version history** note above for details.
(...Regular content goes here...) (...Regular content goes here...)
...@@ -253,7 +253,7 @@ be enabled by project, and is ready for production use: ...@@ -253,7 +253,7 @@ be enabled by project, and is ready for production use:
> - It's recommended for production use. > - It's recommended for production use.
> - For GitLab self-managed instances, GitLab administrators can opt to [disable it](#anchor-to-section). **(CORE ONLY)** > - For GitLab self-managed instances, GitLab administrators can opt to [disable it](#anchor-to-section). **(CORE ONLY)**
CAUTION: **Warning:** WARNING:
This feature might not be available to you. Check the **version history** note above for details. This feature might not be available to you. Check the **version history** note above for details.
(...Regular content goes here...) (...Regular content goes here...)
......
...@@ -110,7 +110,7 @@ Rendered example: ...@@ -110,7 +110,7 @@ Rendered example:
The following sections include a set of [cURL](https://curl.se/) examples The following sections include a set of [cURL](https://curl.se/) examples
you can use in the API documentation. you can use in the API documentation.
CAUTION: **Caution:** WARNING:
Do not use information for real users, URLs, or tokens. For documentation, refer to our Do not use information for real users, URLs, or tokens. For documentation, refer to our
relevant style guide sections on [Fake user information](styleguide/index.md#fake-user-information), relevant style guide sections on [Fake user information](styleguide/index.md#fake-user-information),
[Fake URLs](styleguide/index.md#fake-urls), and [Fake tokens](styleguide/index.md#fake-tokens). [Fake URLs](styleguide/index.md#fake-urls), and [Fake tokens](styleguide/index.md#fake-tokens).
......
...@@ -46,7 +46,7 @@ for the version in question. ...@@ -46,7 +46,7 @@ for the version in question.
## Porting new website changes to old versions ## Porting new website changes to old versions
CAUTION: **Warning:** WARNING:
Porting changes to older branches can have unintended effects as we're constantly Porting changes to older branches can have unintended effects as we're constantly
changing the backend of the website. Use only when you know what you're doing changing the backend of the website. Use only when you know what you're doing
and make sure to test locally. and make sure to test locally.
......
...@@ -292,7 +292,7 @@ and the following syntax rules. ...@@ -292,7 +292,7 @@ and the following syntax rules.
an "information" icon on the nav to make the user aware that the feature is an "information" icon on the nav to make the user aware that the feature is
EE-only. EE-only.
CAUTION: **Caution:** WARNING:
All links present on the data file must end in `.html`, not `.md`. Do not All links present on the data file must end in `.html`, not `.md`. Do not
start any relative link with a forward slash `/`. start any relative link with a forward slash `/`.
......
...@@ -114,7 +114,7 @@ located in the [Dockerfiles directory](https://gitlab.com/gitlab-org/gitlab-docs ...@@ -114,7 +114,7 @@ located in the [Dockerfiles directory](https://gitlab.com/gitlab-org/gitlab-docs
If you need to rebuild the Docker images immediately (must have maintainer level permissions): If you need to rebuild the Docker images immediately (must have maintainer level permissions):
CAUTION: **Caution:** WARNING:
If you change the dockerfile configuration and rebuild the images, you can break the master If you change the dockerfile configuration and rebuild the images, you can break the master
pipeline in the main `gitlab` repository as well as in `gitlab-docs`. Create an image with pipeline in the main `gitlab` repository as well as in `gitlab-docs`. Create an image with
a different name first and test it to ensure you do not break the pipelines. a different name first and test it to ensure you do not break the pipelines.
......
...@@ -46,7 +46,7 @@ yarn eslint-fix ...@@ -46,7 +46,7 @@ yarn eslint-fix
If manual changes are required, a list of changes will be sent to the console. If manual changes are required, a list of changes will be sent to the console.
CAUTION: **Caution:** WARNING:
Limit use to global rule updates. Otherwise, the changes can lead to huge Merge Requests. Limit use to global rule updates. Otherwise, the changes can lead to huge Merge Requests.
### Disabling ESLint in new files ### Disabling ESLint in new files
......
...@@ -17,7 +17,7 @@ request removing the feature flag or the merge request where the default value o ...@@ -17,7 +17,7 @@ request removing the feature flag or the merge request where the default value o
the feature flag is set to enabled. If the feature contains any database migrations, it the feature flag is set to enabled. If the feature contains any database migrations, it
*should* include a changelog entry for the database changes. *should* include a changelog entry for the database changes.
CAUTION: **Caution:** WARNING:
All newly-introduced feature flags should be [disabled by default](process.md#feature-flags-in-gitlab-development). All newly-introduced feature flags should be [disabled by default](process.md#feature-flags-in-gitlab-development).
NOTE: **Note:** NOTE: **Note:**
......
...@@ -413,5 +413,5 @@ tree ...@@ -413,5 +413,5 @@ tree
└── 4352.json └── 4352.json
``` ```
CAUTION: **Caution:** WARNING:
When updating these fixtures, please ensure you update both `json` files and `tree` folder, as the tests apply to both. When updating these fixtures, please ensure you update both `json` files and `tree` folder, as the tests apply to both.
...@@ -385,7 +385,7 @@ These endpoints are all authenticated using JWT. The JWT secret is stored in a f ...@@ -385,7 +385,7 @@ These endpoints are all authenticated using JWT. The JWT secret is stored in a f
specified in `config/gitlab.yml`. By default, the location is in the root of the specified in `config/gitlab.yml`. By default, the location is in the root of the
GitLab Rails app in a file called `.gitlab_kas_secret`. GitLab Rails app in a file called `.gitlab_kas_secret`.
CAUTION: **Caution:** WARNING:
The Kubernetes agent is under development and is not recommended for production use. The Kubernetes agent is under development and is not recommended for production use.
### Kubernetes agent information ### Kubernetes agent information
......
...@@ -26,7 +26,7 @@ The visibility level of a group can be changed only if all subgroups and ...@@ -26,7 +26,7 @@ The visibility level of a group can be changed only if all subgroups and
sub-projects have the same or lower visibility level. For example, a group can be set sub-projects have the same or lower visibility level. For example, a group can be set
to internal only if all subgroups and projects are internal or private. to internal only if all subgroups and projects are internal or private.
CAUTION: **Warning:** WARNING:
If you migrate an existing group to a lower visibility level, that action does not migrate subgroups If you migrate an existing group to a lower visibility level, that action does not migrate subgroups
in the same way. This is a [known issue](https://gitlab.com/gitlab-org/gitlab/-/issues/22406). in the same way. This is a [known issue](https://gitlab.com/gitlab-org/gitlab/-/issues/22406).
...@@ -70,7 +70,7 @@ can still view the groups and their entities (like epics). ...@@ -70,7 +70,7 @@ can still view the groups and their entities (like epics).
Project membership (where the group membership is already taken into account) Project membership (where the group membership is already taken into account)
is stored in the `project_authorizations` table. is stored in the `project_authorizations` table.
CAUTION: **Caution:** WARNING:
Due to [an issue](https://gitlab.com/gitlab-org/gitlab/-/issues/219299), Due to [an issue](https://gitlab.com/gitlab-org/gitlab/-/issues/219299),
projects in personal namespace will not show owner (`50`) permission in projects in personal namespace will not show owner (`50`) permission in
`project_authorizations` table. Note however that [`user.owned_projects`](https://gitlab.com/gitlab-org/gitlab/blob/0d63823b122b11abd2492bca47cc26858eee713d/app/models/user.rb#L906-916) `project_authorizations` table. Note however that [`user.owned_projects`](https://gitlab.com/gitlab-org/gitlab/blob/0d63823b122b11abd2492bca47cc26858eee713d/app/models/user.rb#L906-916)
......
...@@ -781,7 +781,7 @@ appear to be associated to any of the services running, since they all appear to ...@@ -781,7 +781,7 @@ appear to be associated to any of the services running, since they all appear to
> - It's [deployed behind a feature flag](../../user/feature_flags.md), disabled by default. > - It's [deployed behind a feature flag](../../user/feature_flags.md), disabled by default.
> - It's enabled on GitLab.com. > - It's enabled on GitLab.com.
CAUTION: **Warning:** WARNING:
This feature is intended solely for internal GitLab use. This feature is intended solely for internal GitLab use.
In order to add data for aggregated metrics into Usage Ping payload you should add corresponding definition into [`aggregated_metrics.yml`](https://gitlab.com/gitlab-org/gitlab/-/blob/master/lib/gitlab/usage_data_counters/aggregated_metrics.yml) file. Each aggregate definition includes following parts: In order to add data for aggregated metrics into Usage Ping payload you should add corresponding definition into [`aggregated_metrics.yml`](https://gitlab.com/gitlab-org/gitlab/-/blob/master/lib/gitlab/usage_data_counters/aggregated_metrics.yml) file. Each aggregate definition includes following parts:
......
...@@ -21,7 +21,7 @@ deviations from this guide, they should be described in the ...@@ -21,7 +21,7 @@ deviations from this guide, they should be described in the
## Avoid using shell scripts ## Avoid using shell scripts
CAUTION: **Caution:** WARNING:
This is a must-read section. This is a must-read section.
Having said all of the above, we recommend staying away from shell scripts Having said all of the above, we recommend staying away from shell scripts
......
...@@ -720,7 +720,7 @@ at all possible. ...@@ -720,7 +720,7 @@ at all possible.
#### Test Snowplow events #### Test Snowplow events
CAUTION: **Warning:** WARNING:
Snowplow performs **runtime type checks** by using the [contracts gem](https://rubygems.org/gems/contracts). Snowplow performs **runtime type checks** by using the [contracts gem](https://rubygems.org/gems/contracts).
Since Snowplow is **by default disabled in tests and development**, it can be hard to Since Snowplow is **by default disabled in tests and development**, it can be hard to
**catch exceptions** when mocking `Gitlab::Tracking`. **catch exceptions** when mocking `Gitlab::Tracking`.
...@@ -792,7 +792,7 @@ describe "#==" do ...@@ -792,7 +792,7 @@ describe "#==" do
end end
``` ```
CAUTION: **Caution:** WARNING:
Only use simple values as input in the `where` block. Using procs, stateful Only use simple values as input in the `where` block. Using procs, stateful
objects, FactoryBot-created objects etc. can lead to objects, FactoryBot-created objects etc. can lead to
[unexpected results](https://github.com/tomykaira/rspec-parameterized/issues/8). [unexpected results](https://github.com/tomykaira/rspec-parameterized/issues/8).
......
...@@ -52,7 +52,7 @@ For information about the distribution of tests per level in GitLab, see ...@@ -52,7 +52,7 @@ For information about the distribution of tests per level in GitLab, see
- Finally, discuss the proposed test with the developer(s) involved in implementing - Finally, discuss the proposed test with the developer(s) involved in implementing
the feature and the lower-level tests. the feature and the lower-level tests.
CAUTION: **Caution:** WARNING:
Check both [GitLab Community Edition](https://gitlab-org.gitlab.io/gitlab-foss/coverage-ruby/#_AllFiles) and Check both [GitLab Community Edition](https://gitlab-org.gitlab.io/gitlab-foss/coverage-ruby/#_AllFiles) and
[GitLab Enterprise Edition](https://gitlab-org.gitlab.io/gitlab/coverage-ruby/#_AllFiles) coverage projects [GitLab Enterprise Edition](https://gitlab-org.gitlab.io/gitlab/coverage-ruby/#_AllFiles) coverage projects
for previously-written tests for this feature. For analyzing the code coverage, for previously-written tests for this feature. For analyzing the code coverage,
...@@ -86,7 +86,7 @@ file `basic_login_spec.rb`. ...@@ -86,7 +86,7 @@ file `basic_login_spec.rb`.
See the [`RSpec.describe` outer block](#the-outer-rspecdescribe-block) See the [`RSpec.describe` outer block](#the-outer-rspecdescribe-block)
CAUTION: **Deprecation notice:** WARNING:
The outer `context` [was deprecated](https://gitlab.com/gitlab-org/quality/team-tasks/-/issues/550) in `13.2` The outer `context` [was deprecated](https://gitlab.com/gitlab-org/quality/team-tasks/-/issues/550) in `13.2`
in adherence to RSpec 4.0 specifications. Use `RSpec.describe` instead. in adherence to RSpec 4.0 specifications. Use `RSpec.describe` instead.
......
...@@ -19,7 +19,7 @@ We can specify what environments or pipelines to run tests against using the `on ...@@ -19,7 +19,7 @@ We can specify what environments or pipelines to run tests against using the `on
| `production` | Match against production | `Static` | | `production` | Match against production | `Static` |
| `pipeline` | Match against a pipeline | `Array` or `Static`| | `pipeline` | Match against a pipeline | `Array` or `Static`|
CAUTION: **Caution:** WARNING:
You cannot specify `:production` and `{ <switch>: 'value' }` simultaneously. You cannot specify `:production` and `{ <switch>: 'value' }` simultaneously.
These options are mutually exclusive. If you want to specify production, you These options are mutually exclusive. If you want to specify production, you
can control the `tld` and `domain` independently. can control the `tld` and `domain` independently.
......
...@@ -17,7 +17,7 @@ and `GITLAB_ADMIN_PASSWORD`. ...@@ -17,7 +17,7 @@ and `GITLAB_ADMIN_PASSWORD`.
Please be sure to include the tag `:requires_admin` so that the test can be skipped in environments Please be sure to include the tag `:requires_admin` so that the test can be skipped in environments
where admin access is not available. where admin access is not available.
CAUTION: **Caution:** WARNING:
You are strongly advised to [enable feature flags only for a group, project, user](../../feature_flags/development.md#feature-actors), You are strongly advised to [enable feature flags only for a group, project, user](../../feature_flags/development.md#feature-actors),
or [feature group](../../feature_flags/development.md#feature-groups). This makes it possible to or [feature group](../../feature_flags/development.md#feature-groups). This makes it possible to
test a feature in a shared environment without affecting other users. test a feature in a shared environment without affecting other users.
......
...@@ -280,7 +280,7 @@ Uploads routes belong to one of these categories: ...@@ -280,7 +280,7 @@ Uploads routes belong to one of these categories:
1. Grape API: uploads handled by a Grape API endpoint. 1. Grape API: uploads handled by a Grape API endpoint.
1. GraphQL API: uploads handled by a GraphQL resolve function. 1. GraphQL API: uploads handled by a GraphQL resolve function.
CAUTION: **Warning:** WARNING:
GraphQL uploads do not support [direct upload](#direct-upload) yet. Depending on the use case, the feature may not work on installations without NFS (like GitLab.com or Kubernetes installations). Uploading to object storage inside the GraphQL resolve function may result in timeout errors. For more details please follow [issue #280819](https://gitlab.com/gitlab-org/gitlab/-/issues/280819). GraphQL uploads do not support [direct upload](#direct-upload) yet. Depending on the use case, the feature may not work on installations without NFS (like GitLab.com or Kubernetes installations). Uploading to object storage inside the GraphQL resolve function may result in timeout errors. For more details please follow [issue #280819](https://gitlab.com/gitlab-org/gitlab/-/issues/280819).
### Update Workhorse for the new route ### Update Workhorse for the new route
...@@ -310,7 +310,7 @@ few things to do: ...@@ -310,7 +310,7 @@ few things to do:
1. Generally speaking, it's a good idea to check if the instance is from the [`UploadedFile`](https://gitlab.com/gitlab-org/gitlab/-/blob/master/lib/uploaded_file.rb) class. For example, see how we checked 1. Generally speaking, it's a good idea to check if the instance is from the [`UploadedFile`](https://gitlab.com/gitlab-org/gitlab/-/blob/master/lib/uploaded_file.rb) class. For example, see how we checked
[that the parameter is indeed an `UploadedFile`](https://gitlab.com/gitlab-org/gitlab/-/commit/ea30fe8a71bf16ba07f1050ab4820607b5658719#51c0cc7a17b7f12c32bc41cfab3649ff2739b0eb_79_77). [that the parameter is indeed an `UploadedFile`](https://gitlab.com/gitlab-org/gitlab/-/commit/ea30fe8a71bf16ba07f1050ab4820607b5658719#51c0cc7a17b7f12c32bc41cfab3649ff2739b0eb_79_77).
CAUTION: **Caution:** WARNING:
**Do not** call `UploadedFile#from_params` directly! Do not build an [`UploadedFile`](https://gitlab.com/gitlab-org/gitlab/-/blob/master/lib/uploaded_file.rb) **Do not** call `UploadedFile#from_params` directly! Do not build an [`UploadedFile`](https://gitlab.com/gitlab-org/gitlab/-/blob/master/lib/uploaded_file.rb)
instance using `UploadedFile#from_params`! This method can be unsafe to use depending on the `params` instance using `UploadedFile#from_params`! This method can be unsafe to use depending on the `params`
passed. Instead, use the [`UploadedFile`](https://gitlab.com/gitlab-org/gitlab/-/blob/master/lib/uploaded_file.rb) passed. Instead, use the [`UploadedFile`](https://gitlab.com/gitlab-org/gitlab/-/blob/master/lib/uploaded_file.rb)
...@@ -339,7 +339,7 @@ use `requires :file, type: ::API::Validations::Types::WorkhorseFile`. ...@@ -339,7 +339,7 @@ use `requires :file, type: ::API::Validations::Types::WorkhorseFile`.
- The remaining code of the processing. This is where the code must be reading the parameter (for - The remaining code of the processing. This is where the code must be reading the parameter (for
our example, it would be `params[:file]`). our example, it would be `params[:file]`).
CAUTION: **Caution:** WARNING:
**Do not** call `UploadedFile#from_params` directly! Do not build an [`UploadedFile`](https://gitlab.com/gitlab-org/gitlab/-/blob/master/lib/uploaded_file.rb) **Do not** call `UploadedFile#from_params` directly! Do not build an [`UploadedFile`](https://gitlab.com/gitlab-org/gitlab/-/blob/master/lib/uploaded_file.rb)
object using `UploadedFile#from_params`! This method can be unsafe to use depending on the `params` object using `UploadedFile#from_params`! This method can be unsafe to use depending on the `params`
passed. Instead, use the [`UploadedFile`](https://gitlab.com/gitlab-org/gitlab/-/blob/master/lib/uploaded_file.rb) passed. Instead, use the [`UploadedFile`](https://gitlab.com/gitlab-org/gitlab/-/blob/master/lib/uploaded_file.rb)
......
...@@ -102,7 +102,7 @@ might be asked for an administrator password. ...@@ -102,7 +102,7 @@ might be asked for an administrator password.
sudo RESTRICTED-COMMAND sudo RESTRICTED-COMMAND
``` ```
CAUTION: **Caution:** WARNING:
Be careful of the commands you run with `sudo`. Certain commands may cause Be careful of the commands you run with `sudo`. Certain commands may cause
damage to your data or system. damage to your data or system.
......
...@@ -453,7 +453,7 @@ git reset HEAD~1 ...@@ -453,7 +453,7 @@ git reset HEAD~1
This leaves the changed files and folders unstaged in your local repository. This leaves the changed files and folders unstaged in your local repository.
CAUTION: **Warning:** WARNING:
A Git commit should not usually be reversed, particularly if you already pushed it A Git commit should not usually be reversed, particularly if you already pushed it
to the remote repository. Although you can undo a commit, the best option is to avoid to the remote repository. Although you can undo a commit, the best option is to avoid
the situation altogether by working carefully. the situation altogether by working carefully.
......
...@@ -557,7 +557,7 @@ gitlab=# \q ...@@ -557,7 +557,7 @@ gitlab=# \q
#### Set up Gitaly #### Set up Gitaly
CAUTION: **Caution:** WARNING:
In this architecture, having a single Gitaly server creates a single point of failure. Use In this architecture, having a single Gitaly server creates a single point of failure. Use
[Gitaly Cluster](../../administration/gitaly/praefect.md) to remove this limitation. [Gitaly Cluster](../../administration/gitaly/praefect.md) to remove this limitation.
......
...@@ -8,7 +8,7 @@ type: howto ...@@ -8,7 +8,7 @@ type: howto
# Install GitLab on Microsoft Azure # Install GitLab on Microsoft Azure
CAUTION: **Deprecated:** WARNING:
The GitLab image in the Azure Marketplace is deprecated. You can track GitLab's The GitLab image in the Azure Marketplace is deprecated. You can track GitLab's
efforts to [post a new image](https://gitlab.com/gitlab-com/alliances/microsoft/gitlab-tracker/-/issues/2). efforts to [post a new image](https://gitlab.com/gitlab-com/alliances/microsoft/gitlab-tracker/-/issues/2).
......
...@@ -443,7 +443,7 @@ Make sure to replace `<X-Y-stable>` with the stable branch that matches the ...@@ -443,7 +443,7 @@ Make sure to replace `<X-Y-stable>` with the stable branch that matches the
version you want to install. For example, if you want to install 11.8 you would version you want to install. For example, if you want to install 11.8 you would
use the branch name `11-8-stable`. use the branch name `11-8-stable`.
CAUTION: **Caution:** WARNING:
You can change `<X-Y-stable>` to `master` if you want the *bleeding edge* version, but never install `master` on a production server! You can change `<X-Y-stable>` to `master` if you want the *bleeding edge* version, but never install `master` on a production server!
### Configure It ### Configure It
......
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment