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_facts:
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. [community]
Авторы
- Команда 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.8/modules/k8s_auth_module.html