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

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

Описание

• Этот модуль выполняет авторизацию в кластерах OpenShift, требующих явную процедуру входа, то есть такие, где клиент входит в систему (получает маркер авторизации), выполняет операции API с использованием этого маркера, а затем выходит из системы (отзывает маркер).
• С другой стороны, популярная конфигурация для авторизации по имени пользователя и паролю использует 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: openshift_passwords.yml

    - name: Log in (obtain access token)
      community.okd.openshift_auth:
        username: admin
        password: "{{ openshift_admin_password }}"
      register: openshift_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: "{{ openshift_auth_results.openshift_auth.api_key }}"
        kind: Pod
      register: pod_list

    always:
    - name: If login succeeded, try to log out (revoke access token)
      when: openshift_auth_results.openshift_auth.api_key is defined
      community.okd.openshift_auth:
        state: absent
        api_key: "{{ openshift_auth_results.openshift_auth.api_key }}"

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

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

Авторы

• Команда KubeVirt (@kubevirt)
• Fabian von Feilitzsch (@fabianvf)