Skip to content

Commit

Permalink
docs(README): update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
antmelekhin committed May 12, 2024
1 parent 9b2d98c commit 600a19d
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 13 deletions.
26 changes: 14 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,16 +49,18 @@ Requirements
Role Variables
--------------
- Variables for installing GitLab Runner using the GitLab repository:
- `gitlab_runner_package_version` The version of the GitLab Runner package (default: `''`).
- `gitlab_runner_repository_mirror_url` GitLab repository mirror (default: `https://packages.gitlab.com/runner/gitlab-runner`).
- `gitlab_runner_repository_gpgkey_url` URL to GitLab repository GPG key file (default: `https://packages.gitlab.com/runner/gitlab-runner/gpgkey`).
Variables for installing GitLab Runner using the GitLab repository (Debian and RedHat based distributions):
- Variables for installing GitLab Runner using a binary file (Windows):
- `gitlab_runner_binary_version` The version of the GitLab Runner binary (default: `16.11.1`).
- `gitlab_runner_binary_name` GitLab Runner binary name (default: `gitlab-runner-windows-amd64`).
- `gitlab_runner_binary_download_url` URL to download the GitLab Runner binary (default: `https://gitlab-runner-downloads.s3.amazonaws.com/v16.11.1/binaries`).
- `gitlab_runner_binary_install_path` GitLab Runner installation folder (default: `C:\Program Files\gitlab-runner`).
- `gitlab_runner_package_version` The version of the GitLab Runner package. By default, GitLab Runner is installed with the latest available version.
- `gitlab_runner_repository_mirror_url` GitLab repository mirror (default: `https://packages.gitlab.com/runner/gitlab-runner`).
- `gitlab_runner_repository_gpgkey_url` URL to GitLab repository GPG key file (default: `https://packages.gitlab.com/runner/gitlab-runner/gpgkey`).

Variables for installing GitLab Runner using a binary file (Windows):

- `gitlab_runner_binary_version` The version of the GitLab Runner binary (default: `16.11.1`).
- `gitlab_runner_binary_name` GitLab Runner binary name (default: `gitlab-runner-windows-amd64`).
- `gitlab_runner_binary_download_url` URL to download the GitLab Runner binary (default: `https://gitlab-runner-downloads.s3.amazonaws.com/v16.11.1/binaries`).
- `gitlab_runner_binary_install_path` GitLab Runner installation folder (default: `C:\Program Files\gitlab-runner`).

Dependencies
------------
Expand All @@ -68,7 +70,7 @@ None.
Example Playbook
----------------

Install `GitLab Runner`:
Install GitLab Runner:

```yaml
---
Expand All @@ -79,7 +81,7 @@ Install `GitLab Runner`:
- role: antmelekhin.gitlab_runner
```

Install `GitLab Runner` v16.9.1:
Install GitLab Runner v16.9.1:

```yaml
---
Expand All @@ -91,7 +93,7 @@ Install `GitLab Runner` v16.9.1:
gitlab_runner_package_version: '16.9.1-1'
```

Install and configure `GitLab Runner` with shell executor:
Install GitLab Runner and configure the shell executor:

```yaml
---
Expand Down
2 changes: 1 addition & 1 deletion defaults/main.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
# Install GitLab Runner using the Gitlab repository (Debian and RedHat distros)
# Install GitLab Runner using the Gitlab repository (Debian and RedHat based distributions)
gitlab_runner_package_version: ''
gitlab_runner_repository_mirror_url: 'https://packages.gitlab.com/runner/gitlab-runner'
gitlab_runner_repository_gpgkey_url: '{{ gitlab_runner_repository_mirror_url }}/gpgkey'
Expand Down

0 comments on commit 600a19d

Please sign in to comment.