Модуль community.general.scaleway_container — Управление контейнерами Scaleway

Примечание

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

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

Для установки используйте: ansible-galaxy collection install community.general. Для использования этого модуля необходимы дополнительные требования. Подробности см. в разделе Требования.

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

Новая в community.general 6.0.0

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

Обзор

Этот модуль управляет контейнерами на аккаунте Scaleway.

Требования

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

passlib[argon2] >= 1.7.4

Параметры

Параметр	Комментарии
api_timeout aliases: timeout integer	HTTP тайм-аут для Scaleway API в секундах. Default: `30`
api_token aliases: oauth_token string / required	Токен Scaleway OAuth.
api_url aliases: base_url string	URL Scaleway API. Default: `"https://api.scaleway.com"`
container_timeout string	Продолжительность обработки запроса обработчиком перед принудительным завершением.
description string	Описание пространства имен контейнера. Default: `""`
environment_variables dictionary	Переменные окружения пространства имен контейнера. Внедряются в контейнер во время выполнения. Default: `{}`
max_concurrency integer	Максимальное количество подключений на контейнер. Этот параметр будет использоваться для запуска автомасштабирования.
max_scale integer	Максимальное количество реплик для контейнера.
memory_limit integer	Ресурсы определяют характеристики производительности вашего контейнера. Они выделяются вашему контейнеру во время выполнения.
min_scale integer	Минимальное количество реплик для контейнера.
name string / required	Имя пространства имен контейнера.
namespace_id string / required	Идентификатор пространства имен контейнера.
port integer	Порт прослушивания, используемый для предоставления доступа к контейнеру.
privacy string	Политики конфиденциальности определяют, может ли контейнер выполняться анонимно. Выберите `public` для включения анонимного выполнения или `private` для защиты вашего контейнера с помощью механизма аутентификации, предоставляемого Scaleway API. Choices: `"public"` ← (default) `"private"`
protocol string	Протокол связи контейнера. Choices: `"http1"` ← (default) `"h2c"`
query_parameters dictionary	Список параметров, передаваемых в строку запроса. Default: `{}`
redeploy boolean	Переразвернуть контейнер, если требуется обновление. Choices: `false` ← (default) `true`
region string / required	Регион Scaleway для использования (например, `fr-par`). Choices: `"fr-par"` `"nl-ams"` `"pl-waw"`
registry_image string / required	Имя образа, используемого для контейнера.
secret_environment_variables dictionary	Секретные переменные окружения пространства имен контейнера. Обновление этих значений не приведет к выводу состояния `changed` в Ansible. Внедряются в контейнер во время выполнения. Default: `{}`

состояние строка	Укажите желаемое состояние контейнера. Выборы: `"present"` ← (по умолчанию) `"absent"`
validate_certs булево	Проверьте SSL-сертификаты API Scaleway. Выборы: `false` `true` ← (по умолчанию)
wait булево	Подождите, пока ресурс достигнет желаемого состояния, прежде чем возвращаться. Выборы: `false` `true` ← (по умолчанию)
wait_sleep_time целое число	Время ожидания перед каждой попыткой проверки состояния ресурса. По умолчанию: `3`
wait_timeout целое число	Время ожидания достижения ресурсом ожидаемого состояния. По умолчанию: `300`

Атрибуты

Атрибут	Поддержка	Описание
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: Create a container
  community.general.scaleway_container:
    namespace_id: '{{ scw_container_namespace }}'
    state: present
    region: fr-par
    name: my-awesome-container
    registry_image: rg.fr-par.scw.cloud/funcscwtestrgy2f9zw/nginx:latest
    environment_variables:
      MY_VAR: my_value
    secret_environment_variables:
      MY_SECRET_VAR: my_secret_value
  register: container_creation_task

- name: Make sure container is deleted
  community.general.scaleway_container:
    namespace_id: '{{ scw_container_namespace }}'
    state: absent
    region: fr-par
    name: my-awesome-container

Возвращаемые значения

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

Ключ	Описание
контейнер словарь	Информация о контейнере. Возвращено: когда `state=present` Пример: {"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"}

Ключ

Описание

контейнер

словарь

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

Возвращено: когда state=present

Пример: {"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_module.html