Модуль community.general.github_key — Управление ключами доступа к GitHub

Примечание

Этот модуль входит в коллекцию community.general (версия 9.5.0).

Эта коллекция, возможно, уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install community.general.

Для использования в книге задач укажите: community.general.github_key.

Описание
Параметры
Атрибуты
Примеры
Возвращаемые значения

Описание

Создает, удаляет или обновляет ключи доступа к GitHub.

Параметры

Параметр	Комментарии
force boolean	По умолчанию `true`, что заменит существующий удаленный ключ, если он отличается от `pubkey`. Если `false`, ключ будет установлен только если ключ с указанным `name` не существует. Варианты: `false` `true` ← (по умолчанию)
name строка / обязательно	Имя ключа SSH
pubkey строка	Значение открытого ключа SSH. Требуется при `state=present`.
state строка	Удалить ключ, убедиться, что он существует, или обновить его значение. Варианты: `"present"` ← (по умолчанию) `"absent"`
token строка / обязательно	Токен доступа к GitHub с разрешением на просмотр и создание открытых ключей.

Атрибуты

Атрибут	Поддержка	Описание
check_mode	Поддержка: полная	Может работать в режиме `check_mode` и возвращать прогноз изменения статуса без модификации целевого объекта.
diff_mode	Поддержка: нет	Вернёт подробности о том, что изменилось (или, возможно, нуждается в изменении в `check_mode`), при использовании diff-режима.

Примеры

- name: Read SSH public key to authorize
  ansible.builtin.shell: cat /home/foo/.ssh/id_rsa.pub
  register: ssh_pub_key

- name: Authorize key with GitHub
  local_action:
    module: github_key
    name: Access Key for Some Machine
    token: '{{ github_access_token }}'
    pubkey: '{{ ssh_pub_key.stdout }}'

# Alternatively, a single task can be used reading a key from a file on the controller
- name: Authorize key with GitHub
  community.general.github_key:
    name: Access Key for Some Machine
    token: '{{ github_access_token }}'
    pubkey: "{{ lookup('ansible.builtin.file', '/home/foo/.ssh/id_rsa.pub') }}"

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

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

Ключ	Описание
deleted_keys список / элементы=строка	Массив объектов ключей, которые были удалены. Присутствует только при state=absent Возвращается: При state=absent Пример: `[{"created_at": "YYYY-MM-DDTHH:MM:SZ", "id": 0, "key": "BASE64 encoded key", "read_only": false, "url": "http://example.com/github key"}]`
key словарь	Метаданные о только что созданном ключе. Присутствует только при state=present Возвращается: успех Пример: `{"created_at": "YYYY-MM-DDTHH:MM:SZ", "id": 0, "key": "BASE64 encoded key", "read_only": false, "url": "http://example.com/github key"}`
matching_keys список / элементы=строка	Массив ключей, соответствующих заданному имени. Присутствует только при state=present Возвращается: При state=present Пример: `[{"created_at": "YYYY-MM-DDTHH:MM:SZ", "id": 0, "key": "BASE64 encoded key", "read_only": false, "url": "http://example.com/github key"}]`

Авторы

Robert Estelle (@erydo)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/general/github_key_module.html