Модуль kubernetes.core.helm_plugin – Управление плагинами Helm

Примечание

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

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

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

Для использования в playbook, укажите: kubernetes.core.helm_plugin.

Новое в kubernetes.core 1.0.0

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

Краткое описание

Управляет плагинами Helm.

Примечание

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

Требования

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

helm (https://github.com/helm/helm/releases)

Параметры

Параметр	Комментарии
api_key string добавлено в kubernetes.core 1.2.0	Токен, используемый для аутентификации с API. Также может быть указан через переменную окружения `K8S_AUTH_API_KEY`.
binary_path path	Путь к исполняемому файлу helm.
ca_cert псевдонимы: ssl_ca_cert path добавлено в kubernetes.core 1.2.0	Путь к сертификату CA, используемому для аутентификации с API. Для избежания ошибок проверки сертификата необходимо указать полную цепочку сертификатов. Также может быть указан через переменную окружения `K8S_AUTH_SSL_CA_CERT`.
context псевдонимы: kube_context string	Параметр Helm для указания контекста kubeconfig, который нужно использовать. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `K8S_AUTH_CONTEXT`.
host string добавлено в kubernetes.core 1.2.0	Укажите URL для доступа к API. Также может быть указан через переменную окружения `K8S_AUTH_HOST`.
kubeconfig псевдонимы: kubeconfig_path any	Параметр Helm для указания пути к kubeconfig. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `K8S_AUTH_KUBECONFIG`. Конфигурацию можно задать в виде словаря. Добавлено в версии 2.4.0.
plugin_name string	Имя плагина Helm. Требуется только если `state=absent` или `state=latest`.
plugin_path string	Путь к плагину в вашей локальной файловой системе или URL-адрес удаленного репозитория VCS. Если указан путь к плагину из файловой системы, убедитесь, что tar присутствует на удаленной машине, а не на контроллере Ansible. Требуется только если `state=present`.
plugin_version string добавлено в kubernetes.core 2.3.0	Версия плагина для установки. Если это не указано, устанавливается последняя версия. Игнорируется, когда `state=absent` или `state=latest`.
state string	Если `state=present` плагин Helm будет установлен. Если `state=latest` плагин Helm будет обновлен. Добавлено в версии 2.3.0. Если `state=absent` плагин Helm будет удален. Варианты: `"absent"` `"present"` ← (по умолчанию) `"latest"`
validate_certs псевдонимы: verify_ssl boolean добавлено в kubernetes.core 1.2.0	Проверять ли SSL-сертификаты сервера API. Также может быть указан через переменную окружения `K8S_AUTH_VERIFY_SSL`. Варианты: `false` `true` ← (по умолчанию)

Примеры

- name: Install Helm env plugin
  kubernetes.core.helm_plugin:
    plugin_path: https://github.com/adamreese/helm-env
    state: present

- name: Install Helm plugin from local filesystem
  kubernetes.core.helm_plugin:
    plugin_path: https://domain/path/to/plugin.tar.gz
    state: present

- name: Remove Helm env plugin
  kubernetes.core.helm_plugin:
    plugin_name: env
    state: absent

- name: Install Helm plugin with a specific version
  kubernetes.core.helm_plugin:
    plugin_version: 2.0.1
    plugin_path: https://domain/path/to/plugin.tar.gz
    state: present

- name: Update Helm plugin
  kubernetes.core.helm_plugin:
    plugin_name: secrets
    state: latest

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

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

Ключ	Описание
command строка	Полная команда `helm`, созданная этим модулем, в случае необходимости повторного выполнения команды вне модуля или отладки проблемы. Возвращается: всегда Пример: `"helm plugin list ..."`
msg строка	Информация об успешном выполнении команды Возвращается: всегда Пример: `"Plugin installed successfully"`
rc целое число	Код возврата команды плагина helm Возвращается: всегда Пример: `1`
stderr строка	Полная stderr команды `helm`, в случае необходимости отображения или анализа журнала событий Возвращается: всегда Пример: `""`
stdout строка	Полная stdout команды `helm`, в случае необходимости отображения или анализа журнала событий Возвращается: всегда Пример: `""`

Авторы

Abhijeet Kasurde (@Akasurde)

Ссылки на коллекцию

© 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_plugin_module.html