community.general.gitlab_instance_variable 模块 – 创建、更新或删除 GitLab 实例变量

注意

此模块是 community.general 集合 (版本 10.1.0) 的一部分。

如果您正在使用 ansible 包，您可能已经安装了这个集合。它不包含在 ansible-core 中。要检查是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用：ansible-galaxy collection install community.general。您需要进一步的要求才能使用此模块，请参阅 要求 了解详细信息。

要在 playbook 中使用它，请指定：community.general.gitlab_instance_variable。

community.general 7.1.0 中的新功能

概要

  • 如果实例变量不存在，则创建它。

  • 当实例变量存在时，如果值不同，则会更新其值。

  • 对实例变量的支持需要 GitLab >= 13.0。

  • 模块选项中未提及，但在 GitLab 实例上存在的变量，将保持不变 (purge=false) 或将被删除 (purge=true)。

要求

以下是在执行此模块的主机上所需的要求。

参数

参数

注释

api_job_token

字符串

在 community.general 4.2.0 中添加

用于登录的 GitLab CI 作业令牌。

api_oauth_token

字符串

在 community.general 4.2.0 中添加

用于登录的 GitLab OAuth 令牌。

api_password

字符串

用于对 API 进行身份验证的密码。

api_token

字符串

具有 API 权限的 GitLab 访问令牌。

api_url

字符串

API 的可解析端点。

api_username

字符串

用于对 API 进行身份验证的用户名。

ca_path

字符串

在 community.general 8.1.0 中添加

用于验证 GitLab 服务器证书的 CA 证书捆绑包。

purge

布尔值

当设置为 true 时，删除任务中未提及的所有变量。

选择

  • false ← (默认)

  • true

state

字符串

创建或删除实例变量。

选择

  • "present" ← (默认)

  • "absent"

validate_certs

布尔值

在提供 HTTPS 端点时是否验证 SSL 证书。

选择

  • false

  • true ← (默认)

variables

列表 / 元素=字典

表示 CI/CD 变量的字典列表。

默认值： []

masked

布尔值

变量值是否被屏蔽。

选择

  • false ← (默认)

  • true

name

字符串 / 必需

变量的名称。

protected

布尔值

变量值是否受保护。

选择

  • false ← (默认)

  • true

value

字符串

变量值。

当 state=present 时为必需。

variable_type

字符串

变量是环境变量 (env_var) 还是文件 (file)。

选择

  • "env_var" ← (默认)

  • "file"

属性

属性

支持

描述

check_mode

支持：完全

可以在 check_mode 模式下运行，并返回更改状态预测，而不会修改目标。

diff_mode

支持: 无

当处于 diff 模式时，将返回已更改（或可能需要在 check_mode 模式下更改）的详细信息。

示例

- name: Set or update some CI/CD variables
  community.general.gitlab_instance_variable:
    api_url: https://gitlab.com
    api_token: secret_access_token
    purge: false
    variables:
      - name: ACCESS_KEY_ID
        value: abc1312cba
      - name: SECRET_ACCESS_KEY
        value: 1337
        masked: true
        protected: true
        variable_type: env_var

- name: Delete one variable
  community.general.gitlab_instance_variable:
    api_url: https://gitlab.com
    api_token: secret_access_token
    state: absent
    variables:
      - name: ACCESS_KEY_ID

返回值

常见的返回值在此处进行了文档说明，以下是此模块独有的字段

键

描述

instance_variable

字典

包含已添加、更新、删除或存在的变量名称的四个列表。

返回: 总是

added

列表 / 元素=字符串

已创建的变量列表。

返回: 总是

示例: ["ACCESS_KEY_ID", "SECRET_ACCESS_KEY"]

removed

列表 / 元素=字符串

已删除的变量列表。

返回: 总是

示例: ["ACCESS_KEY_ID", "SECRET_ACCESS_KEY"]

untouched

列表 / 元素=字符串

存在的变量列表。

返回: 总是

示例: ["ACCESS_KEY_ID", "SECRET_ACCESS_KEY"]

updated

列表 / 元素=字符串

值已设置的预先存在的变量的列表。

返回: 总是

示例: ["ACCESS_KEY_ID", "SECRET_ACCESS_KEY"]

作者

  • Benedikt Braunger (@benibr)