Commit 965d6ad2 authored by Mike Jang's avatar Mike Jang

Merge branch 'selhorn-runner-2' into 'master'

Docs: Updated capitalization of runner

See merge request gitlab-org/gitlab!40033
parents 3719e613 bba0778b
...@@ -54,7 +54,7 @@ module Types ...@@ -54,7 +54,7 @@ module Types
field :container_registry_enabled, GraphQL::BOOLEAN_TYPE, null: true, field :container_registry_enabled, GraphQL::BOOLEAN_TYPE, null: true,
description: 'Indicates if the project stores Docker container images in a container registry' description: 'Indicates if the project stores Docker container images in a container registry'
field :shared_runners_enabled, GraphQL::BOOLEAN_TYPE, null: true, field :shared_runners_enabled, GraphQL::BOOLEAN_TYPE, null: true,
description: 'Indicates if Shared Runners are enabled for the project' description: 'Indicates if shared runners are enabled for the project'
field :lfs_enabled, GraphQL::BOOLEAN_TYPE, null: true, field :lfs_enabled, GraphQL::BOOLEAN_TYPE, null: true,
description: 'Indicates if the project has Large File Storage (LFS) enabled' description: 'Indicates if the project has Large File Storage (LFS) enabled'
field :merge_requests_ff_only_enabled, GraphQL::BOOLEAN_TYPE, null: true, field :merge_requests_ff_only_enabled, GraphQL::BOOLEAN_TYPE, null: true,
......
...@@ -11886,7 +11886,7 @@ type Project { ...@@ -11886,7 +11886,7 @@ type Project {
): ServiceConnection ): ServiceConnection
""" """
Indicates if Shared Runners are enabled for the project Indicates if shared runners are enabled for the project
""" """
sharedRunnersEnabled: Boolean sharedRunnersEnabled: Boolean
......
...@@ -34868,7 +34868,7 @@ ...@@ -34868,7 +34868,7 @@
}, },
{ {
"name": "sharedRunnersEnabled", "name": "sharedRunnersEnabled",
"description": "Indicates if Shared Runners are enabled for the project", "description": "Indicates if shared runners are enabled for the project",
"args": [ "args": [
], ],
...@@ -1686,7 +1686,7 @@ Information about pagination in a connection. ...@@ -1686,7 +1686,7 @@ Information about pagination in a connection.
| `sentryErrors` | SentryErrorCollection | Paginated collection of Sentry errors on the project | | `sentryErrors` | SentryErrorCollection | Paginated collection of Sentry errors on the project |
| `serviceDeskAddress` | String | E-mail address of the service desk. | | `serviceDeskAddress` | String | E-mail address of the service desk. |
| `serviceDeskEnabled` | Boolean | Indicates if the project has service desk enabled. | | `serviceDeskEnabled` | Boolean | Indicates if the project has service desk enabled. |
| `sharedRunnersEnabled` | Boolean | Indicates if Shared Runners are enabled for the project | | `sharedRunnersEnabled` | Boolean | Indicates if shared runners are enabled for the project |
| `snippetsEnabled` | Boolean | Indicates if Snippets are enabled for the current user | | `snippetsEnabled` | Boolean | Indicates if Snippets are enabled for the current user |
| `sshUrlToRepo` | String | URL to connect to the project via SSH | | `sshUrlToRepo` | String | URL to connect to the project via SSH |
| `starCount` | Int! | Number of times the project has been starred | | `starCount` | Int! | Number of times the project has been starred |
......
...@@ -6,30 +6,30 @@ info: To determine the technical writer assigned to the Stage/Group associated w ...@@ -6,30 +6,30 @@ info: To determine the technical writer assigned to the Stage/Group associated w
# Runners API # Runners API
> [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/2640) in GitLab 8.5 > [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/2640) in GitLab 8.5.
## Registration and authentication tokens ## Registration and authentication tokens
There are two tokens to take into account when connecting a Runner with GitLab. There are two tokens to take into account when connecting a runner with GitLab.
| Token | Description | | Token | Description |
| ----- | ----------- | | ----- | ----------- |
| Registration token | Token used to [register the Runner](https://docs.gitlab.com/runner/register/). It can be [obtained through GitLab](../ci/runners/README.md). | | Registration token | Token used to [register the runner](https://docs.gitlab.com/runner/register/). It can be [obtained through GitLab](../ci/runners/README.md). |
| Authentication token | Token used to authenticate the Runner with the GitLab instance. It is obtained either automatically when [registering a Runner](https://docs.gitlab.com/runner/register/), or manually when [registering the Runner via the Runners API](#register-a-new-runner). | | Authentication token | Token used to authenticate the runner with the GitLab instance. It is obtained either automatically when [registering a runner](https://docs.gitlab.com/runner/register/), or manually when [registering the runner via the Runner API](#register-a-new-runner). |
Here's an example of how the two tokens are used in Runner registration: Here's an example of how the two tokens are used in runner registration:
1. You register the Runner via the GitLab API using a registration token, and an 1. You register the runner via the GitLab API using a registration token, and an
authentication token is returned. authentication token is returned.
1. You use that authentication token and add it to the 1. You use that authentication token and add it to the
[Runner's configuration file](https://docs.gitlab.com/runner/commands/#configuration-file): [runner's configuration file](https://docs.gitlab.com/runner/commands/#configuration-file):
```toml ```toml
[[runners]] [[runners]]
token = "<authentication_token>" token = "<authentication_token>"
``` ```
GitLab and Runner are then connected. GitLab and the runner are then connected.
## List owned runners ## List owned runners
...@@ -224,7 +224,7 @@ PUT /runners/:id ...@@ -224,7 +224,7 @@ PUT /runners/:id
| `run_untagged`| boolean | no | Flag indicating the runner can execute untagged jobs | | `run_untagged`| boolean | no | Flag indicating the runner can execute untagged jobs |
| `locked` | boolean | no | Flag indicating the runner is locked | | `locked` | boolean | no | Flag indicating the runner is locked |
| `access_level` | string | no | The access_level of the runner; `not_protected` or `ref_protected` | | `access_level` | string | no | The access_level of the runner; `not_protected` or `ref_protected` |
| `maximum_timeout` | integer | no | Maximum timeout set when this Runner will handle the job | | `maximum_timeout` | integer | no | Maximum timeout set when this runner will handle the job |
```shell ```shell
curl --request PUT --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/runners/6" --form "description=test-1-20150125-test" --form "tag_list=ruby,mysql,tag1,tag2" curl --request PUT --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/runners/6" --form "description=test-1-20150125-test" --form "tag_list=ruby,mysql,tag1,tag2"
...@@ -291,7 +291,7 @@ curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" "https://git ...@@ -291,7 +291,7 @@ curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" "https://git
> [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/15432) in GitLab 10.3. > [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/15432) in GitLab 10.3.
List jobs that are being processed or were processed by specified Runner. List jobs that are being processed or were processed by specified runner.
```plaintext ```plaintext
GET /runners/:id/jobs GET /runners/:id/jobs
...@@ -541,9 +541,9 @@ Example response: ...@@ -541,9 +541,9 @@ Example response:
] ]
``` ```
## Register a new Runner ## Register a new runner
Register a new Runner for the instance. Register a new runner for the instance.
```plaintext ```plaintext
POST /runners POST /runners
...@@ -554,12 +554,12 @@ POST /runners ...@@ -554,12 +554,12 @@ POST /runners
| `token` | string | yes | [Registration token](#registration-and-authentication-tokens). | | `token` | string | yes | [Registration token](#registration-and-authentication-tokens). |
| `description`| string | no | Runner's description| | `description`| string | no | Runner's description|
| `info` | hash | no | Runner's metadata | | `info` | hash | no | Runner's metadata |
| `active` | boolean | no | Whether the Runner is active | | `active` | boolean | no | Whether the runner is active |
| `locked` | boolean | no | Whether the Runner should be locked for current project | | `locked` | boolean | no | Whether the runner should be locked for current project |
| `run_untagged` | boolean | no | Whether the Runner should handle untagged jobs | | `run_untagged` | boolean | no | Whether the runner should handle untagged jobs |
| `tag_list` | string array | no | List of Runner's tags | | `tag_list` | string array | no | List of runner's tags |
| `access_level` | string | no | The access_level of the runner; `not_protected` or `ref_protected` | | `access_level` | string | no | The access_level of the runner; `not_protected` or `ref_protected` |
| `maximum_timeout` | integer | no | Maximum timeout set when this Runner will handle the job | | `maximum_timeout` | integer | no | Maximum timeout set when this runner will handle the job |
```shell ```shell
curl --request POST "https://gitlab.example.com/api/v4/runners" --form "token=<registration_token>" --form "description=test-1-20150125-test" --form "tag_list=ruby,mysql,tag1,tag2" curl --request POST "https://gitlab.example.com/api/v4/runners" --form "token=<registration_token>" --form "description=test-1-20150125-test" --form "tag_list=ruby,mysql,tag1,tag2"
...@@ -580,9 +580,9 @@ Example response: ...@@ -580,9 +580,9 @@ Example response:
} }
``` ```
## Delete a registered Runner ## Delete a registered runner
Deletes a registered Runner. Deletes a registered runner.
```plaintext ```plaintext
DELETE /runners DELETE /runners
...@@ -602,9 +602,9 @@ Response: ...@@ -602,9 +602,9 @@ Response:
|-----------|---------------------------------| |-----------|---------------------------------|
| 204 | Runner was deleted | | 204 | Runner was deleted |
## Verify authentication for a registered Runner ## Verify authentication for a registered runner
Validates authentication credentials for a registered Runner. Validates authentication credentials for a registered runner.
```plaintext ```plaintext
POST /runners/verify POST /runners/verify
......
...@@ -329,7 +329,7 @@ are listed in the descriptions of the relevant settings. ...@@ -329,7 +329,7 @@ are listed in the descriptions of the relevant settings.
| `send_user_confirmation_email` | boolean | no | Send confirmation email on sign-up. | | `send_user_confirmation_email` | boolean | no | Send confirmation email on sign-up. |
| `session_expire_delay` | integer | no | Session duration in minutes. GitLab restart is required to apply changes | | `session_expire_delay` | integer | no | Session duration in minutes. GitLab restart is required to apply changes |
| `shared_runners_enabled` | boolean | no | (**If enabled, requires:** `shared_runners_text` and `shared_runners_minutes`) Enable shared runners for new projects. | | `shared_runners_enabled` | boolean | no | (**If enabled, requires:** `shared_runners_text` and `shared_runners_minutes`) Enable shared runners for new projects. |
| `shared_runners_minutes` | integer | required by: `shared_runners_enabled` | **(PREMIUM)** Set the maximum number of pipeline minutes that a group can use on shared Runners per month. | | `shared_runners_minutes` | integer | required by: `shared_runners_enabled` | **(PREMIUM)** Set the maximum number of pipeline minutes that a group can use on shared runners per month. |
| `shared_runners_text` | string | required by: `shared_runners_enabled` | Shared runners text. | | `shared_runners_text` | string | required by: `shared_runners_enabled` | Shared runners text. |
| `sign_in_text` | string | no | Text on the login page. | | `sign_in_text` | string | no | Text on the login page. |
| `signin_enabled` | string | no | (Deprecated: Use `password_authentication_enabled_for_web` instead) Flag indicating if password authentication is enabled for the web interface. | | `signin_enabled` | string | no | (Deprecated: Use `password_authentication_enabled_for_web` instead) Flag indicating if password authentication is enabled for the web interface. |
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment