Spec-Zone.ru › Ansible

kubernetes.core.helm_repository модуль — Управление репозиториями Helm.

Примечание

Этот модуль входит в коллекцию kubernetes.core (версия 3.2.0).

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

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

Чтобы использовать его в playbook, укажите: kubernetes.core.helm_repository.

Добавлена в kubernetes.core 0.11.0

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

Описание

  • Управление репозиториями Helm.

Примечание

Для этого модуля существует соответствующий плагин действий.

Требования

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

  • helm (https://github.com/helm/helm/releases)
  • yaml (https://pypi.org/project/PyYAML/)

Параметры

Параметр

Комментарии

api_key

string

added in kubernetes.core 2.3.0

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

binary_path

path

Путь к исполняемому файлу helm.

ca_cert

aliases: ssl_ca_cert

path

added in kubernetes.core 2.3.0

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

context

aliases: kube_context

string

added in kubernetes.core 2.4.0

Параметр Helm для указания контекста kubeconfig, который нужно использовать.

Если значение не указано в задаче, вместо него будет использовано значение переменной среды K8S_AUTH_CONTEXT.

force_update

aliases: force

boolean

added in kubernetes.core 2.4.0

Заменять ли репозиторий, если он уже существует.

Варианты:

  • false ← (default)
  • true

host

string

added in kubernetes.core 2.3.0

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

kubeconfig

aliases: kubeconfig_path

any

added in kubernetes.core 2.4.0

Параметр Helm для указания пути к kubeconfig.

Если значение не указано в задаче, вместо него будет использовано значение переменной среды K8S_AUTH_KUBECONFIG.

Конфигурация может быть предоставлена в виде словаря.

pass_credentials

boolean

added in kubernetes.core 2.3.0

Передавать ли учетные данные во все домены.

Варианты:

  • false ← (default)
  • true

repo_name

aliases: name

string / required

Имя репозитория диаграмм.

repo_password

aliases: password

string

Пароль репозитория диаграмм для репозитория с базовой аутентификацией.

Обязательно, если указан chart_repo_username.

repo_state

aliases: state

string

Требуемое состояние репозитория.

Варианты:

  • "present" ← (default)
  • "absent"

repo_url

aliases: url

string

URL репозитория диаграмм

repo_username

aliases: username

string

Имя пользователя репозитория диаграмм для репозитория с базовой аутентификацией.

Обязательно, если указан chart_repo_password.

validate_certs

aliases: verify_ssl

boolean

added in kubernetes.core 2.3.0

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

Варианты:

  • false
  • true ← (default)

Примеры

- name: Add a repository
  kubernetes.core.helm_repository:
    name: stable
    repo_url: https://kubernetes.github.io/ingress-nginx

- name: Add Red Hat Helm charts repository
  kubernetes.core.helm_repository:
    name: redhat-charts
    repo_url: https://redhat-developer.github.com/redhat-helm-charts

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

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

Ключ

Описание

command

строка

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

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

Пример: "/usr/local/bin/helm repo add bitnami https://charts.bitnami.com/bitnami"

msg

строка

Сообщение об ошибке, возвращенное командой `helm`

Возвращается: при ошибке

Пример: "Repository already have a repository named bitnami"

stderr

строка

Полный вывод стандартного потока ошибок `helm` команды, в случае, если вы хотите его отобразить или изучить журнал событий

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

Пример: ""

stderr_lines

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

Полный вывод стандартного потока ошибок `helm` команды в виде списка, в случае, если вы хотите его отобразить или изучить журнал событий

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

Пример: [""]

stdout

строка

Полный вывод стандартного потока вывода `helm` команды, в случае, если вы хотите его отобразить или изучить журнал событий

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

Пример: "\"bitnami\" has been added to your repositories"

stdout_lines

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

Полный вывод стандартного потока вывода `helm` команды в виде списка, в случае, если вы хотите его отобразить или изучить журнал событий

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

Пример: ["\"bitnami\" has been added to your repositories"]

Авторы

  • Lucas Boisserie (@LucasBoisserie)

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

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

© 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/kubernetes/core/helm_repository_module.html

Spec-Zone.ru

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