community.general.gitlab_deploy_key 模块 – 管理 GitLab 项目部署密钥

注意

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

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

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

要在剧本中使用它，请指定：community.general.gitlab_deploy_key。

概要 

添加、更新和删除项目部署密钥

要求 

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

python-gitlab python 模块
requests (Python 库 https://pypi.ac.cn/project/requests/)

参数 

参数	注释
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 证书包。
can_push 布尔值	此密钥是否可以推送到项目。选择 `false` ← (默认) `true`
key 字符串 / 必需	部署密钥
project 字符串 / 必需	项目的 Id 或完整路径，格式为 group/name。
state 字符串	当 `present` 时，如果部署密钥不存在，则将其添加到项目中。当 `absent` 时，如果部署密钥存在，则将其从项目中删除。选择 `"present"` ← (默认) `"absent"`
title 字符串 / 必需	部署密钥的标题。
validate_certs 布尔值	在提供 HTTPS 端点时是否验证 SSL 证书。选择 `false` `true` ← (默认)

属性 

属性	支持	描述
check_mode	支持: 完全支持	可以在 `check_mode` 中运行，并返回更改状态预测，而无需修改目标。
diff_mode	支持: 不支持	在差异模式下，将返回已更改（或可能需要在 `check_mode` 中更改）的详细信息。

示例 

- name: "Adding a project deploy key"
  community.general.gitlab_deploy_key:
    api_url: https://gitlab.example.com/
    api_token: "{{ api_token }}"
    project: "my_group/my_project"
    title: "Jenkins CI"
    state: present
    key: "ssh-rsa AAAAB3NzaC1yc2EAAAABJQAAAIEAiPWx6WM4lhHNedGfBpPJNPpZ7yKu+dnn1SJejgt4596k6YjzGGphH2TUxwKzxcKDKKezwkpfnxPkSMkuEspGRt/aZZ9w..."

- name: "Update the above deploy key to add push access"
  community.general.gitlab_deploy_key:
    api_url: https://gitlab.example.com/
    api_token: "{{ api_token }}"
    project: "my_group/my_project"
    title: "Jenkins CI"
    state: present
    can_push: true

- name: "Remove the previous deploy key from the project"
  community.general.gitlab_deploy_key:
    api_url: https://gitlab.example.com/
    api_token: "{{ api_token }}"
    project: "my_group/my_project"
    state: absent
    key: "ssh-rsa AAAAB3NzaC1yc2EAAAABJQAAAIEAiPWx6WM4lhHNedGfBpPJNPpZ7yKu+dnn1SJejgt4596k6YjzGGphH2TUxwKzxcKDKKezwkpfnxPkSMkuEspGRt/aZZ9w..."

返回值 

常见的返回值记录在此处，以下是此模块特有的字段

键	描述
deploy_key 字典	API 对象返回: 总是
error 字符串	GitLab API 返回的错误消息返回: 失败示例: `"400: key is already in use"`
msg 字符串	成功或失败消息返回: 总是示例: `"Success"`
result 字典	来自服务器的 JSON 解析响应返回: 总是

作者

Marcus Watkins (@marwatk)
Guillaume Martinez (@Lunik)