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

Примечание

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

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

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

Чтобы использовать его в плейбуке, укажите: community.general.scaleway_container.

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

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

Краткое описание

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

Требования

Следующие требования необходимы на хосте, где выполняется этот модуль.

PyYAML (если используется profile)
passlib[argon2] >= 1.7.4

Параметры

Параметр	Комментарии
api_timeout псевдонимы: timeout целое число	Тайм-аут HTTP-запроса к API Scaleway в секундах. По умолчанию: `30`
api_token псевдонимы: oauth_token строка	Токен OAuth Scaleway. Обязателен, если не указан `profile`.
api_url псевдонимы: base_url строка	URL API Scaleway. По умолчанию: `"https://api.scaleway.com"`
container_timeout строка	Время, в течение которого обработчик может обрабатывать запрос, прежде чем его работа будет остановлена.
cpu_limit целое число добавлено в community.general 11.3.0	Ресурсы определяют характеристики производительности контейнера. Они выделяются контейнеру во время выполнения. Единица измерения — 1/1000 виртуального ЦП.
description строка	Описание пространства имен контейнера. По умолчанию: `""`
environment_variables словарь	Переменные окружения пространства имен контейнера. Передаются контейнеру во время выполнения. По умолчанию: `{}`
max_concurrency целое число	Максимальное число подключений на контейнер. Этот параметр используется для запуска автомасштабирования.
max_scale целое число	Максимальное число реплик контейнера.
memory_limit целое число	Ресурсы определяют характеристики производительности контейнера. Они выделяются контейнеру во время выполнения. Единица измерения — МБ памяти.
min_scale целое число	Минимальное число реплик контейнера.
name строка / обязательный	Имя пространства имен контейнера.
namespace_id строка / обязательный	Идентификатор пространства имен контейнера.
port целое число	Порт прослушивания, используемый для предоставления доступа к контейнеру.
privacy строка	Политики конфиденциальности определяют, можно ли запускать контейнер анонимно. Выберите `public`, чтобы разрешить анонимный запуск, или `private`, чтобы защитить контейнер с помощью механизма аутентификации, предоставляемого API Scaleway. Варианты: `"public"` ← (по умолчанию) `"private"`
profile псевдонимы: scw_profile строка добавлено в community.general 12.2.0	Профиль конфигурации в файле конфигурации, из которого загружается токен OAuth Scaleway; используется вместо `api_token`. Также можно задать `SCW_PROFILE`, чтобы использовать профиль конфигурации SCW CLI.
protocol строка	Протокол обмена данными контейнера. Варианты: `"http1"` ← (по умолчанию) `"h2c"`
query_parameters словарь	Список параметров, передаваемых в строке запроса. По умолчанию: `{}`
redeploy логический	Повторно развернуть контейнер, если требуется обновление. Варианты: `false` ← (по умолчанию) `true`
region строка / обязательный	Регион Scaleway (например, `fr-par`). Варианты: `"fr-par"` `"nl-ams"` `"pl-waw"`
registry_image строка / обязательный	Имя образа, используемого для контейнера.
secret_environment_variables словарь	Секретные переменные окружения пространства имен контейнера. Обновление этих значений не приводит к состоянию `changed` в Ansible. Передаются контейнеру во время выполнения. По умолчанию: `{}`
state строка	Требуемое состояние контейнера. Варианты: `"present"` ← (по умолчанию) `"absent"`
validate_certs логический	Проверять SSL-сертификаты API Scaleway. Варианты: `false` `true` ← (по умолчанию)
wait логический	Дождаться перехода ресурса в требуемое состояние перед возвратом. Варианты: `false` `true` ← (по умолчанию)
wait_sleep_time целое число	Время ожидания перед каждой попыткой проверить состояние ресурса. По умолчанию: `3`
wait_timeout целое число	Время ожидания перехода ресурса в ожидаемое состояние. По умолчанию: `300`

Атрибуты

Атрибут	Поддержка	Описание
action_group	Группа действий: community.general.scaleway добавлено в community.general 11.3.0	Используйте `group/community.general.scaleway` в `module_defaults`, чтобы задать значения по умолчанию для этого модуля.
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

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

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

Ключ	Описание
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"}

Ключ

Описание

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"}

Авторы

Guillaume MARTINEZ (@Lunik)

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

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/community/general/scaleway_container_module.html