Ansible Navigator

Содержание

Ansible Navigator#

Утилита Ansible Navigator является универсальным инструментом для разработки, тестирования и применения инфраструктурного кода в виде коллекций и сценариев. Для этого она предоставляет несколько команд с различными аргументами.

Вызов утилиты имеет следующий вид:

ansible-navigator {<command>} {<arguments>}

Для понимания принципов работы утилиты обратитесь к ее описанию.

Настройки Ansible Navigator могут быть заданы следующими способами, в порядке возрастания приоритета:

конфигурационный файл;
переменная окружения;
аргументы CLI.

Общие аргументы#

Ansible Navigator принимает аргументы, общие для всех команд, а также специфичные для утилит, которые используются для выполнения отдельных задач.

Аргументы, общие для всех команд:

-h, --help#: Вывод справочной информации о командах и аргументах Ansible Navigator.

--version#: Вывод информации о версии Ansible Navigator.

Основные настройки#

Основные настройки управляют поведением самого Ansible Navigator.

ansible-runner-artifact-dir#

Путь к каталогу для хранения артефактов, созданных во время запуска ansible-runner.

Аргументы CLI: --rad, --ansible-runner-artifact-dir.

Переменная окружения: ANSIBLE_NAVIGATOR_ANSIBLE_RUNNER_ARTIFACT_DIR.

Конфигурационный файл:

ansible-navigator:
  ansible-runner:
    artifact-dir:

ansible-runner-rotate-artifacts-count#

Удаление каталогов с артефактами, кроме последних N запусков ansible-runner. При значении 0 не удаляется ни один каталог с артефактами.

Аргументы CLI: --rac, --ansible-runner-rotate-artifacts-count.

Переменная окружения: ANSIBLE_NAVIGATOR_ANSIBLE_RUNNER_ROTATE_ARTIFACTS_COUNT.

Конфигурационный файл:

ansible-navigator:
  ansible-runner:
    rotate-artifacts-count:

ansible-runner-timeout#

Период ожидания в секундах перед принудительным завершением выполнения ansible-runner.

Аргументы CLI: --rt, --ansible-runner-timeout.

Переменная окружения: ANSIBLE_NAVIGATOR_ANSIBLE_RUNNER_TIMEOUT.

Конфигурационный файл:

ansible-navigator:
  ansible-runner:
    timeout:

ansible-runner-write-job-events#

Запись событий job_events в каталог артефактов:

Возможные значения:

true – запись включена;
false – запись выключена.

Аргументы CLI: --rwje, --ansible-runner-write-job-events.

Переменная окружения: ANSIBLE_NAVIGATOR_ANSIBLE_RUNNER_WRITE_JOB_EVENTS.

Конфигурационный файл:

ansible-navigator:
  ansible-runner:
    job-events:

app#

Команда, выполняемая при запуске Ansible Navigator по умолчанию.

Возможные значения:

builder;
collections;
config;
doc;
exec;
images;
inventory;
lint;
replay;
run;
settings;
welcome.

Значение по умолчанию: welcome.

Аргументы CLI: позиционные.

Переменная окружения: ANSIBLE_NAVIGATOR_APP.

Конфигурационный файл:

ansible-navigator:
  app:

cmdline#

Дополнительные параметры, передаваемые в команды Ansible (ansible-playbook, ansible-doc и так далее).

Аргументы CLI: позиционные.

Переменная окружения: ANSIBLE_NAVIGATOR_CMDLINE.

Конфигурационный файл:

ansible-navigator:
  ansible:
    cmdline:

collection-doc-cache-path#

Путь к каталогу для хранения кеша документации коллекций.

Значение по умолчанию: ~/.cache/ansible-navigator/collection_doc_cache.db.

Аргументы CLI: --cdcp, --collection-doc-cache-path.

Переменная окружения: ANSIBLE_NAVIGATOR_COLLECTION_DOC_CACHE_PATH.

Конфигурационный файл:

ansible-navigator:
  collection-doc-cache-path:

container-engine#

Инструмент контейнеризации:

Возможные значения:

auto – тип инструмента контейнеризации выбирается автоматически.

Примечание

Если в системе установлены Docker и Podman, будет использоваться Podman.
podman – Podman.
docker – Docker.

Значение по умолчанию: auto.

Аргументы CLI: --ce, --container-engine.

Переменная окружения: ANSIBLE_NAVIGATOR_CONTAINER_ENGINE.

Конфигурационный файл:

ansible-navigator:
  execution-environment:
    container-engine:

container-options#

Дополнительные параметры, передаваемые в команду запуска инструмента контейнеризации.

Аргументы CLI: --co, --container-options.

Переменная окружения: ANSIBLE_NAVIGATOR_CONTAINER_OPTIONS.

Конфигурационный файл:

ansible-navigator:
  execution-environment:
    container-options:

display-color#

Использование цветового оформления.

Возможные значения:

true – включено;
false – выключено.

Значение по умолчанию: true.

Аргументы CLI: --dc, --display-color.

Переменная окружения: NO_COLOR.

Конфигурационный файл:

ansible-navigator:
  color:
    enable:

editor-command#

Команда запуска текстового редактора.

Значение по умолчанию: vi +{line_number} {filename}.

Аргументы CLI: --ecmd, --editor-command.

Переменная окружения: ANSIBLE_NAVIGATOR_EDITOR_COMMAND.

Конфигурационный файл:

ansible-navigator:
  editor:
    command:

editor-console#

Использование редактора в режиме TUI.

Возможные значения:

true – текстовый интерфейс;
false – режим работы определяется редактором.

Значение по умолчанию: true.

Аргументы CLI: --econ, --editor-console.

Переменная окружения: ANSIBLE_NAVIGATOR_EDITOR_CONSOLE.

Конфигурационный файл:

ansible-navigator:
  editor:
    console:

execution-environment#

Использование среды исполнения.

Возможные значения:

true – разрешено.
false – запрещено.

Значение по умолчанию: true.

Аргументы CLI: --ee, --execution-environment.

Переменная окружения: ANSIBLE_NAVIGATOR_EXECUTION_ENVIRONMENT.

Конфигурационный файл:

ansible-navigator:
  execution-environment:
    enabled:

execution-environment-image#

Название образа среды исполнения.

Значение по умолчанию: hub.astra-automation.ru/aa-1.2/aa-full-ee:latest.

Аргументы CLI: --eei, --execution-environment-image.

Переменная окружения: ANSIBLE_NAVIGATOR_EXECUTION_ENVIRONMENT_IMAGE.

Конфигурационный файл:

ansible-navigator:
  execution-environment:
    image:

execution-environment-volume-mounts#

Монтирование тома <volume> в точку <mount_point> контейнера при запуске среды исполнения.

Подробности о монтировании томов см. в документации используемой системы контейнеризации:

Docker;
Podman.

Аргументы CLI: --eev, --execution-environment-volume-mounts.

Переменная окружения: ANSIBLE_NAVIGATOR_EXECUTION_ENVIRONMENT_VOLUME_MOUNTS.

Конфигурационный файл:

ansible-navigator:
  execution-environment:
    volume-mounts:

log-append#

Управление записью журнала сообщений в файл.

Возможные значения:

true – для хранения всех записей используется один файл журнала;
false – для каждой сессии создается отдельный файл журнала.

Значение по умолчанию: true.

Аргументы CLI: --la, --log-append.

Переменная окружения: ANSIBLE_NAVIGATOR_LOG_APPEND.

Конфигурационный файл:

ansible-navigator:
  logging:
    append:

log-file#

Путь к файлу хранения журнала Ansible Navigator.

Значение по умолчанию: ./ansible-navigator.log.

Аргументы CLI: --lf, --log-file.

Переменная окружения: ANSIBLE_NAVIGATOR_LOG_FILE.

Конфигурационный файл:

ansible-navigator:
  logging:
    file:

log-level#

Минимальный уровень важности сообщения, необходимый для его записи в журнал Ansible Navigator.

Возможные значения: (в порядке возрастания важности):

debug;
info;
warning;
error;
critical.

Значение по умолчанию: warning.

Аргументы CLI: --ll, --log-level.

Переменная окружения: ANSIBLE_NAVIGATOR_LOG_LEVEL.

Конфигурационный файл:

ansible-navigator:
  logging:
    level:

mode#

Режим работы Ansible Navigator.

Возможные значения:

stdout – использование стандартного потока вывода;
interactive – интерактивный режим.

Значение по умолчанию: interactive.

Аргументы CLI: -m, --mode.

Переменная окружения: ANSIBLE_NAVIGATOR_MODE.

Конфигурационный файл:

ansible-navigator:
  mode:

osc4#

Использование в терминале цветового оформления в соответствии со стандартом OSC 4.

Возможные значения:

true – включено;
false – выключено.

Значение по умолчанию: true.

Аргументы CLI: --osc4, --osc4.

Переменная окружения: ANSIBLE_NAVIGATOR_OSC4.

Конфигурационный файл:

ansible-navigator:
  color:
    osc4:

pass-environment-variable#

Передача существующей переменной окружения в среду исполнения.

Аргументы CLI: --penv, --pass-environment-variable.

Переменная окружения: ANSIBLE_NAVIGATOR_PASS_ENVIRONMENT_VARIABLES.

Конфигурационный файл:

ansible-navigator:
  execution-environment:
    environment-variables:
      pass:

pull-arguments#

Дополнительные параметры для команды получения (pull) образа среды исполнения из реестра, например:

--pull-arguments='--tls-verify=false'

Аргументы CLI: --pa, --pull-arguments.

Переменная окружения: ANSIBLE_NAVIGATOR_PULL_ARGUMENTS.

Конфигурационный файл:

ansible-navigator:
  execution-environment:
    pull:
      arguments:

pull-policy#

Политика получения образа среды исполнения.

Возможные значения:

always – всегда загружать образ из реестра.
missing – загрузить образ из реестра только в том случае, когда нет его локальной копии.
never – никогда не загружать образ из реестра.
tag – если значение тега равно latest, образ будет загружен из реестра. Если значение тега отличается от latest, образ будет загружен из реестра только при отсутствии локальной копии.

Значение по умолчанию: tag.

Аргументы CLI: --pp, --pull-policy.

Переменная окружения: ANSIBLE_NAVIGATOR_PULL_POLICY.

Конфигурационный файл:

ansible-navigator:
  execution-environment:
    pull:
      policy:

set-environment-variable#

Передача в среду исполнения переменной окружения <varibable> со значением <value>.

Аргументы CLI: --senv, --set-environment-variable.

Переменная окружения: ANSIBLE_NAVIGATOR_SET_ENVIRONMENT_VARIABLES.

Конфигурационный файл:

ansible-navigator:
  execution-environment:
    environment-variables:
      set:

time-zone#

Используемый часовой пояс.

Возможные значения:

название часового пояса в формате IANA;
local.

Значение по умолчанию: UTC.

Аргументы CLI: --tz, --time-zone.

Переменная окружения: TZ.

Конфигурационный файл:

ansible-navigator:
  time-zone:

ssh-forward-keys#

Монтирование каталога ~/.ssh/ в файловую систему контейнера.

Возможные значения:

true;
false.

Значение по умолчанию: true.

Аргументы CLI: --ssh-forward-keys, --ssh-forward-keys.

Переменная окружения: ANSIBLE_NAVIGATOR_SSH_FORWARD_KEYS.

Конфигурационный файл:

ansible-navigator:
  execution-environment:
    ssh-forwarding:
      keys:

ssh-forward-config#

Монтирование файла ~/.ssh/config в файловую систему контейнера.

Возможные значения:

true;
false.

Значение по умолчанию: true.

Аргументы CLI: --ssh-forward-config, --ssh-forward-config.

Переменная окружения: ANSIBLE_NAVIGATOR_SSH_FORWARD_CONFIG.

Конфигурационный файл:

ansible-navigator:
  execution-environment:
    ssh-forwarding:
      config:

ssh-forward-agent#

Передача переменной окружения SSH_AUTH_SOCK в контейнер.

Возможные значения:

true;
false.

Значение по умолчанию: true.

Аргументы CLI: --ssh-forward-agent, --ssh-forward-agent.

Переменная окружения: ANSIBLE_NAVIGATOR_SSH_FORWARD_AGENT.

Конфигурационный файл:

ansible-navigator:
  execution-environment:
    ssh-forwarding:
      agent:

Настройки команд#

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

builder#

help-builder#

Вывод справки к команде ansible-builder при работе в режиме stdout.

Возможные значения:

True;
False.

Значение по умолчанию: False.

Аргументы CLI: --hb, --help-builder.

Переменная окружения: ANSIBLE_NAVIGATOR_HELP_BUILDER.

Конфигурационный файл:

ansible-navigator:
  ansible-builder:
    help:

workdir#

Путь к каталогу с манифестами ansible-builder.

Значение по умолчанию: . (текущий каталог).

Аргументы CLI: --bwd, --workdir.

Переменная окружения: ANSIBLE_NAVIGATOR_WORKDIR.

Конфигурационный файл:

ansible-navigator:
  ansible-builder:
    workdir:

collections#

format#

Формат для вывода в stdout.

Возможные значения:

json;
yaml.

Значение по умолчанию: yaml.

Аргументы CLI: --fmt, --format.

Переменная окружения: ANSIBLE_NAVIGATOR_FORMAT.

Конфигурационный файл:

ansible-navigator:
  format:

config#

Путь к конфигурационному файлу Ansible.

Аргументы CLI: -c, --config.

Переменная окружения: ANSIBLE_CONFIG.

Конфигурационный файл:

ansible-navigator:
  ansible:
    config:
      path:

help-config#

Вывод справки к команде ansible-config при работе в режиме stdout.

Возможные значения:

True;
False.

Значение по умолчанию: False.

Аргументы CLI: --hc, --help-config.

Переменная окружения: ANSIBLE_NAVIGATOR_HELP_CONFIG.

Конфигурационный файл:

ansible-navigator:
  ansible:
    config:
      help:

doc#

help-doc#

Вывод справки к команде ansible-doc при работе в режиме stdout.

Возможные значения:

True;
False.

Значение по умолчанию: False.

Аргументы CLI: --hd, --help-doc.

Переменная окружения: ANSIBLE_NAVIGATOR_HELP_DOC.

Конфигурационный файл:

ansible-navigator:
  ansible:
    doc:
      help:

plugin-name#

Название расширения.

Аргументы CLI: позиционные.

Переменная окружения: ANSIBLE_NAVIGATOR_PLUGIN_NAME.

Конфигурационный файл:

ansible-navigator:
  ansible:
    doc:
      plugin:
        name:

plugin-type#

Название типа расширения.

Возможные значения:

become;
cache;
callback;
cliconf;
connection;
filter;
httpapi;
inventory;
keyword;
lookup;
module;
netconf;
role;
shell;
strategy;
test;
vars.

Значение по умолчанию: module.

Аргументы CLI: -t, --type.

Переменная окружения: ANSIBLE_NAVIGATOR_PLUGIN_TYPE.

Конфигурационный файл:

ansible-navigator:
  ansible:
    doc:
      plugin:
        type:

exec#

exec-command#

Команда для запуска в контейнере со средой исполнения.

Значение по умолчанию: /bin/bash.

Аргументы CLI: позиционные.

Переменная окружения: ANSIBLE_NAVIGATOR_EXEC_COMMAND.

Конфигурационный файл:

ansible-navigator:
  exec:
    command:

exec-shell#

Необходимость выполнения команды в оболочке.

Возможные значения:

True;
False.

Значение по умолчанию: True.

Аргументы CLI: --exshell, --exec-shell.

Переменная окружения: ANSIBLE_NAVIGATOR_EXEC_SHELL.

Конфигурационный файл:

ansible-navigator:
  exec:
    shell:

images#

format#

Формат для вывода в stdout.

Возможные значения:

json;
yaml.

Значение по умолчанию: yaml.

Аргументы CLI: --fmt, --format.

Переменная окружения: ANSIBLE_NAVIGATOR_FORMAT.

Конфигурационный файл:

ansible-navigator:
  format:

images-details#

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

Возможные значения элементов списка:

ansible_collections – коллекции Ansible;
ansible_version – версия Ansible;
everything – все возможные поля;
os_release – версия ОС;
python_packages – пакеты Python;
python_version – версия интерпретатора Python;
system_packages – пакеты, установленные с помощью системного менеджера пакетов.

Значение по умолчанию: ['everything'].

Аргументы CLI: -d, --details.

Переменная окружения: ANSIBLE_NAVIGATOR_IMAGES_DETAILS.

Конфигурационный файл:

ansible-navigator:
  images:
    details:

inventory#

help-inventory#

Вывод справки к команде ansible-inventory при работе в режиме stdout.

Возможные значения:

True;
False.

Значение по умолчанию: False.

Аргументы CLI: --hi, --help-inventory.

Переменная окружения: ANSIBLE_NAVIGATOR_HELP_INVENTORY.

Конфигурационный файл:

ansible-navigator:
  ansible:
    inventory:
      help:

inventory#

Путь к файлу инвентаря или список узлов одной строкой через запятую.

Аргументы CLI: -i, --inventory.

Переменная окружения: ANSIBLE_INVENTORY.

Конфигурационный файл:

ansible-navigator:
  ansible:
    inventory:
      entries:

inventory-column#

Атрибуты узлов для показа в режиме просмотра инвентаря.

Аргументы CLI: --ic, --inventory-column.

Переменная окружения: ANSIBLE_NAVIGATOR_INVENTORY_COLUMNS.

Конфигурационный файл:

ansible-navigator:
  inventory-columns:

lint#

lint-config#

Путь к конфигурационному файлу ansible-lint.

Аргументы CLI: --lic, --lint-config.

Переменная окружения: ANSIBLE_LINT_CONFIG.

Конфигурационный файл:

ansible-navigator:
  ansible-lint:
    config:

lintables#

Путь к файлам для обработки с помощью ansible-lint.

Аргументы CLI: позиционные.

Переменная окружения: ANSIBLE_NAVIGATOR_LINTABLES.

Конфигурационный файл:

ansible-navigator:
  ansible-lint:
    lintables:

replay#

playbook-artifact-replay#

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

Аргументы CLI: позиционные.

Переменная окружения: ANSIBLE_NAVIGATOR_PLAYBOOK_ARTIFACT_REPLAY.

Конфигурационный файл:

ansible-navigator:
  playbook-artifact:
    replay:

run#

enable-prompts#

Разрешение запроса на ввод пароля при выполнении набора сценариев. Включение этой настройки устанавливает режим stdout и запрещает создание артефактов.

Возможные значения:

True;
False.

Значение по умолчанию: False.

Аргументы CLI: --ep, --enable-prompts.

Переменная окружения: ANSIBLE_NAVIGATOR_ENABLE_PROMPTS.

Конфигурационный файл:

ansible-navigator:
  enable-prompts:

help-playbook#

Вывод справки к команде ansible-playbook при работе в режиме stdout.

Возможные значения:

True;
False.

Значение по умолчанию: False.

Аргументы CLI: --hp, --help-playbook.

Переменная окружения: ANSIBLE_NAVIGATOR_HELP_PLAYBOOK.

Конфигурационный файл:

ansible-navigator:
  ansible:
    playbook:
      help:

inventory#

Путь к файлу инвентаря или список узлов одной строкой через запятую.

Аргументы CLI: -i, --inventory.

Переменная окружения: ANSIBLE_INVENTORY.

Конфигурационный файл:

ansible-navigator:
  ansible:
    inventory:
      entries:

inventory-column#

Атрибуты узлов для показа в режиме просмотра инвентаря.

Аргументы CLI: --ic, --inventory-column.

Переменная окружения: ANSIBLE_NAVIGATOR_INVENTORY_COLUMNS.

Конфигурационный файл:

ansible-navigator:
  inventory-columns:

playbook#

Путь к файлу набора сценариев.

Аргументы CLI: позиционные.

Переменная окружения: ANSIBLE_NAVIGATOR_PLAYBOOK.

Конфигурационный файл:

ansible-navigator:
  ansible:
    playbook:
      path:

playbook-artifact-enable#

Включение или выключение создания артефактов для выполненных наборов сценариев.

Примечание

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

Возможные значения:

True;
False.

Значение по умолчанию: True.

Аргументы CLI: --pae, --playbook-artifact-enable.

Переменная окружения: ANSIBLE_NAVIGATOR_PLAYBOOK_ARTIFACT_ENABLE.

Конфигурационный файл:

ansible-navigator:
  playbook-artifact:
    enable:

playbook-artifact-save-as#

Шаблон названия файлов артефактов, создаваемых для выполненных наборов сценариев.

Доступны следующие подстановочные символы:

{playbook_dir} – каталог с наборами сценариев;
{playbook_name} – название файла набора сценариев;
{playbook_status} – статус выполнения набора сценариев;
{time_stamp} – дата и время создания артефакта.

Значение по умолчанию: {playbook_dir}/{playbook_name}-artifact-{time_stamp}.json.

Аргументы CLI: --pas, --playbook-artifact-save-as.

Переменная окружения: ANSIBLE_NAVIGATOR_PLAYBOOK_ARTIFACT_SAVE_AS.

Конфигурационный файл:

ansible-navigator:
  playbook-artifact:
    save-as:

settings#

settings-effective#

Необходимость отображения действующих настроек.

При расчете значений сочетаются:

значения по умолчанию;
параметры CLI;
переменные окружения;
настройки из конфигурационного файла.

Значение по умолчанию: False.

Аргументы CLI: --se, --effective.

Переменная окружения: ANSIBLE_NAVIGATOR_SETTINGS_EFFECTIVE.

Конфигурационный файл:

ansible-navigator:
  settings:
    effective:

settings-sample#

Генерация примера конфигурационного файла.

Значение по умолчанию: False.

Аргументы CLI: --gs, --sample.

Переменная окружения: ANSIBLE_NAVIGATOR_SETTINGS_SAMPLE.

Конфигурационный файл:

ansible-navigator:
  settings:
    sample:

settings-schema#

Генерация схемы конфигурационного файла.

Возможное значение: json.

Значение по умолчанию: json.

Аргументы CLI: --ss, --schema.

Переменная окружения: ANSIBLE_NAVIGATOR_SETTINGS_SCHEMA.

Конфигурационный файл:

ansible-navigator:
  settings:
    schema:

settings-sources#

Отображение источника каждой действующей настройки.

Значение по умолчанию: False.

Аргументы CLI: --so, --sources.

Переменная окружения: ANSIBLE_NAVIGATOR_SETTINGS_SOURCES.

Конфигурационный файл:

ansible-navigator:
  settings:
    sources: