ansible-galaxy

Выполнение различных операций с ролями и коллекциями.

• Синопсис
• Описание
• Общие параметры

• Действия

  • коллекция

    • скачать коллекцию
    • инициализация коллекции
    • собрать коллекцию
    • опубликовать коллекцию
    • установить коллекцию
    • список коллекций
    • проверить коллекцию

  • роль

    • инициализировать роль
    • удалить роль
    • удалить роль
    • список ролей
    • поиск роли
    • импортировать роль
    • настроить роль
    • информация о роли
    • установить роль
• Окружение
• Файлы
• Автор
• Лицензия
• См. также

Синопсис

usage: ansible-galaxy [-h] [--version] [-v] TYPE ...

Описание

команда для управления Ansible ролями в общих репозиториях, по умолчанию – Ansible Galaxy https://galaxy.ansible.com.

Общие параметры

--version

отображение номера версии программы, расположения файла конфигурации, пути поиска модулей, расположения модулей, расположения исполняемого файла и выход

-h, --help

отображение этого сообщения справки и выход

-v, --verbose

режим подробного вывода (-vvv для большего подробного вывода, -vvvv для включения отладки соединения)

Действия

коллекция

Выполнение действия над коллекцией Ansible Galaxy. Должно быть комбинировано с дальнейшим действием, таким как init/install, как перечислено ниже.

скачать коллекцию

--clear-response-cache

Очистить кэш ответов сервера.

--no-cache

Не использовать кэш ответов сервера.

--pre

Включить предварительные версии. Предварительные версии семантической версии игнорируются по умолчанию

--token <API_KEY>, --api-key <API_KEY>

Ключ API Ansible Galaxy, который можно найти по адресу https://galaxy.ansible.com/me/preferences.

-c, --ignore-certs

Игнорировать ошибки валидации сертификатов SSL.

-n, --no-deps

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

-p <DOWNLOAD_PATH>, --download-path <DOWNLOAD_PATH>

Директория для загрузки коллекций.

-r <REQUIREMENTS>, --requirements-file <REQUIREMENTS>

Файл, содержащий список коллекций для загрузки.

-s <API_SERVER>, --server <API_SERVER>

URL сервера API Galaxy

инициализация коллекции

Создаёт каркас роли или коллекции, соответствующий формату метаданных Galaxy. Требует имени роли или коллекции. Имя коллекции должно быть в формате <namespace>.<collection>.

--collection-skeleton <COLLECTION_SKELETON>

Путь к шаблону коллекции, на основе которого должна быть создана новая коллекция.

--init-path <INIT_PATH>

Путь, в котором будет создана шаблонная коллекция. По умолчанию – текущая рабочая директория.

--token <API_KEY>, --api-key <API_KEY>

Ключ API Ansible Galaxy, который можно найти по адресу https://galaxy.ansible.com/me/preferences.

-c, --ignore-certs

Игнорировать ошибки валидации сертификатов SSL.

-f, --force

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

-s <API_SERVER>, --server <API_SERVER>

URL сервера API Galaxy

собрать коллекцию

Создаёт артефакт коллекции Ansible Galaxy, который может храниться в централизованном репозитории, таком как Ansible Galaxy. По умолчанию, эта команда собирает из текущей рабочей директории. Можно дополнительно указать путь к входным данным коллекции (где находится файл galaxy.yml).

--output-path <OUTPUT_PATH>

Путь, в котором будет построена коллекция. По умолчанию – текущая рабочая директория.

--token <API_KEY>, --api-key <API_KEY>

Ключ API Ansible Galaxy, который можно найти по адресу https://galaxy.ansible.com/me/preferences.

-c, --ignore-certs

Игнорировать ошибки валидации сертификатов SSL.

-f, --force

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

-s <API_SERVER>, --server <API_SERVER>

URL сервера API Galaxy

опубликовать коллекцию

Опубликовать коллекцию в Ansible Galaxy. Требуется путь к архиву коллекции для публикации.

--import-timeout <IMPORT_TIMEOUT>

Время ожидания завершения процесса импорта коллекции.

--no-wait

Не ждать результатов валидации импорта.

--token <API_KEY>, --api-key <API_KEY>

Ключ API Ansible Galaxy, который можно найти по адресу https://galaxy.ansible.com/me/preferences.

-c, --ignore-certs

Игнорировать ошибки валидации сертификатов SSL.

-s <API_SERVER>, --server <API_SERVER>

URL сервера API Galaxy

установить коллекцию

--clear-response-cache

Очистить кэш ответов сервера.

--force-with-deps

Принудительно перезаписать существующую коллекцию и её зависимости.

--no-cache

Не использовать кэш ответов сервера.

--pre

Включить предварительные версии. Предварительные версии семантической версии игнорируются по умолчанию

--token <API_KEY>, --api-key <API_KEY>

Ключ API Ansible Galaxy, который можно найти по адресу https://galaxy.ansible.com/me/preferences.

-U, --upgrade

Обновить установленные артефакты коллекции. Также обновит зависимости, если не указано —no-deps

-c, --ignore-certs

Игнорировать ошибки валидации сертификатов SSL.

-f, --force

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

-i, --ignore-errors

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

-n, --no-deps

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

-p <COLLECTIONS_PATH>, --collections-path <COLLECTIONS_PATH>

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

-r <REQUIREMENTS>, --requirements-file <REQUIREMENTS>

Файл, содержащий список коллекций, которые нужно установить.

-s <API_SERVER>, --server <API_SERVER>

URL сервера API Galaxy

список коллекций

Список установленных коллекций или ролей

--format <OUTPUT_FORMAT>

Формат отображения списка коллекций.

--token <API_KEY>, --api-key <API_KEY>

Ключ API Ansible Galaxy, который можно найти по адресу https://galaxy.ansible.com/me/preferences.

-c, --ignore-certs

Игнорировать ошибки проверки SSL-сертификата.

-p, --collections-path

Один или несколько каталогов для поиска коллекций помимо стандартных COLLECTIONS_PATHS. Несколько путей разделяются двоеточием «:».

-s <API_SERVER>, --server <API_SERVER>

URL сервера API Galaxy

проверка коллекции

--token <API_KEY>, --api-key <API_KEY>

Ключ API Ansible Galaxy, который можно найти по адресу https://galaxy.ansible.com/me/preferences.

-c, --ignore-certs

Игнорировать ошибки проверки SSL-сертификата.

-i, --ignore-errors

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

-p, --collections-path

Один или несколько каталогов для поиска коллекций помимо стандартных COLLECTIONS_PATHS. Несколько путей разделяются двоеточием «:».

-r <REQUIREMENTS>, --requirements-file <REQUIREMENTS>

Файл, содержащий список коллекций для проверки.

-s <API_SERVER>, --server <API_SERVER>

URL сервера API Galaxy

роль

Выполнить действие с ролью Ansible Galaxy. Должен быть объединен с дополнительным действием, таким как delete/install/init, как указано ниже.

создание роли

Создаёт каркас роли или коллекции, соответствующей формату метаданных Galaxy. Требует имени роли или коллекции. Имя коллекции должно быть в формате <namespace>.<collection>.

--init-path <INIT_PATH>

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

--offline

Не запрашивать API Galaxy при создании ролей

--role-skeleton <ROLE_SKELETON>

Путь к шаблону роли, на основе которого должна быть создана новая роль.

--token <API_KEY>, --api-key <API_KEY>

Ключ API Ansible Galaxy, который можно найти по адресу https://galaxy.ansible.com/me/preferences.

--type <ROLE_TYPE>

Инициализация с использованием альтернативного типа роли. Допустимые типы: ‘container’, ‘apb’ и ‘network’.

-c, --ignore-certs

Игнорировать ошибки проверки SSL-сертификата.

-f, --force

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

-s <API_SERVER>, --server <API_SERVER>

URL сервера API Galaxy

удаление роли

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

--token <API_KEY>, --api-key <API_KEY>

Ключ API Ansible Galaxy, который можно найти по адресу https://galaxy.ansible.com/me/preferences.

-c, --ignore-certs

Игнорировать ошибки проверки SSL-сертификата.

-p, --roles-path

Путь к каталогу, содержащему ваши роли. По умолчанию используется первый доступный каталог, настроенный через DEFAULT_ROLES_PATH: ~/.ansible/roles:/usr/share/ansible/roles:/etc/ansible/roles

-s <API_SERVER>, --server <API_SERVER>

URL сервера API Galaxy

удаление роли

Удалить роль из Ansible Galaxy.

--token <API_KEY>, --api-key <API_KEY>

Ключ API Ansible Galaxy, который можно найти по адресу https://galaxy.ansible.com/me/preferences.

-c, --ignore-certs

Игнорировать ошибки проверки SSL-сертификата.

-s <API_SERVER>, --server <API_SERVER>

URL сервера API Galaxy

список ролей

Список установленных коллекций или ролей

--token <API_KEY>, --api-key <API_KEY>

Ключ API Ansible Galaxy, который можно найти по адресу https://galaxy.ansible.com/me/preferences.

-c, --ignore-certs

Игнорировать ошибки проверки SSL-сертификата.

-p, --roles-path

Путь к каталогу, содержащему ваши роли. По умолчанию используется первый доступный каталог, настроенный через DEFAULT_ROLES_PATH: ~/.ansible/roles:/usr/share/ansible/roles:/etc/ansible/roles

-s <API_SERVER>, --server <API_SERVER>

URL сервера API Galaxy

поиск ролей

Поиск ролей на сервере Ansible Galaxy

--author <AUTHOR>

Имя пользователя GitHub

--galaxy-tags <GALAXY_TAGS>

Список тегов Galaxy для фильтрации.

--platforms <PLATFORMS>

Список платформ ОС для фильтрации.

--token <API_KEY>, --api-key <API_KEY>

Ключ API Ansible Galaxy, который можно найти по адресу https://galaxy.ansible.com/me/preferences.

-c, --ignore-certs

Игнорировать ошибки проверки SSL-сертификата.

-s <API_SERVER>, --server <API_SERVER>

URL сервера API Galaxy

импорт роли

Используется для импорта роли в Ansible Galaxy

--branch <REFERENCE>

Имя ветки для импорта. По умолчанию используется основная ветка репозитория (обычно master)

--no-wait

Не ждать результатов импорта.

--role-name <ROLE_NAME>

Имя роли, если отличается от имени репозитория

--status

Проверка статуса последнего запроса на импорт для заданного github_user/github_repo.

--token <API_KEY>, --api-key <API_KEY>

Ключ API Ansible Galaxy, который можно найти по адресу https://galaxy.ansible.com/me/preferences.

-c, --ignore-certs

Игнорировать ошибки проверки SSL-сертификата.

-s <API_SERVER>, --server <API_SERVER>

URL сервера API Galaxy

настройка роли

Настройка интеграции с GitHub или Travis для ролей Ansible Galaxy

--list

Отображение всех ваших интеграций.

--remove <REMOVE_ID>

Удаление интеграции, соответствующей предоставленному значению ID. Используйте –list, чтобы увидеть значения ID.

--token <API_KEY>, --api-key <API_KEY>

Ключ API Ansible Galaxy, который можно найти по адресу https://galaxy.ansible.com/me/preferences.

-c, --ignore-certs

Игнорировать ошибки проверки SSL-сертификата.

-p, --roles-path

Путь к каталогу, содержащему ваши роли. По умолчанию используется первый доступный каталог, настроенный через DEFAULT_ROLES_PATH: ~/.ansible/roles:/usr/share/ansible/roles:/etc/ansible/roles

-s <API_SERVER>, --server <API_SERVER>

URL сервера API Galaxy

role info

выводит подробную информацию об установленной роли, а также информацию, доступную из API Galaxy.

--offline

Не выполнять запросы к API Galaxy при создании ролей

--token <API_KEY>, --api-key <API_KEY>

Ключ API Ansible Galaxy, который можно найти по адресу https://galaxy.ansible.com/me/preferences.

-c, --ignore-certs

Игнорировать ошибки проверки SSL-сертификата.

-p, --roles-path

Путь к каталогу, содержащему ваши роли. По умолчанию используется первый доступный каталог, настроенный через DEFAULT_ROLES_PATH: ~/.ansible/roles:/usr/share/ansible/roles:/etc/ansible/roles

-s <API_SERVER>, --server <API_SERVER>

URL сервера API Galaxy

role install

--force-with-deps

Принудительно перезаписать существующую роль и её зависимости.

--token <API_KEY>, --api-key <API_KEY>

Ключ API Ansible Galaxy, который можно найти по адресу https://galaxy.ansible.com/me/preferences.

-c, --ignore-certs

Игнорировать ошибки проверки SSL-сертификата.

-f, --force

Принудительно перезаписать существующую роль или сборку.

-g, --keep-scm-meta

Использовать tar вместо опции scm-архива при упаковке роли.

-i, --ignore-errors

Игнорировать ошибки и продолжить с следующей указанной ролью.

-n, --no-deps

Не загружать роли, указанные в качестве зависимостей.

-p, --roles-path

Путь к каталогу, содержащему ваши роли. По умолчанию используется первый доступный каталог, настроенный через DEFAULT_ROLES_PATH: ~/.ansible/roles:/usr/share/ansible/roles:/etc/ansible/roles

-r <REQUIREMENTS>, --role-file <REQUIREMENTS>

Файл, содержащий список ролей для установки.

-s <API_SERVER>, --server <API_SERVER>

URL сервера API Galaxy

Окружение

Могут быть указаны следующие переменные окружения.

ANSIBLE_CONFIG – Переопределить файл конфигурации ansible по умолчанию

Множество других доступны для большинства опций в ansible.cfg

Файлы

/etc/ansible/ansible.cfg – Файл конфигурации, используется, если присутствует

~/.ansible.cfg – Файл конфигурации пользователя, переопределяет конфигурацию по умолчанию, если присутствует

Автор

Ansible изначально был написан Майклом ДеХааном.

Полный список авторов см. в файле AUTHORS.

Лицензия

Ansible распространяется на условиях лицензии GPLv3+.

См. также

ansible(1), ansible-config(1), ansible-console(1), ansible-doc(1), ansible-galaxy(1), ansible-inventory(1), ansible-playbook(1), ansible-pull(1), ansible-vault(1),