community.general.gitlab_project_variable module – Creates/updates/deletes GitLab Projects Variables

Note

This module is part of the community.general collection (version 5.4.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install community.general.

To use it in a playbook, specify: community.general.gitlab_project_variable.

Synopsis

  • When a project variable does not exist, it will be created.

  • When a project 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 project, 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.

Parameters

Parameter

Comments

api_job_token

string

added in 4.2.0 of community.general

GitLab CI job token for logging in.

api_oauth_token

string

added in 4.2.0 of community.general

GitLab OAuth token for logging in.

api_password

string

The password to use for authentication against the API

api_token

string

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

project

string / required

The path and name of the project.

purge

boolean

When set to true, all variables which are not untouched in the task will be deleted.

Choices:

  • no ← (default)

  • yes

state

string

Create or delete project variable.

Possible values are present and absent.

Choices:

  • present ← (default)

  • absent

validate_certs

boolean

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

Choices:

  • no

  • yes ← (default)

variables

list / elements=dictionary

added in 4.4.0 of community.general

A list of dictionaries that represents CI/CD variables.

This module works internal with this structure, even if the older vars parameter is used.

Default: []

environment_scope

string

The scope for the variable.

Support for environment_scope requires GitLab Premium >= 13.11.

Default: “*”

masked

boolean

Wether variable value is masked or not.

Support for masked values requires GitLab >= 11.10.

Choices:

  • no ← (default)

  • yes

name

string / required

The name of the variable.

protected

boolean

Wether variable value is protected or not.

Support for protected values requires GitLab >= 9.3.

Choices:

  • no ← (default)

  • yes

value

string

The variable value.

Required when state=present.

variable_type

string

Wether a variable is an environment variable (env_var) or a file (file).

Support for variable_type requires GitLab >= 11.11.

Choices:

  • env_var ← (default)

  • file

vars

dictionary

When the list element is a simple key-value pair, masked and protected will be set 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.

Support for environment_scope requires GitLab Premium >= 13.11.

Support for variable_type requires GitLab >= 11.11.

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.

Field environment_scope must be a string defined by scope environment.

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

Default: {}

Examples

- name: Set or update some CI/CD variables
  community.general.gitlab_project_variable:
    api_url: https://gitlab.com
    api_token: secret_access_token
    project: markuman/dotfiles
    purge: false
    variables:
      - name: ACCESS_KEY_ID
        value: abc123
      - name: SECRET_ACCESS_KEY
        value: dassgrfaeui8989
        masked: yes
        protected: yes
        environment_scope: production

- name: Set or update some CI/CD variables
  community.general.gitlab_project_variable:
    api_url: https://gitlab.com
    api_token: secret_access_token
    project: markuman/dotfiles
    purge: false
    vars:
      ACCESS_KEY_ID: abc123
      SECRET_ACCESS_KEY:
        value: 3214cbad
        masked: true
        protected: true
        variable_type: env_var
        environment_scope: '*'

- name: Delete one variable
  community.general.gitlab_project_variable:
    api_url: https://gitlab.com
    api_token: secret_access_token
    project: markuman/dotfiles
    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

Description

project_variable

dictionary

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

Returned: always

added

list / elements=string

A list of variables which were created.

Returned: always

Sample: “[\u0027ACCESS_KEY_ID\u0027, \u0027SECRET_ACCESS_KEY\u0027]”

removed

list / elements=string

A list of variables which were deleted.

Returned: always

Sample: “[\u0027ACCESS_KEY_ID\u0027, \u0027SECRET_ACCESS_KEY\u0027]”

untouched

list / elements=string

A list of variables which exist.

Returned: always

Sample: “[\u0027ACCESS_KEY_ID\u0027, \u0027SECRET_ACCESS_KEY\u0027]”

updated

list / elements=string

A list of variables whose values were changed.

Returned: always

Sample: “[\u0027ACCESS_KEY_ID\u0027, \u0027SECRET_ACCESS_KEY\u0027]”

Authors

  • Markus Bergholz (@markuman)