k8s_auth – Авторизация в кластерах Kubernetes, требующих явную процедуру входа
Новое в версии 2.8.
Обзор
- Этот модуль обрабатывает аутентификацию в кластерах 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, и попытаться войти в систему.Если установлено в absent, попытаться выйти из системы, отменив токен аутентификации, указанный в api_key. |
| username - | Укажите имя пользователя для аутентификации на сервере API. | |
| validate_certs boolean |
| Выполнять ли проверку 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)
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
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
k8s_auth:
state: absent
api_key: "{{ k8s_auth_results.k8s_auth.api_key }}"
Возвращаемые значения
Общие возвращаемые значения описаны в этом разделе, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание | |
|---|---|---|---|
| k8s_auth complex | success | Данные о фактах аутентификации Kubernetes. | |
| api_key string | success | Токен аутентификации. | |
| ca_cert string | success | Путь к файлу сертификата CA, используемому для проверки подключения к серверу API. | |
| host string | success | URL для доступа к серверу API. | |
| username string | success | Имя пользователя для аутентификации на сервере API. | |
| validate_certs boolean | success | Выполнять ли проверку SSL-сертификатов сервера API. | |
Статус
- Этот модуль не гарантирует обратную совместимость интерфейса. [превью]
- Этот модуль поддерживается сообществом Ansible. [сообщество]
Авторы
- Команда KubeVirt (@kubevirt)
Подсказка
Если вы обнаружите какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/k8s_auth_module.html