community.general.gitlab_runners – Ansible dynamic inventory plugin for GitLab runners.
community.general.gitlab_runners – Ansible dynamic inventory plugin for GitLab runners.
Note
This plugin is part of the community.general collection (version 1.3.2).
To install it use: ansible-galaxy collection install community.general
.
To use it in a playbook, specify: community.general.gitlab_runners
.
Synopsis
- Reads inventories from the GitLab API.
- Uses a YAML configuration file gitlab_runners.[yml|yaml].
Requirements
The below requirements are needed on the local controller node that executes this inventory.
- python >= 2.7
- python-gitlab > 1.8.0
Parameters
Parameter | Choices/Defaults | Configuration | Comments |
---|---|---|---|
api_token string |
env:GITLAB_API_TOKEN added in 1.0.0 of community.general |
GitLab token for logging in.
| |
compose dictionary |
Default: {} |
Create vars from jinja2 expressions. | |
filter string |
|
env:GITLAB_FILTER added in 1.0.0 of community.general |
filter runners from GitLab API |
groups dictionary |
Default: {} |
Add hosts to group based on Jinja2 conditionals. | |
keyed_groups list / elements=string |
Default: [] |
Add hosts to group based on the values of a variable. | |
plugin string / required |
|
The name of this plugin, it should always be set to 'gitlab_runners' for this plugin to recognize it as it's own. | |
server_url string / required |
Default: |
env:GITLAB_SERVER_URL added in 1.0.0 of community.general |
The URL of the GitLab server, with protocol (i.e. http or https). |
strict boolean |
|
If Since it is possible to use facts in the expressions they might not always be available and we ignore those errors by default. | |
verbose_output boolean |
|
Toggle to (not) include all available nodes metadata |
Examples
# gitlab_runners.yml
plugin: community.general.gitlab_runners
host: https://gitlab.com
# Example using constructed features to create groups and set ansible_host
plugin: community.general.gitlab_runners
host: https://gitlab.com
strict: False
keyed_groups:
# add e.g. amd64 hosts to an arch_amd64 group
- prefix: arch
key: 'architecture'
# add e.g. linux hosts to an os_linux group
- prefix: os
key: 'platform'
# create a group per runner tag
# e.g. a runner tagged w/ "production" ends up in group "label_production"
# hint: labels containing special characters will be converted to safe names
- key: 'tag_list'
prefix: tag
Authors
- Stefan Heitmüller (@morph027) <[email protected]>
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/community/general/gitlab_runners_inventory.html