diff --git a/app/views/shared/runners/_shared_runners_description.html.haml b/app/views/shared/runners/_shared_runners_description.html.haml index 89da1a6fa0944b5226ac2e0f1269924f8b723662..a3d44f33ae14febb21d16b89ad7aa7e0a8a28b20 100644 --- a/app/views/shared/runners/_shared_runners_description.html.haml +++ b/app/views/shared/runners/_shared_runners_description.html.haml @@ -1,4 +1,4 @@ -- shared_link_start = '<a href="%{url}" target="_blank" rel="noopener noreferrer">'.html_safe % { url: help_page_path('ci/runners/runners_scope', anchor: 'shared-runners') } +- shared_link_start = '<a href="%{url}" target="_blank" rel="noopener noreferrer">'.html_safe % { url: help_page_path('ci/runners/runners_scope', anchor: 'instance-runners') } %h4 = _('Shared runners') diff --git a/doc/administration/cicd.md b/doc/administration/cicd.md index 040fe843355443a378a479828ab6c5314ad7827c..5c99e2ed497d4777605f6717279639e443e81c60 100644 --- a/doc/administration/cicd.md +++ b/doc/administration/cicd.md @@ -105,18 +105,18 @@ to a cron value of `0 */12 * * *` (`00:00` and `12:00` every day). You can disable some important but computationally expensive parts of the application to relieve stress on the database during ongoing downtime. -### Disable fair scheduling on shared runners +### Disable fair scheduling on instance runners When clearing a large backlog of jobs, you can temporarily enable the `ci_queueing_disaster_recovery_disable_fair_scheduling` [feature flag](../administration/feature_flags.md). This flag disables fair scheduling -on shared runners, which reduces system resource usage on the `jobs/request` endpoint. +on instance runners, which reduces system resource usage on the `jobs/request` endpoint. When enabled, jobs are processed in the order they were put in the system, instead of balanced across many projects. ### Disable compute quota enforcement -To disable the enforcement of [compute quotas](../ci/pipelines/cicd_minutes.md) on shared runners, you can temporarily +To disable the enforcement of [compute quotas](../ci/pipelines/cicd_minutes.md) on instance runners, you can temporarily enable the `ci_queueing_disaster_recovery_disable_quota` [feature flag](../administration/feature_flags.md). This flag reduces system resource usage on the `jobs/request` endpoint. diff --git a/doc/administration/pages/index.md b/doc/administration/pages/index.md index a17b05bc8c2db37169b1d04663414cdcf713dfe8..ca9a21a375277f80e225659caee4359affcdfa0e 100644 --- a/doc/administration/pages/index.md +++ b/doc/administration/pages/index.md @@ -60,7 +60,7 @@ Before proceeding with the Pages configuration, you must: 1. Configure a **wildcard DNS record**. 1. Optional. Have a **wildcard certificate** for that domain if you decide to serve Pages under HTTPS. -1. Optional but recommended. Enable [Shared runners](../../ci/runners/index.md) +1. Optional but recommended. Enable [instance runners](../../ci/runners/index.md) so that your users don't have to bring their own. 1. For custom domains, have a **secondary IP**. diff --git a/doc/administration/pages/source.md b/doc/administration/pages/source.md index 6e2ae56ec5cca3a9189fa113e015901e3a3c91ef..e33d1a47a8aa3cd4cbbacff18e094bc513f29ecb 100644 --- a/doc/administration/pages/source.md +++ b/doc/administration/pages/source.md @@ -60,7 +60,7 @@ Before proceeding with the Pages configuration, make sure that: Pages artifacts. - Optional. You have a **wildcard certificate** for the Pages domain if you decide to serve Pages (`*.example.io`) under HTTPS. -- Optional but recommended. You have configured and enabled the [shared runners](../../ci/runners/index.md) +- Optional but recommended. You have configured and enabled the [instance runners](../../ci/runners/index.md) so your users don't have to bring their own. ### DNS configuration diff --git a/doc/administration/settings/continuous_integration.md b/doc/administration/settings/continuous_integration.md index dfa0c499edb7987cf99a567b0250b3c98b810447..5a85357cf7d9448e674e998213a62a7db85a7c76 100644 --- a/doc/administration/settings/continuous_integration.md +++ b/doc/administration/settings/continuous_integration.md @@ -31,18 +31,18 @@ From now on, every existing project and newly created ones that don't have a If you want to disable it for a specific project, you can do so in [its settings](../../topics/autodevops/index.md#enable-or-disable-auto-devops). -## Enable shared runners for new projects +## Enable instance runners for new projects -You can set all new projects to have the instance's shared runners available by default. +You can set all new projects to have instance runners available by default. 1. On the left sidebar, at the bottom, select **Admin Area**. 1. Select **Settings > CI/CD**. 1. Expand **Continuous Integration and Deployment**. -1. Select the **Enable shared runners for new projects** checkbox. +1. Select the **Enable instance runners for new projects** checkbox. -Any time a new project is created, the shared runners are available. +Any time a new project is created, the instance runners are available. -## Shared runners compute quota +## Instance runners compute quota As an administrator you can set either a global or namespace-specific limit on the number of [compute minutes](../../ci/pipelines/cicd_minutes.md) you can use. @@ -62,17 +62,15 @@ To enable a project runner for more than one project: 1. To the left of the project, select **Enable**. 1. Repeat this process for each additional project. -## Add a message for shared runners +## Add a message for instance runners -To display details about the instance's shared runners in all projects' +To display details about the instance runners in all projects' runner settings: 1. On the left sidebar, at the bottom, select **Admin Area**. 1. Select **Settings > CI/CD**. 1. Expand **Continuous Integration and Deployment**. -1. Enter text, including Markdown if you want, in the **Shared runner details** field. For example: - -  +1. Enter text, including Markdown if you want, in the **Instance runner details** field. To view the rendered details: @@ -80,7 +78,7 @@ To view the rendered details: 1. Select **Settings > CI/CD**. 1. Expand **Runners**. - + ## Maximum artifacts size diff --git a/doc/administration/settings/img/continuous_integration_shared_runner_details_input_v14_10.png b/doc/administration/settings/img/continuous_integration_shared_runner_details_input_v14_10.png deleted file mode 100644 index 08451f3696274afd5293bde7babd4649a0a90aa7..0000000000000000000000000000000000000000 Binary files a/doc/administration/settings/img/continuous_integration_shared_runner_details_input_v14_10.png and /dev/null differ diff --git a/doc/api/runners.md b/doc/api/runners.md index 395221aff12da0e12302b1b161d72f5ad4aae940..2b24b1138218d2e8f7347c851f1846e083ce19ae 100644 --- a/doc/api/runners.md +++ b/doc/api/runners.md @@ -471,7 +471,7 @@ Example response: ## List project's runners -List all runners available in the project, including from ancestor groups and [any allowed shared runners](../ci/runners/runners_scope.md#enable-shared-runners-for-a-project). +List all runners available in the project, including from ancestor groups and [any allowed shared runners](../ci/runners/runners_scope.md#enable-instance-runners-for-a-project). ```plaintext GET /projects/:id/runners @@ -590,7 +590,7 @@ curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" "https://git ## List group's runners -List all runners available in the group as well as its ancestor groups, including [any allowed shared runners](../ci/runners/runners_scope.md#enable-shared-runners-for-a-group). +List all runners available in the group as well as its ancestor groups, including [any allowed shared runners](../ci/runners/runners_scope.md#enable-instance-runners-for-a-group). ```plaintext GET /groups/:id/runners diff --git a/doc/ci/caching/index.md b/doc/ci/caching/index.md index bc24bff890a72f4a04aef1deefc19383d84dce92..ee19104e5c8b0971c8de4cc765d2aed7d54cbb27 100644 --- a/doc/ci/caching/index.md +++ b/doc/ci/caching/index.md @@ -60,7 +60,7 @@ For runners to work with caches efficiently, you must do one of the following: - Use a single runner for all your jobs. - Use multiple runners that have [distributed caching](https://docs.gitlab.com/runner/configuration/autoscale.html#distributed-runners-caching), - where the cache is stored in S3 buckets. Shared runners on GitLab.com behave this way. These runners can be in autoscale mode, + where the cache is stored in S3 buckets. Instance runners on GitLab.com behave this way. These runners can be in autoscale mode, but they don't have to be. To manage cache objects, apply lifecycle rules to delete the cache objects after a period of time. Lifecycle rules are available on the object storage server. diff --git a/doc/ci/cloud_services/index.md b/doc/ci/cloud_services/index.md index fc327a0876d5f2c8c2acd32a570ef68280a0242d..a09498c7908641df5d2842ea3cda2cfeebb03429 100644 --- a/doc/ci/cloud_services/index.md +++ b/doc/ci/cloud_services/index.md @@ -50,7 +50,7 @@ review for the pipeline, focusing on the additional access. For more information - Removes the need to store secrets in your GitLab group or project. Temporary credentials can be retrieved from your cloud provider through OIDC. - Provides temporary access to cloud resources with granular GitLab conditionals including a group, project, branch, or tag. - Enables you to define separation of duties in the CI/CD job with conditional access to environments. Historically, apps may have been deployed with a designated GitLab Runner that had only access to staging or production environments. This led to Runner sprawl as each machine had dedicated permissions. -- Allows shared runners to securely access multiple cloud accounts. The access is determined by the JWT token, which is specific to the user running the pipeline. +- Allows instance runners to securely access multiple cloud accounts. The access is determined by the JWT token, which is specific to the user running the pipeline. - Removes the need to create logic to rotate secrets by retrieving temporary credentials by default. ## How it works diff --git a/doc/ci/docker/using_docker_build.md b/doc/ci/docker/using_docker_build.md index f71227ae23f77b9f36a9888a3aa8229959f83e3f..727ecc812f6a50e051871ff731e70cf1f9cd1375 100644 --- a/doc/ci/docker/using_docker_build.md +++ b/doc/ci/docker/using_docker_build.md @@ -92,7 +92,7 @@ The Docker image includes all of the `docker` tools and can run the job script in context of the image in privileged mode. You should use Docker-in-Docker with TLS enabled, -which is supported by [GitLab.com shared runners](../runners/index.md). +which is supported by [GitLab.com instance runners](../runners/index.md). You should always pin a specific version of the image, like `docker:24.0.5`. If you use a tag like `docker:latest`, you have no control over which version is used. @@ -638,7 +638,7 @@ When using Docker-in-Docker, Docker downloads all layers of your image every tim ## Use the OverlayFS driver NOTE: -The shared runners on GitLab.com use the `overlay2` driver by default. +The instance runners on GitLab.com use the `overlay2` driver by default. By default, when using `docker:dind`, Docker uses the `vfs` storage driver, which copies the file system on every run. You can avoid this disk-intensive operation by using a different driver, for example `overlay2`. diff --git a/doc/ci/docker/using_docker_images.md b/doc/ci/docker/using_docker_images.md index 47263e9f3988d73b2c68253f128a98c99ddc34af..25f2c4cff9dd6b2c2b8147f5e797e60394cd0a5a 100644 --- a/doc/ci/docker/using_docker_images.md +++ b/doc/ci/docker/using_docker_images.md @@ -228,7 +228,7 @@ To define which option should be used, the runner process reads the configuratio in GitLab Runner 13.1 and later. - [Credentials Store](#use-a-credentials-store) and [Credential Helpers](#use-credential-helpers) require binaries to be added to the GitLab Runner `$PATH`, and require access to do so. Therefore, - these features are not available on shared runners, or any other runner where the user does not + these features are not available on instance runners, or any other runner where the user does not have access to the environment where the runner is installed. ### Use statically-defined credentials diff --git a/doc/ci/docker/using_kaniko.md b/doc/ci/docker/using_kaniko.md index d042a08f406fcb80e6ef53653c1ab86a2e8a2b7e..c317c87fc8bb40cc8dc2730e761acbdfc66dc3a7 100644 --- a/doc/ci/docker/using_kaniko.md +++ b/doc/ci/docker/using_kaniko.md @@ -148,7 +148,7 @@ The [Least Privilege Container Builds with Kaniko on GitLab](https://www.youtube video is a walkthrough of the [Kaniko Docker Build](https://gitlab.com/guided-explorations/containers/kaniko-docker-build) Guided Exploration project pipeline. It was tested on: -- [GitLab.com shared runners](../runners/index.md) +- [GitLab.com instance runners](../runners/index.md) - [The Kubernetes runner executor](https://docs.gitlab.com/runner/executors/kubernetes.html) The example can be copied to your own group or instance for testing. More details diff --git a/doc/ci/examples/php.md b/doc/ci/examples/php.md index 5dc89148deb39db6a0f47f7712131adcb70c5c3f..0dd03c5a345ea168db175089ed6a99197f9472c4 100644 --- a/doc/ci/examples/php.md +++ b/doc/ci/examples/php.md @@ -273,7 +273,7 @@ gitlab-runner exec shell test:app We have set up an [Example PHP Project](https://gitlab.com/gitlab-examples/php) for your convenience that runs on [GitLab.com](https://gitlab.com) using our publicly available -[shared runners](../runners/index.md). +[instance runners](../runners/index.md). Want to hack on it? Fork it, commit, and push your changes. Within a few moments the changes are picked by a public runner and the job begins. diff --git a/doc/ci/interactive_web_terminal/index.md b/doc/ci/interactive_web_terminal/index.md index 7e17b564a68877df48fdcc53ec0b13d7aebe53d2..70358f372881f6550a8e7d2dcb4661ae73152ffe 100644 --- a/doc/ci/interactive_web_terminal/index.md +++ b/doc/ci/interactive_web_terminal/index.md @@ -20,7 +20,7 @@ is deployed, some [security precautions](../../administration/integration/termin taken to protect the users. NOTE: -[Shared runners on GitLab.com](../runners/index.md) do not +[Instance runners on GitLab.com](../runners/index.md) do not provide an interactive web terminal. Follow [this issue](https://gitlab.com/gitlab-org/gitlab/-/issues/24674) for progress on adding support. For groups and projects hosted on GitLab.com, interactive web diff --git a/doc/ci/migration/circleci.md b/doc/ci/migration/circleci.md index 9d20a16432c26f52e3f8cad9745e959b0a3748aa..df5cbc660e4b28bbd17dba0ae59ee206a2ad7fad 100644 --- a/doc/ci/migration/circleci.md +++ b/doc/ci/migration/circleci.md @@ -285,7 +285,7 @@ Self-managed runners: - Windows - macOS -GitLab.com shared runners: +GitLab.com instance runners: - Linux - [Windows](../runners/saas/windows_saas_runner.md) ([Beta](../../policy/experiment-beta-support.md#beta)). diff --git a/doc/ci/migration/examples/jenkins-maven.md b/doc/ci/migration/examples/jenkins-maven.md index 858f0272502fb1af594cb6d64850cfff0ea9c0ee..f7e58c51ed83884bfe4f701a4654a49b961aac10 100644 --- a/doc/ci/migration/examples/jenkins-maven.md +++ b/doc/ci/migration/examples/jenkins-maven.md @@ -159,7 +159,7 @@ It also increases flexibility for expanding and extending the functionality of t Prerequisites: - A GitLab Runner with the Docker executor that can be used by the project. - If you are using GitLab.com, you can use the public shared runners. + If you are using GitLab.com, you can use the public instance runners. This migrated pipeline configuration consists of three global keywords (`stages`, `default`, and `variables`) followed by 3 jobs. This configuration makes use of additional GitLab CI/CD features diff --git a/doc/ci/migration/github_actions.md b/doc/ci/migration/github_actions.md index a427227c92aaa25c98c0b2f8b561287363d82b0b..ed9a210fec4c7894d5032f43008d7c134458baa3 100644 --- a/doc/ci/migration/github_actions.md +++ b/doc/ci/migration/github_actions.md @@ -464,7 +464,7 @@ deploy_staging: #### Runners Runners are the services that execute jobs. If you are using GitLab.com, you can use the -[shared runner fleet](../runners/index.md) to run jobs without provisioning your own self-managed runners. +[instance runner fleet](../runners/index.md) to run jobs without provisioning your own self-managed runners. Some key details about runners: diff --git a/doc/ci/migration/jenkins.md b/doc/ci/migration/jenkins.md index 3783c476cdeda5b8f4ee388b8c3369b8508f3a73..450d7f42c87a8a301ca00ea91fb7dc3bddd81aff 100644 --- a/doc/ci/migration/jenkins.md +++ b/doc/ci/migration/jenkins.md @@ -475,7 +475,7 @@ deploy_staging: #### Runners Like Jenkins agents, GitLab runners are the hosts that run jobs. If you are using GitLab.com, -you can use the [shared runner fleet](../runners/index.md) to run jobs without provisioning +you can use the [instance runner fleet](../runners/index.md) to run jobs without provisioning your own runners. To convert a Jenkins agent for use with GitLab CI/CD, uninstall the agent and then diff --git a/doc/ci/pipelines/cicd_minutes.md b/doc/ci/pipelines/cicd_minutes.md index 13d4b2e23110438594f8ddc6b6ce31026f04b20e..e74c38533ff4404d1b2521abf97cdf6eb4a2ade5 100644 --- a/doc/ci/pipelines/cicd_minutes.md +++ b/doc/ci/pipelines/cicd_minutes.md @@ -17,7 +17,7 @@ NOTE: The term `CI/CD minutes` is being renamed to `compute minutes`. During this transition, you might see references in the UI and documentation to `CI/CD minutes`, `CI minutes`, `pipeline minutes`, `CI pipeline minutes`, `pipeline minutes quota`, `compute credits`, `compute units`, and `compute minutes`. For more information, see [epic 2150](https://gitlab.com/groups/gitlab-com/-/epics/2150). Administrators can limit the amount of time that projects can use to run jobs on -[shared runners](../runners/runners_scope.md#shared-runners) each month. This limit +[instance runners](../runners/runners_scope.md#instance-runners) each month. This limit is tracked with a compute quota. By default, one minute of execution time by a single job uses @@ -106,7 +106,7 @@ Prerequisites: ### View Usage Quota Reports for a group -> - Displaying shared runners duration per project [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/355666) in GitLab 15.0. +> - Displaying instance runners duration per project [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/355666) in GitLab 15.0. Prerequisites: @@ -119,13 +119,13 @@ To view compute usage for your group: 1. Select **Settings > Usage Quotas**. 1. Select the **Pipelines** tab. -The projects list shows projects with compute usage or shared runners usage +The projects list shows projects with compute usage or instance runners usage in the current month only. The list includes all projects in the namespace and its subgroups, sorted in descending order of compute usage. ### View Usage Quota reports for a personal namespace -> - Displaying shared runners duration [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/345795) in GitLab 15.0. +> - Displaying instance runners duration [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/345795) in GitLab 15.0. Prerequisites: @@ -138,7 +138,7 @@ You can view the compute usage for a personal namespace: 1. On the left sidebar, select **Usage Quotas**. The projects list shows [personal projects](../../user/project/working_with_projects.md#view-personal-projects) -with compute usage or shared runners usage in the current month only. The list +with compute usage or instance runners usage in the current month only. The list is sorted in descending order of compute usage. ## Purchase additional compute minutes @@ -221,7 +221,7 @@ GitLab uses this formula to calculate the compute usage of a job: Job duration * Cost factor ``` -- **Job duration**: The time, in seconds, that a job took to run on a shared runner, +- **Job duration**: The time, in seconds, that a job took to run on a instance runner, not including time spent in the `created` or `pending` statuses. - [**Cost factor**](#cost-factor): A number based on project visibility. @@ -241,7 +241,7 @@ can be higher than the end-to-end duration of a pipeline. ### Cost factor -The cost factors for jobs running on shared runners on GitLab.com are: +The cost factors for jobs running on instance runners on GitLab.com are: - `1` for internal, public, and private projects. - Exceptions for public projects: @@ -257,8 +257,8 @@ The cost factors on self-managed instances are: #### Cost factor for community contributions to GitLab projects -Community contributors can use up to 300,000 minutes on shared runners when contributing to open source projects -maintained by GitLab. The maximum of 300,000 minutes would only be possible if contributing exclusively to projects [part of the GitLab product](https://handbook.gitlab.com/handbook/engineering/metrics/#projects-that-are-part-of-the-product). The total number of minutes available on shared runners +Community contributors can use up to 300,000 minutes on instance runners when contributing to open source projects +maintained by GitLab. The maximum of 300,000 minutes would only be possible if contributing exclusively to projects [part of the GitLab product](https://handbook.gitlab.com/handbook/engineering/metrics/#projects-that-are-part-of-the-product). The total number of minutes available on instance runners is reduced by the compute minutes used by pipelines from other projects. The 300,000 minutes applies to all SaaS tiers, and the cost factor calculation is: @@ -297,7 +297,7 @@ GitLab SaaS runners have different cost factors, depending on the runner type (L ### Monthly reset of compute usage On the first day of each calendar month, the accumulated compute usage is reset to `0` -for all namespaces that use shared runners. This means your full quota is available, and +for all namespaces that use instance runners. This means your full quota is available, and calculations start again from `0`. For example, if you have a monthly quota of `10,000` compute minutes: @@ -327,7 +327,7 @@ Additional compute minutes are a one-time purchase and do not renew or refresh e When the compute quota is used for the current month, GitLab stops processing new jobs. -- Any non-running job that should be picked by shared runners is automatically dropped. +- Any non-running job that should be picked by instance runners is automatically dropped. - Any job being retried is automatically dropped. - Any running job can be dropped at any point if the overall namespace usage goes over-quota by a grace period. @@ -349,7 +349,7 @@ On GitLab SaaS an in-app banner is displayed and an email notification sent to t In some cases, the quota limit is replaced by one of the following labels: - **Unlimited**: For namespaces with unlimited compute quota. -- **Not supported**: For namespaces where active shared runners are not enabled. +- **Not supported**: For namespaces where active instance runners are not enabled. ## Reduce compute quota usage diff --git a/doc/ci/quick_start/index.md b/doc/ci/quick_start/index.md index 83134519623ffb63db1f033b69548590e0441d50..518937ba5214e5c9d33909706ae66dfc287c7c83 100644 --- a/doc/ci/quick_start/index.md +++ b/doc/ci/quick_start/index.md @@ -30,7 +30,7 @@ To create and run your first pipeline: 1. [Ensure you have runners available](#ensure-you-have-runners-available) to run your jobs. - If you're using GitLab.com, you can skip this step. GitLab.com provides shared runners for you. + If you're using GitLab.com, you can skip this step. GitLab.com provides instance runners for you. 1. [Create a `.gitlab-ci.yml` file](#create-a-gitlab-ciyml-file) at the root of your repository. This file is where you define the CI/CD jobs. diff --git a/doc/ci/runners/configure_runners.md b/doc/ci/runners/configure_runners.md index 03c572516e334df7266362d72773562aeef70951..bf696f71a629fd12f10fa6e987d6300260a98616 100644 --- a/doc/ci/runners/configure_runners.md +++ b/doc/ci/runners/configure_runners.md @@ -21,13 +21,13 @@ You can specify a maximum job timeout for each runner to prevent projects with longer job timeouts from using the runner. The maximum job timeout is used of it is shorter than the job timeout defined in the project. -### For a shared runner +### For an instance runner Prerequisites: - You must be an administrator. -On GitLab.com, you cannot override the job timeout for shared runners and must use the [project defined timeout](../pipelines/settings.md#set-a-limit-for-how-long-jobs-can-run) instead. +On GitLab.com, you cannot override the job timeout for instance runners and must use the [project defined timeout](../pipelines/settings.md#set-a-limit-for-how-long-jobs-can-run) instead. To set the maximum job timeout: @@ -131,28 +131,28 @@ job-artifact-upload-on-timeout: ## Protecting sensitive information To avoid exposing sensitive information, you can restrict the usage -of shared runners on large GitLab instances. This ensures that you +of instance runners on large GitLab instances. This ensures that you control access to your GitLab instances and secure [runner executors](https://docs.gitlab.com/runner/executors/). If certain executors run a job, the file system, the code the runner executes, and the runner authentication token may be exposed. This means that anyone who runs jobs -on a _shared runner_ can access another user's code that runs on the runner. +on an _instance runner_ can access another user's code that runs on the runner. Users with access to the runner authentication token can use it to create a clone of a runner and submit false jobs in a vector attack. For more information, see [Security Considerations](https://docs.gitlab.com/runner/security/). -### Using shared runners in forked projects +### Using instance runners in forked projects -When a project is forked, the job settings related to jobs are copied. If you have shared runners -configured for a project and a user forks that project, the shared runners serve jobs of this project. +When a project is forked, the job settings related to jobs are copied. If you have instance runners +configured for a project and a user forks that project, the instance runners serve jobs of this project. Due to a [known issue](https://gitlab.com/gitlab-org/gitlab/-/issues/364303), if the runner settings of the forked project does not match the new project namespace, the following message displays: `An error occurred while forking the project. Please try again.`. -To work around this issue, ensure that the shared runner settings are consistent in the forked project and the new namespace. +To work around this issue, ensure that the instance runner settings are consistent in the forked project and the new namespace. -- If shared runners are **enabled** on the forked project, then this should also be **enabled** on the new namespace. -- If shared runners are **disabled** on the forked project, then this should also be **disabled** on the new namespace. +- If instance runners are **enabled** on the forked project, then this should also be **enabled** on the new namespace. +- If instance runners are **disabled** on the forked project, then this should also be **disabled** on the new namespace. ### Reset the runner registration token for a project (deprecated) @@ -202,11 +202,11 @@ If a runner authentication token is revealed, an attacker could use the token to To reset the runner authentication token: 1. Delete the runner: - - [Delete a shared runner](runners_scope.md#delete-shared-runners). + - [Delete an instance runner](runners_scope.md#delete-instance-runners). - [Delete a group runner](runners_scope.md#delete-a-group-runner). - [Delete a project runner](runners_scope.md#delete-a-project-runner). 1. Create a new runner so that it is assigned a new runner authentication token: - - [Create a shared runner](runners_scope.md#create-a-shared-runner-with-a-runner-authentication-token). + - [Create an instance runner](runners_scope.md#create-an-instance-runner-with-a-runner-authentication-token). - [Create a group runner](runners_scope.md#create-a-group-runner-with-a-runner-authentication-token). - [Create a project runner](runners_scope.md#create-a-project-runner-with-a-runner-authentication-token). 1. Optional. To verify that the previous runner authentication token has been revoked, use the [Runners API](../../api/runners.md#verify-authentication-for-a-registered-runner). @@ -238,7 +238,7 @@ on [protected branches](../../user/project/protected_branches.md), or jobs that Runners configured to run jobs on protected branches cannot run jobs in [merge request pipelines](../pipelines/merge_request_pipelines.md). -### For a shared runner +### For an instance runner Prerequisites: @@ -284,7 +284,7 @@ Rails test suites. GitLab CI/CD tags are different to Git tags. GitLab CI/CD tags are associated with runners. Git tags are associated with commits. -### For a shared runner +### For an instance runner Prerequisites: @@ -863,9 +863,9 @@ variables: You can set them globally or per-job in the [`variables`](../yaml/index.md#variables) section. -## System calls not available on GitLab.com shared runners +## System calls not available on GitLab.com instance runners -GitLab.com shared runners run on CoreOS. This means that you cannot use some system calls, like `getlogin`, from the C standard library. +GitLab.com instance runners run on CoreOS. This means that you cannot use some system calls, like `getlogin`, from the C standard library. ## Artifact and cache settings diff --git a/doc/ci/runners/new_creation_workflow.md b/doc/ci/runners/new_creation_workflow.md index e4e195bebb409ef3cc9a41d917318d68012b02ba..b4b5dec84bad45761bc7c4c57e4d3383ce534045 100644 --- a/doc/ci/runners/new_creation_workflow.md +++ b/doc/ci/runners/new_creation_workflow.md @@ -63,7 +63,7 @@ workflow will break. To avoid a broken workflow, you must: -1. [Create a shared runner](runners_scope.md#create-a-shared-runner-with-a-runner-authentication-token) and obtain the authentication token. +1. [Create an instance runner](runners_scope.md#create-an-instance-runner-with-a-runner-authentication-token) and obtain the authentication token. 1. Replace the registration token in your runner registration workflow with the authentication token. diff --git a/doc/ci/runners/runners_scope.md b/doc/ci/runners/runners_scope.md index bb446d545c48316e397ed57467ebb263a95af95e..b6d1c52fc875b239b00dc0a3ea4fb8a9f899ce83 100644 --- a/doc/ci/runners/runners_scope.md +++ b/doc/ci/runners/runners_scope.md @@ -12,32 +12,31 @@ DETAILS: GitLab Runner has the following types of runners, which are available based on who you want to have access: -- [Shared runners](#shared-runners) are available to all groups and projects in a GitLab instance. +- [Instance runners](#instance-runners) are available to all groups and projects in a GitLab instance. - [Group runners](#group-runners) are available to all projects and subgroups in a group. - [Project runners](#project-runners) are associated with specific projects. Typically, project runners are used by one project at a time. -## Shared runners +## Instance runners -*Shared runners* are available to every project in a GitLab instance. +*Instance runners* are available to every project in a GitLab instance. -Use shared runners when you have multiple jobs with similar requirements. Rather than +Use instance runners when you have multiple jobs with similar requirements. Rather than 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: +If you are using a self-managed instance of GitLab, administrators can: -- Your administrator can [install GitLab Runner](https://docs.gitlab.com/runner/install/index.html) and register a shared runner. -- The administrator can also configure a maximum number of shared runner - [compute minutes for each group](../pipelines/cicd_minutes.md#set-the-compute-quota-for-a-specific-namespace). +- [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](../pipelines/cicd_minutes.md#set-the-compute-quota-for-a-specific-namespace). If you are using GitLab.com: -- You can select from a list of [shared runners that GitLab maintains](index.md). -- The shared runners consume the [compute minutes](../pipelines/cicd_minutes.md) +- You can select from a list of [instance runners that GitLab maintains](index.md). +- The instance runners consume the [compute minutes](../pipelines/cicd_minutes.md) included with your account. -### Create a shared runner with a runner authentication token +### Create an instance runner with a runner authentication token > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/383139) in GitLab 15.10. Deployed behind the `create_runner_workflow_for_admin` [flag](../../administration/feature_flags.md) > - [Enabled by default](https://gitlab.com/gitlab-org/gitlab/-/issues/389269) in GitLab 16.0. @@ -49,7 +48,7 @@ Prerequisites: When you create a runner, it is assigned a runner authentication token that you use to register it. The runner uses the token to authenticate with GitLab when picking up jobs from the job queue. -To create a shared runner: +To create an instance runner: 1. On the left sidebar, at the bottom, select **Admin Area**. 1. Select **CI/CD > Runners**. @@ -73,7 +72,7 @@ NOTE: The runner authentication token displays in the UI for a limited period of time during registration. After you register the runner, the authentication token is stored in the `config.toml`. -### Create a shared runner with a registration token (deprecated) +### Create an instance runner with a registration token (deprecated) WARNING: The ability to pass a runner registration token, and support for certain configuration arguments was @@ -84,7 +83,7 @@ Prerequisites: - You must be an administrator. -To create a shared runner: +To create an instance runner: 1. On the left sidebar, at the bottom, select **Admin Area**. 1. Select **CI/CD > Runners**. @@ -92,7 +91,7 @@ To create a shared runner: 1. Copy the registration token. 1. [Register the runner](https://docs.gitlab.com/runner/register/#register-with-a-runner-registration-token-deprecated). -### Pause or resume a shared runner +### Pause or resume an instance runner Prerequisites: @@ -107,92 +106,92 @@ You can pause a runner so that it does not accept jobs from groups and projects - To pause the runner, select **Pause** (**{pause}**). - To resume the runner, select **Resume** (**{play}**). -### Delete shared runners +### Delete instance runners Prerequisites: - You must be an administrator. -When you delete a shared runner, it is permanently deleted from the GitLab instance and can +When you delete an instance runner, it is permanently deleted from the GitLab instance and can no longer be used by groups and projects. If you want to temporarily stop the runner from accepting -jobs, you can [pause](#pause-or-resume-a-shared-runner) the runner instead. +jobs, you can [pause](#pause-or-resume-an-instance-runner) the runner instead. -To delete a single or multiple shared runners: +To delete a single or multiple instance runners: 1. On the left sidebar, at the bottom, select **Admin Area**. 1. Select **CI/CD > Runners**. 1. In the search box, enter the runner description or filter the list of runners. -1. Delete the shared runner: +1. Delete the instance runner: - To delete a single runner, next to the runner, select **Delete runner** (**{remove}**). - - To delete multiple shared runners, select the checkbox for each runner and select **Delete selected**. + - To delete multiple instance runners, select the checkbox for each runner and select **Delete selected**. - To delete all runners, select the checkbox at the top of the runner list and select **Delete selected**. 1. Select **Permanently delete runner**. -### Enable shared runners for a project +### Enable instance runners for a project -On GitLab.com, [shared runners](index.md) are enabled in all projects by +On GitLab.com, [instance runners](index.md) are enabled in all projects by default. On self-managed instances of GitLab, an administrator can -[enable them for all new projects](../../administration/settings/continuous_integration.md#enable-shared-runners-for-new-projects). +[enable them for all new projects](../../administration/settings/continuous_integration.md#enable-instance-runners-for-new-projects). For existing projects, an administrator must [install](https://docs.gitlab.com/runner/install/index.html) and [register](https://docs.gitlab.com/runner/register/index.html) them. -To enable shared runners for a project: +To enable instance runners for a project: 1. On the left sidebar, select **Search or go to** and find your project. 1. Select **Settings > CI/CD**. 1. Expand **Runners**. -1. Turn on the **Enable shared runners for this project** toggle. +1. Turn on the **Enable instance runners for this project** toggle. -### Enable shared runners for a group +### Enable instance runners for a group -To enable shared runners for a group: +To enable instance runners for a group: 1. On the left sidebar, select **Search or go to** and find your group. 1. Select **Settings > CI/CD**. 1. Expand **Runners**. -1. Turn on the **Enable shared runners for this group** toggle. +1. Turn on the **Enable instance runners for this group** toggle. -### Disable shared runners for a project +### Disable instance runners for a project -You can disable shared runners for individual projects or for groups. +You can disable instance runners for individual projects or for groups. You must have the Owner role for the project or group. -To disable shared runners for a project: +To disable instance runners for a project: 1. On the left sidebar, select **Search or go to** and find your project. 1. Select **Settings > CI/CD**. 1. Expand **Runners**. -1. In the **Shared runners** area, turn off the **Enable shared runners for this project** toggle. +1. In the **Instance runners** area, turn off the **Enable instance runners for this project** toggle. -Shared runners are automatically disabled for a project: +instance runners are automatically disabled for a project: -- If the shared runners setting for the parent group is disabled, and +- If the instance runners setting for the parent group is disabled, and - If overriding this setting is not permitted at the project level. -### Disable shared runners for a group +### Disable instance runners for a group -To disable shared runners for a group: +To disable instance runners for a group: 1. On the left sidebar, select **Search or go to** and find your group. 1. Select **Settings > CI/CD**. 1. Expand **Runners**. -1. Turn off the **Enable shared runners for this group** toggle. -1. Optional. To allow shared runners to be enabled for individual projects or subgroups, +1. Turn off the **Enable instance runners for this group** toggle. +1. Optional. To allow instance runners to be enabled for individual projects or subgroups, select **Allow projects and subgroups to override the group setting**. -### How shared runners pick jobs +### How instance runners pick jobs -Shared runners process jobs by using a fair usage queue. This queue prevents +Instance runners process jobs by using a fair usage queue. This queue prevents projects from creating hundreds of jobs and using all available -shared runner resources. +instance runner resources. The fair usage queue algorithm assigns jobs based on the projects that have the -fewest number of jobs already running on shared runners. +fewest number of jobs already running on instance runners. For example, if these jobs are in the queue: @@ -314,7 +313,7 @@ those that are inherited from the instance or other groups. By default, only those that are inherited are shown. -To show all runners available in the instance, including shared runners and +To show all runners available in the instance, including instance runners and those in other groups: 1. On the left sidebar, select **Search or go to** and find your group. @@ -356,7 +355,7 @@ To delete a single or multiple group runners: 1. In the search box, enter the runner description or filter the list of runners. 1. Delete the group runner: - To delete a single runner, next to the runner, select **Delete runner** (**{remove}**). - - To delete multiple shared runners, select the checkbox for each runner and select **Delete selected**. + - To delete multiple instance runners, select the checkbox for each runner and select **Delete selected**. - To delete all runners, select the checkbox at the top of the runner list and select **Delete selected**. 1. Select **Permanently delete runner**. @@ -424,7 +423,7 @@ must be enabled for each project explicitly. Project runners process jobs by using a first in, first out ([FIFO](https://en.wikipedia.org/wiki/FIFO_(computing_and_electronics))) queue. NOTE: -Project runners do not get shared with forked projects automatically. +Project runners do not get instance with forked projects automatically. A fork *does* copy the CI/CD settings of the cloned repository. ### Create a project runner with a runner authentication token @@ -562,7 +561,7 @@ To lock or unlock a project runner: find the project where you want to enable the runner. 1. Select **Settings > CI/CD**. 1. Expand **Runners**. -1. Find the project runner you want to lock or unlock. Make sure it's enabled. You cannot lock shared or group runners. +1. Find the project runner you want to lock or unlock. Make sure it's enabled. You cannot lock instance or group runners. 1. Select **Edit** (**{pencil}**). 1. Select the **Lock to current projects** checkbox. 1. Select **Save changes**. @@ -638,22 +637,22 @@ the source of the HTTP requests it makes to GitLab when polling for jobs. The IP address is always kept up to date so if the runner IP changes it automatically updates in GitLab. -The IP address for shared runners and project runners can be found in +The IP address for instance runners and project runners can be found in different places. -### Determine the IP address of a shared runner +### Determine the IP address of an instance runner Prerequisites: - You must have administrator access to the instance. -To determine the IP address of a shared runner: +To determine the IP address of an instance runner: 1. On the left sidebar, at the bottom, select **Admin Area**. 1. Select **CI/CD > Runners**. 1. Find the runner in the table and view the **IP Address** column. - + ### Determine the IP address of a project runner diff --git a/doc/ci/services/mysql.md b/doc/ci/services/mysql.md index 8c771ef4d390d2b0ebb150adb46460adcde3765b..451f9ab46f121e6d6c4fe4d47008c7593bb6db03 100644 --- a/doc/ci/services/mysql.md +++ b/doc/ci/services/mysql.md @@ -131,5 +131,5 @@ GitLab Runner with the Shell executor. ## Example project To view a MySQL example, create a fork of this [sample project](https://gitlab.com/gitlab-examples/mysql). -This project uses publicly-available [shared runners](../runners/index.md) on [GitLab.com](https://gitlab.com). +This project uses publicly-available [instance runners](../runners/index.md) on [GitLab.com](https://gitlab.com). Update the README.md file, commit your changes, and view the CI/CD pipeline to see it in action. diff --git a/doc/ci/services/postgres.md b/doc/ci/services/postgres.md index bad0433cf10f5e2d2b4e460c7a26703123a7ef7a..f1eceff3e8082e9f7f3220d0c92678975acac078 100644 --- a/doc/ci/services/postgres.md +++ b/doc/ci/services/postgres.md @@ -146,7 +146,7 @@ Database: nice_marmot We have set up an [Example PostgreSQL Project](https://gitlab.com/gitlab-examples/postgres) for your convenience that runs on [GitLab.com](https://gitlab.com) using our publicly -available [shared runners](../runners/index.md). +available [instance runners](../runners/index.md). Want to hack on it? Fork it, commit, and push your changes. Within a few moments the changes are picked by a public runner and the job begins. diff --git a/doc/ci/services/redis.md b/doc/ci/services/redis.md index c46b0e3fe258c55b56cbac2a9c879cffe8d64752..d5c113309f9c7051da6c9a515644028ef3083fb8 100644 --- a/doc/ci/services/redis.md +++ b/doc/ci/services/redis.md @@ -70,7 +70,7 @@ Host: localhost We have set up an [Example Redis Project](https://gitlab.com/gitlab-examples/redis) for your convenience that runs on [GitLab.com](https://gitlab.com) using our publicly available -[shared runners](../runners/index.md). +[instance runners](../runners/index.md). Want to hack on it? Fork it, commit and push your changes. Within a few moments the changes are picked by a public runner and the job begins. diff --git a/doc/ci/testing/code_quality.md b/doc/ci/testing/code_quality.md index 73c3863eadf12da29d25c3d45f6927ff29d0b218..92da8ff56041914a451753776e7aa3d16deb34b5 100644 --- a/doc/ci/testing/code_quality.md +++ b/doc/ci/testing/code_quality.md @@ -105,7 +105,7 @@ The project quality view displays an overview of the code quality findings. The Prerequisites: - GitLab CI/CD configuration (`.gitlab-ci.yml`) must include the `test` stage. -- If you're using shared runners, the Code Quality job must be configured for the +- If you're using instance runners, the Code Quality job must be configured for the [Docker-in-Docker workflow](../docker/using_docker_build.md#use-docker-in-docker). - If you're using private runners, you should use an [alternative configuration](#improve-code-quality-performance-with-private-runners) diff --git a/doc/subscriptions/bronze_starter.md b/doc/subscriptions/bronze_starter.md index e1c5bbcadc27758c1e95aab44518265bf442ae0e..d69bf6b2d52732c41909880b2e94bbef7a14cd9c 100644 --- a/doc/subscriptions/bronze_starter.md +++ b/doc/subscriptions/bronze_starter.md @@ -94,7 +94,7 @@ the tiers are no longer mentioned in GitLab documentation: - [Mirror with Perforce Helix with Git Fusion](../user/project/repository/mirror/bidirectional.md#mirror-with-perforce-helix-with-git-fusion) - Runners: - Run pipelines in the parent project [for merge requests from a forked project](../ci/pipelines/merge_request_pipelines.md#run-pipelines-in-the-parent-project) - - [Shared runners compute quota](../ci/pipelines/cicd_minutes.md) + - [Instance runners compute quota](../ci/pipelines/cicd_minutes.md) - [Push rules](../user/project/repository/push_rules.md) - SAML for self-managed GitLab instance: - [Administrator groups](../integration/saml.md#administrator-groups) diff --git a/doc/subscriptions/gitlab_com/index.md b/doc/subscriptions/gitlab_com/index.md index 9d475bc03fe2edc4994eed2fa1fef9c5c40ddf05..a624b7b957783ed2162656f31ec5da1fbd22b60f 100644 --- a/doc/subscriptions/gitlab_com/index.md +++ b/doc/subscriptions/gitlab_com/index.md @@ -390,7 +390,7 @@ To add a secondary contact for your subscription: ## Compute Compute is the resource consumed when running [pipelines](../../ci/pipelines/index.md) -on GitLab shared runners. +on GitLab instance runners. Refer to [Compute usage](../../ci/pipelines/cicd_minutes.md) for more information. diff --git a/doc/topics/autodevops/requirements.md b/doc/topics/autodevops/requirements.md index 403fb864a4d8f7e23a78e20407c1d5eab28fdc01..6a2f8dfff4d1ae83ca0e5946ad0a33dce4343111 100644 --- a/doc/topics/autodevops/requirements.md +++ b/doc/topics/autodevops/requirements.md @@ -138,7 +138,7 @@ To make full use of Auto DevOps with Kubernetes, you need: You can configure Docker-based runners to autoscale as well, using [Docker Machine](https://docs.gitlab.com/runner/executors/docker_machine.html). - Runners should be registered as [shared runners](../../ci/runners/runners_scope.md#shared-runners) + Runners should be registered as [instance runners](../../ci/runners/runners_scope.md#instance-runners) for the entire GitLab instance, or [project runners](../../ci/runners/runners_scope.md#project-runners) that are assigned to specific projects. diff --git a/doc/tutorials/automate_runner_creation/index.md b/doc/tutorials/automate_runner_creation/index.md index a23870f8153b16fe4ce52cf166275e582de3a296..e63ab7cdf1bd52f7341b04bf70999a029822329a 100644 --- a/doc/tutorials/automate_runner_creation/index.md +++ b/doc/tutorials/automate_runner_creation/index.md @@ -28,7 +28,7 @@ method that uses registration tokens. For more information, see ## Before you begin - GitLab Runner must be installed on your GitLab instance. -- To create shared runners, you must be an administrator. +- To create instance runners, you must be an administrator. - To create group runners, you must be an administrator or have the Owner role for the group. - To create project runners, you must be an administrator or have the Maintainer role for the project. @@ -177,7 +177,7 @@ runner installation and registration. After you create a runner and its configuration, you can use the same runner authentication token to register multiple runners with the same configuration. -For example, you can deploy multiple shared runners with the same executor type +For example, you can deploy multiple instance runners with the same executor type and job tags to the target compute host. Each runner registered with the same runner authentication token has a unique `system_id`, which GitLab Runner generates randomly and stores in your local file system. diff --git a/doc/user/application_security/container_scanning/index.md b/doc/user/application_security/container_scanning/index.md index 5d88eae71944c8524666a3fb60227d24ac5306c8..cba060d6ed86ee9144d76c17fe1af72f4756bc57 100644 --- a/doc/user/application_security/container_scanning/index.md +++ b/doc/user/application_security/container_scanning/index.md @@ -83,7 +83,7 @@ To enable container scanning in your pipeline, you need the following: - [GitLab Runner](https://docs.gitlab.com/runner/) with the [`docker`](https://docs.gitlab.com/runner/executors/docker.html) or [`kubernetes`](https://docs.gitlab.com/runner/install/kubernetes.html) executor on Linux/amd64. - Docker `18.09.03` or later installed on the same computer as the runner. If you're using the - shared runners on GitLab.com, then this is already the case. + instance runners on GitLab.com, then this is already the case. - An image matching the [supported distributions](#supported-distributions). - [Build and push](../../packages/container_registry/build_and_push_images.md#use-gitlab-cicd) the Docker image to your project's container registry. diff --git a/doc/user/application_security/dast/browser/configuration/variables.md b/doc/user/application_security/dast/browser/configuration/variables.md index 98c0748aa8d0e513610824215c7d8df3397bcbf1..30230fc457f940d2373ecd77db260ec1848385f4 100644 --- a/doc/user/application_security/dast/browser/configuration/variables.md +++ b/doc/user/application_security/dast/browser/configuration/variables.md @@ -46,7 +46,7 @@ For authentication CI/CD variables, see [Authentication](authentication.md). | `DAST_BROWSER_MAX_RESPONSE_SIZE_MB` | number | `15` | The maximum size of a HTTP response body. Responses with bodies larger than this are blocked by the browser. Defaults to 10 MB. | | `DAST_BROWSER_NAVIGATION_STABILITY_TIMEOUT` | [Duration string](https://pkg.go.dev/time#ParseDuration) | `7s` | The maximum amount of time to wait for a browser to consider a page loaded and ready for analysis after a navigation completes. Defaults to `800ms`.| | `DAST_BROWSER_NAVIGATION_TIMEOUT` | [Duration string](https://pkg.go.dev/time#ParseDuration) | `15s` | The maximum amount of time to wait for a browser to navigate from one page to another. | -| `DAST_BROWSER_NUMBER_OF_BROWSERS` | number | `3` | The maximum number of concurrent browser instances to use. For shared runners on GitLab.com, we recommended a maximum of three. Private runners with more resources may benefit from a higher number, but are likely to produce little benefit after five to seven instances. | +| `DAST_BROWSER_NUMBER_OF_BROWSERS` | number | `3` | The maximum number of concurrent browser instances to use. For instance runners on GitLab.com, we recommended a maximum of three. Private runners with more resources may benefit from a higher number, but are likely to produce little benefit after five to seven instances. | | `DAST_BROWSER_PAGE_LOADING_SELECTOR` | selector | `css:#page-is-loading` | Selector that when is no longer visible on the page, indicates to the analyzer that the page has finished loading and the scan can continue. Cannot be used with `DAST_BROWSER_PAGE_READY_SELECTOR`. | | `DAST_BROWSER_PAGE_READY_SELECTOR` | selector | `css:#page-is-ready` | Selector that when detected as visible on the page, indicates to the analyzer that the page has finished loading and the scan can continue. Cannot be used with `DAST_BROWSER_PAGE_LOADING_SELECTOR`. | | `DAST_BROWSER_PASSIVE_CHECK_WORKERS` | int | `5` | Number of workers that passive scan in parallel. Recommend setting to the number of available CPUs. | diff --git a/doc/user/gitlab_com/index.md b/doc/user/gitlab_com/index.md index 9093d62dbd68594948fc1fe62a86f13bc677923b..d663e7db31425871f5dc3dd6a3c832ab7f60f3a3 100644 --- a/doc/user/gitlab_com/index.md +++ b/doc/user/gitlab_com/index.md @@ -264,7 +264,7 @@ from those IPs and allow them. GitLab.com is fronted by Cloudflare. For incoming connections to GitLab.com, you might need to allow CIDR blocks of Cloudflare ([IPv4](https://www.cloudflare.com/ips-v4/) and [IPv6](https://www.cloudflare.com/ips-v6/)). For outgoing connections from CI/CD runners, we are not providing static IP addresses. -All GitLab.com shared runners are deployed into Google Cloud Platform (GCP) in `us-east1`. +All GitLab.com instance runners are deployed into Google Cloud Platform (GCP) in `us-east1`. Any IP-based firewall can be configured by looking up [IP address ranges or CIDR blocks for GCP](https://cloud.google.com/compute/docs/faq#find_ip_range). diff --git a/doc/user/group/access_and_permissions.md b/doc/user/group/access_and_permissions.md index 33fea38633d66ab8370859bf399d7b3463cb2b7a..a725e6d640625ea9e952784782a48010483ce9c4 100644 --- a/doc/user/group/access_and_permissions.md +++ b/doc/user/group/access_and_permissions.md @@ -114,7 +114,7 @@ Keep in mind that restricting group access by IP address has the following impli ### GitLab.com access restrictions -On GitLab.com shared runners are added to the [global allowlist](../../administration/settings/visibility_and_access_controls.md#configure-globally-allowed-ip-address-ranges), so that they are available regardless of IP restrictions. +On GitLab.com instance runners are added to the [global allowlist](../../administration/settings/visibility_and_access_controls.md#configure-globally-allowed-ip-address-ranges), so that they are available regardless of IP restrictions. Artifact and Registry downloading from runners is sourced from any Google or, in the case of MacOS runners, Amazon IP address in that region. The download is therefore not added to the global allowlist. diff --git a/doc/user/packages/container_registry/index.md b/doc/user/packages/container_registry/index.md index 4c5438ee1adbe4e825471b724515a2f8622db6ba..55d0465901eae8ce119f21bbaff6993517dd6895 100644 --- a/doc/user/packages/container_registry/index.md +++ b/doc/user/packages/container_registry/index.md @@ -34,7 +34,7 @@ You can search, sort, filter, and [delete](delete_container_registry_images.md#u your container images. You can share a filtered view by copying the URL from your browser. Only members of the project or group can access the container registry for a private project. -Container images downloaded from a private registry may be [available to other users in a shared runner](https://docs.gitlab.com/runner/security/index.html#usage-of-private-docker-images-with-if-not-present-pull-policy). +Container images downloaded from a private registry may be [available to other users in an instance runner](https://docs.gitlab.com/runner/security/index.html#usage-of-private-docker-images-with-if-not-present-pull-policy). If a project is public, the container registry is also public. diff --git a/doc/user/packages/yarn_repository/index.md b/doc/user/packages/yarn_repository/index.md index 6ef206c1a6017257d6761692f0e6ed738173d59f..c40862a611f35433aee0f1211e48fc1a9c473032 100644 --- a/doc/user/packages/yarn_repository/index.md +++ b/doc/user/packages/yarn_repository/index.md @@ -29,7 +29,7 @@ achieve. For more information, review the [guidance on tokens](../../../user/pac - If your organization uses two-factor authentication (2FA), you must use a personal access token with the scope set to `api`. - If you publish a package via CI/CD pipelines, you can use a CI job token in - private runners or you can register a variable for shared runners. + private runners or you can register a variable for instance runners. ### Publish configuration @@ -72,9 +72,9 @@ Your package should now publish to the package registry. You can use pipeline variables when you use this method. -You can use **Shared Runners** *(Default)* or **Private Runners** (Advanced). +You can use **instance runners** *(Default)* or **Private Runners** (Advanced). -#### Shared runners +#### Instance runners To create an authentication token for your project or group: diff --git a/doc/user/project/clusters/cluster_access.md b/doc/user/project/clusters/cluster_access.md index 40961357cb70132582d5b3d1ffbd0fa452296230..6187e1e216862ac873db26f2bd703728d3bcd01f 100644 --- a/doc/user/project/clusters/cluster_access.md +++ b/doc/user/project/clusters/cluster_access.md @@ -92,5 +92,5 @@ arbitrary images as they effectively have root access. If you don't want to use a runner in privileged mode, either: -- Use shared runners on GitLab.com. They don't have this security issue. +- Use instance runners on GitLab.com. They don't have this security issue. - Set up your own runners that use [`docker+machine`](https://docs.gitlab.com/runner/executors/docker_machine.html). diff --git a/doc/user/project/pages/introduction.md b/doc/user/project/pages/introduction.md index 0082040c28d014b7942f933f1287ce0672045fbf..066a5f7f97b085ce0004e01fc878d3921a809c19 100644 --- a/doc/user/project/pages/introduction.md +++ b/doc/user/project/pages/introduction.md @@ -35,7 +35,7 @@ If you are using [GitLab Pages on GitLab.com](#gitlab-pages-on-gitlabcom) to hos - The domain name for GitLab Pages on GitLab.com is `gitlab.io`. - Custom domains and TLS support are enabled. -- Shared runners are enabled by default, provided for free and can be used to +- Instance runners are enabled by default, provided for free and can be used to build your website. If you want you can still bring your own runner. ## Example projects diff --git a/doc/user/project/repository/forking_workflow.md b/doc/user/project/repository/forking_workflow.md index 7eda7658976af74318ae290f0447815b6756a80f..8a57c226876f8b08c37fd81acda23df1964197b5 100644 --- a/doc/user/project/repository/forking_workflow.md +++ b/doc/user/project/repository/forking_workflow.md @@ -225,8 +225,8 @@ to share objects with another repository: ### Error: `An error occurred while forking the project. Please try again` -This error can be due to a mismatch in shared runner settings between the forked project -and the new namespace. See [Forks](../../../ci/runners/configure_runners.md#using-shared-runners-in-forked-projects) +This error can be due to a mismatch in instance runner settings between the forked project +and the new namespace. See [Forks](../../../ci/runners/configure_runners.md#using-instance-runners-in-forked-projects) in the Runner documentation for more information. ### Removing fork relationship fails diff --git a/doc/user/project/settings/import_export_troubleshooting.md b/doc/user/project/settings/import_export_troubleshooting.md index 3f2b9a23f2dff8ee5121781ebb83e73adc096b5c..35cf86b3ea0b26310fa803262667c31d7c58c822 100644 --- a/doc/user/project/settings/import_export_troubleshooting.md +++ b/doc/user/project/settings/import_export_troubleshooting.md @@ -28,12 +28,12 @@ tail /var/log/gitlab/gitlab-rails/importer.log ## Project fails to import due to mismatch -If the [shared runners enablement](../../../ci/runners/runners_scope.md#enable-shared-runners-for-a-project) +If the [instance runners enablement](../../../ci/runners/runners_scope.md#enable-instance-runners-for-a-project) does not match between the exported project, and the project import, the project fails to import. Review [issue 276930](https://gitlab.com/gitlab-org/gitlab/-/issues/276930), and either: -- Ensure shared runners are enabled in both the source and destination projects. -- Disable shared runners on the parent group when you import the project. +- Ensure instance runners are enabled in both the source and destination projects. +- Disable instance runners on the parent group when you import the project. ## Users missing from imported project