Commit 91c06e00 authored by Craig Norris's avatar Craig Norris

Remove notes from docs

Remove unneeded notes from product docs.
parent b5d29112
...@@ -17,12 +17,9 @@ a service networking solution that you can manage by using `/etc/gitlab/gitlab.r ...@@ -17,12 +17,9 @@ a service networking solution that you can manage by using `/etc/gitlab/gitlab.r
## Configure the Consul nodes ## Configure the Consul nodes
NOTE: **Important:** After you review the [reference architecture](reference_architectures/index.md#available-reference-architectures)
Before proceeding, refer to the documentation to determine the number of Consul server nodes you should have,
[available reference architectures](reference_architectures/index.md#available-reference-architectures) on _each_ Consul server node:
to find out how many Consul server nodes you should have.
On **each** Consul server node perform the following:
1. Follow the instructions to [install](https://about.gitlab.com/install/) 1. Follow the instructions to [install](https://about.gitlab.com/install/)
GitLab by choosing your preferred platform, but do not supply the GitLab by choosing your preferred platform, but do not supply the
...@@ -93,10 +90,9 @@ Consult the [troubleshooting section](#troubleshooting-consul) if the cluster is ...@@ -93,10 +90,9 @@ Consult the [troubleshooting section](#troubleshooting-consul) if the cluster is
able to recover after the upgrade. The [outage recovery](#outage-recovery) may able to recover after the upgrade. The [outage recovery](#outage-recovery) may
be of particular interest. be of particular interest.
NOTE: **Note:** GitLab uses Consul to store only easily regenerated, transient data. If the
GitLab uses Consul to store only transient data that is easily regenerated. If bundled Consul wasn't used by any process other than GitLab itself, you can
the bundled Consul was not used by any process other than GitLab itself, then [rebuild the cluster from scratch](#recreate-from-scratch).
[rebuilding the cluster from scratch](#recreate-from-scratch) is fine.
## Troubleshooting Consul ## Troubleshooting Consul
......
...@@ -179,7 +179,6 @@ Plan.default.actual_limits.update!(project_hooks: 100) ...@@ -179,7 +179,6 @@ 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. Set the limit to `0` to disable it.
## Incoming emails from auto-responders ## Incoming emails from auto-responders
...@@ -217,7 +216,6 @@ Plan.default.actual_limits.update!(offset_pagination_limit: 10000) ...@@ -217,7 +216,6 @@ 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. Set the limit to `0` to disable it.
## CI/CD limits ## CI/CD limits
...@@ -250,7 +248,6 @@ To set this limit on a self-managed installation, run the following in the ...@@ -250,7 +248,6 @@ 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. Set the limit to `0` to disable it.
### Number of CI/CD subscriptions to a project ### Number of CI/CD subscriptions to a project
...@@ -273,7 +270,6 @@ To set this limit on a self-managed installation, run the following in the ...@@ -273,7 +270,6 @@ 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. Set the limit to `0` to disable it.
### Number of pipeline schedules ### Number of pipeline schedules
...@@ -462,11 +458,10 @@ Setting a limit helps reduce the memory usage of the indexing processes as well ...@@ -462,11 +458,10 @@ Setting a limit helps reduce the memory usage of the indexing processes as well
as the overall index size. This value defaults to `1024 KiB` (1 MiB) as any as the overall index size. This value defaults to `1024 KiB` (1 MiB) as any
text files larger than this likely aren't meant to be read by humans. text files larger than this likely aren't meant to be read by humans.
NOTE: **Note:** You must set a limit, as unlimited file sizes aren't supported. Setting this
You must set a limit, as an unlimited file size is not supported. Setting this value to be greater than the amount of memory on GitLab's Sidekiq nodes causes
value to be greater than the amount of memory on GitLab's Sidekiq nodes will GitLab's Sidekiq nodes to run out of memory, as they will pre-allocate this
lead to GitLab's Sidekiq nodes running out of memory as they will pre-allocate amount of memory during indexing.
this amount of memory during indexing.
### Maximum field length ### Maximum field length
...@@ -486,7 +481,6 @@ indexed](#maximum-file-size-indexed)). ...@@ -486,7 +481,6 @@ indexed](#maximum-file-size-indexed)).
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-advanced-search). Elasticsearch](../integration/elasticsearch.md#enabling-advanced-search).
NOTE: **Note:**
Set the limit to `0` to disable it. Set the limit to `0` to disable it.
## Wiki limits ## Wiki limits
......
...@@ -19,11 +19,10 @@ From GitLab 13.0, using NFS for Git repositories is deprecated. In GitLab 14.0, ...@@ -19,11 +19,10 @@ 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 can impact overall GitLab performance, especially for
Filesystem performance has a big impact on overall GitLab actions that read or write to Git repositories. For steps you can use to test
performance, especially for actions that read or write to Git repositories. See filesystem performance, see
[Filesystem Performance Benchmarking](operations/filesystem_benchmarking.md) [Filesystem Performance Benchmarking](operations/filesystem_benchmarking.md).
for steps to test filesystem performance.
## Known kernel version incompatibilities ## Known kernel version incompatibilities
......
...@@ -61,18 +61,17 @@ must be enabled, only the following providers can be used: ...@@ -61,18 +61,17 @@ must be enabled, only the following providers can be used:
- [Google Cloud Storage](#google-cloud-storage-gcs) - [Google Cloud Storage](#google-cloud-storage-gcs)
- [Azure Blob storage](#azure-blob-storage) - [Azure Blob storage](#azure-blob-storage)
Background upload is not supported with the consolidated object storage Background upload isn't supported with the consolidated object storage
configuration. We recommend enabling direct upload mode because it does configuration. We recommend enabling direct upload mode because it doesn't
not require a shared folder, and [this setting may become the require a shared folder, and [this setting may become the
default](https://gitlab.com/gitlab-org/gitlab/-/issues/27331). default](https://gitlab.com/gitlab-org/gitlab/-/issues/27331).
NOTE: **Note:** Consolidated object storage configuration can't be used for backups or
Consolidated object storage configuration cannot be used for 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).
NOTE: **Note:** Enabling consolidated object storage enables object storage for all object
Enabling consolidated object storage will enable object storage for all object types. types. If you want to use local storage for specific object types, you can
If you wish to use local storage for specific object types, you can [selectively disable object storages](#selectively-disabling-object-storage). [selectively disable object storages](#selectively-disabling-object-storage).
Most types of objects, such as CI artifacts, LFS files, upload Most types of objects, such as CI artifacts, LFS files, upload
attachments, and so on can be saved in object storage by specifying a single attachments, and so on can be saved in object storage by specifying a single
...@@ -347,10 +346,9 @@ gitlab_rails['object_store']['connection'] = { ...@@ -347,10 +346,9 @@ gitlab_rails['object_store']['connection'] = {
###### Azure Workhorse settings (source installs only) ###### Azure Workhorse settings (source installs only)
NOTE: **Note:** For source installations, Workhorse also needs to be configured with Azure
For source installations, Workhorse needs to be configured with the credentials. This isn't needed in Omnibus installs, because the Workhorse
Azure credentials as well. This is not needed in Omnibus installs because settings are populated from the previous settings.
the Workhorse settings are populated from the settings above.
1. Edit `/home/git/gitlab-workhorse/config.toml` and add or amend the following lines: 1. Edit `/home/git/gitlab-workhorse/config.toml` and add or amend the following lines:
...@@ -370,14 +368,14 @@ GitLab Rails and Workhorse. ...@@ -370,14 +368,14 @@ GitLab Rails and Workhorse.
#### OpenStack-compatible connection settings #### OpenStack-compatible connection settings
NOTE: **Note:** Although OpenStack Swift provides S3 compatibility, some users may want to use
This is not compatible with the consolidated object storage form. the [Swift API](https://docs.openstack.org/swift/latest/api/object_api_v1_overview.html).
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.
While OpenStack Swift provides S3 compatibility, some users may want to use the This isn't compatible with the consolidated object storage form. OpenStack Swift
[Swift API](https://docs.openstack.org/swift/latest/api/object_api_v1_overview.html). is supported only with the storage-specific form. If you want to use the
Here are the valid connection settings below for the Swift API, provided by consolidated form, see the [S3 settings](#s3-compatible-connection-settings).
Here are the valid connection settings for the Swift API, provided by
[fog-openstack](https://github.com/fog/fog-openstack): [fog-openstack](https://github.com/fog/fog-openstack):
| Setting | Description | Default | | Setting | Description | Default |
...@@ -392,12 +390,11 @@ Here are the valid connection settings below for the Swift API, provided by ...@@ -392,12 +390,11 @@ Here are the valid connection settings below for the Swift API, provided by
#### Rackspace Cloud Files #### Rackspace Cloud Files
NOTE: **Note:** The following table describes the valid connection parameters for
This is not compatible with the consolidated object Rackspace Cloud, provided by [fog-rackspace](https://github.com/fog/fog-rackspace/).
storage form. Rackspace Cloud is only supported with the storage-specific form.
Here are the valid connection parameters for Rackspace Cloud, provided by This isn't compatible with the consolidated object storage form.
[fog-rackspace](https://github.com/fog/fog-rackspace/): Rackspace Cloud is supported only with the storage-specific form.
| Setting | Description | example | | Setting | Description | example |
|---------|-------------|---------| |---------|-------------|---------|
...@@ -407,13 +404,13 @@ Here are the valid connection parameters for Rackspace Cloud, provided by ...@@ -407,13 +404,13 @@ Here are the valid connection parameters for Rackspace Cloud, provided by
| `rackspace_region` | The Rackspace storage region to use, a three letter code from the [list of service access endpoints](https://developer.rackspace.com/docs/cloud-files/v1/general-api-info/service-access/) | `iad` | | `rackspace_region` | The Rackspace storage region to use, a three letter code from the [list of service access endpoints](https://developer.rackspace.com/docs/cloud-files/v1/general-api-info/service-access/) | `iad` |
| `rackspace_temp_url_key` | The private key you have set in the Rackspace API for [temporary URLs](https://developer.rackspace.com/docs/cloud-files/v1/use-cases/public-access-to-your-cloud-files-account/#tempurl). | `ABC123DEF456ABC123DEF456ABC123DE` | | `rackspace_temp_url_key` | The private key you have set in the Rackspace API for [temporary URLs](https://developer.rackspace.com/docs/cloud-files/v1/use-cases/public-access-to-your-cloud-files-account/#tempurl). | `ABC123DEF456ABC123DEF456ABC123DE` |
NOTE: **Note:** Regardless of whether the container has public access enabled or disabled, Fog
Regardless of whether the container has public access enabled or disabled, Fog will uses the TempURL method to grant access to LFS objects. If you see error
use the TempURL method to grant access to LFS objects. If you see errors in logs referencing messages in logs that refer to instantiating storage with a `temp-url-key`,
instantiating storage with a `temp-url-key`, ensure that you have set the key properly be sure you have set the key properly both in the Rackspace API and in
on the Rackspace API and in `gitlab.rb`. You can verify the value of the key Rackspace `gitlab.rb`. You can verify the value of the key Rackspace has set by sending a
has set by sending a GET request with token header to the service access endpoint URL GET request with token header to the service access endpoint URL and comparing
and comparing the output of the returned headers. the output of the returned headers.
### Object-specific configuration ### Object-specific configuration
...@@ -521,15 +518,16 @@ gitlab_rails['uploads_object_store_remote_directory'] = 'uploads' ...@@ -521,15 +518,16 @@ gitlab_rails['uploads_object_store_remote_directory'] = 'uploads'
gitlab_rails['uploads_object_store_connection'] = { 'provider' => 'AWS', 'aws_access_key_id' => 'access_key', 'aws_secret_access_key' => 'secret' } gitlab_rails['uploads_object_store_connection'] = { 'provider' => 'AWS', 'aws_access_key_id' => 'access_key', 'aws_secret_access_key' => 'secret' }
``` ```
While this provides flexibility in that it makes it possible for GitLab Although this provides flexibility in that it makes it possible for GitLab
to store objects across different cloud providers, it also creates to store objects across different cloud providers, it also creates
additional complexity and unnecessary redundancy. Since both GitLab 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 used _only_ if all lines from
The consolidated object storage configuration is **only** used if all the original form is omitted. To move to the consolidated form, remove the
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.) original configuration (for example, `artifacts_object_store_enabled`, or
`uploads_object_store_connection`)
## Storage-specific configuration ## Storage-specific configuration
......
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