gitlab_runners – Ansible dynamic inventory plugin for GitLab runners¶
New in version 2.8.
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 master node that executes this inventory.
python >= 2.7
python-gitlab > 1.8.0
Parameters¶
Examples¶
# gitlab_runners.yml
plugin: gitlab_runners
host: https://gitlab.com
# Example using constructed features to create groups and set ansible_host
plugin: 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
Status¶
This inventory is not guaranteed to have a backwards compatible interface. [preview]
This inventory is maintained by the Ansible Community. [community]
Authors¶
UNKNOWN
Hint
If you notice any issues in this documentation, you can edit this document to improve it.
Hint
Configuration entries for each entry type have a low to high priority order. For example, a variable that is lower in the list will override a variable that is higher up.