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, как указано ниже.

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

--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. Требуется путь к архиву tarball коллекции для публикации.

--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

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

Установить одну или несколько ролей(ansible-galaxy role install), или одну или несколько коллекций(ansible-galaxy collection install). Вы можете передать список (роли или коллекции) или использовать опцию файла, указанную ниже (они взаимоисключающие). Если вы передаёте список, он может содержать имя (которое будет загружено через API Galaxy и github), или локальный архивный файл tar.

--force-with-deps

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

--pre

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

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

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

-c, --ignore-certs

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

-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

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

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

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

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

-c, --ignore-certs

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

-p, --collection-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, --collection-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

информация о роли

Выводит подробную информацию об установленной роли, а также информацию, доступную из 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

Установить одну или несколько ролей (ansible-galaxy role install) или одну или несколько коллекций (ansible-galaxy collection install). Можно передать список (ролей или коллекций) или использовать параметр файла (эти параметры взаимоисключающие). Если передаётся список, это может быть имя (которое будет загружено через API Galaxy и GitHub), или локальный архив tar.

--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),