kubernetes.core.k8s_auth – Аутентификация в кластерах Kubernetes, требующих явного входа в систему
Примечание
Этот плагин входит в коллекцию kubernetes.core (версия 1.1.1).
Для его установки используйте: ansible-galaxy collection install kubernetes.core.
Для использования в playbook укажите: kubernetes.core.k8s_auth.
Обзор
- Этот модуль обрабатывает аутентификацию в кластерах Kubernetes, требующих явной процедуры аутентификации, то есть тех, где клиент входит в систему (получает маркер аутентификации), выполняет операции API с использованием данного маркера, а затем выходит из системы (отменяет маркер). Примером дистрибутива Kubernetes, требующего этого модуля, является OpenShift.
- С другой стороны, популярная конфигурация для аутентификации по имени пользователя и паролю использует 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, подключитесь к серверу 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)
kubernetes.core.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
kubernetes.core.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
kubernetes.core.k8s_auth:
state: absent
api_key: "{{ k8s_auth_results.k8s_auth.api_key }}"
Возвращаемые значения
Общие возвращаемые значения документированы здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание | |
|---|---|---|---|
| k8s_auth сложный | success | Факты аутентификации Kubernetes. | |
| api_key строка | success | Маркер аутентификации. | |
| ca_cert строка | success | Путь к файлу сертификата CA, используемому для проверки подключения к серверу API. | |
| host строка | success | URL для доступа к серверу API. | |
| username строка | success | Имя пользователя для аутентификации на сервере API. | |
| validate_certs boolean | success | Проверять ли 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/kubernetes/core/k8s_auth_module.html