Spec-Zone.ru › Ansible

community.general.stackpath_compute инвентаризация – Источник инвентаризации StackPath Edge Computing

Примечание

Этот плагин инвентаризации входит в коллекцию community.general (версия 9.5.0).

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

Для установки используйте: ansible-galaxy collection install community.general.

Для использования в плейбуке укажите: community.general.stackpath_compute.

Добавлен в community.general 1.2.0

  • Описание
  • Параметры
  • Примеры

Описание

  • Получение хостов инвентаризации из StackPath Edge Computing.
  • Использует файл конфигурации YAML, который заканчивается на stackpath_compute.(yml|yaml).

Параметры

Параметр

Комментарии

cache

boolean

Переключатель для включения/выключения кэширования исходных данных инвентаризации, требуется настройка плагина кэша для работы.

Варианты:

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

Настройка:

  • Запись INI:

    [inventory]
    cache = false
    
  • Переменная окружения: ANSIBLE_INVENTORY_CACHE

cache_connection

string

Данные или путь к соединению кэша, см. документацию к плагину кэша для подробностей.

Настройка:

  • Записи INI:

    [defaults]
    fact_caching_connection = VALUE
    
    [inventory]
    cache_connection = VALUE
    
  • Переменная окружения: ANSIBLE_CACHE_PLUGIN_CONNECTION
  • Переменная окружения: ANSIBLE_INVENTORY_CACHE_CONNECTION

cache_plugin

string

Плагин кэша для использования с исходными данными инвентаризации.

По умолчанию: "memory"

Настройка:

  • Записи INI:

    [defaults]
    fact_caching = memory
    
    [inventory]
    cache_plugin = memory
    
  • Переменная окружения: ANSIBLE_CACHE_PLUGIN
  • Переменная окружения: ANSIBLE_INVENTORY_CACHE_PLUGIN

cache_prefix

string

Префикс для использования с файлами/таблицами плагина кэша

По умолчанию: "ansible_inventory_"

Настройка:

  • Записи INI:

    [defaults]
    fact_caching_prefix = ansible_inventory_
    
    [inventory]
    cache_prefix = ansible_inventory_
    
  • Переменная окружения: ANSIBLE_CACHE_PLUGIN_PREFIX
  • Переменная окружения: ANSIBLE_INVENTORY_CACHE_PLUGIN_PREFIX

cache_timeout

integer

Время жизни кэша в секундах

По умолчанию: 3600

Настройка:

  • Записи INI:

    [defaults]
    fact_caching_timeout = 3600
    
    [inventory]
    cache_timeout = 3600
    
  • Переменная окружения: ANSIBLE_CACHE_PLUGIN_TIMEOUT
  • Переменная окружения: ANSIBLE_INVENTORY_CACHE_TIMEOUT

client_id

string / обязательно

Идентификатор клиента OAuth, сгенерированный в разделе «Управление API» портала клиентов StackPath https://control.stackpath.net/api-management.

client_secret

string / обязательно

Секрет клиента OAuth, сгенерированный в разделе «Управление API» портала клиентов StackPath https://control.stackpath.net/api-management.

compose

dictionary

Создать переменные из выражений Jinja2.

По умолчанию: {}

groups

dictionary

Добавление хостов в группу на основе условных выражений Jinja2.

По умолчанию: {}

keyed_groups

list / elements=dictionary

Добавление хостов в группу на основе значений переменной.

По умолчанию: []

default_value

string

добавлен в ansible-core 2.12

Значение по умолчанию, когда значение переменной хоста — пустая строка.

Этот параметр взаимоисключающий с keyed_groups[].trailing_separator.

key

string

Ключ из входного словаря, используемый для создания групп

parent_group

string

родительская группа для группировки по ключу

prefix

string

Имя группы по ключу будет начинаться с этого префикса

По умолчанию: ""

separator

string

Разделитель, используемый для построения имени группы по ключу

По умолчанию: "_"

trailing_separator

boolean

added in ansible-core 2.12

Установите этот параметр в False, чтобы опустить keyed_groups[].separator после переменной хоста, когда значение пустая строка.

Этот параметр взаимоисключающий с keyed_groups[].default_value.

Варианты:

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

leading_separator

boolean

added in ansible-core 2.11

Используется совместно с keyed_groups.

По умолчанию, у ключевой группы, у которой нет префикса или разделителя, имя начинается с нижнего подчёркивания.

Это связано с тем, что по умолчанию префикс — пустая строка, а разделитель — «_».

Установите этот параметр в False, чтобы опустить начальное нижнее подчёркивание (или другой разделитель), если префикс не указан.

Если имя группы получено из отображения, разделитель всё ещё используется для конкатенации элементов.

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

Варианты:

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

plugin

string / обязательно

Маркер, подтверждающий, что это файл источника для плагина.

Варианты:

  • "community.general.stackpath_compute"

stack_slugs

список / элементы=строка

Список Stack slugs для запроса экземпляров. Если нет записей, то получить экземпляры во всех стеках на аккаунте.

strict

boolean

Если yes сделать некорректные записи ошибкой, иначе пропустить и продолжить.

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

Варианты:

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

use_extra_vars

boolean

added in ansible-core 2.11

Объединить дополнительные переменные в доступные переменные для композиции (наивысший приоритет).

Варианты:

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

Настройка:

  • Запись INI:

    [inventory_plugins]
    use_extra_vars = false
    
  • Переменная среды: ANSIBLE_INVENTORY_USE_EXTRA_VARS

use_internal_ip

boolean

Использовать внутренние IP-адреса или нет. Если False, используются внешние IP-адреса; внутренние иначе.

Если у экземпляра нет внешнего IP-адреса, он не будет возвращен, когда этот параметр установлен в false.

Варианты:

  • false
  • true

Примеры

# Example using credentials to fetch all workload instances in a stack.
---
plugin: community.general.stackpath_compute
client_id: my_client_id
client_secret: my_client_secret
stack_slugs:
- my_first_stack_slug
- my_other_stack_slug
use_internal_ip: false

Авторы

  • UNKNOWN (@shayrybak)

Подсказка

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

Ссылки на сборку

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

© 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/stackpath_compute_inventory.html

Spec-Zone.ru

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