Spec-Zone.ru › Ansible 2.11

community.okd.openshift_auth – Авторизация в кластерах OpenShift, требующих явную процедуру входа

Примечание

Этот плагин является частью коллекции community.okd (версия 1.0.1).

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

Для использования в плейбуке укажите: community.okd.openshift_auth.

Новое в версии 0.2.0: из community.okd

  • Обзор
  • Требования
  • Параметры
  • Примеры
  • Возвращаемые значения

Обзор

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

Требования

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

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

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
api_key
строка
Если state установлено в absent, это указывает токен для отмены.
ca_cert
путь
Путь к файлу сертификата CA, используемому для проверки соединения с сервером API. Необходимо предоставить полный цепочку сертификатов, чтобы избежать ошибок валидации сертификатов.

псевдонимы: ssl_ca_cert
host
строка / обязательно
Укажите URL для доступа к серверу API.
password
строка
Укажите пароль для аутентификации на сервере API.
state
строка
    Варианты:
  • present ←
  • absent
Если установлено в present, подключитесь к серверу API по URL, указанному в host, и выполните попытку входа.
Если установлено в absent, выполните попытку выхода, отменив токен аутентификации, указанный в api_key.
username
строка
Укажите имя пользователя для аутентификации на сервере API.
validate_certs
булево
    Варианты:
  • no
  • yes ←
Указывает, нужно ли проверять SSL-сертификаты сервера API.

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

Примеры

- hosts: localhost
  module_defaults:
    group/k8s:
      host: https://k8s.example.com/
      ca_cert: ca.pem
  tasks:
  - block:
    # It's good practice to store login credentials in a secure vault and not
    # directly in playbooks.
    - 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
сложный
success
То же, что и у openshift_auth. Сохранено только для обратной совместимости

api_key
строка
success
Токен аутентификации.

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

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

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

validate_certs
булево
success
Указывает, нужно ли проверять SSL-сертификаты сервера API.

openshift_auth
сложный
success
Данные аутентификации OpenShift.

api_key
строка
success
Токен аутентификации.

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

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

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

validate_certs
булево
success
Указывает, нужно ли проверять SSL-сертификаты сервера API.



Авторы

  • Команда KubeVirt (@kubevirt)
  • Фёбиан фон Фейлитцш (@fabianvf)

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

Spec-Zone.ru

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