Spec-Zone.ru › Ansible

Модуль kubernetes.core.helm_pull — загрузка чарта из репозитория и (при необходимости) распаковка в локальный каталог.

Примечание

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

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

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

Чтобы использовать модуль в сценарии, укажите: kubernetes.core.helm_pull.

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

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

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

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

Требования

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

  • helm >= 3.0.0 (https://github.com/helm/helm/releases)

Параметры

Параметр

Комментарии

binary_path

path

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

chart_ca_cert

path

Проверять сертификаты серверов с поддержкой HTTPS с помощью этого набора сертификатов CA.

Требуется helm >= 3.1.0.

chart_devel

boolean

Использовать также версии для разработки. Эквивалентно версии ‘>0.0.0-0’.

Несовместим с chart_version.

Варианты:

  • false
  • true

chart_ref

string / обязательный

Имя чарта в репозитории чартов.

Абсолютный URL.

chart_ssl_cert_file

path

Идентифицировать HTTPS-клиент с помощью этого файла SSL-сертификата.

Требуется helm >= 3.1.0.

chart_ssl_key_file

path

Идентифицировать HTTPS-клиент с помощью этого файла SSL-ключа.

Требуется helm >= 3.1.0.

chart_version

string

Задает ограничение версии используемого чарта.

Ограничением может быть конкретная метка (например, 1.1.1) или допустимый диапазон (например, ^2.0.0).

Несовместим с chart_devel.

destination

path / обязательный

Каталог для сохранения чарта.

force

boolean

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

Принудительно загрузить чарт, даже если он уже есть в целевом каталоге.

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

При использовании с untar_chart=true перед распаковкой удалит все существующие каталоги чартов.

Варианты:

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

pass_credentials

boolean

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

Варианты:

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

plain_http

boolean

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

Использовать HTTP вместо HTTPS при работе с реестрами OCI.

Требуется Helm >= 3.13.0.

Варианты:

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

provenance

boolean

Загрузить файл provenance, но не выполнять проверку.

Варианты:

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

repo_password

псевдонимы: password, chart_repo_password

string

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

Обязателен, если указан repo_username.

repo_url

псевдонимы: url, chart_repo_url

string

URL репозитория чартов, в котором находится требуемый чарт.

repo_username

псевдонимы: username, chart_repo_username

string

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

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

skip_tls_certs_check

псевдонимы: insecure_skip_tls_verify

boolean

Проверять ли сертификат TLS при загрузке чарта.

Требуется helm >= 3.3.0. Псевдоним insecure_skip_tls_verify добавлен в версии 5.3.0.

Варианты:

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

untar_chart

boolean

Если задано значение true, после загрузки чарт будет распакован.

Варианты:

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

verify_chart

boolean

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

Варианты:

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

verify_chart_keyring

path

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

Примеры

- name: Download chart using chart url
  kubernetes.core.helm_pull:
    chart_ref: https://github.com/grafana/helm-charts/releases/download/grafana-5.6.0/grafana-5.6.0.tgz
    destination: /path/to/chart

- name: Download Chart using chart_name and repo_url
  kubernetes.core.helm_pull:
    chart_ref: redis
    repo_url: https://charts.bitnami.com/bitnami
    untar_chart: yes
    destination: /path/to/chart

- name: Download Chart (skip tls certificate check)
  kubernetes.core.helm_pull:
    chart_ref: redis
    repo_url: https://charts.bitnami.com/bitnami
    untar_chart: yes
    destination: /path/to/chart
    skip_tls_certs_check: yes

- name: Download Chart using chart registry credentials
  kubernetes.core.helm_pull:
    chart_ref: redis
    repo_url: https://charts.bitnami.com/bitnami
    untar_chart: yes
    destination: /path/to/chart
    username: myuser
    password: mypassword123

- name: Download Chart (force re-download even if exists)
  kubernetes.core.helm_pull:
    chart_ref: redis
    repo_url: https://charts.bitnami.com/bitnami
    chart_version: '17.0.0'
    destination: /path/to/chart
    force: yes

- name: Download and untar chart (force re-extraction even if directory exists)
  kubernetes.core.helm_pull:
    chart_ref: redis
    repo_url: https://charts.bitnami.com/bitnami
    chart_version: '17.0.0'
    destination: /path/to/chart
    untar_chart: yes
    force: yes

Возвращаемые значения

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

Ключ

Описание

command

string

Полная команда `helm pull`, сформированная этим модулем. Её можно повторно выполнить вне модуля или использовать для отладки проблемы.

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

Пример: "helm pull --repo test ..."

msg

string

Сообщение с результатом операции.

Возвращается: если чарт уже существует

Пример: "Chart redis version 17.0.0 already exists in destination directory"

rc

integer

Код возврата команды Helm pull.

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

Пример: 1

stderr

string

Полный вывод команды `helm pull` в stderr; его можно отобразить или изучить в журнале событий.

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

Пример: ""

stdout

string

Полный вывод команды `helm pull` в stdout; его можно отобразить или изучить в журнале событий.

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

Пример: ""

Авторы

  • Aubin Bikouo (@abikouo)

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

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

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

Spec-Zone.ru

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