Модуль kubernetes.core.helm_plugin — управление плагинами Helm
Примечание
Этот модуль входит в коллекцию kubernetes.core (версия 6.4.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install kubernetes.core. Для использования этого модуля требуются дополнительные компоненты; подробности см. в разделе Требования.
Чтобы использовать модуль в плейбуке, укажите: kubernetes.core.helm_plugin.
Добавлено в kubernetes.core 1.0.0
Краткое описание
- Управляет плагинами Helm.
Примечание
Этому модулю соответствует плагин действий.
Требования
На узле, выполняющем этот модуль, должны быть установлены следующие компоненты.
- helm >= 3.0.0 (https://github.com/helm/helm/releases)
Параметры
Параметр | Комментарии |
|---|---|
api_key string добавлено в kubernetes.core 1.2.0 | Токен для аутентификации в API. Также можно указать с помощью переменной среды |
binary_path path | Путь к исполняемому файлу helm, который следует использовать. |
ca_cert aliases: ssl_ca_cert path добавлено в kubernetes.core 1.2.0 | Путь к сертификату CA для аутентификации в API. Чтобы избежать ошибок проверки сертификата, необходимо указать всю цепочку сертификатов. Также можно указать с помощью переменной среды |
context aliases: kube_context string | Параметр Helm, задающий контекст kubeconfig, который следует использовать. Если значение не указано в задаче, вместо него будет использовано значение переменной среды |
host string добавлено в kubernetes.core 1.2.0 | URL для доступа к API. Также можно указать с помощью переменной среды |
kubeconfig aliases: kubeconfig_path any | Параметр Helm, задающий путь к kubeconfig, который следует использовать. Если значение не указано в задаче, вместо него будет использовано значение переменной среды Конфигурацию можно передать в виде словаря. Добавлено в версии 2.4.0. |
plugin_name string | Имя плагина Helm. Обязателен только для |
plugin_path string | Путь к плагину в локальной файловой системе или URL удалённого репозитория VCS. Если указан путь к плагину в файловой системе, убедитесь, что tar установлен на удалённом компьютере, а не на контроллере Ansible. Обязателен только для |
plugin_version string добавлено в kubernetes.core 2.3.0 | Версия устанавливаемого плагина. Если не указана, устанавливается последняя версия. Игнорируется, если |
state string | Если Если Если Варианты:
|
validate_certs aliases: verify_ssl boolean добавлено в kubernetes.core 1.2.0 | Следует ли проверять SSL-сертификаты сервера API. Также можно указать с помощью переменной среды Варианты:
|
verify boolean добавлено в kubernetes.core 6.4.0 | Проверять подпись плагина перед установкой. Для этого параметра требуется helm версии >= 4.0.0 Используется с state=present. Варианты:
|
Примеры
- 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 string | Полная команда `helm`, сформированная этим модулем. Она может понадобиться, если вы захотите повторно выполнить команду вне модуля или отладить проблему. Возвращается: всегда Пример: |
msg string | Информация об успешном выполнении команды Возвращается: всегда Пример: |
rc integer | Код возврата команды плагина Helm Возвращается: всегда Пример: |
stderr string | Полный вывод команды `helm` в stderr. Его можно отобразить или изучить в журнале событий. Возвращается: всегда Пример: |
stdout string | Полный вывод команды `helm` в stdout. Его можно отобразить или изучить в журнале событий. Возвращается: всегда Пример: |
Ссылки на коллекцию
© 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/kubernetes/core/helm_plugin_module.html