community.kubernetes.k8s_auth – Авторизация в кластерах Kubernetes, требующих явную авторизацию

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

Описание

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

Требования

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

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

Параметры

Примеры

- 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 }}"

Возвращаемые значения

Общие возвращаемые значения описаны здесь, следующие являются полями, уникальными для этого модуля:

Авторы

• Команда KubeVirt (@kubevirt)