gitlab_runners – Ansible dynamic inventory plugin for GitLab runners

From Get docs
< Inventory PluginsAnsible/docs/2.9/plugins/inventory/gitlab runners


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

Parameter Choices/Defaults Configuration Comments

api_token

string

GitLab token for logging in.


aliases: private_token, access_token

compose

dictionary

Default:

{}

Create vars from jinja2 expressions.

filter

string

  • active
  • paused
  • online
  • specific
  • shared

filter runners from GitLab API

groups

dictionary

Default:

{}

Add hosts to group based on Jinja2 conditionals.

keyed_groups

list

Default:

[]

Add hosts to group based on the values of a variable.

plugin

string / required

  • gitlab_runners

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:

The URL of the GitLab server, with protocol (i.e. http or https).

strict

boolean

  • no

  • yes

If 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.

verbose_output

boolean

  • no
  • yes

Toggle to (not) include all available nodes metadata



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

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.


© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/plugins/inventory/gitlab_runners.html