Модуль community.general.jenkins_credential — управление учетными данными и доменами Jenkins через API

Краткое описание

• Этот модуль позволяет управлять учетными данными Jenkins и областями действия доменов через HTTP API Jenkins.
• Создание, обновление и удаление учетных данных различных типов, таких как username/password, secret text, SSH key, certificates, GitHub App, а также доменов.
• Для областей действия доменов (type=scope) модуль поддерживает ограничения на основе hostname, hostname:port, path и scheme.

Требования

На узле, выполняющем этот модуль, должны быть установлены следующие компоненты.

• urllib3 >= 1.26.0

Параметры

Атрибуты

Примеры

- name: Generate token
  community.general.jenkins_credential:
    name: "test-token"
    jenkins_user: "admin"
    jenkins_password: "password"
    type: "token"
  register: token_result

- name: Save Jenkins token to INI file (you must secure/encrypt separately)
  vars:
    jenkins_token_ini: # Defining dict for to_ini filter
      api_token:
        uuid: "{{ token_result.token_uuid }}"
        token: "{{ token_result.token }}"
  ansible.builtin.copy:
    dest: "/secure/path/jenkins_token.ini"
    mode: '0600'
    content: "{{ jenkins_token_ini | community.general.to_ini }}"

# Note:
# (1) Jenkins token is intended to be securely stored in encrypted storage
#     or secrets vault outside the playbook, retrieved when needed.
# (2) Examples below showcasing token retrieval from
#     variable "token_result" are NOT how it should be used to add credentials.
# (3) Data in "token_result" is inconsistent and unavailable
#     across different playbooks and multiple executions.

- name: Add CUSTOM scope credential
  community.general.jenkins_credential:
    id: "CUSTOM"
    type: "scope"
    jenkins_user: "admin"
    token: "{{ token_result.token }}"
    description: "Custom scope credential"
    inc_path:
      - "include/path"
      - "include/path2"
    exc_path:
      - "exclude/path"
      - "exclude/path2"
    inc_hostname:
      - "included-hostname"
      - "included-hostname2"
    exc_hostname:
      - "excluded-hostname"
      - "excluded-hostname2"
    schemes:
      - "http"
      - "https"
    inc_hostname_port:
      - "included-hostname:7000"
      - "included-hostname2:7000"
    exc_hostname_port:
      - "excluded-hostname:7000"
      - "excluded-hostname2:7000"

- name: Add user_and_pass credential
  community.general.jenkins_credential:
    id: "userpass-id"
    type: "user_and_pass"
    jenkins_user: "admin"
    token: "{{ token_result.token }}"
    description: "User and password credential"
    username: "user1"
    password: "pass1"

- name: Add file credential to custom scope
  community.general.jenkins_credential:
    id: "file-id"
    type: "file"
    jenkins_user: "admin"
    token: "{{ token_result.token }}"
    scope: "CUSTOM"
    description: "File credential"
    file_path: "../vars/my-secret.pem"

- name: Add text credential to folder
  community.general.jenkins_credential:
    id: "text-id"
    type: "text"
    jenkins_user: "admin"
    token: "{{ token_result.token }}"
    description: "Text credential"
    secret: "mysecrettext"
    location: "folder"
    url: "http://localhost:8080/job/test"

- name: Add githubApp credential
  community.general.jenkins_credential:
    id: "githubapp-id"
    type: "github_app"
    jenkins_user: "admin"
    token: "{{ token_result.token }}"
    description: "GitHub app credential"
    appID: "12345"
    file_path: "../vars/github.pem"
    owner: "github_owner"

- name: Add sshKey credential
  community.general.jenkins_credential:
    id: "sshkey-id"
    type: "ssh_key"
    jenkins_user: "admin"
    token: "{{ token_result.token }}"
    description: "SSH key credential"
    username: "sshuser"
    file_path: "../vars/ssh_key"
    passphrase: 1234

- name: Add certificate credential (p12)
  community.general.jenkins_credential:
    id: "certificate-id"
    type: "certificate"
    jenkins_user: "admin"
    token: "{{ token_result.token }}"
    description: "Certificate credential"
    password: "12345678901234"
    file_path: "../vars/certificate.p12"

- name: Add certificate credential (pem)
  community.general.jenkins_credential:
    id: "certificate-id-pem"
    type: "certificate"
    jenkins_user: "admin"
    token: "{{ token_result.token }}"
    description: "Certificate credential (pem)"
    file_path: "../vars/cert.pem"
    private_key_path: "../vars/private.key"

Возвращаемые значения

Общие возвращаемые значения описаны здесь. Ниже перечислены поля, уникальные для этого модуля: