Welcome to mirror list, hosted at ThFree Co, Russian Federation.

gitlab.com/gitlab-org/gitlab-foss.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorGitLab Bot <gitlab-bot@gitlab.com>2023-04-07 06:10:32 +0300
committerGitLab Bot <gitlab-bot@gitlab.com>2023-04-07 06:10:32 +0300
commit903b588e9a8f876d0135220e46a30f82b0f05f36 (patch)
tree65f56f165bcc6c8b590b6598b70303c4b9511d49 /doc
parent75b46eb33cd5dd542c69919a8bd5338933b79ecb (diff)
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc')
-rw-r--r--doc/ci/runners/register_runner.md49
-rw-r--r--doc/development/documentation/topic_types/tutorial.md22
2 files changed, 59 insertions, 12 deletions
diff --git a/doc/ci/runners/register_runner.md b/doc/ci/runners/register_runner.md
index ec10a1299dc..7b22e6215ba 100644
--- a/doc/ci/runners/register_runner.md
+++ b/doc/ci/runners/register_runner.md
@@ -4,9 +4,21 @@ group: Runner
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/product/ux/technical-writing/#assignments
---
-# Register a shared runner **(FREE)**
+# Generate runner tokens **(FREE)**
-> [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), disabled by default.
+To register a runner, you can use either:
+
+- An authentication token assigned to the runner when you create the runner in the UI. The runner uses the token to authenticate with GitLab when picking up jobs from the job queue.
+- A registration token (deprecated).
+
+## Generate an authentication token
+
+Registration with an authentication token is only available for shared runners. Support for project and group
+runners is proposed in this [epic](https://gitlab.com/groups/gitlab-org/-/epics/7633).
+
+### For a shared runner
+
+> [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), disabled by default.
FLAG:
On self-managed GitLab, this feature is not available. To make it available, ask an administrator to [enable the feature flag](../../administration/feature_flags.md) named `create_runner_workflow_for_admin`.
@@ -14,9 +26,9 @@ On GitLab.com, this feature is available but can be configured by GitLab.com adm
Prerequisites:
-- You must be an administrator to register a shared runner.
+- You must be an administrator.
-To register a [shared runner](../runners/runners_scope.md#shared-runners):
+To generate an authentication token for a shared runner:
1. On the top bar, select **Main menu > Admin**.
1. On the left sidebar, select **CI/CD > Runners**.
@@ -31,3 +43,32 @@ To register a [shared runner](../runners/runners_scope.md#shared-runners):
NOTE:
The token only displays in the UI for a short period of time during registration,
and is then saved in `config.toml`.
+
+## Generate a registration token (deprecated)
+
+WARNING:
+The ability to pass a runner registration token was [deprecated](https://gitlab.com/gitlab-org/gitlab/-/issues/380872) in GitLab 15.6 and is
+planned for removal in 17.0, along with support for certain configuration arguments. This change is a breaking change. GitLab plans to introduce a new
+[GitLab Runner token architecture](../../architecture/blueprints/runner_tokens/index.md), which introduces
+a new method for registering runners and eliminates the legacy
+[runner registration token](../../security/token_overview.md#runner-registration-tokens-deprecated).
+
+### For a shared runner
+
+1. On the top bar, select **Main menu > Admin**.
+1. On the left sidebar, select **CI/CD > Runners**.
+1. Select **Register an instance runner**.
+1. Copy the registration token.
+
+### For a group runner
+
+1. On the top bar, select **Main menu > Groups** and find your group.
+1. On the left sidebar, select **CI/CD > Runners**.
+1. Copy the registration token.
+
+### For a project runner
+
+1. On the top bar, select **Main menu > Projects** and find your project.
+1. On the left sidebar, select **Settings > CI/CD**.
+1. Expand the **Runners** section.
+1. Copy the registration token.
diff --git a/doc/development/documentation/topic_types/tutorial.md b/doc/development/documentation/topic_types/tutorial.md
index c8e45b7069f..b75b1e6b629 100644
--- a/doc/development/documentation/topic_types/tutorial.md
+++ b/doc/development/documentation/topic_types/tutorial.md
@@ -13,13 +13,17 @@ In general, you might consider using a tutorial when:
of sub-steps.
- The steps cover a variety of GitLab features or third-party tools.
-Tutorials are not [tasks](task.md). A task gives instructions for how to complete
-a procedure. A tutorial combines different tasks to achieve a specific goal. At
-the end of a tutorial, you have a working example of something.
-
-Tutorials are learning aids that complement our core documentation.
-They do not introduce new features.
-Always use the primary [topic types](index.md) to document new features.
+## Tutorial guidance
+
+- Tutorials are not [tasks](task.md). A task gives instructions for one procedure.
+ A tutorial combines multiple tasks to achieve a specific goal.
+- Tutorials provide a working example. Ideally the reader can create the example the
+ tutorial describes. If they can't replicate it exactly, they should be able
+ to replicate something similar.
+- Tutorials do not introduce new features.
+- Tutorials do not need to adhere to the Single Source of Truth tenet. While it's not
+ ideal to duplicate content that is available elsewhere, it's worse to force the reader to
+ leave the page to find what they need.
## Tutorial format
@@ -35,7 +39,9 @@ To create a website:
1. [Do the first task](#do-the-first-task)
1. [Do the second task](#do-the-second-task)
-Prerequisites (optional):
+## Prerequisites
+
+This topic is optional.
- Thing 1
- Thing 2