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-13 18:18:04 +0300
committerGitLab Bot <gitlab-bot@gitlab.com>2023-04-13 18:18:04 +0300
commitdd7da8bd31926a1210011856f7d66ee43fa65156 (patch)
tree48e8d6cd77f833d331b700e4ee636ab40b7b2f8d /doc
parent944a3a7b7e19354abdfcaa79129d0736c4b8565f (diff)
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc')
-rw-r--r--doc/api/bulk_imports.md5
-rw-r--r--doc/api/runners.md32
-rw-r--r--doc/api/users.md39
-rw-r--r--doc/user/admin_area/settings/index.md4
-rw-r--r--doc/user/admin_area/settings/security_and_compliance.md20
-rw-r--r--doc/user/compliance/license_scanning_of_cyclonedx_files/index.md1
-rw-r--r--doc/user/group/import/index.md4
-rw-r--r--doc/user/ssh.md2
8 files changed, 87 insertions, 20 deletions
diff --git a/doc/api/bulk_imports.md b/doc/api/bulk_imports.md
index 96e2912498b..f8d354a56ed 100644
--- a/doc/api/bulk_imports.md
+++ b/doc/api/bulk_imports.md
@@ -18,7 +18,8 @@ prerequisites for [migrating groups by direct transfer](../user/group/import/ind
## Start a new group migration
-> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/66353) in GitLab 14.2.
+> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/66353) in GitLab 14.2.
+> - `project_entity` source type [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/390515) in GitLab 15.11.
```plaintext
POST /bulk_imports
@@ -30,7 +31,7 @@ POST /bulk_imports
| `configuration[url]` | String | yes | Source GitLab instance URL. |
| `configuration[access_token]` | String | yes | Access token to the source GitLab instance. |
| `entities` | Array | yes | List of entities to import. |
-| `entities[source_type]` | String | yes | Source entity type (only `group_entity` is supported). |
+| `entities[source_type]` | String | yes | Source entity type. Valid values are `group_entity` (GitLab 14.2 and later) and `project_entity` (GitLab 15.11 and later). |
| `entities[source_full_path]` | String | yes | Source full path of the entity to import. |
| `entities[destination_name]` | String | yes | Deprecated: Use :destination_slug instead. Destination slug for the entity. |
| `entities[destination_slug]` | String | yes | Destination slug for the entity. |
diff --git a/doc/api/runners.md b/doc/api/runners.md
index 1a722163c41..8d0be1c3aba 100644
--- a/doc/api/runners.md
+++ b/doc/api/runners.md
@@ -273,10 +273,10 @@ PUT /runners/:id
| `id` | integer | yes | The ID of a runner |
| `description` | string | no | The description of the runner |
| `active` | boolean | no | Deprecated: Use `paused` instead. Flag indicating whether the runner is allowed to receive jobs |
-| `paused` | boolean | no | Specifies whether the runner should ignore new jobs |
+| `paused` | boolean | no | Specifies if the runner should ignore new jobs |
| `tag_list` | array | no | The list of tags for the runner |
-| `run_untagged` | boolean | no | Specifies whether the runner can execute untagged jobs |
-| `locked` | boolean | no | Specifies whether the runner is locked |
+| `run_untagged` | boolean | no | Specifies if the runner can execute untagged jobs |
+| `locked` | boolean | no | Specifies if the runner is locked |
| `access_level` | string | no | The access level of the runner; `not_protected` or `ref_protected` |
| `maximum_timeout` | integer | no | Maximum timeout that limits the amount of time (in seconds) that runners can run jobs |
@@ -656,20 +656,20 @@ Register a new runner for the instance.
POST /runners
```
-| Attribute | Type | Required | Description |
-|--------------------|--------------|----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| `token` | string | yes | [Registration token](#registration-and-authentication-tokens) |
-| `description` | string | no | Runner's description |
+| Attribute | Type | Required | Description |
+|--------------------|--------------|----------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| `token` | string | yes | [Registration token](#registration-and-authentication-tokens) |
+| `description` | string | no | Description of the runner |
| `info` | hash | no | Runner's metadata. You can include `name`, `version`, `revision`, `platform`, and `architecture`, but only `version`, `platform`, and `architecture` are displayed in the Admin Area of the UI |
-| `active` | boolean | no | Deprecated: Use `paused` instead. Specifies whether the runner is allowed to receive new jobs |
-| `paused` | boolean | no | Specifies whether the runner should ignore new jobs |
-| `locked` | boolean | no | Specifies whether the runner should be locked for the current project |
-| `run_untagged` | boolean | no | Specifies whether the runner should handle untagged jobs |
-| `tag_list` | string array | no | A list of runner tags |
-| `access_level` | string | no | The access level of the runner; `not_protected` or `ref_protected` |
-| `maximum_timeout` | integer | no | Maximum timeout that limits the amount of time (in seconds) that runners can run jobs |
-| `maintainer_note` | string | no | [Deprecated](https://gitlab.com/gitlab-org/gitlab/-/issues/350730), see `maintenance_note` |
-| `maintenance_note` | string | no | Free-form maintenance notes for the runner (1024 characters) |
+| `active` | boolean | no | Deprecated: Use `paused` instead. Specifies if the runner is allowed to receive new jobs |
+| `paused` | boolean | no | Specifies if the runner should ignore new jobs |
+| `locked` | boolean | no | Specifies if the runner should be locked for the current project |
+| `run_untagged` | boolean | no | Specifies if the runner should handle untagged jobs |
+| `tag_list` | string array | no | A list of runner tags |
+| `access_level` | string | no | The access level of the runner; `not_protected` or `ref_protected` |
+| `maximum_timeout` | integer | no | Maximum timeout that limits the amount of time (in seconds) that runners can run jobs |
+| `maintainer_note` | string | no | [Deprecated](https://gitlab.com/gitlab-org/gitlab/-/issues/350730), see `maintenance_note` |
+| `maintenance_note` | string | no | Free-form maintenance notes for the runner (1024 characters) |
```shell
curl --request POST "https://gitlab.example.com/api/v4/runners" \
diff --git a/doc/api/users.md b/doc/api/users.md
index dba1c30f7e8..bb261cea682 100644
--- a/doc/api/users.md
+++ b/doc/api/users.md
@@ -2196,3 +2196,42 @@ Returns:
- `400 Bad request` if two factor authentication is not enabled for the specified user.
- `403 Forbidden` if not authenticated as an administrator.
- `404 User Not Found` if user cannot be found.
+
+## Create a CI runner **(FREE SELF)**
+
+It creates a new runner, linked to the current user.
+
+Requires administrator access or ownership of the target namespace or project. Token values are returned once. Make sure you save it because you can't access
+it again.
+
+```plaintext
+POST /user/runners
+```
+
+| Attribute | Type | Required | Description |
+|--------------------|--------------|----------|-----------------------------------------------------------------------------------------------------------------------------------------|
+| `runner_type` | string | yes | Specifies the scope of the runner; `instance_type`, `group_type`, or `project_type`. |
+| `namespace_id` | integer | no | The ID of the project or group that the runner is created in. Required if `runner_type` is `group_type` or `project_type`. |
+| `description` | string | no | Description of the runner. |
+| `paused` | boolean | no | Specifies if the runner should ignore new jobs. |
+| `locked` | boolean | no | Specifies if the runner should be locked for the current project. |
+| `run_untagged` | boolean | no | Specifies if the runner should handle untagged jobs. |
+| `tag_list` | string array | no | A list of runner tags. |
+| `access_level` | string | no | The access level of the runner; `not_protected` or `ref_protected`. |
+| `maximum_timeout` | integer | no | Maximum timeout that limits the amount of time (in seconds) that runners can run jobs. |
+| `maintenance_note` | string | no | Free-form maintenance notes for the runner (1024 characters). |
+
+```shell
+curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" --data "runner_type=instance_type" \
+ "https://gitlab.example.com/api/v4/user/runners"
+```
+
+Example response:
+
+```json
+{
+ "id": 9171,
+ "token": "glrt-kyahzxLaj4Dc1jQf4xjX",
+ "token_expires_at": null
+}
+```
diff --git a/doc/user/admin_area/settings/index.md b/doc/user/admin_area/settings/index.md
index 152c35dd504..11c14102efb 100644
--- a/doc/user/admin_area/settings/index.md
+++ b/doc/user/admin_area/settings/index.md
@@ -66,6 +66,10 @@ The **CI/CD** settings contain:
[risks are involved](../../packages/container_registry/reduce_container_registry_storage.md#use-with-external-container-registries)
in enabling some of these settings.
+## Security and Compliance settings
+
+- [License compliance settings](security_and_compliance.md#choose-package-registry-metadata-to-sync): Enable or disable synchronization of package metadata by a registry type.
+
### Geo **(PREMIUM SELF)**
The **Geo** setting contains:
diff --git a/doc/user/admin_area/settings/security_and_compliance.md b/doc/user/admin_area/settings/security_and_compliance.md
new file mode 100644
index 00000000000..13abf1027cd
--- /dev/null
+++ b/doc/user/admin_area/settings/security_and_compliance.md
@@ -0,0 +1,20 @@
+---
+stage: Secure
+group: Composition Analysis
+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
+type: howto
+---
+
+# Security and Compliance Admin Area settings **(ULTIMATE SELF)**
+
+The settings for package metadata synchronization are located in the [Admin Area](index.md).
+
+## Choose package registry metadata to sync
+
+To choose the packages you want to synchronize with the GitLab License Database for [License Compliance](../../compliance/license_scanning_of_cyclonedx_files/index.md):
+
+1. On the top bar, select **Main menu > Admin**.
+1. On the left sidebar, select **Settings > Security and Compliance**.
+1. Expand **License Compliance**.
+1. Select or clear checkboxes for the package registries that you want to sync.
+1. Select **Save changes**.
diff --git a/doc/user/compliance/license_scanning_of_cyclonedx_files/index.md b/doc/user/compliance/license_scanning_of_cyclonedx_files/index.md
index e81951d93d4..1ca10ed61db 100644
--- a/doc/user/compliance/license_scanning_of_cyclonedx_files/index.md
+++ b/doc/user/compliance/license_scanning_of_cyclonedx_files/index.md
@@ -22,6 +22,7 @@ Licenses not in the SPDX list are reported as "Unknown". License information can
Prerequisites:
+- Enable [Synchronization with the GitLab License Database](../../admin_area/settings/security_and_compliance.md#choose-package-registry-metadata-to-sync) in Admin Area for the GitLab instance.
- Enable [Dependency Scanning](../../application_security/dependency_scanning/index.md#configuration).
From the `.gitlab-ci.yml` file, remove the deprecated line `Jobs/License-Scanning.gitlab-ci.yml`, if
diff --git a/doc/user/group/import/index.md b/doc/user/group/import/index.md
index 8e8299594f0..2fba15d58b6 100644
--- a/doc/user/group/import/index.md
+++ b/doc/user/group/import/index.md
@@ -225,6 +225,7 @@ Group items that are migrated to the destination GitLab instance include:
> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/267945) in GitLab 14.4 [with a flag](../../feature_flags.md) named `bulk_import_projects`. Disabled by default.
> - [Enabled on GitLab.com](https://gitlab.com/gitlab-org/gitlab/-/issues/339941) in GitLab 15.6.
> - `bulk_import_projects` feature flag [removed](https://gitlab.com/gitlab-org/gitlab/-/issues/339941) in GitLab 15.10.
+> - Project-only migrations using API [added](https://gitlab.com/gitlab-org/gitlab/-/issues/390515) in GitLab 15.11.
If you choose to migrate projects when you [select groups to migrate](#select-the-groups-and-projects-to-import),
project items are migrated with the projects.
@@ -246,6 +247,9 @@ specific project item is migrated:
Any other project items are **not** migrated.
+If you choose not to migrate projects along with groups or if you want to retry a project migration, you can
+initiate project-only migrations using the [API](../../../api/bulk_imports.md).
+
WARNING:
Migrating projects when migrating groups by direct transfer is in [Beta](../../../policy/alpha-beta-support.md#beta)
and is not ready for production use.
diff --git a/doc/user/ssh.md b/doc/user/ssh.md
index 3ab61fa77a9..a74c3fea360 100644
--- a/doc/user/ssh.md
+++ b/doc/user/ssh.md
@@ -20,8 +20,6 @@ SSH uses two keys, a public key and a private key.
- The public key can be distributed.
- The private key should be protected.
-When you need to copy or upload your SSH public key, make sure you do not accidentally copy or upload your private key instead.
-
You cannot expose data by uploading your public key. When you need to copy or upload your SSH public key, make sure you do not accidentally copy or upload your private key instead.
You can use your private key to [sign commits](project/repository/ssh_signed_commits/index.md),