Spec-Zone.ru › Ansible

Модуль community.okd.openshift_auth — аутентификация в кластерах OpenShift, требующих явного входа в систему

Примечание

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

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

Для установки используйте: ansible-galaxy collection install community.okd. Для использования этого модуля необходимы дополнительные требования; подробности см. в разделе Требования.

Чтобы использовать модуль в плейбуке, укажите: community.okd.openshift_auth.

Добавлено в community.okd 0.2.0

  • Краткое описание
  • Требования
  • Параметры
  • Примеры
  • Возвращаемые значения

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

  • Этот модуль выполняет аутентификацию в кластерах OpenShift, требующих явных процедур аутентификации: клиент входит в систему (получает токен аутентификации), выполняет операции API с помощью этого токена, а затем выходит из системы (отзывает токен).
  • С другой стороны, популярная конфигурация аутентификации по имени пользователя и паролю использует HTTP Basic Auth и не включает дополнительных шагов входа и выхода из системы (вместо этого учетные данные для входа можно прикреплять к каждому выполняемому вызову API). Поэтому такая аутентификация обрабатывается непосредственно модулем k8s (и другими модулями для конкретных ресурсов) с использованием параметров host, username и password. Дополнительные сведения см. в документации предпочитаемого вами модуля.

Псевдонимы: k8s_auth

Требования

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

  • python >= 3.6
  • urllib3
  • requests
  • requests-oauthlib

Параметры

Параметр

Комментарии

api_key

string

Если для state задано значение absent, указывает токен для отзыва.

ca_cert

псевдонимы: ssl_ca_cert

path

Путь к файлу сертификата CA, используемому для проверки соединения с сервером API. Во избежание ошибок проверки сертификата необходимо предоставить полную цепочку сертификатов.

host

string / обязательный

Укажите URL для доступа к серверу API.

password

string

Укажите пароль для аутентификации на сервере API.

state

string

Если задано значение present, подключиться к серверу API по URL, указанному в host, и попытаться войти в систему.

Если задано значение absent, попытаться выйти из системы, отозвав токен аутентификации, указанный в api_key.

Варианты:

  • "present" ← (по умолчанию)
  • "absent"

username

string

Укажите имя пользователя для аутентификации на сервере API.

validate_certs

псевдонимы: verify_ssl

boolean

Проверять ли SSL-сертификаты сервера API.

Варианты:

  • false
  • true ← (по умолчанию)

Примеры

- name: Example Playbook
  hosts: localhost
  module_defaults:
    group/community.okd.okd:
      host: https://k8s.example.com/
      ca_cert: ca.pem
  tasks:
    - name: Authenticate to OpenShift cluster and gell a list of all pods from any namespace
      block:
        # It's good practice to store login credentials in a secure vault and not
        # directly in playbooks.
        - name: Include 'openshift_passwords.yml'
          ansible.builtin.include_vars: openshift_passwords.yml

        - name: Log in (obtain access token)
          community.okd.openshift_auth:
            username: admin
            password: "{{ openshift_admin_password }}"
          register: openshift_auth_results

        # Previous task provides the token/api_key, while all other parameters
        # are taken from module_defaults
        - name: Get a list of all pods from any namespace
          kubernetes.core.k8s_info:
            api_key: "{{ openshift_auth_results.openshift_auth.api_key }}"
            kind: Pod
          register: pod_list

      always:
        - name: If login succeeded, try to log out (revoke access token)
          when: openshift_auth_results.openshift_auth.api_key is defined
          community.okd.openshift_auth:
            state: absent
            api_key: "{{ openshift_auth_results.openshift_auth.api_key }}"

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

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

Ключ

Описание

k8s_auth

complex

То же, что и возвращаемое значение openshift_auth. Сохранено только для обратной совместимости.

Возвращается: при успехе

api_key

string

Токен аутентификации.

Возвращается: при успехе

ca_cert

string

Путь к файлу сертификата CA, используемому для проверки соединения с сервером API.

Возвращается: при успехе

host

string

URL для доступа к серверу API.

Возвращается: при успехе

username

string

Имя пользователя для аутентификации на сервере API.

Возвращается: при успехе

validate_certs

boolean

Проверять ли SSL-сертификаты сервера API.

Возвращается: при успехе

openshift_auth

complex

Факты аутентификации OpenShift.

Возвращается: при успехе

api_key

string

Токен аутентификации.

Возвращается: при успехе

ca_cert

string

Путь к файлу сертификата CA, используемому для проверки соединения с сервером API.

Возвращается: при успехе

host

string

URL для доступа к серверу API.

Возвращается: при успехе

username

string

Имя пользователя для аутентификации на сервере API.

Возвращается: при успехе

validate_certs

boolean

Проверять ли SSL-сертификаты сервера API.

Возвращается: при успехе

Авторы

  • Команда KubeVirt (@kubevirt)
  • Fabian von Feilitzsch (@fabianvf)

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

  • Отслеживание проблем
  • Репозиторий (исходный код)

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

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API