Spec-Zone.ru › Ansible

Модуль community.okd.openshift_registry_info — Отображение информации об интегрированном репозитории.

Примечание

Этот модуль входит в коллекцию community.okd (версия 3.0.1).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить её установку, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install community.okd. Для использования этого модуля необходимы дополнительные требования. Подробности см. в разделе Требования.

Чтобы использовать его в книге задач, укажите: community.okd.openshift_registry_info.

Новая функция в community.okd 2.2.0

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

Описание

  • Этот модуль предоставляет информацию об интегрированном репозитории.
  • Используйте check для проверки возможности локального клиента получить доступ к репозиторию.
  • Если администратор не настроила общедоступное имя хоста для репозитория, эта команда может завершиться ошибкой при выполнении вне сервера.
  • Аналогично oc registry info.

Требования

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

  • python >= 3.6
  • kubernetes >= 12.0.0
  • docker-image-py

Параметры

Параметр

Комментарии

api_key

строка

Токен, используемый для аутентификации с API. Также может быть задан через переменную окружения K8S_AUTH_API_KEY.

ca_cert

алиасы: ssl_ca_cert

путь

Путь к сертификату CA, используемому для аутентификации с API. Для предотвращения ошибок проверки сертификата необходимо предоставить весь цепочку сертификатов. Также может быть задан через переменную окружения K8S_AUTH_SSL_CA_CERT.

check

логическое

Попытка связаться с интегрированным реестром с использованием локального клиента.

Варианты:

  • false ← (по умолчанию)
  • true

client_cert

алиасы: cert_file

путь

Путь к сертификату, используемому для аутентификации с API. Также может быть задан через переменную окружения K8S_AUTH_CERT_FILE.

client_key

алиасы: key_file

путь

Путь к файлу ключа, используемому для аутентификации с API. Также может быть задан через переменную окружения K8S_AUTH_KEY_FILE.

context

строка

Имя контекста, найденного в файле конфигурации. Также может быть задан через переменную окружения K8S_AUTH_CONTEXT.

host

строка

Укажите URL для доступа к API. Также может быть задан через переменную окружения K8S_AUTH_HOST.

impersonate_groups

список / элементы=строка

добавлен в kubernetes.core 2.3.0

Группа(ы) для импользования для операции.

Также может быть задан через переменную окружения K8S_AUTH_IMPERSONATE_GROUPS. Пример: Group1,Group2

impersonate_user

строка

добавлен в kubernetes.core 2.3.0

Имя пользователя для импользования для операции.

Также может быть задан через переменную окружения K8S_AUTH_IMPERSONATE_USER.

kubeconfig

любой

Путь к существующему файлу конфигурации Kubernetes. Если не указан и не предоставлены другие параметры подключения, клиент Kubernetes попытается загрузить файл конфигурации по умолчанию из ~/.kube/config. Также может быть задан через переменную окружения K8S_AUTH_KUBECONFIG.

Несколько файлов конфигурации Kubernetes могут быть предоставлены, используя разделитель «;» для платформы Windows или «:» для других платформ.

Конфигурация Kubernetes может быть предоставлена в виде словаря. Эта функция требует библиотеки kubernetes для Python версии >= 17.17.0. Добавлена в версии 2.2.0.

no_proxy

строка

добавлен в kubernetes.core 2.3.0

Список хостов/доменов/IP/CIDR через запятую, которые не должны проходить через прокси. Также может быть задан через переменную окружения K8S_AUTH_NO_PROXY.

Обратите внимание, что этот модуль не подхватывает типичные настройки прокси из среды (например, NO_PROXY).

Эта функция требует kubernetes >= 19.15.0. Если библиотека kubernetes меньше 19.15.0, то она завершается ошибкой, даже если no_proxy задан правильно.

Пример значения: «localhost,.local,.example.com,127.0.0.1,127.0.0.0/8,10.0.0.0/8,172.16.0.0/12,192.168.0.0/16»

password

строка

Укажите пароль для аутентификации с API. Также может быть задан через переменную окружения K8S_AUTH_PASSWORD.

Пожалуйста, ознакомьтесь с описанием параметра username, чтобы понять, когда этот параметр применим.

persist_config

логическое

Сохранять или нет токены обновления конфигурации kube. Также может быть задан через переменную окружения K8S_AUTH_PERSIST_CONFIG.

Когда контекст k8s использует учетные данные пользователя с токенами обновления (например, oidc или gke/gcloud auth), токен обновляется библиотекой k8s для Python, но по умолчанию не сохраняется. Поэтому старый токен обновления может истечь, и следующая аутентификация может завершиться ошибкой. Установка этого флага в true укажет библиотеке k8s для Python на сохранение нового токена обновления в файл конфигурации kube.

По умолчанию false.

Обратите внимание, что текущая версия библиотеки k8s для Python пока не поддерживает установку этого флага в True.

Исправление для этой библиотеки k8s для Python находится здесь: https://github.com/kubernetes-client/python-base/pull/169

Варианты:

  • false
  • true

proxy

строка

URL HTTP-прокси, который необходимо использовать для подключения. Также может быть задан через переменную окружения K8S_AUTH_PROXY.

Обратите внимание, что этот модуль не подхватывает типичные настройки прокси из среды (например, HTTP_PROXY).

proxy_headers

словарь

добавлен в kubernetes.core 2.0.0

Заголовок, используемый для HTTP-прокси.

Документацию можно найти здесь https://urllib3.readthedocs.io/en/latest/reference/urllib3.util.html?highlight=proxy_headers#urllib3.util.make_headers.

basic_auth

строка

Разделенный двоеточием имя пользователя:пароль для заголовка базовой аутентификации.

Также может быть задан через переменную окружения K8S_AUTH_PROXY_HEADERS_BASIC_AUTH.

proxy_basic_auth

string

Значение имени пользователя и пароля через двоеточие для заголовка прокси-аутентификации по схеме basic.

Также можно указать через переменную окружения K8S_AUTH_PROXY_HEADERS_PROXY_BASIC_AUTH.

user_agent

string

Строка, представляющая пользовательский агент, например, foo/1.0.

Также можно указать через переменную окружения K8S_AUTH_PROXY_HEADERS_USER_AGENT.

username

string

Укажите имя пользователя для аутентификации с API. Также может быть указано через переменную окружения K8S_AUTH_USERNAME.

Обратите внимание, что это работает только с кластерами, настроенными на использование HTTP Basic Auth. Если ваш кластер имеет другой вид аутентификации (например, OAuth2 в OpenShift), этот параметр не будет работать должным образом, и вам следует обратиться к модулю community.okd.k8s_auth, так как он может выполнить необходимые действия.

validate_certs

aliases: verify_ssl

boolean

Производить ли проверку SSL-сертификатов сервера API. Также может быть указано через переменную окружения K8S_AUTH_VERIFY_SSL.

Варианты:

  • false
  • true

Примечания

Примечание

  • Чтобы избежать ошибок проверки SSL-сертификатов, когда validate_certs равно True, полная цепочка сертификатов сервера API должна быть предоставлена через ca_cert или в файле kubeconfig.

Примеры

# Get registry information
- name: Read integrated registry information
  community.okd.openshift_registry_info:

# Read registry integrated information and attempt to contact using local client.
- name: Attempt to contact integrated registry using local client
  community.okd.openshift_registry_info:
    check: true

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

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

Ключ

Описание

check

dictionary

Можно ли локальному клиенту связаться с реестром.

Возвращается: success

msg

string

Сообщение, описывающее операцию проверки связи.

Возвращается: всегда

reached

string

Доступен ли реестр.

Возвращается: success

internal_hostname

string

Имя хоста внутреннего реестра.

Возвращается: success

public_hostname

string

Имя хоста публичного реестра.

Возвращается: success

Авторы

  • Aubin Bikouo (@abikouo)

Ссылки на сборку

  • Отслеживание задач
  • Репозиторий (исходные коды)

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/okd/openshift_registry_info_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API