Spec-Zone.ru › Ansible

Модуль community.general.ansible_galaxy_install – Установка ролей или коллекций Ansible с помощью ansible-galaxy

Примечание

Этот модуль является частью коллекции community.general (версия 9.5.0).

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

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

Для использования в playbook, укажите: community.general.ansible_galaxy_install.

Новое в community.general 3.5.0

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

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

  • Этот модуль позволяет устанавливать коллекции или роли Ansible с помощью ansible-galaxy.

Требования

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

  • ansible-core 2.11 или новее

Параметры

Параметр

Комментарии

dest

path

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

Обратите внимание, что ansible-galaxy не будет устанавливать коллекции с type=both, когда requirements_file содержит и роли, и коллекции, и указан dest.

force

boolean

Принудительная перезапись существующих ролей и/или коллекций.

Может использоваться для обновления, но вывод модуля всегда будет сообщать changed=true.

Использование force=true обязательно при понижении версии.

Варианты:

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

name

string

Имя устанавливаемой коллекции или роли.

Версии могут быть указаны с помощью обычных форматов ansible-galaxy. Например, коллекция community.docker:1.6.1 или роль ansistrano.deploy,3.8.0.

name и requirements_file являются взаимоисключающими.

no_deps

boolean

добавлено в community.general 4.5.0

Воздерживаться от установки зависимостей.

Варианты:

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

requirements_file

path

Путь к файлу, содержащему список требований для установки.

Работает для type равного collection и role.

name и requirements_file являются взаимоисключающими.

state

string

добавлено в community.general 9.1.0

Если state=present, то коллекция или роль будут установлены. Обратите внимание, что коллекции и роли не обновляются с помощью этого параметра.

В настоящее время state=latest игнорируется, если только type=collection, и это гарантирует, что коллекция установлена и обновлена до последней доступной версии.

Обратите внимание, что force=true можно использовать для выполнения обновления независимо от type.

Варианты:

  • "present" ← (по умолчанию)
  • "latest"

type

string / required

Тип установки, выполняемый ansible-galaxy.

Если type=both, то необходимо передать requirements_file, и он может содержать как роли, так и коллекции.

Однако обратное неверно: при использовании requirements_file, type может быть любым из трех вариантов.

Варианты:

  • "collection"
  • "role"
  • "both"

Атрибуты

Атрибут

Поддержка

Описание

check_mode

Поддержка: отсутствует

Может работать в check_mode и возвращать прогноз состояния «изменено» без изменения цели.

diff_mode

Поддержка: отсутствует

Возвращает подробную информацию о том, что изменилось (или что может потребовать изменения в check_mode), в режиме diff.

Примечания

Примечание

  • Поддержка Ansible 2.9/2.10 была удалена в community.general 8.0.0.
  • Модуль будет пытаться запуститься, используя локаль C.UTF-8. Если это не удастся, он попытается использовать en_US.UTF-8. Если и это не удастся, модуль завершится с ошибкой.

См. также

См. также

C(ansible-galaxy) страница руководства по команде

Страница руководства для команды.

Примеры

---
- name: Install collection community.network
  community.general.ansible_galaxy_install:
    type: collection
    name: community.network

- name: Install role at specific path
  community.general.ansible_galaxy_install:
    type: role
    name: ansistrano.deploy
    dest: /ansible/roles

- name: Install collections and roles together
  community.general.ansible_galaxy_install:
    type: both
    requirements_file: requirements.yml

- name: Force-install collection community.network at specific version
  community.general.ansible_galaxy_install:
    type: collection
    name: community.network:3.0.2
    force: true

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

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

Ключ

Описание

dest

строка

Значение параметра dest.

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

force

логическое

Значение параметра force.

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

installed_collections

словарь

Если задан requirements_file, возвращает словарь со всеми установленным коллекциями по пути.

Если задан name, возвращает имя коллекции и установленную версию по пути.

Возвращается: всегда при установке коллекций

Пример: {"/custom/ansible/ansible_collections": {"community.general": "3.1.0"}, "/home/az/.ansible/collections/ansible_collections": {"community.docker": "1.6.0", "community.general": "3.0.2"}}

<путь>

словарь

Коллекции и версии для этого пути.

Возвращается: успех

installed_roles

словарь

Если задан requirements_file, возвращает словарь со всеми установленными ролями по пути.

Если задан name, возвращает имя роли и установленную версию по пути.

Возвращается: всегда при установке ролей

Пример: {"/custom/ansible/roles": {"ansistrano.deploy": "3.8.0"}, "/home/user42/.ansible/roles": {"ansistrano.deploy": "3.9.0", "baztian.xfce": "v0.0.3"}}

<путь>

словарь

Роли и версии для этого пути.

Возвращается: успех

name

строка

Значение параметра name.

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

new_collections

словарь

Новые коллекции, установленные этим модулем.

Возвращается: успех

Пример: {"community.docker": "1.6.1", "community.general": "3.1.0"}

new_roles

словарь

Новые роли, установленные этим модулем.

Возвращается: успех

Пример: {"ansistrano.deploy": "3.8.0", "baztian.xfce": "v0.0.3"}

requirements_file

строка

Значение параметра requirements_file.

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

type

строка

Значение параметра type.

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

Авторы

  • Алексей Знаменский (@russoz)

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

  • Система отслеживания ошибок
  • Репозиторий (источники)
  • Спросить о помощи
  • Отправить отчет об ошибке
  • Запросить функцию
  • Общение

© 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/community/general/ansible_galaxy_install_module.html

Spec-Zone.ru

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