Модуль community.general.scaleway_container_info — Получение информации о контейнере Scaleway

Примечание

Этот модуль является частью коллекции community.general (версия 9.5.0).

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

Чтобы установить её, используйте: ansible-galaxy collection install community.general.

Чтобы использовать её в playbook, укажите: community.general.scaleway_container_info.

Новый в community.general 6.0.0

Обзор
Параметры
Атрибуты
Примечания
Примеры
Значения возврата

Обзор

Этот модуль возвращает информацию о контейнере на аккаунте Scaleway.

Параметры

Параметр	Комментарии
api_timeout алиасы: timeout целое число	Таймаут HTTP-соединения с API Scaleway в секундах. По умолчанию: `30`
api_token алиасы: oauth_token строка / обязательно	Токен Scaleway OAuth.
api_url алиасы: base_url строка	URL API Scaleway. По умолчанию: `"https://api.scaleway.com"`
name строка / обязательно	Имя контейнера.
namespace_id строка / обязательно	Идентификатор пространства имён контейнера.
query_parameters словарь	Список параметров, передаваемых в строку запроса. По умолчанию: `{}`
region строка / обязательно	Регион Scaleway для использования (например, `fr-par`). Допустимые значения: `"fr-par"` `"nl-ams"` `"pl-waw"`
validate_certs булево	Проверять SSL-сертификаты API Scaleway. Допустимые значения: `false` `true` ← (по умолчанию)

Атрибуты

Атрибут	Поддержка	Описание
check_mode	Поддержка: полная Это действие не изменяет состояние.	Может выполняться в режиме `check_mode` и возвращать прогноз изменений статуса без модификации целевого объекта.
diff_mode	Поддержка: Нет Это действие не изменяет состояние.	Возвращает детали изменений (или, возможно, требующих изменения в `check_mode`), когда используется режим diff.

Примечания

Примечание

Также обратитесь к документации API по адресу https://developer.scaleway.com/.
Если api_token не задан в модуле, можно использовать переменные окружения в порядке убывания приоритета SCW_TOKEN, SCW_API_KEY, SCW_OAUTH_TOKEN или SCW_API_TOKEN.
Если нужно использовать другой api_url, можно также установить переменную окружения SCW_API_URL.

Примеры

- name: Get a container info
  community.general.scaleway_container_info:
    namespace_id: '{{ scw_container_namespace }}'
    region: fr-par
    name: my-awesome-container
  register: container_info_task

Значения возврата

Общие значения возврата описаны здесь, ниже приведены поля, уникальные для данного модуля:

Ключ	Описание
container словарь	Информация о контейнере. Возвращается: всегда Пример: {"cpu_limit": 140, "description": "Container used for testing scaleway_container ansible module", "domain_name": "cnansibletestgfogtjod-cn-ansible-test.functions.fnc.fr-par.scw.cloud", "environment_variables": {"MY_VAR": "my_value"}, "error_message": null, "http_option": "", "id": "c9070eb0-d7a4-48dd-9af3-4fb139890721", "max_concurrency": 50, "max_scale": 5, "memory_limit": 256, "min_scale": 0, "name": "cn-ansible-test", "namespace_id": "75e299f1-d1e5-4e6b-bc6e-4fb51cfe1e69", "port": 80, "privacy": "public", "protocol": "http1", "region": "fr-par", "registry_image": "rg.fr-par.scw.cloud/namespace-ansible-ci/nginx:latest", "secret_environment_variables": [{"key": "MY_SECRET_VAR", "value": "$argon2id$v=19$m=65536,t=1,p=2$tb6UwSPWx/rH5Vyxt9Ujfw$5ZlvaIjWwNDPxD9Rdght3NarJz4IETKjpvAU3mMSmFg"}], "status": "created", "timeout": "300s"}

Ключ

Описание

container

словарь

Информация о контейнере.

Возвращается: всегда

Пример: {"cpu_limit": 140, "description": "Container used for testing scaleway_container ansible module", "domain_name": "cnansibletestgfogtjod-cn-ansible-test.functions.fnc.fr-par.scw.cloud", "environment_variables": {"MY_VAR": "my_value"}, "error_message": null, "http_option": "", "id": "c9070eb0-d7a4-48dd-9af3-4fb139890721", "max_concurrency": 50, "max_scale": 5, "memory_limit": 256, "min_scale": 0, "name": "cn-ansible-test", "namespace_id": "75e299f1-d1e5-4e6b-bc6e-4fb51cfe1e69", "port": 80, "privacy": "public", "protocol": "http1", "region": "fr-par", "registry_image": "rg.fr-par.scw.cloud/namespace-ansible-ci/nginx:latest", "secret_environment_variables": [{"key": "MY_SECRET_VAR", "value": "$argon2id$v=19$m=65536,t=1,p=2$tb6UwSPWx/rH5Vyxt9Ujfw$5ZlvaIjWwNDPxD9Rdght3NarJz4IETKjpvAU3mMSmFg"}], "status": "created", "timeout": "300s"}

Авторы

Guillaume MARTINEZ (@Lunik)

Ссылки на коллекцию

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