community.general.gitlab_group_variable – Creates, updates, or deletes GitLab groups variables

From Get docs
Ansible/docs/2.10/collections/community/general/gitlab group variable module


community.general.gitlab_group_variable – Creates, updates, or deletes GitLab groups variables

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


New in version 1.2.0: of community.general


Synopsis

  • Creates a group variable if it does not exist.
  • When a group variable does exist, its value will be updated when the values are different.
  • Variables which are untouched in the playbook, but are not untouched in the GitLab group, they stay untouched (purge is false) or will be deleted (purge is true).

Requirements

The below requirements are needed on the host that executes this module.

  • python >= 2.7
  • python-gitlab python module

Parameters

Parameter Choices/Defaults Comments

api_password

string

The password to use for authentication against the API

api_token

string / required

GitLab access token with API permissions.

api_url

string

The resolvable endpoint for the API

api_username

string

The username to use for authentication against the API

group

string / required

The path and name of the group.

purge

boolean

  • no

  • yes

When set to true, delete all variables which are not untouched in the task.

state

string

  • present

  • absent

Create or delete group variable.

validate_certs

boolean

  • no
  • yes

Whether or not to validate SSL certs when supplying a https endpoint.

vars

dictionary

Default:

{}

When the list element is a simple key-value pair, set masked and protected to false.

When the list element is a dict with the keys value, masked and protected, the user can have full control about whether a value should be masked, protected or both.

Support for protected values requires GitLab >= 9.3.

Support for masked values requires GitLab >= 11.10.

A value must be a string or a number.

Field variable_type must be a string with either env_var, which is the default, or file.

When a value is masked, it must be in Base64 and have a length of at least 8 characters. See GitLab documentation on acceptable values for a masked variable (https://docs.gitlab.com/ce/ci/variables/#masked-variables).



Notes

Note

  • Supports check_mode.


Examples

- name: Set or update some CI/CD variables
  community.general.gitlab_group_variable:
    api_url: https://gitlab.com
    api_token: secret_access_token
    group: scodeman/testgroup/
    purge: false
    vars:
      ACCESS_KEY_ID: abc123
      SECRET_ACCESS_KEY: 321cba

- name: Set or update some CI/CD variables
  community.general.gitlab_group_variable:
    api_url: https://gitlab.com
    api_token: secret_access_token
    group: scodeman/testgroup/
    purge: false
    vars:
      ACCESS_KEY_ID: abc123
      SECRET_ACCESS_KEY:
        value: 3214cbad
        masked: true
        protected: true
        variable_type: env_var

- name: Delete one variable
  community.general.gitlab_group_variable:
    api_url: https://gitlab.com
    api_token: secret_access_token
    group: scodeman/testgroup/
    state: absent
    vars:
      ACCESS_KEY_ID: abc123

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description

group_variable

dictionary

always

Four lists of the variablenames which were added, updated, removed or exist.


added

list / elements=string

always

A list of variables which were created.


Sample:

['ACCESS_KEY_ID', 'SECRET_ACCESS_KEY']

removed

list / elements=string

always

A list of variables which were deleted.


Sample:

['ACCESS_KEY_ID', 'SECRET_ACCESS_KEY']

untouched

list / elements=string

always

A list of variables which exist.


Sample:

['ACCESS_KEY_ID', 'SECRET_ACCESS_KEY']

updated

list / elements=string

always

A list of variables whose values were changed.


Sample:

['ACCESS_KEY_ID', 'SECRET_ACCESS_KEY']




Authors

  • Florent Madiot (@scodeman)

© 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_group_variable_module.html