From cacf91a9d6c8350c511a26a9ae16a6a2523fd146 Mon Sep 17 00:00:00 2001
From: Marcel Amirault <mamirault@gitlab.com>
Date: Sat, 18 Jan 2025 23:25:40 +0900
Subject: [PATCH] Update self-managed phrasing in CI docs
The offering is called GitLab Self-Managed in all cases
---
.../settings/continuous_integration.md | 4 ++--
doc/ci/components/index.md | 18 +++++++++---------
doc/ci/debugging.md | 2 +-
doc/ci/index.md | 2 +-
doc/ci/jobs/ci_job_token.md | 2 +-
doc/ci/jobs/job_artifacts.md | 2 +-
doc/ci/migration/bamboo.md | 8 ++++----
doc/ci/migration/jenkins.md | 5 ++++-
doc/ci/pipelines/compute_minutes.md | 4 ++--
doc/ci/pipelines/index.md | 2 +-
doc/ci/runners/runners_scope.md | 4 ++--
.../code_quality_codeclimate_scanning.md | 2 +-
doc/ci/variables/index.md | 2 +-
doc/ci/yaml/artifacts_reports.md | 4 ++--
doc/ci/yaml/includes.md | 2 +-
doc/ci/yaml/index.md | 4 ++--
16 files changed, 35 insertions(+), 32 deletions(-)
diff --git a/doc/administration/settings/continuous_integration.md b/doc/administration/settings/continuous_integration.md
index b3293bcb524be..d94e5091774f2 100644
--- a/doc/administration/settings/continuous_integration.md
+++ b/doc/administration/settings/continuous_integration.md
@@ -237,13 +237,13 @@ a job artifact served by GitLab Pages. This page warns about the potential for
malicious user-generated content, as described in
[issue 352611](https://gitlab.com/gitlab-org/gitlab/-/issues/352611).
-Self-managed administrators can disable the external redirect warning page,
+GitLab Self-Managed administrators can disable the external redirect warning page,
so you can view job artifact pages directly:
1. On the left sidebar, at the bottom, select **Admin**.
1. Select **Settings > CI/CD**.
1. Expand **Continuous Integration and Deployment**.
-1. Deselect **Enable the external redirect page for job artifacts**.
+1. Clear **Enable the external redirect page for job artifacts**.
## Archive jobs
diff --git a/doc/ci/components/index.md b/doc/ci/components/index.md
index d2a2f12dac94b..f7d2643a3855d 100644
--- a/doc/ci/components/index.md
+++ b/doc/ci/components/index.md
@@ -163,8 +163,8 @@ could extend the wrong configuration. Make sure your pipeline and the component
any configuration with the same name, unless you intend to [override](../yaml/includes.md#override-included-configuration-values)
the component's configuration.
-To use GitLab.com components in a self-managed instance, you must
-[mirror the component project](#use-a-gitlabcom-component-in-a-self-managed-instance).
+To use GitLab.com components on a GitLab Self-Managed instance, you must
+[mirror the component project](#use-a-gitlabcom-component-on-gitlab-self-managed).
WARNING:
If a component requires the use of tokens, passwords, or other sensitive data to function,
@@ -364,16 +364,16 @@ full URL and path for your instance (like `https://gitlab.com/api/v4`).
These [predefined variables](../variables/predefined_variables.md)
ensure that your component also works when used on another instance, for example when using
-[a GitLab.com component in a self-managed instance](#use-a-gitlabcom-component-in-a-self-managed-instance).
+[a GitLab.com component on a GitLab Self-Managed instance](#use-a-gitlabcom-component-on-gitlab-self-managed).
### Do not assume API resources are always public
-Ensure that the component and its testing pipeline work also [in a self-managed instance](#use-a-gitlabcom-component-in-a-self-managed-instance).
+Ensure that the component and its testing pipeline work also [on GitLab Self-Managed](#use-a-gitlabcom-component-on-gitlab-self-managed).
While some API resources of public projects on GitLab.com could be accessed via unauthenticated requests
-on self-managed a component project could be mirrored as private or internal project.
+on a GitLab Self-Managed instance a component project could be mirrored as private or internal project.
It's important that an access token can optionally be provided via inputs or variables to
-authenticate requests on self-managed instances.
+authenticate requests on GitLab Self-Managed instances.
### Avoid using global keywords
@@ -719,7 +719,7 @@ can be converted to a CI/CD component:
You can learn more by following a practical example for [migrating the Go CI/CD template to CI/CD component](examples.md#cicd-component-migration-example-go).
-## Use a GitLab.com component in a self-managed instance
+## Use a GitLab.com component on GitLab Self-Managed
DETAILS:
**Tier:** Premium, Ultimate
@@ -729,9 +729,9 @@ The CI/CD catalog of a fresh install of a GitLab instance starts with no publish
To populate your instance's catalog, you can:
- [Publish your own components](#publish-a-component-project).
-- Mirror components from GitLab.com in your self-managed instance.
+- Mirror components from GitLab.com in your GitLab Self-Managed instance.
-To mirror a GitLab.com component in your self-managed instance:
+To mirror a GitLab.com component in your GitLab Self-Managed instance:
1. Make sure that [network outbound requests](../../security/webhooks.md) are allowed for `gitlab.com`.
1. [Create a group](../../user/group/index.md#create-a-group) to host the component projects (recommended group: `components`).
diff --git a/doc/ci/debugging.md b/doc/ci/debugging.md
index ef00a560bb12f..97c0c0992419b 100644
--- a/doc/ci/debugging.md
+++ b/doc/ci/debugging.md
@@ -427,7 +427,7 @@ To reduce the configuration size, you can:
- Use [parent and child pipelines](pipelines/downstream_pipelines.md#parent-child-pipelines) to move some
work to jobs in an independent child pipeline.
-On a self-managed instance, you can [increase the size limits](../administration/instance_limits.md#maximum-size-and-depth-of-cicd-configuration-yaml-files).
+On GitLab Self-Managed, you can [increase the size limits](../administration/instance_limits.md#maximum-size-and-depth-of-cicd-configuration-yaml-files).
### `500` error when editing the `.gitlab-ci.yml` file
diff --git a/doc/ci/index.md b/doc/ci/index.md
index 95b941d809ccf..3d5790a39d11e 100644
--- a/doc/ci/index.md
+++ b/doc/ci/index.md
@@ -52,7 +52,7 @@ runners on GitLab.com if you'd like.
If you don't use GitLab.com, you can:
-- Register runners or use runners already registered for your self-managed instance.
+- Register runners or use runners already registered for your GitLab Self-Managed instance.
- Create a runner on your local machine.
For more information, see:
diff --git a/doc/ci/jobs/ci_job_token.md b/doc/ci/jobs/ci_job_token.md
index 832b2c3f7d31f..1d2a8f6ad153b 100644
--- a/doc/ci/jobs/ci_job_token.md
+++ b/doc/ci/jobs/ci_job_token.md
@@ -87,7 +87,7 @@ project's pipeline:
If your project is public or internal, some publicly accessible resources can be accessed
with a job token from any project. These resources can also be [limited to only projects on the allowlist](#limit-job-token-scope-for-public-or-internal-projects).
-Self-managed instance administrators can [override and enforce this setting](../../administration/settings/continuous_integration.md#job-token-permissions).
+GitLab Self-Managed administrators can [override and enforce this setting](../../administration/settings/continuous_integration.md#job-token-permissions).
When the setting is enforced, the CI/CD job token is always restricted to the project's allowlist.
### Add a group or project to the job token allowlist
diff --git a/doc/ci/jobs/job_artifacts.md b/doc/ci/jobs/job_artifacts.md
index a0e18fcf7ac3d..7726444fe3481 100644
--- a/doc/ci/jobs/job_artifacts.md
+++ b/doc/ci/jobs/job_artifacts.md
@@ -402,5 +402,5 @@ After disabling this setting, all new artifacts expire according to the `expire_
Artifacts in old pipelines continue to be kept until a new pipeline runs for the same ref.
Then the artifacts in the earlier pipeline for that ref are allowed to expire too.
-You can disable this behavior for all projects on a self-managed instance in the
+You can disable this behavior for all projects on GitLab Self-Managed in the
[instance's CI/CD settings](../../administration/settings/continuous_integration.md#keep-the-latest-artifacts-for-all-jobs-in-the-latest-successful-pipelines).
diff --git a/doc/ci/migration/bamboo.md b/doc/ci/migration/bamboo.md
index 01832a183330d..a7ee9416f2355 100644
--- a/doc/ci/migration/bamboo.md
+++ b/doc/ci/migration/bamboo.md
@@ -29,11 +29,11 @@ pre-configured features and integrations.
### Offerings
-Atlassian offers Bamboo in its Cloud (SaaS) or Data center (Self-managed) options.
+Atlassian offers Bamboo in its Cloud (SaaS) or Data center (self-hosted) options.
A third Server option is scheduled for [EOL on February 15, 2024](https://about.gitlab.com/blog/2023/09/26/atlassian-server-ending-move-to-a-single-devsecops-platform/).
-These options are similar to GitLab [SaaS](../../subscriptions/gitlab_com/index.md)
-and [Self-Managed](../../subscriptions/self_managed/index.md). GitLab also offers
+These options are similar to [GitLab.com](../../subscriptions/gitlab_com/index.md)
+and [GitLab Self-Managed](../../subscriptions/self_managed/index.md). GitLab also offers
[GitLab Dedicated](../../subscriptions/gitlab_dedicated/index.md), a fully isolated
single-tenant SaaS service.
@@ -46,7 +46,7 @@ remote agents running external to the server.
GitLab uses a similar concept to agents called [runners](https://docs.gitlab.com/runner/)
which use [executors](https://docs.gitlab.com/runner/executors/) to run builds.
-Examples of executors are shell, Docker, or Kubernetes. You can choose to use GitLab [SaaS runners](../runners/index.md)
+Examples of executors are shell, Docker, or Kubernetes. You can choose to use [GitLab.com runners](../runners/index.md)
or deploy your own [self-managed runners](https://docs.gitlab.com/runner/install/index.html).
### Workflow
diff --git a/doc/ci/migration/jenkins.md b/doc/ci/migration/jenkins.md
index 7219665840ff7..0001a8211cc3e 100644
--- a/doc/ci/migration/jenkins.md
+++ b/doc/ci/migration/jenkins.md
@@ -26,7 +26,10 @@ Additionally, there are some important differences between the two:
- GitLab CI/CD pipelines are all configured in a YAML format configuration file.
Jenkins uses either a Groovy format configuration file (declarative pipelines)
or Jenkins DSL (scripted pipelines).
-- GitLab can run either on SaaS (cloud) or self-managed deployments. Jenkins deployments must be self-managed.
+- GitLab offers [GitLab.com](../../subscriptions/gitlab_com/index.md), a multi-tenant SaaS service,
+ and [GitLab Dedicated](../../subscriptions/gitlab_dedicated/index.md), a fully isolated
+ single-tenant SaaS service. You can also run your own [GitLab Self-Managed](../../subscriptions/self_managed/index.md)
+ instance. Jenkins deployments must be self-hosted.
- GitLab provides source code management (SCM) out of the box. Jenkins requires a separate
SCM solution to store code.
- GitLab provides a built-in container registry. Jenkins requires a separate solution
diff --git a/doc/ci/pipelines/compute_minutes.md b/doc/ci/pipelines/compute_minutes.md
index 48eab1bb5fecd..d91cbf5aee5f2 100644
--- a/doc/ci/pipelines/compute_minutes.md
+++ b/doc/ci/pipelines/compute_minutes.md
@@ -30,7 +30,7 @@ On GitLab.com:
- You can [purchase additional compute minutes](../../subscriptions/gitlab_com/compute_minutes.md)
if you need more than the amount of compute in your monthly quota.
-Compute quotas [are disabled by default on self-managed instances](../../administration/cicd/compute_minutes.md).
+Compute quotas [are disabled by default on GitLab Self-Managed](../../administration/cicd/compute_minutes.md).
## View compute usage
@@ -140,7 +140,7 @@ The default cost factors for jobs running on instance runners on GitLab.com are:
- Discounted dynamically for [community contributions to GitLab projects](#community-contributions-to-gitlab-projects).
- Increased if you use [different types of instance runners](#gitlab-hosted-runner-cost-factors).
-The cost factors on self-managed instances [are different](../../administration/cicd/compute_minutes.md).
+The cost factors on GitLab Self-Managed [are different](../../administration/cicd/compute_minutes.md).
#### Community contributions to GitLab projects
diff --git a/doc/ci/pipelines/index.md b/doc/ci/pipelines/index.md
index fdfb81ed62f75..2910b018fc665 100644
--- a/doc/ci/pipelines/index.md
+++ b/doc/ci/pipelines/index.md
@@ -297,7 +297,7 @@ To trigger the pipeline when the upstream project is rebuilt:
1. Select **Subscribe**.
The maximum number of upstream pipeline subscriptions is 2 by default, for both the upstream and
-downstream projects. On self-managed instances, an administrator can change this
+downstream projects. On GitLab Self-Managed, an administrator can change this
[limit](../../administration/instance_limits.md#number-of-cicd-subscriptions-to-a-project).
<!--- end_remove -->
diff --git a/doc/ci/runners/runners_scope.md b/doc/ci/runners/runners_scope.md
index 7fab59b7d3bc3..1b81175935cb1 100644
--- a/doc/ci/runners/runners_scope.md
+++ b/doc/ci/runners/runners_scope.md
@@ -25,7 +25,7 @@ Use instance runners when you have multiple jobs with similar requirements. Rath
having multiple runners idling for many projects, you can have a few runners that handle
multiple projects.
-If you are using a self-managed instance of GitLab, administrators can:
+If you are using GitLab Self-Managed, administrators can:
- [Install GitLab Runner](https://docs.gitlab.com/runner/install/index.html) and register an instance runner.
- Configure a maximum number of instance runner [compute minutes for each group](../../administration/cicd/compute_minutes.md#set-the-compute-quota-for-a-group).
@@ -134,7 +134,7 @@ To delete a single or multiple instance runners:
On GitLab.com, [instance runners](index.md) are enabled in all projects by
default.
-On self-managed instances of GitLab, an administrator can
+On GitLab Self-Managed, an administrator can
[enable them for all new projects](../../administration/settings/continuous_integration.md#enable-instance-runners-for-new-projects).
For existing projects, an administrator must
diff --git a/doc/ci/testing/code_quality_codeclimate_scanning.md b/doc/ci/testing/code_quality_codeclimate_scanning.md
index a9b81397e1d9a..b8148365446d2 100644
--- a/doc/ci/testing/code_quality_codeclimate_scanning.md
+++ b/doc/ci/testing/code_quality_codeclimate_scanning.md
@@ -55,7 +55,7 @@ To enable Code Quality, either:
Code Quality now runs in pipelines.
WARNING:
-On self-managed instances, if a malicious actor compromises the Code Quality job definition they
+On GitLab Self-Managed, if a malicious actor compromises the Code Quality job definition they
could execute privileged Docker commands on the runner host. Having proper access control policies
mitigates this attack vector by allowing access only to trusted actors.
diff --git a/doc/ci/variables/index.md b/doc/ci/variables/index.md
index 703bca30ea950..b929c1836391b 100644
--- a/doc/ci/variables/index.md
+++ b/doc/ci/variables/index.md
@@ -849,7 +849,7 @@ to set `ci_pipeline_variables_minimum_override_role` to one of:
- `owner`: Only users with the Owner role can run pipelines with pipeline variables.
You must have the Owner role for the project to change the setting to this value.
- `maintainer`: Only users with at least the Maintainer role can run pipelines with pipeline variables.
- Default when not specified on self-managed and Dedicated.
+ Default when not specified on GitLab Self-Managed and GitLab Dedicated.
- `developer`: Only users with at least the Developer role can run pipelines with pipeline variables.
## Exporting variables
diff --git a/doc/ci/yaml/artifacts_reports.md b/doc/ci/yaml/artifacts_reports.md
index 5abb6ea219ad2..cf4a96efa42a2 100644
--- a/doc/ci/yaml/artifacts_reports.md
+++ b/doc/ci/yaml/artifacts_reports.md
@@ -269,10 +269,10 @@ The exceptions to the [original dotenv rules](https://github.com/motdotla/dotenv
- The variable key can contain only letters, digits, and underscores (`_`).
- The maximum size of the `.env` file is 5 KB.
- This limit [can be changed on self-managed instances](../../administration/instance_limits.md#limit-dotenv-file-size).
+ This limit [can be changed on GitLab Self-Managed](../../administration/instance_limits.md#limit-dotenv-file-size).
- On GitLab.com, [the maximum number of inherited variables](../../user/gitlab_com/index.md#gitlab-cicd)
is 50 for Free, 100 for Premium and 150 for Ultimate. The default for
- self-managed instances is 20, and can be changed by changing the
+ GitLab Self-Managed is 20, and can be changed by changing the
`dotenv_variables` [application limit](../../administration/instance_limits.md#limit-dotenv-variables).
- Variable substitution in the `.env` file is not supported.
- [Multiline values in the `.env` file](https://github.com/motdotla/dotenv#multiline-values) are not supported.
diff --git a/doc/ci/yaml/includes.md b/doc/ci/yaml/includes.md
index 168123b57091f..8e311dc7ea539 100644
--- a/doc/ci/yaml/includes.md
+++ b/doc/ci/yaml/includes.md
@@ -630,7 +630,7 @@ with the [pipeline editor](../pipeline_editor/index.md), which validates if the
limit is reached. You can remove one included file at a time to try to narrow down
which configuration file is the source of the loop or excessive included files.
-In [GitLab 16.0 and later](https://gitlab.com/gitlab-org/gitlab/-/issues/207270) self-managed users can
+In [GitLab 16.0 and later](https://gitlab.com/gitlab-org/gitlab/-/issues/207270) users on GitLab Self-Managed can
change the [maximum includes](../../administration/settings/continuous_integration.md#maximum-includes) value.
### `SSL_connect SYSCALL returned=5 errno=0 state=SSLv3/TLS write client hello` and other network failures
diff --git a/doc/ci/yaml/index.md b/doc/ci/yaml/index.md
index 197baab5debd2..e11fc6772a26f 100644
--- a/doc/ci/yaml/index.md
+++ b/doc/ci/yaml/index.md
@@ -194,7 +194,7 @@ And optionally:
- Pipeline, the `include` files are fetched again. If they changed after the last
pipeline run, the new pipeline uses the changed configuration.
- You can have up to 150 includes per pipeline by default, including [nested](includes.md#use-nested-includes). Additionally:
- - In [GitLab 16.0 and later](https://gitlab.com/gitlab-org/gitlab/-/issues/207270) self-managed users can
+ - In [GitLab 16.0 and later](https://gitlab.com/gitlab-org/gitlab/-/issues/207270) users on GitLab Self-Managed can
change the [maximum includes](../../administration/settings/continuous_integration.md#maximum-includes) value.
- In [GitLab 15.10 and later](https://gitlab.com/gitlab-org/gitlab/-/issues/367150) you can have up to 150 includes.
In nested includes, the same file can be included multiple times, but duplicated includes
@@ -3072,7 +3072,7 @@ This example creates four paths of execution:
- The maximum number of jobs that a single job can have in the `needs` array is limited:
- For GitLab.com, the limit is 50. For more information, see
[issue 350398](https://gitlab.com/gitlab-org/gitlab/-/issues/350398).
- - For self-managed instances, the default limit is 50. This limit [can be changed](../../administration/cicd/index.md#set-the-needs-job-limit).
+ - For GitLab Self-Managed, the default limit is 50. This limit [can be changed](../../administration/cicd/index.md#set-the-needs-job-limit).
- If `needs` refers to a job that uses the [`parallel`](#parallel) keyword,
it depends on all jobs created in parallel, not just one job. It also downloads
artifacts from all the parallel jobs by default. If the artifacts have the same
--
GitLab