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

Обзор

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

Псевдонимы: k8s_auth

Требования

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

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

Параметры

Примеры

- name: Example Playbook
  hosts: localhost
  module_defaults:
    group/community.okd.okd:
      host: https://k8s.example.com/
      ca_cert: ca.pem
  tasks:
    - name: Authenticate to OpenShift cluster and gell a list of all pods from any namespace
      block:
        # It's good practice to store login credentials in a secure vault and not
        # directly in playbooks.
        - name: Include 'openshift_passwords.yml'
          ansible.builtin.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 }}"

Значения возврата

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