Commit 8cb0a93a authored by Evan Read's avatar Evan Read

Merge branch 'docs-alert-boxes-4' into 'master'

Add newlines after alert box text

See merge request gitlab-org/gitlab!37036
parents 71fd52c0 f350a712
...@@ -12,4 +12,5 @@ scope: raw ...@@ -12,4 +12,5 @@ scope: raw
raw: raw:
- '((NOTE|TIP|CAUTION|DANGER): \*\*[^:]*\*\*)|' - '((NOTE|TIP|CAUTION|DANGER): \*\*[^:]*\*\*)|'
- '((NOTE: \*\*NOTE:\*\*)|(TIP: \*\*TIP:\*\*)|(CAUTION: \*\*CAUTION:\*\*)|(DANGER: \*\*DANGER:\*\*))|' - '((NOTE: \*\*NOTE:\*\*)|(TIP: \*\*TIP:\*\*)|(CAUTION: \*\*CAUTION:\*\*)|(DANGER: \*\*DANGER:\*\*))|'
- '((NOTE: \*\*note:\*\*)|(TIP: \*\*tip:\*\*)|(CAUTION: \*\*caution:\*\*)|(DANGER: \*\*danger:\*\*))' - '((NOTE: \*\*note:\*\*)|(TIP: \*\*tip:\*\*)|(CAUTION: \*\*caution:\*\*)|(DANGER: \*\*danger:\*\*))|'
- '((NOTE|TIP|CAUTION|DANGER): \*\*.*\*\*.+)'
...@@ -62,7 +62,8 @@ JWT will provide you with a secret key for you to use. ...@@ -62,7 +62,8 @@ JWT will provide you with a secret key for you to use.
} }
``` ```
NOTE: **Note:** For more information on each configuration option refer to NOTE: **Note:**
For more information on each configuration option refer to
the [OmniAuth JWT usage documentation](https://github.com/mbleigh/omniauth-jwt#usage). the [OmniAuth JWT usage documentation](https://github.com/mbleigh/omniauth-jwt#usage).
1. Change `YOUR_APP_SECRET` to the client secret and set `auth_url` to your redirect URL. 1. Change `YOUR_APP_SECRET` to the client secret and set `auth_url` to your redirect URL.
......
...@@ -34,7 +34,8 @@ The steps below cover: ...@@ -34,7 +34,8 @@ The steps below cover:
'Entire domain (GitLab)' or 'Selected organizational units' for both 'Verify user 'Entire domain (GitLab)' or 'Selected organizational units' for both 'Verify user
credentials' and 'Read user information'. Select 'Add LDAP Client' credentials' and 'Read user information'. Select 'Add LDAP Client'
TIP: **Tip:** If you plan to use GitLab [LDAP Group Sync](index.md#group-sync-starter-only) TIP: **Tip:**
If you plan to use GitLab [LDAP Group Sync](index.md#group-sync-starter-only)
, turn on 'Read group information'. , turn on 'Read group information'.
![Add LDAP Client Step 2](img/google_secure_ldap_add_step_2.png) ![Add LDAP Client Step 2](img/google_secure_ldap_add_step_2.png)
......
...@@ -32,13 +32,15 @@ To bring the former **primary** node up to date: ...@@ -32,13 +32,15 @@ To bring the former **primary** node up to date:
sudo gitlab-ctl start sudo gitlab-ctl start
``` ```
NOTE: **Note:** If you [disabled the **primary** node permanently](index.md#step-2-permanently-disable-the-primary-node), NOTE: **Note:**
If you [disabled the **primary** node permanently](index.md#step-2-permanently-disable-the-primary-node),
you need to undo those steps now. For Debian/Ubuntu you just need to run you need to undo those steps now. For Debian/Ubuntu you just need to run
`sudo systemctl enable gitlab-runsvdir`. For CentOS 6, you need to install `sudo systemctl enable gitlab-runsvdir`. For CentOS 6, you need to install
the GitLab instance from scratch and set it up as a **secondary** node by the GitLab instance from scratch and set it up as a **secondary** node by
following [Setup instructions](../replication/index.md#setup-instructions). In this case, you don't need to follow the next step. following [Setup instructions](../replication/index.md#setup-instructions). In this case, you don't need to follow the next step.
NOTE: **Note:** If you [changed the DNS records](index.md#step-4-optional-updating-the-primary-domain-dns-record) NOTE: **Note:**
If you [changed the DNS records](index.md#step-4-optional-updating-the-primary-domain-dns-record)
for this node during disaster recovery procedure you may need to [block for this node during disaster recovery procedure you may need to [block
all the writes to this node](planned_failover.md#prevent-updates-to-the-primary-node) all the writes to this node](planned_failover.md#prevent-updates-to-the-primary-node)
during this procedure. during this procedure.
......
...@@ -130,7 +130,8 @@ There is an [issue where support is being discussed](https://gitlab.com/gitlab-o ...@@ -130,7 +130,8 @@ There is an [issue where support is being discussed](https://gitlab.com/gitlab-o
connect to the **primary** node's database. For this reason, we need the address of connect to the **primary** node's database. For this reason, we need the address of
each node. each node.
NOTE: **Note:** For external PostgreSQL instances, see [additional instructions](external_database.md). NOTE: **Note:**
For external PostgreSQL instances, see [additional instructions](external_database.md).
If you are using a cloud provider, you can lookup the addresses for each If you are using a cloud provider, you can lookup the addresses for each
Geo node through your cloud provider's management console. Geo node through your cloud provider's management console.
...@@ -419,7 +420,8 @@ data before running `pg_basebackup`. ...@@ -419,7 +420,8 @@ 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:** Each Geo **secondary** node must have its own unique replication slot name. CAUTION: **Warning:**
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.
```shell ```shell
......
...@@ -270,7 +270,8 @@ the tracking database on port 5432. ...@@ -270,7 +270,8 @@ the tracking database on port 5432.
query_exec "GRANT USAGE ON FOREIGN SERVER gitlab_secondary TO ${GEO_DB_USER};" query_exec "GRANT USAGE ON FOREIGN SERVER gitlab_secondary TO ${GEO_DB_USER};"
``` ```
NOTE: **Note:** The script template above uses `gitlab-psql` as it's intended to be executed from the Geo machine, NOTE: **Note:**
The script template above uses `gitlab-psql` as it's intended to be executed from the Geo machine,
but you can change it to `psql` and run it from any machine that has access to the database. We also recommend using but you can change it to `psql` and run it from any machine that has access to the database. We also recommend using
`psql` for AWS RDS. `psql` for AWS RDS.
......
...@@ -90,7 +90,8 @@ The following steps enable a GitLab cluster to serve as the **primary** node. ...@@ -90,7 +90,8 @@ The following steps enable a GitLab cluster to serve as the **primary** node.
After making these changes, [reconfigure GitLab](../../restart_gitlab.md#omnibus-gitlab-reconfigure) so the changes take effect. After making these changes, [reconfigure GitLab](../../restart_gitlab.md#omnibus-gitlab-reconfigure) so the changes take effect.
NOTE: **Note:** PostgreSQL and Redis should have already been disabled on the NOTE: **Note:**
PostgreSQL and Redis should have already been disabled on the
application servers, and connections from the application servers to those application servers, and connections from the application servers to those
services on the backend servers configured, during normal GitLab multi-node set up. See services on the backend servers configured, during normal GitLab multi-node set up. See
multi-node configuration documentation for multi-node configuration documentation for
...@@ -141,7 +142,8 @@ recommended. ...@@ -141,7 +142,8 @@ recommended.
### Step 2: Configure the main read-only replica PostgreSQL database on the **secondary** node ### Step 2: Configure the main read-only replica PostgreSQL database on the **secondary** node
NOTE: **Note:** The following documentation assumes the database will be run on NOTE: **Note:**
The following documentation assumes the database will be run on
a single node only. Multi-node PostgreSQL on **secondary** nodes is a single node only. Multi-node PostgreSQL on **secondary** nodes is
[not currently supported](https://gitlab.com/groups/gitlab-org/-/epics/2536). [not currently supported](https://gitlab.com/groups/gitlab-org/-/epics/2536).
...@@ -206,7 +208,8 @@ If using an external PostgreSQL instance, refer also to ...@@ -206,7 +208,8 @@ If using an external PostgreSQL instance, refer also to
### Step 3: Configure the tracking database on the **secondary** node ### Step 3: Configure the tracking database on the **secondary** node
NOTE: **Note:** This documentation assumes the tracking database will be run on NOTE: **Note:**
This documentation assumes the tracking database will be run on
only a single machine, rather than as a PostgreSQL cluster. only a single machine, rather than as a PostgreSQL cluster.
Configure the tracking database. Configure the tracking database.
......
...@@ -701,7 +701,8 @@ To check the configuration: ...@@ -701,7 +701,8 @@ To check the configuration:
Description | Description |
``` ```
NOTE: **Note:** Pay particular attention to the host and port under NOTE: **Note:**
Pay particular attention to the host and port under
FDW options. That configuration should point to the Geo secondary FDW options. That configuration should point to the Geo secondary
database. database.
......
...@@ -36,7 +36,8 @@ different steps. ...@@ -36,7 +36,8 @@ different steps.
## General update steps ## General update steps
NOTE: **Note:** These general update steps are not intended for [high-availability deployments](https://docs.gitlab.com/omnibus/update/README.html#multi-node--ha-deployment), and will cause downtime. If you want to avoid downtime, consider using [zero downtime updates](https://docs.gitlab.com/omnibus/update/README.html#zero-downtime-updates). NOTE: **Note:**
These general update steps are not intended for [high-availability deployments](https://docs.gitlab.com/omnibus/update/README.html#multi-node--ha-deployment), and will cause downtime. If you want to avoid downtime, consider using [zero downtime updates](https://docs.gitlab.com/omnibus/update/README.html#zero-downtime-updates).
To update the Geo nodes when a new GitLab version is released, update **primary** To update the Geo nodes when a new GitLab version is released, update **primary**
and all **secondary** nodes: and all **secondary** nodes:
......
...@@ -136,7 +136,8 @@ We will note in the instructions below where these secrets are required. ...@@ -136,7 +136,8 @@ We will note in the instructions below where these secrets are required.
### PostgreSQL ### PostgreSQL
NOTE: **Note:** do not store the GitLab application database and the Praefect NOTE: **Note:**
do not store the GitLab application database and the Praefect
database on the same PostgreSQL server if using database on the same PostgreSQL server if using
[Geo](../geo/replication/index.md). The replication state is internal to each instance [Geo](../geo/replication/index.md). The replication state is internal to each instance
of GitLab and should not be replicated. of GitLab and should not be replicated.
...@@ -286,7 +287,8 @@ application server, or a Gitaly node. ...@@ -286,7 +287,8 @@ 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 will be replicas of each other. `gitaly-2`, and `gitaly-3`, which will be replicas of each other.
CAUTION: **Caution:** If you have data on an already existing storage called CAUTION: **Caution:**
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 Praefect storage](#migrating-existing-repositories-to-praefect) [migrate the data to the Praefect storage](#migrating-existing-repositories-to-praefect)
afterwards. afterwards.
...@@ -300,7 +302,8 @@ application server, or a Gitaly node. ...@@ -300,7 +302,8 @@ application server, or a Gitaly node.
More Gitaly nodes can be added to the cluster to increase the number of More Gitaly nodes can be added to the cluster to increase the number of
replicas. More clusters can also be added for very large GitLab instances. replicas. More clusters can also be added for very large GitLab instances.
NOTE: **Note:** The `gitaly-1` node is currently denoted the primary. This NOTE: **Note:**
The `gitaly-1` node is currently denoted the primary. This
can be used to manually fail from one node to another. This will be removed can be used to manually fail from one node to another. This will be removed
in the [future](https://gitlab.com/gitlab-org/gitaly/-/issues/2634). in the [future](https://gitlab.com/gitlab-org/gitaly/-/issues/2634).
...@@ -493,7 +496,8 @@ To configure Praefect with TLS: ...@@ -493,7 +496,8 @@ To configure Praefect with TLS:
### Gitaly ### Gitaly
NOTE: **Note:** Complete these steps for **each** Gitaly node. NOTE: **Note:**
Complete these steps for **each** Gitaly node.
To complete this section you will need: To complete this section you will need:
...@@ -967,7 +971,8 @@ Virtual storage: default ...@@ -967,7 +971,8 @@ Virtual storage: default
Currently `dataloss` only considers a repository up to date if it has been directly replicated to from the previous write-enabled primary. While reconciling from an up to date secondary can recover the data, this is not visible in the data loss report. This is due for improvement via [Gitaly#2866](https://gitlab.com/gitlab-org/gitaly/-/issues/2866). Currently `dataloss` only considers a repository up to date if it has been directly replicated to from the previous write-enabled primary. While reconciling from an up to date secondary can recover the data, this is not visible in the data loss report. This is due for improvement via [Gitaly#2866](https://gitlab.com/gitlab-org/gitaly/-/issues/2866).
NOTE: **Note:** `dataloss` is still in beta and the output format is subject to change. NOTE: **Note:**
`dataloss` is still in beta and the output format is subject to change.
### Checking repository checksums ### Checking repository checksums
......
...@@ -6,11 +6,13 @@ type: reference ...@@ -6,11 +6,13 @@ type: reference
This section describes how to configure the GitLab application (Rails) component. This section describes how to configure the GitLab application (Rails) component.
NOTE: **Note:** There is some additional configuration near the bottom for NOTE: **Note:**
There is some additional configuration near the bottom for
additional GitLab application servers. It's important to read and understand additional GitLab application servers. It's important to read and understand
these additional steps before proceeding with GitLab installation. these additional steps before proceeding with GitLab installation.
NOTE: **Note:** [Cloud Object Storage service](object_storage.md) with [Gitaly](gitaly.md) NOTE: **Note:**
[Cloud Object Storage service](object_storage.md) with [Gitaly](gitaly.md)
is recommended over [NFS](nfs.md) wherever possible for improved performance. is recommended over [NFS](nfs.md) wherever possible for improved performance.
1. If necessary, install the NFS client utility packages using the following 1. If necessary, install the NFS client utility packages using the following
...@@ -79,19 +81,22 @@ is recommended over [NFS](nfs.md) wherever possible for improved performance. ...@@ -79,19 +81,22 @@ is recommended over [NFS](nfs.md) wherever possible for improved performance.
1. [Enable monitoring](#enable-monitoring) 1. [Enable monitoring](#enable-monitoring)
NOTE: **Note:** To maintain uniformity of links across HA clusters, the `external_url` NOTE: **Note:**
To maintain uniformity of links across HA clusters, the `external_url`
on the first application server as well as the additional application on the first application server as well as the additional application
servers should point to the external URL that users will use to access GitLab. servers should point to the external URL that users will use to access GitLab.
In a typical HA setup, this will be the URL of the load balancer which will In a typical HA setup, this will be the URL of the load balancer which will
route traffic to all GitLab application servers in the HA cluster. route traffic to all GitLab application servers in the HA cluster.
NOTE: **Note:** When you specify `https` in the `external_url`, as in the example NOTE: **Note:**
When you specify `https` in the `external_url`, as in the example
above, GitLab assumes you have SSL certificates in `/etc/gitlab/ssl/`. If above, GitLab assumes you have SSL certificates in `/etc/gitlab/ssl/`. If
certificates are not present, NGINX will fail to start. See certificates are not present, NGINX will fail to start. See
[NGINX documentation](https://docs.gitlab.com/omnibus/settings/nginx.html#enable-https) [NGINX documentation](https://docs.gitlab.com/omnibus/settings/nginx.html#enable-https)
for more information. for more information.
NOTE: **Note:** It is best to set the `uid` and `gid`s prior to the initial reconfigure NOTE: **Note:**
It is best to set the `uid` and `gid`s prior to the initial reconfigure
of GitLab. Omnibus will not recursively `chown` directories if set after the initial reconfigure. of GitLab. Omnibus will not recursively `chown` directories if set after the initial reconfigure.
## First GitLab application server ## First GitLab application server
...@@ -133,7 +138,8 @@ need some extra configuration. ...@@ -133,7 +138,8 @@ need some extra configuration.
1. Run `sudo gitlab-ctl reconfigure` to compile the configuration. 1. Run `sudo gitlab-ctl reconfigure` to compile the configuration.
NOTE: **Note:** You will need to restart the GitLab applications nodes after an update has occurred and database NOTE: **Note:**
You will need to restart the GitLab applications nodes after an update has occurred and database
migrations performed. migrations performed.
## Enable Monitoring ## Enable Monitoring
......
...@@ -12,7 +12,8 @@ From GitLab 13.0, using NFS for Git repositories is deprecated. In GitLab 14.0, ...@@ -12,7 +12,8 @@ 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.
NOTE: **Note:** Filesystem performance has a big impact on overall GitLab NOTE: **Note:**
Filesystem performance has a big impact on overall GitLab
performance, especially for actions that read or write to Git repositories. See performance, especially for actions that read or write to Git repositories. See
[Filesystem Performance Benchmarking](../operations/filesystem_benchmarking.md) [Filesystem Performance Benchmarking](../operations/filesystem_benchmarking.md)
for steps to test filesystem performance. for steps to test filesystem performance.
...@@ -105,7 +106,8 @@ administrators to keep NFS server delegation disabled. ...@@ -105,7 +106,8 @@ administrators to keep NFS server delegation disabled.
#### Improving NFS performance with Unicorn #### Improving NFS performance with Unicorn
NOTE: **Note:** From GitLab 12.1, it will automatically be detected if Rugged can and should be used per storage. NOTE: **Note:**
From GitLab 12.1, it will automatically be detected if Rugged can and should be used per storage.
If you previously enabled Rugged using the feature flag, you will need to unset the feature flag by using: If you previously enabled Rugged using the feature flag, you will need to unset the feature flag by using:
...@@ -117,7 +119,8 @@ If the Rugged feature flag is explicitly set to either true or false, GitLab wil ...@@ -117,7 +119,8 @@ If the Rugged feature flag is explicitly set to either true or false, GitLab wil
#### Improving NFS performance with Puma #### Improving NFS performance with Puma
NOTE: **Note:** From GitLab 12.7, Rugged auto-detection is disabled if Puma thread count is greater than 1. NOTE: **Note:**
From GitLab 12.7, Rugged auto-detection is disabled if Puma thread count is greater than 1.
If you want to use Rugged with Puma, it is recommended to [set Puma thread count to 1](https://docs.gitlab.com/omnibus/settings/puma.html#puma-settings). If you want to use Rugged with Puma, it is recommended to [set Puma thread count to 1](https://docs.gitlab.com/omnibus/settings/puma.html#puma-settings).
......
...@@ -94,7 +94,8 @@ you want using steps 1 and 2 from the GitLab downloads page. ...@@ -94,7 +94,8 @@ you want using steps 1 and 2 from the GitLab downloads page.
1. Run `gitlab-ctl reconfigure`. 1. Run `gitlab-ctl reconfigure`.
NOTE: **Note:** You will need to restart the Sidekiq nodes after an update has occurred and database NOTE: **Note:**
You will need to restart the Sidekiq nodes after an update has occurred and database
migrations performed. migrations performed.
## Example configuration ## Example configuration
......
...@@ -83,7 +83,8 @@ Plan.default.actual_limits.update!(project_hooks: 100) ...@@ -83,7 +83,8 @@ Plan.default.actual_limits.update!(project_hooks: 100)
Plan.default.actual_limits.update!(group_hooks: 100) Plan.default.actual_limits.update!(group_hooks: 100)
``` ```
NOTE: **Note:** Set the limit to `0` to disable it. NOTE: **Note:**
Set the limit to `0` to disable it.
## Incoming emails from auto-responders ## Incoming emails from auto-responders
...@@ -120,7 +121,8 @@ Plan.default.actual_limits.update!(offset_pagination_limit: 10000) ...@@ -120,7 +121,8 @@ Plan.default.actual_limits.update!(offset_pagination_limit: 10000)
- **Default offset pagination limit:** 50000 - **Default offset pagination limit:** 50000
NOTE: **Note:** Set the limit to `0` to disable it. NOTE: **Note:**
Set the limit to `0` to disable it.
## CI/CD limits ## CI/CD limits
...@@ -152,7 +154,8 @@ To set this limit on a self-managed installation, run the following in the ...@@ -152,7 +154,8 @@ To set this limit on a self-managed installation, run the following in the
Plan.default.actual_limits.update!(ci_active_jobs: 500) Plan.default.actual_limits.update!(ci_active_jobs: 500)
``` ```
NOTE: **Note:** Set the limit to `0` to disable it. NOTE: **Note:**
Set the limit to `0` to disable it.
### Number of CI/CD subscriptions to a project ### Number of CI/CD subscriptions to a project
...@@ -174,7 +177,8 @@ To set this limit on a self-managed installation, run the following in the ...@@ -174,7 +177,8 @@ To set this limit on a self-managed installation, run the following in the
Plan.default.actual_limits.update!(ci_project_subscriptions: 500) Plan.default.actual_limits.update!(ci_project_subscriptions: 500)
``` ```
NOTE: **Note:** Set the limit to `0` to disable it. NOTE: **Note:**
Set the limit to `0` to disable it.
### Number of pipeline schedules ### Number of pipeline schedules
...@@ -306,7 +310,8 @@ characters and the rest will not be indexed and hence will not be searchable. ...@@ -306,7 +310,8 @@ characters and the rest will not be indexed and hence will not be searchable.
This limit can be configured for self-managed installations when [enabling This limit can be configured for self-managed installations when [enabling
Elasticsearch](../integration/elasticsearch.md#enabling-elasticsearch). Elasticsearch](../integration/elasticsearch.md#enabling-elasticsearch).
NOTE: **Note:** Set the limit to `0` to disable it. NOTE: **Note:**
Set the limit to `0` to disable it.
## Wiki limits ## Wiki limits
......
...@@ -130,7 +130,8 @@ that, login with an Admin account and do following: ...@@ -130,7 +130,8 @@ that, login with an Admin account and do following:
- Check **Enable PlantUML** checkbox. - Check **Enable PlantUML** checkbox.
- Set the PlantUML instance as `https://gitlab.example.com/-/plantuml/`. - Set the PlantUML instance as `https://gitlab.example.com/-/plantuml/`.
NOTE: **Note:** If you are using a PlantUML server running v1.2020.9 and NOTE: **Note:**
If you are using a PlantUML server running v1.2020.9 and
above (for example, [plantuml.com](https://plantuml.com)), set the `PLANTUML_ENCODING` above (for example, [plantuml.com](https://plantuml.com)), set the `PLANTUML_ENCODING`
environment variable to enable the `deflate` compression. On Omnibus, environment variable to enable the `deflate` compression. On Omnibus,
this can be done set in `/etc/gitlab.rb`: this can be done set in `/etc/gitlab.rb`:
......
...@@ -45,7 +45,8 @@ detail below. ...@@ -45,7 +45,8 @@ detail below.
## Enabling and disabling terminal support ## Enabling and disabling terminal support
NOTE: **Note:** AWS Elastic Load Balancers (ELBs) do not support web sockets. NOTE: **Note:**
AWS Elastic Load Balancers (ELBs) do not support web sockets.
AWS Application Load Balancers (ALBs) must be used if you want web terminals AWS Application Load Balancers (ALBs) must be used if you want web terminals
to work. See [AWS Elastic Load Balancing Product Comparison](https://aws.amazon.com/elasticloadbalancing/features/#compare) to work. See [AWS Elastic Load Balancing Product Comparison](https://aws.amazon.com/elasticloadbalancing/features/#compare)
for more information. for more information.
......
...@@ -106,7 +106,8 @@ If you configure GitLab to store CI logs and artifacts on object storage, you mu ...@@ -106,7 +106,8 @@ If you configure GitLab to store CI logs and artifacts on object storage, you mu
#### Object Storage Settings #### Object Storage Settings
NOTE: **Note:** In GitLab 13.2 and later, we recommend using the NOTE: **Note:**
In GitLab 13.2 and later, we recommend using the
[consolidated object storage settings](object_storage.md#consolidated-object-storage-configuration). [consolidated object storage settings](object_storage.md#consolidated-object-storage-configuration).
This section describes the earlier configuration format. This section describes the earlier configuration format.
......
...@@ -73,7 +73,7 @@ job output in the UI will be empty. ...@@ -73,7 +73,7 @@ job output in the UI will be empty.
For example, to delete all job logs older than 60 days, run the following from a shell in your GitLab instance: For example, to delete all job logs older than 60 days, run the following from a shell in your GitLab instance:
DANGER: **Warning:** DANGER: **Danger:**
This command will permanently delete the log files and is irreversible. This command will permanently delete the log files and is irreversible.
```shell ```shell
......
...@@ -63,7 +63,8 @@ GitLab provides two different options for the uploading mechanism: "Direct uploa ...@@ -63,7 +63,8 @@ GitLab provides two different options for the uploading mechanism: "Direct uploa
[Read more about using object storage with GitLab](../object_storage.md). [Read more about using object storage with GitLab](../object_storage.md).
NOTE: **Note:** In GitLab 13.2 and later, we recommend using the NOTE: **Note:**
In GitLab 13.2 and later, we recommend using the
[consolidated object storage settings](../object_storage.md#consolidated-object-storage-configuration). [consolidated object storage settings](../object_storage.md#consolidated-object-storage-configuration).
This section describes the earlier configuration format. This section describes the earlier configuration format.
......
...@@ -112,7 +112,8 @@ The ActionCable connection or channel class is used as the `controller`. ...@@ -112,7 +112,8 @@ The ActionCable connection or channel class is used as the `controller`.
} }
``` ```
NOTE: **Note:** Starting with GitLab 12.5, if an error occurs, an NOTE: **Note:**
Starting with GitLab 12.5, if an error occurs, an
`exception` field is included with `class`, `message`, and `exception` field is included with `class`, `message`, and
`backtrace`. Previous versions included an `error` field instead of `backtrace`. Previous versions included an `error` field instead of
`exception.class` and `exception.message`. For example: `exception.class` and `exception.message`. For example:
......
...@@ -72,7 +72,8 @@ be configured already. ...@@ -72,7 +72,8 @@ be configured already.
## Object Storage Settings ## Object Storage Settings
NOTE: **Note:** In GitLab 13.2 and later, we recommend using the NOTE: **Note:**
In GitLab 13.2 and later, we recommend using the
[consolidated object storage settings](object_storage.md#consolidated-object-storage-configuration). [consolidated object storage settings](object_storage.md#consolidated-object-storage-configuration).
This section describes the earlier configuration format. This section describes the earlier configuration format.
......
...@@ -44,13 +44,15 @@ Using the consolidated object storage configuration has a number of advantages: ...@@ -44,13 +44,15 @@ Using the consolidated object storage configuration has a number of advantages:
- It enables the use of [encrypted S3 buckets](#encrypted-s3-buckets). - It enables the use of [encrypted S3 buckets](#encrypted-s3-buckets).
- It [uploads files to S3 with proper `Content-MD5` headers](https://gitlab.com/gitlab-org/gitlab-workhorse/-/issues/222). - It [uploads files to S3 with proper `Content-MD5` headers](https://gitlab.com/gitlab-org/gitlab-workhorse/-/issues/222).
NOTE: **Note:** Only AWS S3-compatible providers and Google are NOTE: **Note:**
Only AWS S3-compatible providers and Google are
supported at the moment since [direct upload supported at the moment since [direct upload
mode](../development/uploads.md#direct-upload) must be used. Background mode](../development/uploads.md#direct-upload) must be used. Background
upload is not supported in this mode. We recommend direct upload mode because upload is not supported in this mode. We recommend direct upload mode because
it does not require a shared folder, and [this setting may become the default](https://gitlab.com/gitlab-org/gitlab/-/issues/27331). it does not require a shared folder, and [this setting may become the default](https://gitlab.com/gitlab-org/gitlab/-/issues/27331).
NOTE: **Note:** Consolidated object storage configuration cannot be used for NOTE: **Note:**
Consolidated object storage configuration cannot be used for
backups or Mattermost. See [the full table for a complete list](#storage-specific-configuration). backups or Mattermost. See [the full table for a complete list](#storage-specific-configuration).
Most types of objects, such as CI artifacts, LFS files, upload Most types of objects, such as CI artifacts, LFS files, upload
...@@ -253,7 +255,8 @@ gitlab_rails['object_store']['connection'] = { ...@@ -253,7 +255,8 @@ gitlab_rails['object_store']['connection'] = {
#### OpenStack-compatible connection settings #### OpenStack-compatible connection settings
NOTE: **Note:** This is not compatible with the consolidated object storage form. NOTE: **Note:**
This is not compatible with the consolidated object storage form.
OpenStack Swift is only supported with the storage-specific form. See the OpenStack Swift is only supported with the storage-specific form. See the
[S3 settings](#s3-compatible-connection-settings) if you want to use the consolidated form. [S3 settings](#s3-compatible-connection-settings) if you want to use the consolidated form.
...@@ -274,7 +277,8 @@ Here are the valid connection settings below for the Swift API, provided by ...@@ -274,7 +277,8 @@ Here are the valid connection settings below for the Swift API, provided by
#### Rackspace Cloud Files #### Rackspace Cloud Files
NOTE: **Note:** This is not compatible with the consolidated object NOTE: **Note:**
This is not compatible with the consolidated object
storage form. Rackspace Cloud is only supported with the storage-specific form. storage form. Rackspace Cloud is only supported with the storage-specific form.
Here are the valid connection parameters for Rackspace Cloud, provided by Here are the valid connection parameters for Rackspace Cloud, provided by
...@@ -408,7 +412,8 @@ additional complexity and unnecessary redundancy. Since both GitLab ...@@ -408,7 +412,8 @@ additional complexity and unnecessary redundancy. Since both GitLab
Rails and Workhorse components need access to object storage, the Rails and Workhorse components need access to object storage, the
consolidated form avoids excessive duplication of credentials. consolidated form avoids excessive duplication of credentials.
NOTE: **Note:** The consolidated object storage configuration is **only** used if all NOTE: **Note:**
The consolidated object storage configuration is **only** used if all
lines from the original form is omitted. To move to the consolidated form, remove the original configuration (for example, `artifacts_object_store_enabled`, `uploads_object_store_connection`, and so on.) lines from the original form is omitted. To move to the consolidated form, remove the original configuration (for example, `artifacts_object_store_enabled`, `uploads_object_store_connection`, and so on.)
## Storage-specific configuration ## Storage-specific configuration
......
...@@ -3,7 +3,8 @@ ...@@ -3,7 +3,8 @@
> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/1631) in [GitLab Starter](https://about.gitlab.com/pricing/) 9.3. > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/1631) in [GitLab Starter](https://about.gitlab.com/pricing/) 9.3.
> - [Available in](https://gitlab.com/gitlab-org/gitlab/-/issues/3953) GitLab Community Edition 10.4. > - [Available in](https://gitlab.com/gitlab-org/gitlab/-/issues/3953) GitLab Community Edition 10.4.
NOTE: **Note:** This document describes a drop-in replacement for the NOTE: **Note:**
This document describes a drop-in replacement for the
`authorized_keys` file. For normal (non-deploy key) users, consider using `authorized_keys` file. For normal (non-deploy key) users, consider using
[SSH certificates](ssh_certificates.md). They are even faster, but are not a [SSH certificates](ssh_certificates.md). They are even faster, but are not a
drop-in replacement. drop-in replacement.
...@@ -73,16 +74,19 @@ Confirm that SSH is working by commenting out your user's key in the `authorized ...@@ -73,16 +74,19 @@ Confirm that SSH is working by commenting out your user's key in the `authorized
A successful pull would mean that GitLab was able to find the key in the database, A successful pull would mean that GitLab was able to find the key in the database,
since it is not present in the file anymore. since it is not present in the file anymore.
NOTE: **Note:** For Omnibus Docker, `AuthorizedKeysCommand` is setup by default in NOTE: **Note:**
For Omnibus Docker, `AuthorizedKeysCommand` is setup by default in
GitLab 11.11 and later. GitLab 11.11 and later.
NOTE: **Note:** For Installations from source, the command would be located at NOTE: **Note:**
For Installations from source, the command would be located at
`/home/git/gitlab-shell/bin/gitlab-shell-authorized-keys-check` if [the install from source](../../install/installation.md#install-gitlab-shell) instructions were followed. `/home/git/gitlab-shell/bin/gitlab-shell-authorized-keys-check` if [the install from source](../../install/installation.md#install-gitlab-shell) instructions were followed.
You might want to consider creating a wrapper script somewhere else since this command needs to be You might want to consider creating a wrapper script somewhere else since this command needs to be
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:** Do not disable writes until SSH is confirmed to be working CAUTION: **Caution:**
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.
In the case of lookup failures (which are common), the `authorized_keys` In the case of lookup failures (which are common), the `authorized_keys`
......
...@@ -65,7 +65,8 @@ operations per second. ...@@ -65,7 +65,8 @@ operations per second.
### Simple benchmarking ### Simple benchmarking
NOTE: **Note:** This test is naive but may be useful if `fio` is not NOTE: **Note:**
This test is naive but may be useful if `fio` is not
available on the system. It's possible to receive good results on this available on the system. It's possible to receive good results on this
test but still have poor performance due to read speed and various other test but still have poor performance due to read speed and various other
factors. factors.
......
...@@ -344,7 +344,8 @@ This path is accessible to: ...@@ -344,7 +344,8 @@ This path is accessible to:
- The user running the Container Registry daemon. - The user running the Container Registry daemon.
- The user running GitLab. - The user running GitLab.
CAUTION: **Warning:** You should confirm that all GitLab, Registry and web server users CAUTION: **Warning:**
You should confirm that all GitLab, Registry and web server users
have access to this directory. have access to this directory.
**Omnibus GitLab installations** **Omnibus GitLab installations**
...@@ -382,7 +383,8 @@ driver for the Container Registry. ...@@ -382,7 +383,8 @@ 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:** GitLab will not backup Docker images that are not stored on the CAUTION: **Warning:**
GitLab will not backup Docker images that are not stored on the
filesystem. Remember to enable backups with your object storage provider if filesystem. Remember to enable backups with your object storage provider if
desired. desired.
......
...@@ -87,7 +87,8 @@ store the blobs of the dependency proxy. ...@@ -87,7 +87,8 @@ store the blobs of the dependency proxy.
[Read more about using object storage with GitLab](../object_storage.md). [Read more about using object storage with GitLab](../object_storage.md).
NOTE: **Note:** In GitLab 13.2 and later, we recommend using the NOTE: **Note:**
In GitLab 13.2 and later, we recommend using the
[consolidated object storage settings](../object_storage.md#consolidated-object-storage-configuration). [consolidated object storage settings](../object_storage.md#consolidated-object-storage-configuration).
This section describes the earlier configuration format. This section describes the earlier configuration format.
......
...@@ -99,7 +99,8 @@ store packages. ...@@ -99,7 +99,8 @@ store packages.
[Read more about using object storage with GitLab](../object_storage.md). [Read more about using object storage with GitLab](../object_storage.md).
NOTE: **Note:** We recommend using the [consolidated object storage settings](../object_storage.md#consolidated-object-storage-configuration). The following instructions apply to the original config format. NOTE: **Note:**
We recommend using the [consolidated object storage settings](../object_storage.md#consolidated-object-storage-configuration). The following instructions apply to the original config format.
**Omnibus GitLab installations** **Omnibus GitLab installations**
......
...@@ -966,7 +966,8 @@ after it has been restored to service. ...@@ -966,7 +966,8 @@ after it has been restored to service.
gitlab-ctl restart repmgrd gitlab-ctl restart repmgrd
``` ```
CAUTION: **Warning:** When the server is brought back online, and before CAUTION: **Warning:**
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,
this will cause a split, and the old master will need to be resynced from this will cause a split, and the old master will need to be resynced from
...@@ -1129,7 +1130,8 @@ If you're running into an issue with a component not outlined here, be sure to c ...@@ -1129,7 +1130,8 @@ If you're running into an issue with a component not outlined here, be sure to c
## Patroni ## Patroni
NOTE: **Note:** Starting from GitLab 13.1, Patroni is available for **experimental** use to replace repmgr. Due to its NOTE: **Note:**
Starting from GitLab 13.1, Patroni is available for **experimental** use to replace repmgr. Due to its
experimental nature, Patroni support is **subject to change without notice.** experimental nature, Patroni support is **subject to change without notice.**
Patroni is an opinionated solution for PostgreSQL high-availability. It takes the control of PostgreSQL, overrides its Patroni is an opinionated solution for PostgreSQL high-availability. It takes the control of PostgreSQL, overrides its
...@@ -1320,7 +1322,8 @@ You can switch an exiting database cluster to use Patroni instead of repmgr with ...@@ -1320,7 +1322,8 @@ You can switch an exiting database cluster to use Patroni instead of repmgr with
sudo gitlab-ctl stop postgresql sudo gitlab-ctl stop postgresql
``` ```
NOTE: **Note:** Ensure that there is no `walsender` process running on the primary node. NOTE: **Note:**
Ensure that there is no `walsender` process running on the primary node.
`ps aux | grep walsender` must not show any running process. `ps aux | grep walsender` must not show any running process.
1. On the primary node, [configure Patroni](#configuring-patroni-cluster). Remove `repmgr` and any other 1. On the primary node, [configure Patroni](#configuring-patroni-cluster). Remove `repmgr` and any other
......
...@@ -53,7 +53,8 @@ together with Omnibus GitLab. This is recommended as part of our ...@@ -53,7 +53,8 @@ together with Omnibus GitLab. This is recommended as part of our
gitlab_rails['auto_migrate'] = false gitlab_rails['auto_migrate'] = false
``` ```
NOTE: **Note:** The role `postgres_role` was introduced with GitLab 10.3 NOTE: **Note:**
The role `postgres_role` was introduced with GitLab 10.3
1. [Reconfigure GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure) for the changes to take effect. 1. [Reconfigure GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure) for the changes to take effect.
1. Note the PostgreSQL node's IP address or hostname, port, and 1. Note the PostgreSQL node's IP address or hostname, port, and
......
...@@ -339,7 +339,8 @@ the same Sentinels. ...@@ -339,7 +339,8 @@ the same Sentinels.
### Step 3. Configuring the Redis Sentinel instances ### Step 3. Configuring the Redis Sentinel instances
NOTE: **Note:** If you are using an external Redis Sentinel instance, be sure NOTE: **Note:**
If you are using an external Redis Sentinel instance, be sure
to exclude the `requirepass` parameter from the Sentinel to exclude the `requirepass` parameter from the Sentinel
configuration. This parameter will cause clients to report `NOAUTH configuration. This parameter will cause clients to report `NOAUTH
Authentication required.`. [Redis Sentinel 3.2.x does not support Authentication required.`. [Redis Sentinel 3.2.x does not support
......
...@@ -658,7 +658,8 @@ On each node perform the following: ...@@ -658,7 +658,8 @@ On each node perform the following:
sudo gitlab-ctl tail gitaly sudo gitlab-ctl tail gitaly
``` ```
NOTE: **Note:** When you specify `https` in the `external_url`, as in the example NOTE: **Note:**
When you specify `https` in the `external_url`, as in the example
above, GitLab assumes you have SSL certificates in `/etc/gitlab/ssl/`. If above, GitLab assumes you have SSL certificates in `/etc/gitlab/ssl/`. If
certificates are not present, NGINX will fail to start. See the certificates are not present, NGINX will fail to start. See the
[NGINX documentation](https://docs.gitlab.com/omnibus/settings/nginx.html#enable-https) [NGINX documentation](https://docs.gitlab.com/omnibus/settings/nginx.html#enable-https)
......
...@@ -4,7 +4,8 @@ This page describes GitLab reference architecture for up to 3,000 users. ...@@ -4,7 +4,8 @@ This page describes GitLab reference architecture for up to 3,000 users.
For a full list of reference architectures, see For a full list of reference architectures, see
[Available reference architectures](index.md#available-reference-architectures). [Available reference architectures](index.md#available-reference-architectures).
NOTE: **Note:** The 3,000-user reference architecture documented below is NOTE: **Note:**
The 3,000-user reference architecture documented below is
designed to help your organization achieve a highly-available GitLab deployment. designed to help your organization achieve a highly-available GitLab deployment.
If you do not have the expertise or need to maintain a highly-available If you do not have the expertise or need to maintain a highly-available
environment, you can have a simpler and less costly-to-operate environment by environment, you can have a simpler and less costly-to-operate environment by
......
...@@ -38,7 +38,8 @@ When scaling GitLab, there are several factors to consider: ...@@ -38,7 +38,8 @@ When scaling GitLab, there are several factors to consider:
- A load balancer is added in front to distribute traffic across the application nodes. - A load balancer is added in front to distribute traffic across the application nodes.
- The application nodes connects to a shared file server and PostgreSQL and Redis services on the backend. - The application nodes connects to a shared file server and PostgreSQL and Redis services on the backend.
NOTE: **Note:** Depending on your workflow, the following recommended NOTE: **Note:**
Depending on your workflow, the following recommended
reference architectures may need to be adapted accordingly. Your workload reference architectures may need to be adapted accordingly. Your workload
is influenced by factors including how active your users are, is influenced by factors including how active your users are,
how much automation you use, mirroring, and repository/change size. Additionally the how much automation you use, mirroring, and repository/change size. Additionally the
......
...@@ -60,7 +60,8 @@ files and add the full paths of the alternative repository storage paths. In ...@@ -60,7 +60,8 @@ files and add the full paths of the alternative repository storage paths. In
the example below, we add two more mount points that are named `nfs_1` and `nfs_2` the example below, we add two more mount points that are named `nfs_1` and `nfs_2`
respectively. respectively.
NOTE: **Note:** This example uses NFS. We do not recommend using EFS for storage as it may impact GitLab's performance. See the [relevant documentation](high_availability/nfs.md#avoid-using-awss-elastic-file-system-efs) for more details. NOTE: **Note:**
This example uses NFS. We do not recommend using EFS for storage as it may impact GitLab's performance. See the [relevant documentation](high_availability/nfs.md#avoid-using-awss-elastic-file-system-efs) for more details.
**For installations from source** **For installations from source**
......
...@@ -21,7 +21,8 @@ files must be provided: ...@@ -21,7 +21,8 @@ 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.
NOTE: **Note:** Be mindful of the access levels for your private keys and visibility to NOTE: **Note:**
Be mindful of the access levels for your private keys and visibility to
third parties. third parties.
**For Omnibus installations:** **For Omnibus installations:**
...@@ -38,7 +39,8 @@ third parties. ...@@ -38,7 +39,8 @@ third parties.
1. Save the file and [reconfigure GitLab](restart_gitlab.md#omnibus-gitlab-reconfigure) for the changes to take effect. 1. Save the file and [reconfigure GitLab](restart_gitlab.md#omnibus-gitlab-reconfigure) for the changes to take effect.
NOTE: **Note:** The key needs to be readable by the GitLab system user (`git` by default). NOTE: **Note:**
The key needs to be readable by the GitLab system user (`git` by default).
**For installations from source:** **For installations from source:**
...@@ -61,7 +63,8 @@ NOTE: **Note:** The key needs to be readable by the GitLab system user (`git` by ...@@ -61,7 +63,8 @@ NOTE: **Note:** The key needs to be readable by the GitLab system user (`git` by
1. Save the file and [restart GitLab](restart_gitlab.md#installations-from-source) for the changes to take effect. 1. Save the file and [restart GitLab](restart_gitlab.md#installations-from-source) for the changes to take effect.
NOTE: **Note:** The key needs to be readable by the GitLab system user (`git` by default). NOTE: **Note:**
The key needs to be readable by the GitLab system user (`git` by default).
### How to convert S/MIME PKCS#12 / PFX format to PEM encoding ### How to convert S/MIME PKCS#12 / PFX format to PEM encoding
......
...@@ -8,7 +8,8 @@ This page is useful information about PostgreSQL that the GitLab Support ...@@ -8,7 +8,8 @@ This page is useful information about PostgreSQL that the GitLab Support
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:** Some procedures documented here may break your GitLab instance. Use at your own risk. CAUTION: **Caution:**
Some procedures documented here may break your GitLab instance. Use 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
to use these commands, it is best to [contact Support](https://about.gitlab.com/support/) to use these commands, it is best to [contact Support](https://about.gitlab.com/support/)
...@@ -115,7 +116,8 @@ Quoting from issue [#1](https://gitlab.com/gitlab-org/gitlab/-/issues/30528): ...@@ -115,7 +116,8 @@ Quoting from issue [#1](https://gitlab.com/gitlab-org/gitlab/-/issues/30528):
> "If a deadlock is hit, and we resolve it through aborting the transaction after a short period, then the retry mechanisms we already have will make the deadlocked piece of work try again, and it's unlikely we'll deadlock multiple times in a row." > "If a deadlock is hit, and we resolve it through aborting the transaction after a short period, then the retry mechanisms we already have will make the deadlocked piece of work try again, and it's unlikely we'll deadlock multiple times in a row."
TIP: **Tip:** In support, our general approach to reconfiguring timeouts (applies also to the HTTP stack as well) is that it's acceptable to do it temporarily as a workaround. If it makes GitLab usable for the customer, then it buys time to understand the problem more completely, implement a hot fix, or make some other change that addresses the root cause. Generally, the timeouts should be put back to reasonable defaults once the root cause is resolved. TIP: **Tip:**
In support, our general approach to reconfiguring timeouts (applies also to the HTTP stack as well) is that it's acceptable to do it temporarily as a workaround. If it makes GitLab usable for the customer, then it buys time to understand the problem more completely, implement a hot fix, or make some other change that addresses the root cause. Generally, the timeouts should be put back to reasonable defaults once the root cause is resolved.
In this case, the guidance we had from development was to drop deadlock_timeout and/or statement_timeout but to leave the third setting at 60s. Setting idle_in_transaction protects the database from sessions potentially hanging for days. There's more discussion in [the issue relating to introducing this timeout on GitLab.com](https://gitlab.com/gitlab-com/gl-infra/production/-/issues/1053). In this case, the guidance we had from development was to drop deadlock_timeout and/or statement_timeout but to leave the third setting at 60s. Setting idle_in_transaction protects the database from sessions potentially hanging for days. There's more discussion in [the issue relating to introducing this timeout on GitLab.com](https://gitlab.com/gitlab-com/gl-infra/production/-/issues/1053).
......
...@@ -283,7 +283,8 @@ queue = Sidekiq::Queue.new('<queue name>') ...@@ -283,7 +283,8 @@ queue = Sidekiq::Queue.new('<queue name>')
queue.each { |job| job.delete if <condition>} queue.each { |job| job.delete if <condition>}
``` ```
NOTE: **Note:** This will remove jobs that are queued but not started, running jobs will not be killed. Have a look at the section below for cancelling running jobs. NOTE: **Note:**
This will remove jobs that are queued but not started, running jobs will not be killed. Have a look at the section below for cancelling running jobs.
In the method above, `<queue-name>` is the name of the queue that contains the job(s) you want to delete and `<condition>` will decide which jobs get deleted. In the method above, `<queue-name>` is the name of the queue that contains the job(s) you want to delete and `<condition>` will decide which jobs get deleted.
......
...@@ -57,7 +57,8 @@ This configuration relies on valid AWS credentials to be configured already. ...@@ -57,7 +57,8 @@ This configuration relies on valid AWS credentials to be configured already.
[Read more about using object storage with GitLab](object_storage.md). [Read more about using object storage with GitLab](object_storage.md).
NOTE: **Note:** We recommend using the [consolidated object storage settings](object_storage.md#consolidated-object-storage-configuration). The following instructions apply to the original config format. NOTE: **Note:**
We recommend using the [consolidated object storage settings](object_storage.md#consolidated-object-storage-configuration). The following instructions apply to the original config format.
## Object Storage Settings ## Object Storage Settings
......
...@@ -170,7 +170,8 @@ Example response: ...@@ -170,7 +170,8 @@ Example response:
} }
``` ```
NOTE: **Note:** An older endpoint `PUT /groups/:id/labels` with `name` in the parameters is still available, but deprecated. NOTE: **Note:**
An older endpoint `PUT /groups/:id/labels` with `name` in the parameters is still available, but deprecated.
## Delete a group label ## Delete a group label
...@@ -189,7 +190,8 @@ DELETE /groups/:id/labels/:label_id ...@@ -189,7 +190,8 @@ DELETE /groups/:id/labels/:label_id
curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/5/labels/bug" curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/5/labels/bug"
``` ```
NOTE: **Note:** An older endpoint `DELETE /groups/:id/labels` with `name` in the parameters is still available, but deprecated. NOTE: **Note:**
An older endpoint `DELETE /groups/:id/labels` with `name` in the parameters is still available, but deprecated.
## Subscribe to a group label ## Subscribe to a group label
......
...@@ -199,7 +199,8 @@ DELETE /projects/:id/labels/:label_id ...@@ -199,7 +199,8 @@ DELETE /projects/:id/labels/:label_id
curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/1/labels/bug" curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/1/labels/bug"
``` ```
NOTE: **Note:** An older endpoint `DELETE /projects/:id/labels` with `name` in the parameters is still available, but deprecated. NOTE: **Note:**
An older endpoint `DELETE /projects/:id/labels` with `name` in the parameters is still available, but deprecated.
## Edit an existing label ## Edit an existing label
...@@ -242,7 +243,8 @@ Example response: ...@@ -242,7 +243,8 @@ Example response:
} }
``` ```
NOTE: **Note:** An older endpoint `PUT /projects/:id/labels` with `name` or `label_id` in the parameters is still available, but deprecated. NOTE: **Note:**
An older endpoint `PUT /projects/:id/labels` with `name` or `label_id` in the parameters is still available, but deprecated.
## Promote a project label to a group label ## Promote a project label to a group label
...@@ -279,7 +281,8 @@ Example response: ...@@ -279,7 +281,8 @@ Example response:
} }
``` ```
NOTE: **Note:** An older endpoint `PUT /projects/:id/labels/promote` with `name` in the parameters is still available, but deprecated. NOTE: **Note:**
An older endpoint `PUT /projects/:id/labels/promote` with `name` in the parameters is still available, but deprecated.
## Subscribe to a label ## Subscribe to a label
......
...@@ -68,7 +68,8 @@ the `plan` parameter associated with a namespace: ...@@ -68,7 +68,8 @@ the `plan` parameter associated with a namespace:
] ]
``` ```
NOTE: **Note:** Only group maintainers/owners are presented with `members_count_with_descendants`, as well as `plan` **(BRONZE ONLY)**. NOTE: **Note:**
Only group maintainers/owners are presented with `members_count_with_descendants`, as well as `plan` **(BRONZE ONLY)**.
## Search for namespace ## Search for namespace
......
...@@ -1087,7 +1087,8 @@ POST /projects ...@@ -1087,7 +1087,8 @@ POST /projects
| `group_with_project_templates_id` | integer | no | **(PREMIUM)** For group-level custom templates, specifies ID of group from which all the custom project templates are sourced. Leave empty for instance-level templates. Requires `use_custom_template` to be true | | `group_with_project_templates_id` | integer | no | **(PREMIUM)** For group-level custom templates, specifies ID of group from which all the custom project templates are sourced. Leave empty for instance-level templates. Requires `use_custom_template` to be true |
| `packages_enabled` | boolean | no | **(PREMIUM ONLY)** Enable or disable packages repository feature | | `packages_enabled` | boolean | no | **(PREMIUM ONLY)** Enable or disable packages repository feature |
NOTE: **Note:** If your HTTP repository is not publicly accessible, NOTE: **Note:**
If your HTTP repository is not publicly accessible,
add authentication information to the URL: `https://username:password@gitlab.company.com/group/project.git` add authentication information to the URL: `https://username:password@gitlab.company.com/group/project.git`
where `password` is a public access key with the `api` scope enabled. where `password` is a public access key with the `api` scope enabled.
...@@ -1157,7 +1158,8 @@ POST /projects/user/:user_id ...@@ -1157,7 +1158,8 @@ POST /projects/user/:user_id
| `group_with_project_templates_id` | integer | no | **(PREMIUM)** For group-level custom templates, specifies ID of group from which all the custom project templates are sourced. Leave empty for instance-level templates. Requires `use_custom_template` to be true | | `group_with_project_templates_id` | integer | no | **(PREMIUM)** For group-level custom templates, specifies ID of group from which all the custom project templates are sourced. Leave empty for instance-level templates. Requires `use_custom_template` to be true |
| `packages_enabled` | boolean | no | **(PREMIUM ONLY)** Enable or disable packages repository feature | | `packages_enabled` | boolean | no | **(PREMIUM ONLY)** Enable or disable packages repository feature |
NOTE: **Note:** If your HTTP repository is not publicly accessible, NOTE: **Note:**
If your HTTP repository is not publicly accessible,
add authentication information to the URL: `https://username:password@gitlab.company.com/group/project.git` add authentication information to the URL: `https://username:password@gitlab.company.com/group/project.git`
where `password` is a public access key with the `api` scope enabled. where `password` is a public access key with the `api` scope enabled.
...@@ -1228,7 +1230,8 @@ PUT /projects/:id ...@@ -1228,7 +1230,8 @@ PUT /projects/:id
| `packages_enabled` | boolean | no | **(PREMIUM ONLY)** Enable or disable packages repository feature | | `packages_enabled` | boolean | no | **(PREMIUM ONLY)** Enable or disable packages repository feature |
| `service_desk_enabled` | boolean | no | **(PREMIUM ONLY)** Enable or disable service desk feature | | `service_desk_enabled` | boolean | no | **(PREMIUM ONLY)** Enable or disable service desk feature |
NOTE: **Note:** If your HTTP repository is not publicly accessible, NOTE: **Note:**
If your HTTP repository is not publicly accessible,
add authentication information to the URL: `https://username:password@gitlab.company.com/group/project.git` add authentication information to the URL: `https://username:password@gitlab.company.com/group/project.git`
where `password` is a public access key with the `api` scope enabled. where `password` is a public access key with the `api` scope enabled.
......
...@@ -318,7 +318,8 @@ Example Responses: ...@@ -318,7 +318,8 @@ Example Responses:
} }
``` ```
NOTE: **Note:** The `plan` and `trial` parameters are only available on GitLab Enterprise Edition. NOTE: **Note:**
The `plan` and `trial` parameters are only available on GitLab Enterprise Edition.
Users on GitLab [Starter, Bronze, or higher](https://about.gitlab.com/pricing/) will also see Users on GitLab [Starter, Bronze, or higher](https://about.gitlab.com/pricing/) will also see
the `shared_runners_minutes_limit`, and `extra_shared_runners_minutes_limit` parameters. the `shared_runners_minutes_limit`, and `extra_shared_runners_minutes_limit` parameters.
...@@ -1412,7 +1413,8 @@ Parameters: ...@@ -1412,7 +1413,8 @@ Parameters:
### Get user activities (admin only) ### Get user activities (admin only)
NOTE: **Note:** This API endpoint is only available on 8.15 (EE) and 9.1 (CE) and above. NOTE: **Note:**
This API endpoint is only available on 8.15 (EE) and 9.1 (CE) and above.
Get the last activity date for all users, sorted from oldest to newest. Get the last activity date for all users, sorted from oldest to newest.
......
...@@ -681,11 +681,13 @@ To add `DOCKER_AUTH_CONFIG` to a Runner: ...@@ -681,11 +681,13 @@ To add `DOCKER_AUTH_CONFIG` to a Runner:
1. Restart the Runner service. 1. Restart the Runner service.
NOTE: **Note:** The double quotes included in the `DOCKER_AUTH_CONFIG` NOTE: **Note:**
The double quotes included in the `DOCKER_AUTH_CONFIG`
data must be escaped with backslashes. This prevents them from being data must be escaped with backslashes. This prevents them from being
interpreted as TOML. interpreted as TOML.
NOTE: **Note:** The `environment` option is a list. So your Runner may NOTE: **Note:**
The `environment` option is a list. So your Runner may
have existing entries and you should add this to the list, not replace have existing entries and you should add this to the list, not replace
it. it.
...@@ -715,7 +717,8 @@ To configure credentials store, follow these steps: ...@@ -715,7 +717,8 @@ To configure credentials store, follow these steps:
`${GITLAB_RUNNER_HOME}/.docker/config.json`. GitLab Runner will read this configuration file `${GITLAB_RUNNER_HOME}/.docker/config.json`. GitLab Runner will read this configuration file
and will use the needed helper for this specific repository. and will use the needed helper for this specific repository.
NOTE: **Note:** `credsStore` is used to access ALL the registries. NOTE: **Note:**
`credsStore` is used to access ALL the registries.
If you will want to use both images from private registry and public images from DockerHub, If you will want to use both images from private registry and public images from DockerHub,
pulling from DockerHub will fail, because Docker daemon will try to use the same credentials for **ALL** the registries. pulling from DockerHub will fail, because Docker daemon will try to use the same credentials for **ALL** the registries.
......
...@@ -38,10 +38,12 @@ but support [is planned](https://gitlab.com/gitlab-org/charts/gitlab-runner/-/is ...@@ -38,10 +38,12 @@ but support [is planned](https://gitlab.com/gitlab-org/charts/gitlab-runner/-/is
## Debugging a running job ## Debugging a running job
NOTE: **Note:** Not all executors are NOTE: **Note:**
Not all executors are
[supported](https://docs.gitlab.com/runner/executors/#compatibility-chart). [supported](https://docs.gitlab.com/runner/executors/#compatibility-chart).
NOTE: **Note:** The `docker` executor does not keep running NOTE: **Note:**
The `docker` executor does not keep running
after the build script is finished. At that point, the terminal will automatically after the build script is finished. At that point, the terminal will automatically
disconnect and will not wait for the user to finish. Please follow [this disconnect and will not wait for the user to finish. Please follow [this
issue](https://gitlab.com/gitlab-org/gitlab-runner/-/issues/3605) for updates on issue](https://gitlab.com/gitlab-org/gitlab-runner/-/issues/3605) for updates on
......
...@@ -419,7 +419,7 @@ information in the UI. ...@@ -419,7 +419,7 @@ information in the UI.
## Erasing artifacts ## Erasing artifacts
DANGER: **Warning:** DANGER: **Danger:**
This is a destructive action that leads to data loss. Use with caution. This is a destructive action that leads to data loss. Use with caution.
You can erase a single job via the UI, which will also remove the job's You can erase a single job via the UI, which will also remove the job's
......
...@@ -3921,7 +3921,8 @@ variables: ...@@ -3921,7 +3921,8 @@ variables:
GIT_STRATEGY: none GIT_STRATEGY: none
``` ```
NOTE: **Note:** `GIT_STRATEGY` is not supported for NOTE: **Note:**
`GIT_STRATEGY` is not supported for
[Kubernetes executor](https://docs.gitlab.com/runner/executors/kubernetes.html), [Kubernetes executor](https://docs.gitlab.com/runner/executors/kubernetes.html),
but may be in the future. See the [support Git strategy with Kubernetes executor feature proposal](https://gitlab.com/gitlab-org/gitlab-runner/-/issues/3847) but may be in the future. See the [support Git strategy with Kubernetes executor feature proposal](https://gitlab.com/gitlab-org/gitlab-runner/-/issues/3847)
for updates. for updates.
......
...@@ -571,7 +571,8 @@ module Types ...@@ -571,7 +571,8 @@ module Types
end end
``` ```
NOTE: **Note:** If the field's type already [has a particular NOTE: **Note:**
If the field's type already [has a particular
authorization](#type-authorization) then there is no need to add that authorization](#type-authorization) then there is no need to add that
same authorization to the field. same authorization to the field.
......
...@@ -27,7 +27,8 @@ limit values. It's recommended to create separate migration script files. ...@@ -27,7 +27,8 @@ limit values. It's recommended to create separate migration script files.
add_column(:plan_limits, :project_hooks, :integer, default: 100, null: false) add_column(:plan_limits, :project_hooks, :integer, default: 100, null: false)
``` ```
NOTE: **Note:** Plan limits entries set to `0` mean that limits are not NOTE: **Note:**
Plan limits entries set to `0` mean that limits are not
enabled. You should use this setting only in special and documented circumstances. enabled. You should use this setting only in special and documented circumstances.
1. (Optionally) Create the database migration that fine-tunes each level with 1. (Optionally) Create the database migration that fine-tunes each level with
...@@ -57,7 +58,8 @@ limit values. It's recommended to create separate migration script files. ...@@ -57,7 +58,8 @@ limit values. It's recommended to create separate migration script files.
end end
``` ```
NOTE: **Note:** Some plans exist only on GitLab.com. This will be no-op NOTE: **Note:**
Some plans exist only on GitLab.com. This will be no-op
for plans that do not exist. for plans that do not exist.
### Plan limits validation ### Plan limits validation
...@@ -95,7 +97,8 @@ can be used to validate that a model does not exceed the limits. It ensures ...@@ -95,7 +97,8 @@ can be used to validate that a model does not exceed the limits. It ensures
that the count of the records for the current model does not exceed the defined that the count of the records for the current model does not exceed the defined
limit. limit.
NOTE: **Note:** You must specify the limit scope of the object being validated NOTE: **Note:**
You must specify the limit scope of the object being validated
and the limit name if it's different from the pluralized model name. and the limit name if it's different from the pluralized model name.
```ruby ```ruby
...@@ -143,4 +146,5 @@ GitLab.com: ...@@ -143,4 +146,5 @@ GitLab.com:
- `silver` - Namespaces and projects with a Silver subscription - `silver` - Namespaces and projects with a Silver subscription
- `gold` - Namespaces and projects with a Gold subscription - `gold` - Namespaces and projects with a Gold subscription
NOTE: **Note:** The test environment doesn't have any plans. NOTE: **Note:**
The test environment doesn't have any plans.
...@@ -17,7 +17,8 @@ To request access to Chatops on GitLab.com: ...@@ -17,7 +17,8 @@ To request access to Chatops on GitLab.com:
1. You could also use the "Sign in with" Google button to sign in, with your GitLab.com email address. 1. You could also use the "Sign in with" Google button to sign in, with your GitLab.com email address.
1. Ask in the [#production](https://gitlab.slack.com/messages/production) channel for an existing member to add you to the `chatops` project in Ops. They can do it by running `/chatops run member add <username> gitlab-com/chatops --ops` command in that channel. 1. Ask in the [#production](https://gitlab.slack.com/messages/production) channel for an existing member to add you to the `chatops` project in Ops. They can do it by running `/chatops run member add <username> gitlab-com/chatops --ops` command in that channel.
NOTE: **Note:** If you had to change your username for GitLab.com on the first step, make sure [to reflect this information](https://gitlab.com/gitlab-com/www-gitlab-com#adding-yourself-to-the-team-page) on [the team page](https://about.gitlab.com/company/team/). NOTE: **Note:**
If you had to change your username for GitLab.com on the first step, make sure [to reflect this information](https://gitlab.com/gitlab-com/www-gitlab-com#adding-yourself-to-the-team-page) on [the team page](https://about.gitlab.com/company/team/).
## See also ## See also
......
...@@ -92,7 +92,8 @@ A job with the `created` state won't be seen by the Runner yet. To make it possi ...@@ -92,7 +92,8 @@ A job with the `created` state won't be seen by the Runner yet. To make it possi
When the Runner is connected, it requests the next `pending` job to run by polling the server continuously. When the Runner is connected, it requests the next `pending` job to run by polling the server continuously.
NOTE: **Note:** API endpoints used by the Runner to interact with GitLab are defined in [`lib/api/runner.rb`](https://gitlab.com/gitlab-org/gitlab/blob/master/lib/api/runner.rb) NOTE: **Note:**
API endpoints used by the Runner to interact with GitLab are defined in [`lib/api/runner.rb`](https://gitlab.com/gitlab-org/gitlab/blob/master/lib/api/runner.rb)
After the server receives the request it selects a `pending` job based on the [`Ci::RegisterJobService` algorithm](#ciregisterjobservice), then assigns and sends the job to the Runner. After the server receives the request it selects a `pending` job based on the [`Ci::RegisterJobService` algorithm](#ciregisterjobservice), then assigns and sends the job to the Runner.
...@@ -126,7 +127,8 @@ There are 3 top level queries that this service uses to gather the majority of t ...@@ -126,7 +127,8 @@ There are 3 top level queries that this service uses to gather the majority of t
This list of jobs is then filtered further by matching tags between job and Runner tags. This list of jobs is then filtered further by matching tags between job and Runner tags.
NOTE: **Note:** If a job contains tags, the Runner will not pick the job if it does not match **all** the tags. NOTE: **Note:**
If a job contains tags, the Runner will not pick the job if it does not match **all** the tags.
The Runner may have more tags than defined for the job, but not vice-versa. The Runner may have more tags than defined for the job, but not vice-versa.
Finally if the Runner can only pick jobs that are tagged, all untagged jobs are filtered out. Finally if the Runner can only pick jobs that are tagged, all untagged jobs are filtered out.
......
...@@ -113,7 +113,8 @@ end ...@@ -113,7 +113,8 @@ end
Validating the foreign key will scan the whole table and make sure that each relation is correct. Validating the foreign key will scan the whole table and make sure that each relation is correct.
NOTE: **Note:** When using [background migrations](../background_migrations.md), foreign key validation should happen in the next GitLab release. NOTE: **Note:**
When using [background migrations](../background_migrations.md), foreign key validation should happen in the next GitLab release.
Migration file for validating the foreign key: Migration file for validating the foreign key:
......
...@@ -190,7 +190,8 @@ In general, migrations for a single deploy shouldn't take longer than ...@@ -190,7 +190,8 @@ In general, migrations for a single deploy shouldn't take longer than
1 hour for GitLab.com. The following guidelines are not hard rules, they were 1 hour for GitLab.com. The following guidelines are not hard rules, they were
estimated to keep migration timing to a minimum. estimated to keep migration timing to a minimum.
NOTE: **Note:** Keep in mind that all runtimes should be measured against GitLab.com. NOTE: **Note:**
Keep in mind that all runtimes should be measured against GitLab.com.
| Migration Type | Execution Time Recommended | Notes | | Migration Type | Execution Time Recommended | Notes |
|----|----|---| |----|----|---|
......
# Geo self-service framework (alpha) # Geo self-service framework (alpha)
NOTE: **Note:** This document might be subjected to change. It's a NOTE: **Note:**
This document might be subjected to change. It's a
proposal we're working on and once the implementation is complete this proposal we're working on and once the implementation is complete this
documentation will be updated. Follow progress in the documentation will be updated. Follow progress in the
[epic](https://gitlab.com/groups/gitlab-org/-/epics/2161). [epic](https://gitlab.com/groups/gitlab-org/-/epics/2161).
NOTE: **Note:** The Geo self-service framework is currently in NOTE: **Note:**
The Geo self-service framework is currently in
alpha. If you need to replicate a new data type, reach out to the Geo alpha. If you need to replicate a new data type, reach out to the Geo
team to discuss the options. You can contact them in `#g_geo` on Slack team to discuss the options. You can contact them in `#g_geo` on Slack
or mention `@geo-team` in the issue or merge request. or mention `@geo-team` in the issue or merge request.
......
...@@ -114,7 +114,8 @@ bundle exec rake gitlab:features:disable_rugged ...@@ -114,7 +114,8 @@ bundle exec rake gitlab:features:disable_rugged
Most of this code exists in the `lib/gitlab/git/rugged_impl` directory. Most of this code exists in the `lib/gitlab/git/rugged_impl` directory.
NOTE: **Note:** You should NOT need to add or modify code related to NOTE: **Note:**
You should NOT need to add or modify code related to
Rugged unless explicitly discussed with the [Gitaly Rugged unless explicitly discussed with the [Gitaly
Team](https://gitlab.com/groups/gl-gitaly/group_members). This code will Team](https://gitlab.com/groups/gl-gitaly/group_members). This code will
NOT work on GitLab.com or other GitLab instances that do not use NFS. NOT work on GitLab.com or other GitLab instances that do not use NFS.
......
...@@ -95,7 +95,8 @@ Active Record's `:message` option accepts a `Proc`, so we can do this instead: ...@@ -95,7 +95,8 @@ Active Record's `:message` option accepts a `Proc`, so we can do this instead:
validates :group_id, uniqueness: { scope: [:project_id], message: -> (object, data) { _("already shared with this group") } } validates :group_id, uniqueness: { scope: [:project_id], message: -> (object, data) { _("already shared with this group") } }
``` ```
NOTE: **Note:** Messages in the API (`lib/api/` or `app/graphql`) do NOTE: **Note:**
Messages in the API (`lib/api/` or `app/graphql`) do
not need to be externalised. not need to be externalised.
### HAML files ### HAML files
......
...@@ -408,4 +408,5 @@ tree ...@@ -408,4 +408,5 @@ tree
└── 4352.json └── 4352.json
``` ```
CAUTION: **Caution:** When updating these fixtures, please ensure you update both `json` files and `tree` folder, as the tests apply to both. CAUTION: **Caution:**
When updating these fixtures, please ensure you update both `json` files and `tree` folder, as the tests apply to both.
...@@ -17,7 +17,8 @@ The first option is to simply [import the Project tarball file via the GitLab UI ...@@ -17,7 +17,8 @@ The first option is to simply [import the Project tarball file via the GitLab UI
It should take up to 15 minutes for the project to fully import. You can head to the project's main page for the current status. It should take up to 15 minutes for the project to fully import. You can head to the project's main page for the current status.
NOTE: **Note:** This method ignores all the errors silently (including the ones related to `GITALY_DISABLE_REQUEST_LIMITS`) and is used by GitLab's users. For development and testing, check the other methods below. NOTE: **Note:**
This method ignores all the errors silently (including the ones related to `GITALY_DISABLE_REQUEST_LIMITS`) and is used by GitLab's users. For development and testing, check the other methods below.
### Importing via the `import-project` script ### Importing via the `import-project` script
......
...@@ -604,7 +604,8 @@ In this particular case, the default value exists and we're just changing the me ...@@ -604,7 +604,8 @@ In this particular case, the default value exists and we're just changing the me
`request_access_enabled` column, which does not imply a rewrite of all the existing records `request_access_enabled` column, which does not imply a rewrite of all the existing records
in the `namespaces` table. Only when creating a new column with a default, all the records are going be rewritten. in the `namespaces` table. Only when creating a new column with a default, all the records are going be rewritten.
NOTE: **Note:** A faster [ALTER TABLE ADD COLUMN with a non-null default](https://www.depesz.com/2018/04/04/waiting-for-postgresql-11-fast-alter-table-add-column-with-a-non-null-default/) NOTE: **Note:**
A faster [ALTER TABLE ADD COLUMN with a non-null default](https://www.depesz.com/2018/04/04/waiting-for-postgresql-11-fast-alter-table-add-column-with-a-non-null-default/)
was introduced on PostgresSQL 11.0, removing the need of rewriting the table when a new column with a default value is added. was introduced on PostgresSQL 11.0, removing the need of rewriting the table when a new column with a default value is added.
For the reasons mentioned above, it's safe to use `change_column_default` in a single-transaction migration For the reasons mentioned above, it's safe to use `change_column_default` in a single-transaction migration
......
...@@ -68,7 +68,8 @@ The current state of existing package registries availability is: ...@@ -68,7 +68,8 @@ The current state of existing package registries availability is:
| Go | Yes | No - [open issue](https://gitlab.com/gitlab-org/gitlab/-/issues/213900) | No - [open-issue](https://gitlab.com/gitlab-org/gitlab/-/issues/213902) | | Go | Yes | No - [open issue](https://gitlab.com/gitlab-org/gitlab/-/issues/213900) | No - [open-issue](https://gitlab.com/gitlab-org/gitlab/-/issues/213902) |
| Composer | Yes | Yes | No | | Composer | Yes | Yes | No |
NOTE: **Note:** NPM is currently a hybrid of the instance level and group level. NOTE: **Note:**
NPM is currently a hybrid of the instance level and group level.
It is using the top-level group or namespace as the defining portion of the name It is using the top-level group or namespace as the defining portion of the name
(for example, `@my-group-name/my-package-name`). (for example, `@my-group-name/my-package-name`).
......
...@@ -272,7 +272,8 @@ Currently supported profiling targets are: ...@@ -272,7 +272,8 @@ Currently supported profiling targets are:
- Puma worker - Puma worker
- Sidekiq - Sidekiq
NOTE: **Note:** The Puma master process is not supported. Neither is Unicorn. NOTE: **Note:**
The Puma master process is not supported. Neither is Unicorn.
Sending SIGUSR2 to either of those will trigger restarts. In the case of Puma, Sending SIGUSR2 to either of those will trigger restarts. In the case of Puma,
take care to only send the signal to Puma workers. take care to only send the signal to Puma workers.
......
...@@ -10,7 +10,8 @@ There is a `Gitlab::Profiler.profile` method, and corresponding ...@@ -10,7 +10,8 @@ There is a `Gitlab::Profiler.profile` method, and corresponding
`bin/profile-url` script, that enable profiling a GET or POST request to a `bin/profile-url` script, that enable profiling a GET or POST request to a
specific URL, either as an anonymous user (the default) or as a specific user. specific URL, either as an anonymous user (the default) or as a specific user.
NOTE: **Note:** The first argument to the profiler is either a full URL NOTE: **Note:**
The first argument to the profiler is either a full URL
(including the instance hostname) or an absolute path, including the (including the instance hostname) or an absolute path, including the
leading slash. leading slash.
......
...@@ -303,7 +303,8 @@ class ExternalDependencyWorker ...@@ -303,7 +303,8 @@ class ExternalDependencyWorker
end end
``` ```
NOTE: **Note:** Note that a job cannot be both high urgency and have NOTE: **Note:**
Note that a job cannot be both high urgency and have
external dependencies. external dependencies.
## CPU-bound and Memory-bound Workers ## CPU-bound and Memory-bound Workers
......
...@@ -110,7 +110,8 @@ Use the coverage reports to ensure your tests cover 100% of your code. ...@@ -110,7 +110,8 @@ Use the coverage reports to ensure your tests cover 100% of your code.
### System / Feature tests ### System / Feature tests
NOTE: **Note:** Before writing a new system test, [please consider **not** NOTE: **Note:**
Before writing a new system test, [please consider **not**
writing one](testing_levels.md#consider-not-writing-a-system-test)! writing one](testing_levels.md#consider-not-writing-a-system-test)!
- Feature specs should be named `ROLE_ACTION_spec.rb`, such as - Feature specs should be named `ROLE_ACTION_spec.rb`, such as
......
...@@ -130,7 +130,8 @@ class CleanupUsersUpdatedAtRename < ActiveRecord::Migration[4.2] ...@@ -130,7 +130,8 @@ class CleanupUsersUpdatedAtRename < ActiveRecord::Migration[4.2]
end end
``` ```
NOTE: **Note:** If you're renaming a [large table](https://gitlab.com/gitlab-org/gitlab/-/blob/master/rubocop/rubocop-migrations.yml#L3), please carefully consider the state when the first migration has run but the second cleanup migration hasn't been run yet. NOTE: **Note:**
If you're renaming a [large table](https://gitlab.com/gitlab-org/gitlab/-/blob/master/rubocop/rubocop-migrations.yml#L3), please carefully consider the state when the first migration has run but the second cleanup migration hasn't been run yet.
With [Canary](https://about.gitlab.com/handbook/engineering/infrastructure/library/canary/) it is possible that the system runs in this state for a significant amount of time. With [Canary](https://about.gitlab.com/handbook/engineering/infrastructure/library/canary/) it is possible that the system runs in this state for a significant amount of time.
## Changing Column Constraints ## Changing Column Constraints
......
...@@ -30,7 +30,8 @@ In addition to having a basic familiarity with [AWS](https://docs.aws.amazon.com ...@@ -30,7 +30,8 @@ In addition to having a basic familiarity with [AWS](https://docs.aws.amazon.com
- A domain name for the GitLab instance - A domain name for the GitLab instance
- An SSL/TLS certificate to secure your domain. If you do not already own one, you can provision a free public SSL/TLS certificate through [AWS Certificate Manager](https://aws.amazon.com/certificate-manager/)(ACM) for use with the [Elastic Load Balancer](#load-balancer) we'll create. - An SSL/TLS certificate to secure your domain. If you do not already own one, you can provision a free public SSL/TLS certificate through [AWS Certificate Manager](https://aws.amazon.com/certificate-manager/)(ACM) for use with the [Elastic Load Balancer](#load-balancer) we'll create.
NOTE: **Note:** It can take a few hours to validate a certificate provisioned through ACM. To avoid delays later, request your certificate as soon as possible. NOTE: **Note:**
It can take a few hours to validate a certificate provisioned through ACM. To avoid delays later, request your certificate as soon as possible.
## Architecture ## Architecture
...@@ -304,7 +305,8 @@ We need a security group for our database that will allow inbound traffic from t ...@@ -304,7 +305,8 @@ We need a security group for our database that will allow inbound traffic from t
### Create the database ### Create the database
DANGER: **Danger:** Avoid using burstable instances (t class instances) for the database as this could lead to performance issues due to CPU credits running out during sustained periods of high load. DANGER: **Danger:**
Avoid using burstable instances (t class instances) for the database as this could lead to performance issues due to CPU credits running out during sustained periods of high load.
Now, it's time to create the database: Now, it's time to create the database:
...@@ -386,7 +388,8 @@ persistence and is used to store session data, temporary cache information, and ...@@ -386,7 +388,8 @@ persistence and is used to store session data, temporary cache information, and
Since our GitLab instances will be in private subnets, we need a way to connect to these instances via SSH to make configuration changes, perform upgrades, etc. One way of doing this is via a [bastion host](https://en.wikipedia.org/wiki/Bastion_host), sometimes also referred to as a jump box. Since our GitLab instances will be in private subnets, we need a way to connect to these instances via SSH to make configuration changes, perform upgrades, etc. One way of doing this is via a [bastion host](https://en.wikipedia.org/wiki/Bastion_host), sometimes also referred to as a jump box.
TIP: **Tip:** If you do not want to maintain bastion hosts, you can set up [AWS Systems Manager Session Manager](https://docs.aws.amazon.com/systems-manager/latest/userguide/session-manager.html) for access to instances. This is beyond the scope of this document. TIP: **Tip:**
If you do not want to maintain bastion hosts, you can set up [AWS Systems Manager Session Manager](https://docs.aws.amazon.com/systems-manager/latest/userguide/session-manager.html) for access to instances. This is beyond the scope of this document.
### Create Bastion Host A ### Create Bastion Host A
...@@ -542,7 +545,8 @@ gitlab=# \q ...@@ -542,7 +545,8 @@ gitlab=# \q
#### Set up Gitaly #### Set up Gitaly
CAUTION: **Caution:** In this architecture, having a single Gitaly server creates a single point of failure. This limitation will be removed once [Gitaly Cluster](https://gitlab.com/groups/gitlab-org/-/epics/1489) is released. CAUTION: **Caution:**
In this architecture, having a single Gitaly server creates a single point of failure. This limitation will be removed once [Gitaly Cluster](https://gitlab.com/groups/gitlab-org/-/epics/1489) is released.
Gitaly is a service that provides high-level RPC access to Git repositories. Gitaly is a service that provides high-level RPC access to Git repositories.
It should be enabled and configured on a separate EC2 instance in one of the It should be enabled and configured on a separate EC2 instance in one of the
...@@ -568,7 +572,8 @@ Let's create an EC2 instance where we'll install Gitaly: ...@@ -568,7 +572,8 @@ Let's create an EC2 instance where we'll install Gitaly:
1. Click **Review and launch** followed by **Launch** if you're happy with your settings. 1. Click **Review and launch** followed by **Launch** if you're happy with your settings.
1. Finally, acknowledge that you have access to the selected private key file or create a new one. Click **Launch Instances**. 1. Finally, acknowledge that you have access to the selected private key file or create a new one. Click **Launch Instances**.
NOTE: **Optional:** Instead of storing configuration _and_ repository data on the root volume, you can also choose to add an additional EBS volume for repository storage. Follow the same guidance as above. See the [Amazon EBS pricing](https://aws.amazon.com/ebs/pricing/). We do not recommend using EFS as it may negatively impact GitLab’s performance. You can review the [relevant documentation](../../administration/high_availability/nfs.md#avoid-using-awss-elastic-file-system-efs) for more details. NOTE: **Note:**
Instead of storing configuration _and_ repository data on the root volume, you can also choose to add an additional EBS volume for repository storage. Follow the same guidance as above. See the [Amazon EBS pricing](https://aws.amazon.com/ebs/pricing/). We do not recommend using EFS as it may negatively impact GitLab’s performance. You can review the [relevant documentation](../../administration/high_availability/nfs.md#avoid-using-awss-elastic-file-system-efs) for more details.
Now that we have our EC2 instance ready, follow the [documentation to install GitLab and set up Gitaly on its own server](../../administration/gitaly/index.md#run-gitaly-on-its-own-server). Perform the client setup steps from that document on the [GitLab instance we created](#install-gitlab) above. Now that we have our EC2 instance ready, follow the [documentation to install GitLab and set up Gitaly on its own server](../../administration/gitaly/index.md#run-gitaly-on-its-own-server). Perform the client setup steps from that document on the [GitLab instance we created](#install-gitlab) above.
......
...@@ -25,7 +25,8 @@ For a video demonstration on installing GitLab on OpenShift, check the article [ ...@@ -25,7 +25,8 @@ For a video demonstration on installing GitLab on OpenShift, check the article [
## Prerequisites ## Prerequisites
CAUTION: **Caution:** This information is no longer up to date, as the current versions CAUTION: **Caution:**
This information is no longer up to date, as the current versions
have changed and products have been renamed. have changed and products have been renamed.
OpenShift 3 is not yet deployed on RedHat's offered [Online platform](https://www.openshift.com/), OpenShift 3 is not yet deployed on RedHat's offered [Online platform](https://www.openshift.com/),
......
...@@ -90,7 +90,8 @@ Apart from a local hard drive you can also mount a volume that supports the netw ...@@ -90,7 +90,8 @@ Apart from a local hard drive you can also mount a volume that supports the netw
If you have enough RAM and a recent CPU the speed of GitLab is mainly limited by hard drive seek times. Having a fast drive (7200 RPM and up) or a solid state drive (SSD) will improve the responsiveness of GitLab. If you have enough RAM and a recent CPU the speed of GitLab is mainly limited by hard drive seek times. Having a fast drive (7200 RPM and up) or a solid state drive (SSD) will improve the responsiveness of GitLab.
NOTE: **Note:** Since file system performance may affect GitLab's overall performance, [we don't recommend using AWS EFS for storage](../administration/high_availability/nfs.md#avoid-using-awss-elastic-file-system-efs). NOTE: **Note:**
Since file system performance may affect GitLab's overall performance, [we don't recommend using AWS EFS for storage](../administration/high_availability/nfs.md#avoid-using-awss-elastic-file-system-efs).
### CPU ### CPU
...@@ -145,7 +146,8 @@ GitLab database. This extension [can be enabled](https://www.postgresql.org/docs ...@@ -145,7 +146,8 @@ GitLab database. This extension [can be enabled](https://www.postgresql.org/docs
On some systems you may need to install an additional package (for example, On some systems you may need to install an additional package (for example,
`postgresql-contrib`) for this extension to become available. `postgresql-contrib`) for this extension to become available.
NOTE: **Note:** Support for [PostgreSQL 9.6 and 10 has been removed in GitLab 13.0](https://about.gitlab.com/releases/2020/05/22/gitlab-13-0-released/#postgresql-11-is-now-the-minimum-required-version-to-install-gitlab) so that GitLab can benefit from PostgreSQL 11 improvements, such as partitioning. For the schedule of transitioning to PostgreSQL 12, see [the related epic](https://gitlab.com/groups/gitlab-org/-/epics/2184). NOTE: **Note:**
Support for [PostgreSQL 9.6 and 10 has been removed in GitLab 13.0](https://about.gitlab.com/releases/2020/05/22/gitlab-13-0-released/#postgresql-11-is-now-the-minimum-required-version-to-install-gitlab) so that GitLab can benefit from PostgreSQL 11 improvements, such as partitioning. For the schedule of transitioning to PostgreSQL 12, see [the related epic](https://gitlab.com/groups/gitlab-org/-/epics/2184).
#### Additional requirements for GitLab Geo #### Additional requirements for GitLab Geo
...@@ -260,7 +262,8 @@ For reference, GitLab.com's [auto-scaling shared runner](../user/gitlab_com/inde ...@@ -260,7 +262,8 @@ For reference, GitLab.com's [auto-scaling shared runner](../user/gitlab_com/inde
## Supported web browsers ## Supported web browsers
CAUTION: **Caution:** With GitLab 13.0 (May 2020) we have removed official support for Internet Explorer 11. CAUTION: **Caution:**
With GitLab 13.0 (May 2020) we have removed official support for Internet Explorer 11.
With the release of GitLab 13.4 (September 2020) we will remove all code that supports Internet Explorer 11. With the release of GitLab 13.4 (September 2020) we will remove all code that supports Internet Explorer 11.
You can provide feedback [on this issue](https://gitlab.com/gitlab-org/gitlab/-/issues/197987) or via your usual support channels. You can provide feedback [on this issue](https://gitlab.com/gitlab-org/gitlab/-/issues/197987) or via your usual support channels.
...@@ -277,7 +280,8 @@ For the listed web browsers, GitLab supports: ...@@ -277,7 +280,8 @@ For the listed web browsers, GitLab supports:
- The current and previous major versions of browsers except Internet Explorer. - The current and previous major versions of browsers except Internet Explorer.
- The current minor version of a supported major version. - The current minor version of a supported major version.
NOTE: **Note:** We don't support running GitLab with JavaScript disabled in the browser and have no plans of supporting that NOTE: **Note:**
We don't support running GitLab with JavaScript disabled in the browser and have no plans of supporting that
in the future because we have features such as Issue Boards which require JavaScript extensively. in the future because we have features such as Issue Boards which require JavaScript extensively.
<!-- ## Troubleshooting <!-- ## Troubleshooting
......
...@@ -632,7 +632,8 @@ Here are some common pitfalls and how to overcome them: ...@@ -632,7 +632,8 @@ Here are some common pitfalls and how to overcome them:
**For a single node Elasticsearch cluster the functional cluster health status will be yellow** (will never be green) because the primary shard is allocated but replicas can not be as there is no other node to which Elasticsearch can assign a replica. This also applies if you are using the **For a single node Elasticsearch cluster the functional cluster health status will be yellow** (will never be green) because the primary shard is allocated but replicas can not be as there is no other node to which Elasticsearch can assign a replica. This also applies if you are using the
[Amazon Elasticsearch](https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/aes-handling-errors.html#aes-handling-errors-yellow-cluster-status) service. [Amazon Elasticsearch](https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/aes-handling-errors.html#aes-handling-errors-yellow-cluster-status) service.
CAUTION: **Warning:** Setting the number of replicas to `0` is not something that we recommend (this is not allowed in the GitLab Elasticsearch Integration menu). If you are planning to add more Elasticsearch nodes (for a total of more than 1 Elasticsearch) the number of replicas will need to be set to an integer value larger than `0`. Failure to do so will result in lack of redundancy (losing one node will corrupt the index). CAUTION: **Warning:**
Setting the number of replicas to `0` is not something that we recommend (this is not allowed in the GitLab Elasticsearch Integration menu). If you are planning to add more Elasticsearch nodes (for a total of more than 1 Elasticsearch) the number of replicas will need to be set to an integer value larger than `0`. Failure to do so will result in lack of redundancy (losing one node will corrupt the index).
If you have a **hard requirement to have a green status for your single node Elasticsearch cluster**, please make sure you understand the risks outlined in the previous paragraph and then simply run the following query to set the number of replicas to `0`(the cluster will no longer try to create any shard replicas): If you have a **hard requirement to have a green status for your single node Elasticsearch cluster**, please make sure you understand the risks outlined in the previous paragraph and then simply run the following query to set the number of replicas to `0`(the cluster will no longer try to create any shard replicas):
......
...@@ -70,7 +70,8 @@ one major version. For example, it is safe to: ...@@ -70,7 +70,8 @@ one major version. For example, it is safe to:
- `9.5.5` -> `9.5.9` - `9.5.5` -> `9.5.9`
- `8.9.2` -> `8.9.6` - `8.9.2` -> `8.9.6`
NOTE: **Note:** Version specific changes in Omnibus GitLab Linux packages can be found in [the Omnibus GitLab documentation](https://docs.gitlab.com/omnibus/update/README.html#version-specific-changes). NOTE: **Note:**
Version specific changes in Omnibus GitLab Linux packages can be found in [the Omnibus GitLab documentation](https://docs.gitlab.com/omnibus/update/README.html#version-specific-changes).
NOTE: **Note:** NOTE: **Note:**
Instructions are available for downloading an Omnibus GitLab Linux package locally and [manually installing](https://docs.gitlab.com/omnibus/manual_install.html) it. Instructions are available for downloading an Omnibus GitLab Linux package locally and [manually installing](https://docs.gitlab.com/omnibus/manual_install.html) it.
......
...@@ -515,7 +515,8 @@ backups will be copied to, and will be created if it does not exist. If the ...@@ -515,7 +515,8 @@ backups will be copied to, and will be created if it does not exist. If the
directory that you want to copy the tarballs to is the root of your mounted directory that you want to copy the tarballs to is the root of your mounted
directory, just use `.` instead. directory, just use `.` instead.
NOTE: **Note:** Since file system performance may affect GitLab's overall performance, we do not recommend using EFS for storage. See the [relevant documentation](../administration/high_availability/nfs.md#avoid-using-awss-elastic-file-system-efs) for more details. NOTE: **Note:**
Since file system performance may affect GitLab's overall performance, we do not recommend using EFS for storage. See the [relevant documentation](../administration/high_availability/nfs.md#avoid-using-awss-elastic-file-system-efs) for more details.
For Omnibus GitLab packages: For Omnibus GitLab packages:
......
...@@ -18,11 +18,13 @@ tracking. ...@@ -18,11 +18,13 @@ tracking.
For more information on how to use these options see the [Rack Attack README](https://github.com/kickstarter/rack-attack/blob/master/README.md). For more information on how to use these options see the [Rack Attack README](https://github.com/kickstarter/rack-attack/blob/master/README.md).
NOTE: **Note:** See NOTE: **Note:**
See
[User and IP rate limits](../user/admin_area/settings/user_and_ip_rate_limits.md) [User and IP rate limits](../user/admin_area/settings/user_and_ip_rate_limits.md)
for simpler limits that are configured in the UI. for simpler limits that are configured in the UI.
NOTE: **Note:** Starting with GitLab 11.2, Rack Attack is disabled by default. If your NOTE: **Note:**
Starting with GitLab 11.2, Rack Attack is disabled by default. If your
instance is not exposed to the public internet, it is recommended that you leave instance is not exposed to the public internet, it is recommended that you leave
Rack Attack disabled. Rack Attack disabled.
......
...@@ -72,7 +72,8 @@ Heroku buildpacks, with the following caveats: ...@@ -72,7 +72,8 @@ Heroku buildpacks, with the following caveats:
- The `/bin/herokuish` command is not present in the resulting image, and prefixing - The `/bin/herokuish` command is not present in the resulting image, and prefixing
commands with `/bin/herokuish procfile exec` is no longer required (nor possible). commands with `/bin/herokuish procfile exec` is no longer required (nor possible).
NOTE: **Note:** Auto Test still uses Herokuish, as test suite detection is not NOTE: **Note:**
Auto Test still uses Herokuish, as test suite detection is not
yet part of the Cloud Native Buildpack specification. For more information, see yet part of the Cloud Native Buildpack specification. For more information, see
[this issue](https://gitlab.com/gitlab-org/gitlab/-/issues/212689). [this issue](https://gitlab.com/gitlab-org/gitlab/-/issues/212689).
...@@ -398,7 +399,8 @@ To use Auto Deploy on a Kubernetes 1.16+ cluster: ...@@ -398,7 +399,8 @@ To use Auto Deploy on a Kubernetes 1.16+ cluster:
1. If you are deploying your application for the first time and are using 1. If you are deploying your application for the first time and are using
GitLab 12.9 or 12.10, set `AUTO_DEVOPS_POSTGRES_CHANNEL` to `2`. GitLab 12.9 or 12.10, set `AUTO_DEVOPS_POSTGRES_CHANNEL` to `2`.
DANGER: **Danger:** On GitLab 12.9 and 12.10, opting into DANGER: **Danger:**
On GitLab 12.9 and 12.10, opting into
`AUTO_DEVOPS_POSTGRES_CHANNEL` version `2` deletes the version `1` PostgreSQL `AUTO_DEVOPS_POSTGRES_CHANNEL` version `2` deletes the version `1` PostgreSQL
database. Follow the [guide to upgrading PostgreSQL](upgrading_postgresql.md) database. Follow the [guide to upgrading PostgreSQL](upgrading_postgresql.md)
to back up and restore your database before opting into version `2` (On to back up and restore your database before opting into version `2` (On
......
...@@ -30,7 +30,8 @@ involves: ...@@ -30,7 +30,8 @@ involves:
any existing channel 1 database. For more information, see any existing channel 1 database. For more information, see
[Detected an existing PostgreSQL database](index.md#detected-an-existing-postgresql-database). [Detected an existing PostgreSQL database](index.md#detected-an-existing-postgresql-database).
TIP: **Tip:** If you have configured Auto DevOps to have staging, TIP: **Tip:**
If you have configured Auto DevOps to have staging,
consider trying out the backup and restore steps on staging first, or consider trying out the backup and restore steps on staging first, or
trying this out on a review app. trying this out on a review app.
...@@ -161,11 +162,13 @@ pvc-9085e3d3-5239-11ea-9c8d-42010a8e0096 8Gi RWO Retain ...@@ -161,11 +162,13 @@ pvc-9085e3d3-5239-11ea-9c8d-42010a8e0096 8Gi RWO Retain
## Install new PostgreSQL ## Install new PostgreSQL
CAUTION: **Caution:** Using the newer version of PostgreSQL will delete CAUTION: **Caution:**
Using the newer version of PostgreSQL will delete
the older 0.7.1 PostgreSQL. To prevent the underlying data from being the older 0.7.1 PostgreSQL. To prevent the underlying data from being
deleted, you can choose to retain the [persistent volume](#retain-persistent-volumes). deleted, you can choose to retain the [persistent volume](#retain-persistent-volumes).
TIP: **Tip:** You can also TIP: **Tip:**
You can also
[scope](../../ci/environments/index.md#scoping-environments-with-specs) the [scope](../../ci/environments/index.md#scoping-environments-with-specs) the
`AUTO_DEVOPS_POSTGRES_CHANNEL`, `AUTO_DEVOPS_POSTGRES_DELETE_V1` and `AUTO_DEVOPS_POSTGRES_CHANNEL`, `AUTO_DEVOPS_POSTGRES_DELETE_V1` and
`POSTGRES_VERSION` variables to specific environments, e.g. `staging`. `POSTGRES_VERSION` variables to specific environments, e.g. `staging`.
......
...@@ -149,9 +149,11 @@ Sidekiq::ScheduledSet.new.select { |r| r.klass == 'BackgroundMigrationWorker' }. ...@@ -149,9 +149,11 @@ Sidekiq::ScheduledSet.new.select { |r| r.klass == 'BackgroundMigrationWorker' }.
### What do I do if my background migrations are stuck? ### What do I do if my background migrations are stuck?
CAUTION: **Warning:** The following operations can disrupt your GitLab performance. CAUTION: **Warning:**
The following operations can disrupt your GitLab performance.
NOTE: **Note:** It is safe to re-execute these commands, especially if you have 1000+ pending jobs which would likely overflow your runtime memory. NOTE: **Note:**
It is safe to re-execute these commands, especially if you have 1000+ pending jobs which would likely overflow your runtime memory.
**For Omnibus installations** **For Omnibus installations**
......
...@@ -4,7 +4,8 @@ comments: false ...@@ -4,7 +4,8 @@ comments: false
# Upgrading from Community Edition to Enterprise Edition from source # Upgrading from Community Edition to Enterprise Edition from source
NOTE: **Note:** In the past we used separate documents for upgrading from NOTE: **Note:**
In the past we used separate documents for upgrading from
Community Edition to Enterprise Edition. These documents can be found in the Community Edition to Enterprise Edition. These documents can be found in the
[`doc/update` directory of Enterprise Edition's source [`doc/update` directory of Enterprise Edition's source
code](https://gitlab.com/gitlab-org/gitlab/tree/11-8-stable-ee/doc/update). code](https://gitlab.com/gitlab-org/gitlab/tree/11-8-stable-ee/doc/update).
......
...@@ -20,7 +20,8 @@ The page uses the project's latest default branch [CI pipeline](../../../ci/pipe ...@@ -20,7 +20,8 @@ The page uses the project's latest default branch [CI pipeline](../../../ci/pipe
state of each feature. If a job with the expected security report artifact exists in the pipeline, state of each feature. If a job with the expected security report artifact exists in the pipeline,
the feature is considered configured. the feature is considered configured.
NOTE: **Note:** if the latest pipeline used [Auto DevOps](../../../topics/autodevops/index.md), NOTE: **Note:**
if the latest pipeline used [Auto DevOps](../../../topics/autodevops/index.md),
all security features will be configured by default. all security features will be configured by default.
## Limitations ## Limitations
......
...@@ -58,7 +58,8 @@ If you're using the shared Runners on GitLab.com, this is enabled by default. ...@@ -58,7 +58,8 @@ If you're using the shared Runners on GitLab.com, this is enabled by default.
Beginning with GitLab 13.0, Docker privileged mode is necessary only if you've [enabled Docker-in-Docker for SAST](#enabling-docker-in-docker). Beginning with GitLab 13.0, Docker privileged mode is necessary only if you've [enabled Docker-in-Docker for SAST](#enabling-docker-in-docker).
CAUTION: **Caution:** Our SAST jobs currently expect a Linux container type. Windows containers are not yet supported. CAUTION: **Caution:**
Our SAST jobs currently expect a Linux container type. Windows containers are not yet supported.
CAUTION: **Caution:** CAUTION: **Caution:**
If you use your own Runners, make sure the Docker version installed If you use your own Runners, make sure the Docker version installed
......
...@@ -39,7 +39,8 @@ To run Secret Detection jobs, by default, you need GitLab Runner with the ...@@ -39,7 +39,8 @@ To run Secret Detection jobs, by default, you need GitLab Runner with the
[`kubernetes`](https://docs.gitlab.com/runner/install/kubernetes.html) executor. [`kubernetes`](https://docs.gitlab.com/runner/install/kubernetes.html) executor.
If you're using the shared Runners on GitLab.com, this is enabled by default. If you're using the shared Runners on GitLab.com, this is enabled by default.
CAUTION: **Caution:** Our Secret Detection jobs currently expect a Linux container type. Windows containers are not yet supported. CAUTION: **Caution:**
Our Secret Detection jobs currently expect a Linux container type. Windows containers are not yet supported.
CAUTION: **Caution:** CAUTION: **Caution:**
If you use your own Runners, make sure the Docker version installed If you use your own Runners, make sure the Docker version installed
......
...@@ -88,7 +88,8 @@ To disallow users to contribute outside of the top-level group, please see [Grou ...@@ -88,7 +88,8 @@ To disallow users to contribute outside of the top-level group, please see [Grou
## Providers ## Providers
NOTE: **Note:** GitLab is unable to provide support for IdPs that are not listed here. NOTE: **Note:**
GitLab is unable to provide support for IdPs that are not listed here.
| Provider | Documentation | | Provider | Documentation |
|----------|---------------| |----------|---------------|
......
...@@ -92,7 +92,8 @@ You can then test the connection by clicking on **Test Connection**. If the conn ...@@ -92,7 +92,8 @@ You can then test the connection by clicking on **Test Connection**. If the conn
1. Save your changes. For reference, you can view [an example configuration in the troubleshooting reference](../../../administration/troubleshooting/group_saml_scim.md#azure-active-directory). 1. Save your changes. For reference, you can view [an example configuration in the troubleshooting reference](../../../administration/troubleshooting/group_saml_scim.md#azure-active-directory).
NOTE: **Note:** If you used a unique identifier **other than** `objectId`, be sure to map it to `externalId`. NOTE: **Note:**
If you used a unique identifier **other than** `objectId`, be sure to map it to `externalId`.
1. Below the mapping list click on **Show advanced options > Edit attribute list for AppName**. 1. Below the mapping list click on **Show advanced options > Edit attribute list for AppName**.
...@@ -127,7 +128,8 @@ Before proceeding, be sure to complete the [GitLab configuration](#gitlab-config ...@@ -127,7 +128,8 @@ Before proceeding, be sure to complete the [GitLab configuration](#gitlab-config
1. If you see an **Admin** button in the top right, click the button. This will 1. If you see an **Admin** button in the top right, click the button. This will
ensure you are in the Admin area. ensure you are in the Admin area.
TIP: **Tip:** If you're using the Developer Console, click **Developer Console** in the top TIP: **Tip:**
If you're using the Developer Console, click **Developer Console** in the top
bar and select **Classic UI**. Otherwise, you may not see the buttons described bar and select **Classic UI**. Otherwise, you may not see the buttons described
in the following steps: in the following steps:
......
...@@ -14,7 +14,8 @@ website uses an extended Kramdown gem, [GitLab Kramdown](https://gitlab.com/gitl ...@@ -14,7 +14,8 @@ website uses an extended Kramdown gem, [GitLab Kramdown](https://gitlab.com/gitl
Consult the [GitLab Kramdown Guide](https://about.gitlab.com/handbook/markdown-guide/) Consult the [GitLab Kramdown Guide](https://about.gitlab.com/handbook/markdown-guide/)
for a complete Kramdown reference. for a complete Kramdown reference.
NOTE: **Note:** We encourage you to view this document as [rendered by GitLab itself](https://gitlab.com/gitlab-org/gitlab/blob/master/doc/user/markdown.md). NOTE: **Note:**
We encourage you to view this document as [rendered by GitLab itself](https://gitlab.com/gitlab-org/gitlab/blob/master/doc/user/markdown.md).
## GitLab Flavored Markdown (GFM) ## GitLab Flavored Markdown (GFM)
...@@ -76,7 +77,8 @@ character of the top list item (`C` in this case): ...@@ -76,7 +77,8 @@ character of the top list item (`C` in this case):
- dark - dark
- milk - milk
NOTE: **Note:** We will flag any significant differences between Redcarpet and CommonMark NOTE: **Note:**
We will flag any significant differences between Redcarpet and CommonMark
Markdown in this document. Markdown in this document.
If you have a large volume of Markdown files, it can be tedious to determine If you have a large volume of Markdown files, it can be tedious to determine
...@@ -261,7 +263,8 @@ when rendered within GitLab, may appear different depending on the OS and browse ...@@ -261,7 +263,8 @@ when rendered within GitLab, may appear different depending on the OS and browse
Most emoji are natively supported on macOS, Windows, iOS, Android, and will fall back on image-based emoji where there is no support. Most emoji are natively supported on macOS, Windows, iOS, Android, and will fall back on image-based emoji where there is no support.
NOTE: **Note:** On Linux, you can download [Noto Color Emoji](https://www.google.com/get/noto/help/emoji/) NOTE: **Note:**
On Linux, you can download [Noto Color Emoji](https://www.google.com/get/noto/help/emoji/)
to get full native emoji support. Ubuntu 18.04 (like many modern Linux distributions) has to get full native emoji support. Ubuntu 18.04 (like many modern Linux distributions) has
this font installed by default. this font installed by default.
...@@ -402,7 +405,8 @@ a^2+b^2=c^2 ...@@ -402,7 +405,8 @@ a^2+b^2=c^2
_Be advised that KaTeX only supports a [subset](https://katex.org/docs/supported.html) of LaTeX._ _Be advised that KaTeX only supports a [subset](https://katex.org/docs/supported.html) of LaTeX._
NOTE: **Note:** This also works for the Asciidoctor `:stem: latexmath`. For details see NOTE: **Note:**
This also works for the Asciidoctor `:stem: latexmath`. For details see
the [Asciidoctor user manual](https://asciidoctor.org/docs/user-manual/#activating-stem-support). the [Asciidoctor user manual](https://asciidoctor.org/docs/user-manual/#activating-stem-support).
### Special GitLab references ### Special GitLab references
...@@ -779,7 +783,8 @@ Combined emphasis with **asterisks and _underscores_**. ...@@ -779,7 +783,8 @@ Combined emphasis with **asterisks and _underscores_**.
Strikethrough uses two tildes. ~~Scratch this.~~ Strikethrough uses two tildes. ~~Scratch this.~~
NOTE: **Note:** Strikethrough is not part of the core Markdown standard, but is part of GFM. NOTE: **Note:**
Strikethrough is not part of the core Markdown standard, but is part of GFM.
#### Multiple underscores in words and mid-word emphasis #### Multiple underscores in words and mid-word emphasis
...@@ -1246,7 +1251,8 @@ Do not change to reference style links. ...@@ -1246,7 +1251,8 @@ Do not change to reference style links.
Some text to show that the reference links can follow later. Some text to show that the reference links can follow later.
NOTE: **Note:** Relative links do not allow the referencing of project files in a wiki NOTE: **Note:**
Relative links do not allow the referencing of project files in a wiki
page, or a wiki page in a project file. The reason for this is that a wiki is always page, or a wiki page in a project file. The reason for this is that a wiki is always
in a separate Git repository in GitLab. For example, `[I'm a reference-style link](style)` in a separate Git repository in GitLab. For example, `[I'm a reference-style link](style)`
will point the link to `wikis/style` only when the link is inside of a wiki Markdown file. will point the link to `wikis/style` only when the link is inside of a wiki Markdown file.
......
...@@ -238,7 +238,8 @@ The regex that is used for naming is validating all package names from all packa ...@@ -238,7 +238,8 @@ The regex that is used for naming is validating all package names from all packa
It allows for capital letters, while NPM does not, and allows for almost all of the It allows for capital letters, while NPM does not, and allows for almost all of the
characters NPM allows with a few exceptions (`~` is not allowed). characters NPM allows with a few exceptions (`~` is not allowed).
NOTE: **Note:** Capital letters are needed because the scope is required to be NOTE: **Note:**
Capital letters are needed because the scope is required to be
identical to the top level namespace of the project. So, for example, if your identical to the top level namespace of the project. So, for example, if your
project path is `My-Group/project-foo`, your package must be named `@My-Group/any-package-name`. project path is `My-Group/project-foo`, your package must be named `@My-Group/any-package-name`.
`@my-group/any-package-name` will not work. `@my-group/any-package-name` will not work.
......
...@@ -35,7 +35,8 @@ As an administrator, you can delete a user account by: ...@@ -35,7 +35,8 @@ As an administrator, you can delete a user account by:
- **Delete user and contributions** to delete the user and - **Delete user and contributions** to delete the user and
their associated records. their associated records.
DANGER: **Danger:** Using the **Delete user and contributions** option may result DANGER: **Danger:**
Using the **Delete user and contributions** option may result
in removing more data than intended. Please see [associated records](#associated-records) in removing more data than intended. Please see [associated records](#associated-records)
below for additional details. below for additional details.
......
...@@ -308,7 +308,8 @@ integration to work properly. ...@@ -308,7 +308,8 @@ integration to work properly.
![rbac](img/rbac_v13_1.png) ![rbac](img/rbac_v13_1.png)
NOTE: **Note:** Disabling RBAC means that any application running in the cluster, NOTE: **Note:**
Disabling RBAC means that any application running in the cluster,
or user who can authenticate to the cluster, has full API access. This is a or user who can authenticate to the cluster, has full API access. This is a
[security concern](index.md#security-implications), and may not be desirable. [security concern](index.md#security-implications), and may not be desirable.
......
...@@ -275,7 +275,8 @@ For **non**-GitLab-managed clusters, the namespace can be customized using ...@@ -275,7 +275,8 @@ For **non**-GitLab-managed clusters, the namespace can be customized using
[`environment:kubernetes:namespace`](../../../ci/environments/index.md#configuring-kubernetes-deployments) [`environment:kubernetes:namespace`](../../../ci/environments/index.md#configuring-kubernetes-deployments)
in `.gitlab-ci.yml`. in `.gitlab-ci.yml`.
NOTE: **Note:** When using a [GitLab-managed cluster](#gitlab-managed-clusters), the NOTE: **Note:**
When using a [GitLab-managed cluster](#gitlab-managed-clusters), the
namespaces are created automatically prior to deployment and [can not be namespaces are created automatically prior to deployment and [can not be
customized](https://gitlab.com/gitlab-org/gitlab/-/issues/38054). customized](https://gitlab.com/gitlab-org/gitlab/-/issues/38054).
......
...@@ -8,7 +8,8 @@ info: To determine the technical writer assigned to the Stage/Group associated w ...@@ -8,7 +8,8 @@ info: To determine the technical writer assigned to the Stage/Group associated w
> [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/22133) in GitLab 11.7. > [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/22133) in GitLab 11.7.
NOTE: **Note:** NGINX Ingress versions prior to 0.16.0 offer an included [VTS Prometheus metrics exporter](nginx_ingress_vts.md), which exports metrics different than the built-in metrics. NOTE: **Note:**
NGINX Ingress versions prior to 0.16.0 offer an included [VTS Prometheus metrics exporter](nginx_ingress_vts.md), which exports metrics different than the built-in metrics.
GitLab has support for automatically detecting and monitoring the Kubernetes NGINX Ingress controller. This is provided by leveraging the built-in Prometheus metrics included with Kubernetes NGINX Ingress controller [version 0.16.0](https://github.com/kubernetes/ingress-nginx/blob/master/Changelog.md#0160) onward. GitLab has support for automatically detecting and monitoring the Kubernetes NGINX Ingress controller. This is provided by leveraging the built-in Prometheus metrics included with Kubernetes NGINX Ingress controller [version 0.16.0](https://github.com/kubernetes/ingress-nginx/blob/master/Changelog.md#0160) onward.
......
...@@ -8,7 +8,8 @@ info: To determine the technical writer assigned to the Stage/Group associated w ...@@ -8,7 +8,8 @@ info: To determine the technical writer assigned to the Stage/Group associated w
> [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/13438) in GitLab 9.5. > [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/13438) in GitLab 9.5.
NOTE: **Note:** [NGINX Ingress version 0.16](nginx_ingress.md) and above have built-in Prometheus metrics, which are different than the VTS based metrics. NOTE: **Note:**
[NGINX Ingress version 0.16](nginx_ingress.md) and above have built-in Prometheus metrics, which are different than the VTS based metrics.
GitLab has support for automatically detecting and monitoring the Kubernetes NGINX Ingress controller. This is provided by leveraging the included VTS Prometheus metrics exporter in [version 0.9.0](https://github.com/kubernetes/ingress-nginx/blob/master/Changelog.md#09-beta1) through [0.15.x](https://github.com/kubernetes/ingress-nginx/blob/master/Changelog.md#0150). GitLab has support for automatically detecting and monitoring the Kubernetes NGINX Ingress controller. This is provided by leveraging the included VTS Prometheus metrics exporter in [version 0.9.0](https://github.com/kubernetes/ingress-nginx/blob/master/Changelog.md#09-beta1) through [0.15.x](https://github.com/kubernetes/ingress-nginx/blob/master/Changelog.md#0150).
......
...@@ -31,7 +31,8 @@ git commit -m "this is my commit message. Related to https://gitlab.com/<usernam ...@@ -31,7 +31,8 @@ git commit -m "this is my commit message. Related to https://gitlab.com/<usernam
Of course, you can replace `gitlab.com` with the URL of your own GitLab instance. Of course, you can replace `gitlab.com` with the URL of your own GitLab instance.
NOTE: **Note:** Linking your first commit to your issue is going to be relevant NOTE: **Note:**
Linking your first commit to your issue is going to be relevant
for tracking your process with [GitLab Cycle Analytics](https://about.gitlab.com/stages-devops-lifecycle/value-stream-analytics/). for tracking your process with [GitLab Cycle Analytics](https://about.gitlab.com/stages-devops-lifecycle/value-stream-analytics/).
It will measure the time taken for planning the implementation of that issue, It will measure the time taken for planning the implementation of that issue,
which is the time between creating an issue and making the first commit. which is the time between creating an issue and making the first commit.
......
...@@ -7,7 +7,8 @@ Issues can be imported to a project by uploading a CSV file with the columns ...@@ -7,7 +7,8 @@ Issues can be imported to a project by uploading a CSV file with the columns
The user uploading the CSV file will be set as the author of the imported issues. The user uploading the CSV file will be set as the author of the imported issues.
NOTE: **Note:** A permission level of [Developer](../../permissions.md), or higher, is required NOTE: **Note:**
A permission level of [Developer](../../permissions.md), or higher, is required
to import issues. to import issues.
## Prepare for the import ## Prepare for the import
......
...@@ -94,7 +94,7 @@ also be merged. ...@@ -94,7 +94,7 @@ also be merged.
All issues, merge requests, issue board lists, issue board filters, and label subscriptions All issues, merge requests, issue board lists, issue board filters, and label subscriptions
with the old labels will be assigned to the new group label. with the old labels will be assigned to the new group label.
WARNING: **Caution:** CAUTION: **Caution:**
Promoting a label is a permanent action, and cannot be reversed. Promoting a label is a permanent action, and cannot be reversed.
To promote a project label to a group label: To promote a project label to a group label:
......
...@@ -25,9 +25,11 @@ For a commit or tag to be *verified* by GitLab: ...@@ -25,9 +25,11 @@ For a commit or tag to be *verified* by GitLab:
which is usually up to three years. which is usually up to three years.
- The signing time is equal or later then commit time. - The signing time is equal or later then commit time.
NOTE: **Note:** Certificate revocation lists are checked on a daily basis via background worker. NOTE: **Note:**
Certificate revocation lists are checked on a daily basis via background worker.
NOTE: **Note:** Self signed certificates without `authorityKeyIdentifier`, NOTE: **Note:**
Self signed certificates without `authorityKeyIdentifier`,
`subjectKeyIdentifier`, and `crlDistributionPoints` are not supported. We `subjectKeyIdentifier`, and `crlDistributionPoints` are not supported. We
recommend using certificates from a PKI that are in line with recommend using certificates from a PKI that are in line with
[RFC 5280](https://tools.ietf.org/html/rfc5280). [RFC 5280](https://tools.ietf.org/html/rfc5280).
......
...@@ -41,7 +41,8 @@ The Web IDE currently provides: ...@@ -41,7 +41,8 @@ The Web IDE currently provides:
[JSON Schema Store](https://www.schemastore.org/json/). This feature [JSON Schema Store](https://www.schemastore.org/json/). This feature
is only supported for the `.gitlab-ci.yml` file. is only supported for the `.gitlab-ci.yml` file.
NOTE: **Note:** Validation support based on schemas is hidden behind NOTE: **Note:**
Validation support based on schemas is hidden behind
the feature flag `:schema_linting` on self-managed installations. To enable the the feature flag `:schema_linting` on self-managed installations. To enable the
feature, you can [turn on the feature flag in Rails console](../../../administration/feature_flags.md#how-to-enable-and-disable-features-behind-flags). feature, you can [turn on the feature flag in Rails console](../../../administration/feature_flags.md#how-to-enable-and-disable-features-behind-flags).
...@@ -232,7 +233,8 @@ terminal will block the job from finishing for the duration configured in ...@@ -232,7 +233,8 @@ terminal will block the job from finishing for the duration configured in
[`[session_server].session_timeout`](https://docs.gitlab.com/runner/configuration/advanced-configuration.html#the-session_server-section) [`[session_server].session_timeout`](https://docs.gitlab.com/runner/configuration/advanced-configuration.html#the-session_server-section)
until you close the terminal window. until you close the terminal window.
NOTE: **Note:** Not all executors are NOTE: **Note:**
Not all executors are
[supported](https://docs.gitlab.com/runner/executors/#compatibility-chart). [supported](https://docs.gitlab.com/runner/executors/#compatibility-chart).
The [File Sync](#file-syncing-to-web-terminal) feature is supported on Kubernetes runners only. The [File Sync](#file-syncing-to-web-terminal) feature is supported on Kubernetes runners only.
......
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