Модуль community.okd.openshift_registry_info — отображение информации об интегрированном реестре.
Примечание
Этот модуль входит в коллекцию community.okd (версия 5.0.0).
Возможно, эта коллекция уже установлена, если вы используете пакет 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 string | Токен для аутентификации в API. Также можно указать с помощью переменной окружения K8S_AUTH_API_KEY. |
ca_cert псевдонимы: ssl_ca_cert path | Путь к сертификату ЦС для аутентификации в API. Чтобы избежать ошибок проверки сертификата, необходимо предоставить всю цепочку сертификатов. Также можно указать с помощью переменной окружения K8S_AUTH_SSL_CA_CERT. |
check boolean | Попытаться обратиться к интегрированному реестру с помощью локального клиента. Варианты:
|
client_cert псевдонимы: cert_file path | Путь к сертификату для аутентификации в API. Также можно указать с помощью переменной окружения K8S_AUTH_CERT_FILE. |
client_key псевдонимы: key_file path | Путь к файлу ключа для аутентификации в API. Также можно указать с помощью переменной окружения K8S_AUTH_KEY_FILE. |
context string | Имя контекста из файла конфигурации. Также можно указать с помощью переменной окружения K8S_AUTH_CONTEXT. |
host string | URL для доступа к API. Также можно указать с помощью переменной окружения K8S_AUTH_HOST. |
impersonate_groups list / элементы=string добавлено в kubernetes.core 2.3.0 | Группа или группы, от имени которых выполняется операция. Также можно указать с помощью переменной окружения K8S_AUTH_IMPERSONATE_GROUPS. Пример: Group1,Group2 |
impersonate_user string добавлено в kubernetes.core 2.3.0 | Имя пользователя, от имени которого выполняется операция. Также можно указать с помощью переменной окружения K8S_AUTH_IMPERSONATE_USER. |
kubeconfig any | Путь к существующему файлу конфигурации Kubernetes. Если путь не указан и другие параметры подключения не заданы, клиент Kubernetes попытается загрузить файл конфигурации по умолчанию из ~/.kube/config. Также можно указать с помощью переменной окружения K8S_AUTH_KUBECONFIG. Можно указать несколько файлов конфигурации Kubernetes, разделив их символом «;» в Windows или символом «:» на других платформах. Конфигурацию Kubernetes можно указать в виде словаря. Для этой возможности требуется версия клиента Python Kubernetes >= 17.17.0. Добавлено в версии 2.2.0. |
no_proxy string добавлено в 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 string | Пароль для аутентификации в API. Также можно указать с помощью переменной окружения K8S_AUTH_PASSWORD. Описание параметра |
persist_config boolean | Сохранять ли токены обновления конфигурации kube. Также можно указать с помощью переменной окружения K8S_AUTH_PERSIST_CONFIG. Если в контексте k8s используются учётные данные пользователя с токенами обновления (например, oidc или gke/gcloud auth), токен обновляется клиентской библиотекой Python k8s, но по умолчанию не сохраняется. Поэтому срок действия старого токена обновления может истечь, и следующая аутентификация завершится ошибкой. Если установить этот флаг в true, клиентская библиотека Python k8s сохранит новый токен обновления в файл конфигурации kube. По умолчанию — false. Обратите внимание: текущая версия клиентской библиотеки Python k8s пока не поддерживает установку этого флага в True. Исправление для этой библиотеки Python k8s находится здесь: https://github.com/kubernetes-client/python-base/pull/169 Варианты:
|
proxy string | URL HTTP-прокси, используемого для подключения. Также можно указать с помощью переменной окружения K8S_AUTH_PROXY. Обратите внимание: этот модуль не использует стандартные настройки прокси из окружения (например, HTTP_PROXY). |
proxy_headers dictionary добавлено в 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 string |
Имя пользователя и пароль, разделённые двоеточием, для заголовка базовой аутентификации. Также можно указать с помощью переменной окружения K8S_AUTH_PROXY_HEADERS_BASIC_AUTH. |
|
proxy_basic_auth string |
Имя пользователя и пароль, разделённые двоеточием, для заголовка базовой аутентификации прокси. Также можно указать с помощью переменной окружения K8S_AUTH_PROXY_HEADERS_PROXY_BASIC_AUTH. |
|
user_agent string |
Строка, задающая желаемое значение user-agent, например 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 псевдонимы: verify_ssl boolean | Проверять ли SSL-сертификаты сервера API. Также можно указать с помощью переменной окружения K8S_AUTH_VERIFY_SSL. Варианты:
|
Примечания
Примечание
- Чтобы избежать ошибок проверки 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 | Может ли локальный клиент связаться с реестром. Возвращается: при успешном выполнении |
|
msg string |
Сообщение с описанием операции проверки связи. Возвращается: всегда |
|
reached string |
Удалось ли связаться с реестром. Возвращается: при успешном выполнении |
internal_hostname string | Внутреннее имя узла реестра. Возвращается: при успешном выполнении |
public_hostname string | Общедоступное имя узла реестра. Возвращается: при успешном выполнении |
Ссылки на коллекцию
© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/community/okd/openshift_registry_info_module.html