community.kubernetes.k8s_auth – Авторизация в кластерах Kubernetes, требующих явную процедуру входа
Примечание
Этот плагин входит в коллекцию community.kubernetes (версия 1.1.1).
Для его установки используйте: ansible-galaxy collection install community.kubernetes.
Для использования в книге задач укажите: community.kubernetes.k8s_auth.
Обзор
- Этот модуль отвечает за аутентификацию в кластерах Kubernetes, требующих явных процедур аутентификации, то есть таких, где клиент входит в систему (получает маркер аутентификации), выполняет операции API с помощью указанного маркера, а затем выходит из системы (отменяет маркер). Примером распределения Kubernetes, требующего этого модуля, является OpenShift.
- С другой стороны, популярной конфигурацией для аутентификации по имени пользователя и паролю является использование HTTP Basic Auth, которая не включает дополнительных шагов входа/выхода (вместо этого учетные данные для входа могут быть прикреплены к каждому выполняемому вызову API) и, следовательно, обрабатывается непосредственно модулем
k8s(и другими модулями, специфичными для ресурсов), используя параметрыhost,usernameиpassword. Обратитесь к документации вашего предпочтительного модуля для получения дополнительных сведений.
Примечание
У этого модуля есть соответствующий плагин действий.
Требования
Ниже перечислены требования, необходимые на хосте, который выполняет этот модуль.
- python >= 2.7
- urllib3
- requests
- requests-oauthlib
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| api_key строка | Когда state установлено в отсутствует, это указывает токен для отмены. | |
| ca_cert путь | Путь к файлу сертификата CA, используемого для проверки подключения к серверу API. Полная цепочка сертификатов должна быть предоставлена, чтобы избежать ошибок проверки сертификатов. псевдонимы: ssl_ca_cert | |
| host строка / обязательно | Укажите URL для доступа к серверу API. | |
| password строка | Укажите пароль для аутентификации на сервере API. | |
| state строка |
| Если установлено в present, подключитесь к серверу API по URL, указанному в host, и попробуйте войти в систему.Если установлено в отсутствует, попробуйте выйти из системы, отменив токен аутентификации, указанный в api_key. |
| username строка | Укажите имя пользователя для аутентификации на сервере API. | |
| validate_certs булево |
| Нужно ли проверять 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: k8s_passwords.yml
- name: Log in (obtain access token)
community.kubernetes.k8s_auth:
username: admin
password: "{{ k8s_admin_password }}"
register: k8s_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
community.kubernetes.k8s_info:
api_key: "{{ k8s_auth_results.k8s_auth.api_key }}"
kind: Pod
register: pod_list
always:
- name: If login succeeded, try to log out (revoke access token)
when: k8s_auth_results.k8s_auth.api_key is defined
community.kubernetes.k8s_auth:
state: absent
api_key: "{{ k8s_auth_results.k8s_auth.api_key }}"
Возвращаемые значения
Общие возвращаемые значения описаны в разделе, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание | |
|---|---|---|---|
| k8s_auth сложный | успешно | Факты аутентификации Kubernetes. | |
| api_key строка | успешно | Токен аутентификации. | |
| ca_cert строка | успешно | Путь к файлу сертификата CA, используемого для проверки подключения к серверу API. | |
| host строка | успешно | URL для доступа к серверу API. | |
| username строка | успешно | Имя пользователя для аутентификации на сервере API. | |
| validate_certs булево | успешно | Нужно ли проверять SSL-сертификаты сервера API. | |
Авторы
- Команда KubeVirt (@kubevirt)
© 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/kubernetes/k8s_auth_module.html