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

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

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

--api-key <API_KEY>

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

--collection-skeleton <COLLECTION_SKELETON>

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

--init-path <INIT_PATH>

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

-c, --ignore-certs

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

-f, --force

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

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

URL сервера API Galaxy

создание коллекции

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

--api-key <API_KEY>

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

--output-path <OUTPUT_PATH>

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

-c, --ignore-certs

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

-f, --force

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

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

URL сервера API Galaxy

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

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

--api-key <API_KEY>

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

--import-timeout <IMPORT_TIMEOUT>

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

--no-wait

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

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

--api-key <API_KEY>

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

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

роль

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

инициализация роли

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

--api-key <API_KEY>

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

--init-path <INIT_PATH>

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

--offline

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

--role-skeleton <ROLE_SKELETON>

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

--type <ROLE_TYPE>

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

-c, --ignore-certs

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

-f, --force

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

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

URL сервера API Galaxy

role remove

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

--api-key <API_KEY>

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

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

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

--api-key <API_KEY>

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

-c, --ignore-certs

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

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

URL сервера API Galaxy

role list

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

--api-key <API_KEY>

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

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

ищет роли на сервере Ansible Galaxy

--api-key <API_KEY>

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

--author <AUTHOR>

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

--galaxy-tags <GALAXY_TAGS>

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

--platforms <PLATFORMS>

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

-c, --ignore-certs

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

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

URL сервера API Galaxy

role import

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

--api-key <API_KEY>

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

--branch <REFERENCE>

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

--no-wait

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

--role-name <ROLE_NAME>

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

--status

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

-c, --ignore-certs

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

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

URL сервера API Galaxy

role setup

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

--api-key <API_KEY>

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

--list

Отобразить все ваши интеграции.

--remove <REMOVE_ID>

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

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

--api-key <API_KEY>

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

--offline

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

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

--api-key <API_KEY>

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

--force-with-deps

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

-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 <ROLE_FILE>, --role-file <ROLE_FILE>

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

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