From f6ecf497a64af4038055b9eeee79d5b9ed59d2c5 Mon Sep 17 00:00:00 2001 From: Suzanne Selhorn <sselhorn@gitlab.com> Date: Wed, 24 Nov 2021 19:03:05 +0000 Subject: [PATCH] Updated Build cloud to SaaS runners --- doc/api/projects.md | 2 +- doc/ci/large_repositories/index.md | 4 ++-- doc/ci/runners/index.md | 6 +++--- .../runners/runner_cloud/linux_runner_cloud.md | 6 +++--- .../runners/runner_cloud/macos/environment.md | 4 ++-- .../runners/runner_cloud/macos_runner_cloud.md | 17 +++++++++-------- .../runner_cloud/windows_runner_cloud.md | 4 ++-- doc/install/requirements.md | 3 ++- doc/user/gitlab_com/index.md | 6 +++--- 9 files changed, 27 insertions(+), 25 deletions(-) diff --git a/doc/api/projects.md b/doc/api/projects.md index fb3099091ab10..09fb22942e191 100644 --- a/doc/api/projects.md +++ b/doc/api/projects.md @@ -1354,7 +1354,7 @@ PUT /projects/:id ``` For example, to toggle the setting for -[shared runners on a GitLab.com project](../user/gitlab_com/index.md#shared-runner-cloud-runners): +[shared runners on a GitLab.com project](../ci/runners/index.md): ```shell curl --request PUT --header "PRIVATE-TOKEN: <your-token>" \ diff --git a/doc/ci/large_repositories/index.md b/doc/ci/large_repositories/index.md index 76e34df1f8cc0..fe4af9421db4b 100644 --- a/doc/ci/large_repositories/index.md +++ b/doc/ci/large_repositories/index.md @@ -259,5 +259,5 @@ For very active repositories with a large number of references and files, you ca must be configured per-repository. The pack-objects cache also automatically works for forks. On GitLab.com, where the pack-objects cache is enabled on all Gitaly servers, we found that we no longer need a pre-clone step for `gitlab-org/gitlab` development. - Optimize your CI/CD jobs by seeding repository data in a pre-clone step with the - [`pre_clone_script`](https://docs.gitlab.com/runner/configuration/advanced-configuration.html#the-runners-section) of GitLab Runner. See the - [Runner Cloud for Linux](../runners/runner_cloud/linux_runner_cloud.md#pre-clone-script) for more details. + [`pre_clone_script`](https://docs.gitlab.com/runner/configuration/advanced-configuration.html#the-runners-section) of GitLab Runner. See + [SaaS runners on Linux](../runners/runner_cloud/linux_runner_cloud.md#pre-clone-script) for details. diff --git a/doc/ci/runners/index.md b/doc/ci/runners/index.md index d408bc466099a..b4e9fe818cf3d 100644 --- a/doc/ci/runners/index.md +++ b/doc/ci/runners/index.md @@ -5,12 +5,12 @@ info: To determine the technical writer assigned to the Stage/Group associated w type: reference --- -# GitLab Runner Cloud **(FREE)** +# Runner SaaS **(FREE SAAS)** -If you are using self-managed GitLab or you want to use your own runners on GitLab.com, you can +If you are using self-managed GitLab or you use GitLab.com but want to use your own runners, you can [install and configure your own runners](https://docs.gitlab.com/runner/install/). -If you are using GitLab SaaS (GitLab.com), your CI jobs automatically run on runners in the GitLab Runner Cloud. +If you are using GitLab SaaS (GitLab.com), your CI jobs automatically run on runners provided by GitLab. No configuration is required. Your jobs can run on: - [Linux runners](build_cloud/linux_build_cloud.md). diff --git a/doc/ci/runners/runner_cloud/linux_runner_cloud.md b/doc/ci/runners/runner_cloud/linux_runner_cloud.md index d0fedfcabb225..bda495009e20a 100644 --- a/doc/ci/runners/runner_cloud/linux_runner_cloud.md +++ b/doc/ci/runners/runner_cloud/linux_runner_cloud.md @@ -4,9 +4,9 @@ group: Runner info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments --- -# Runner Cloud for Linux **(FREE)** +# SaaS runners on Linux **(FREE SAAS)** -Runner Cloud runners for Linux run in autoscale mode and are powered by Google Cloud Platform. +SaaS runners on Linux are autoscaled ephemeral Google Cloud Platform virtual machines. Autoscaling means reduced queue times to spin up CI/CD jobs, and isolated VMs for each job, thus maximizing security. These shared runners are available on GitLab.com. @@ -38,7 +38,7 @@ These runners share a [distributed cache](https://docs.gitlab.com/runner/configu ## Pre-clone script -Cloud runners for Linux provide a way to run commands in a CI +With SaaS runners on Linux, you can run commands in a CI job before the runner attempts to run `git init` and `git fetch` to download a GitLab repository. The [`pre_clone_script`](https://docs.gitlab.com/runner/configuration/advanced-configuration.html#the-runners-section) diff --git a/doc/ci/runners/runner_cloud/macos/environment.md b/doc/ci/runners/runner_cloud/macos/environment.md index ddefad775c1a3..3332eab9b443f 100644 --- a/doc/ci/runners/runner_cloud/macos/environment.md +++ b/doc/ci/runners/runner_cloud/macos/environment.md @@ -4,9 +4,9 @@ group: Runner info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments --- -# VM instances and images for Runner Cloud for macOS **(FREE)** +# VM instances and images for SaaS runners on macOS **(FREE SAAS)** -When you use the Runner Cloud for macOS: +When you use SaaS runners on macOS: - Each of your jobs runs in a newly provisioned VM, which is dedicated to the specific job. - The VM is active only for the duration of the job and immediately deleted. diff --git a/doc/ci/runners/runner_cloud/macos_runner_cloud.md b/doc/ci/runners/runner_cloud/macos_runner_cloud.md index 332284fa8c1f2..40c4deb51aa45 100644 --- a/doc/ci/runners/runner_cloud/macos_runner_cloud.md +++ b/doc/ci/runners/runner_cloud/macos_runner_cloud.md @@ -4,19 +4,20 @@ group: Runner info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments --- -# Runner Cloud for macOS (Beta) **(FREE SAAS)** +# SaaS runners on macOS (Beta) **(FREE SAAS)** -The Runner Cloud for macOS Beta provides on-demand runners integrated with GitLab SaaS [CI/CD](../../../ci/index.md). +SaaS runners on macOS provide an on-demand macOS build environment integrated with +GitLab SaaS [CI/CD](../../../ci/index.md). Use these runners to build, test, and deploy apps for the Apple ecosystem (macOS, iOS, tvOS). You can take advantage of all the capabilities of the GitLab single DevOps platform and not have to manage or operate a build environment. -Cloud runners for macOS are in [Beta](https://about.gitlab.com/handbook/product/gitlab-the-product/#beta) +SaaS runners on macOS are in [Beta](https://about.gitlab.com/handbook/product/gitlab-the-product/#beta) and shouldn't be relied upon for mission-critical production jobs. ## Quickstart -To start using Runner Cloud for macOS Beta, you must submit an access request [issue](https://gitlab.com/gitlab-com/macos-buildcloud-runners-beta/-/issues/new?issuable_template=beta_access_request). After your +To start using SaaS runners on macOS, you must submit an access request [issue](https://gitlab.com/gitlab-com/macos-buildcloud-runners-beta/-/issues/new?issuable_template=beta_access_request). After your access has been granted and your build environment configured, you must configure your `.gitlab-ci.yml` pipeline file: @@ -28,10 +29,10 @@ The runners automatically run your build. ## Example `.gitlab-ci.yml` file -The following sample `.gitlab-ci.yml` file shows how to start using the runners for macOS: +The following sample `.gitlab-ci.yml` file shows how to start using the SaaS runners on macOS: ```yaml -.macos_buildcloud_runners: +.macos_saas_runners: tags: - shared-macos-amd64 image: macos-11-xcode-12 @@ -45,14 +46,14 @@ before_script: build: extends: - - .macos_buildcloud_runners + - .macos_saas_runners stage: build script: - echo "running scripts in the build job" test: extends: - - .macos_buildcloud_runners + - .macos_saas_runners stage: test script: - echo "running scripts in the test job" diff --git a/doc/ci/runners/runner_cloud/windows_runner_cloud.md b/doc/ci/runners/runner_cloud/windows_runner_cloud.md index ef4d4076c9157..87ee542fb1494 100644 --- a/doc/ci/runners/runner_cloud/windows_runner_cloud.md +++ b/doc/ci/runners/runner_cloud/windows_runner_cloud.md @@ -4,9 +4,9 @@ group: Runner info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments --- -# Runner Cloud for Windows (beta) **(FREE)** +# SaaS runners on Windows (beta) **(FREE SAAS)** -Runner Cloud runners for Windows are in [beta](https://about.gitlab.com/handbook/product/gitlab-the-product/#beta) +SaaS runners on Windows are in [beta](https://about.gitlab.com/handbook/product/gitlab-the-product/#beta) and shouldn't be used for production workloads. During this beta period, the [shared runner pipeline quota](../../../user/admin_area/settings/continuous_integration.md#shared-runners-pipeline-minutes-quota) diff --git a/doc/install/requirements.md b/doc/install/requirements.md index 9f435f0442913..8aa7ca511c4b6 100644 --- a/doc/install/requirements.md +++ b/doc/install/requirements.md @@ -302,7 +302,8 @@ The GitLab Runner server requirements depend on: Since the nature of the jobs varies for each use case, you need to experiment by adjusting the job concurrency to get the optimum setting. -For reference, the GitLab.com Runner Cloud [auto-scaling runner for Linux](../ci/runners/build_cloud/linux_build_cloud.md) is configured so that a **single job** runs in a **single instance** with: +For reference, the [SaaS runners on Linux](../ci/runners/build_cloud/linux_build_cloud.md) +are configured so that a **single job** runs in a **single instance** with: - 1 vCPU. - 3.75 GB of RAM. diff --git a/doc/user/gitlab_com/index.md b/doc/user/gitlab_com/index.md index bf0f03128d9cc..900490053d64a 100644 --- a/doc/user/gitlab_com/index.md +++ b/doc/user/gitlab_com/index.md @@ -200,11 +200,11 @@ The following limits apply for [Webhooks](../project/integrations/webhooks.md): | [Number of webhooks](../../administration/instance_limits.md#number-of-webhooks) | `100` per project, `50` per group | `100` per project, `50` per group | | Maximum payload size | 25 MB | 25 MB | -## Shared Runner Cloud runners +## Runner SaaS -GitLab has shared runners on GitLab.com that you can use to run your CI jobs. +Runner SaaS is the hosted, secure, and managed build environment you can use to run CI/CD jobs for your GitLab.com hosted project. -For more information, see [GitLab Runner Cloud runners](../../ci/runners/index.md). +For more information, see [Runner SaaS](../../ci/runners/index.md). ## Sidekiq -- GitLab