community / community.general / 3.8.10 / inventory / gitlab_runners Ansible dynamic inventory plugin for GitLab runners. Authors: Stefan Heitmüller (@morph027) <stefan.heitmueller@gmx.com>community.general.gitlab_runners (3.8.10) — inventory
Install with ansible-galaxy collection install community.general:==3.8.10
collections: - name: community.general version: 3.8.10
Reads inventories from the GitLab API.
Uses a YAML configuration file gitlab_runners.[yml|yaml].
filter: choices: - active - paused - online - specific - shared description: filter runners from GitLab API env: - name: GITLAB_FILTER version_added: 1.0.0 version_added_collection: community.general type: str groups: default: {} description: Add hosts to group based on Jinja2 conditionals. type: dict plugin: choices: - gitlab_runners - community.general.gitlab_runners description: The name of this plugin, it should always be set to 'gitlab_runners' for this plugin to recognize it as it's own. required: true type: str strict: default: false description: - If V(yes) make invalid entries a fatal error, otherwise skip and continue. - Since it is possible to use facts in the expressions they might not always be available and we ignore those errors by default. type: bool compose: default: {} description: Create vars from jinja2 expressions. type: dict api_token: aliases: - private_token - access_token description: GitLab token for logging in. env: - name: GITLAB_API_TOKEN version_added: 1.0.0 version_added_collection: community.general type: str server_url: description: The URL of the GitLab server, with protocol (i.e. http or https). env: - name: GITLAB_SERVER_URL version_added: 1.0.0 version_added_collection: community.general required: true type: str keyed_groups: default: [] description: Add hosts to group based on the values of a variable. elements: dict suboptions: default_value: description: - The default value when the host variable's value is an empty string. - This option is mutually exclusive with O(keyed_groups[].trailing_separator). type: str version_added: '2.12' version_added_collection: ansible.builtin key: description: - The key from input dictionary used to generate groups type: str parent_group: description: parent group for keyed group type: str prefix: default: '' description: A keyed group name will start with this prefix type: str separator: default: _ description: separator used to build the keyed group name type: str trailing_separator: default: true description: - Set this option to V(False) to omit the O(keyed_groups[].separator) after the host variable when the value is an empty string. - This option is mutually exclusive with O(keyed_groups[].default_value). type: bool version_added: '2.12' version_added_collection: ansible.builtin type: list use_extra_vars: default: false description: Merge extra vars into the available variables for composition (highest precedence). env: - name: ANSIBLE_INVENTORY_USE_EXTRA_VARS ini: - key: use_extra_vars section: inventory_plugins type: bool version_added: '2.11' version_added_collection: ansible.builtin verbose_output: default: true description: Toggle to (not) include all available nodes metadata type: bool leading_separator: default: true description: - Use in conjunction with keyed_groups. - By default, a keyed group that does not have a prefix or a separator provided will have a name that starts with an underscore. - This is because the default prefix is "" and the default separator is "_". - Set this option to False to omit the leading underscore (or other separator) if no prefix is given. - If the group name is derived from a mapping the separator is still used to concatenate the items. - To not use a separator in the group name at all, set the separator for the keyed group to an empty string instead. type: boolean version_added: '2.11' version_added_collection: ansible.builtin