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

Примечание

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

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

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

Для использования в playbook, укажите: community.general.scaleway_container_namespace.

Новое в community.general 6.0.0

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

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

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

Требования

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

passlib[argon2] >= 1.7.4

Параметры

Параметр	Комментарии
api_timeout псевдонимы: timeout целое число	Таймаут HTTP для API Scaleway в секундах. По умолчанию: `30`
api_token псевдонимы: oauth_token строка / обязательно	Токен OAuth Scaleway.
api_url псевдонимы: base_url строка	URL API Scaleway. По умолчанию: `"https://api.scaleway.com"`
description строка	Описание пространства имен контейнера. По умолчанию: `""`
environment_variables словарь	Переменные среды пространства имен контейнера. Вставляются в контейнеры во время выполнения. По умолчанию: `{}`
name строка / обязательно	Имя пространства имен контейнера.
project_id строка / обязательно	Идентификатор проекта.
query_parameters словарь	Список параметров, передаваемых в строку запроса. По умолчанию: `{}`
region строка / обязательно	Регион Scaleway для использования (например, `fr-par`). Варианты: `"fr-par"` `"nl-ams"` `"pl-waw"`
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`

Атрибуты

Атрибут	Поддержка	Описание
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 namespace
  community.general.scaleway_container_namespace:
    project_id: '{{ scw_project }}'
    state: present
    region: fr-par
    name: my-awesome-container-namespace
    environment_variables:
      MY_VAR: my_value
    secret_environment_variables:
      MY_SECRET_VAR: my_secret_value
  register: container_namespace_creation_task

- name: Make sure container namespace is deleted
  community.general.scaleway_container_namespace:
    project_id: '{{ scw_project }}'
    state: absent
    region: fr-par
    name: my-awesome-container-namespace

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

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

Ключ	Описание
container_namespace словарь	Информация о пространстве имён контейнера. Возвращается: когда `state=present` Пример: {"description": "", "environment_variables": {"MY_VAR": "my_value"}, "error_message": null, "id": "531a1fd7-98d2-4a74-ad77-d398324304b8", "name": "my-awesome-container-namespace", "organization_id": "e04e3bdc-015c-4514-afde-9389e9be24b0", "project_id": "d44cea58-dcb7-4c95-bff1-1105acb60a98", "region": "fr-par", "registry_endpoint": "", "registry_namespace_id": "", "secret_environment_variables": [{"key": "MY_SECRET_VAR", "value": "$argon2id$v=19$m=65536,t=1,p=2$tb6UwSPWx/rH5Vyxt9Ujfw$5ZlvaIjWwNDPxD9Rdght3NarJz4IETKjpvAU3mMSmFg"}], "status": "pending"}

Ключ

Описание

container_namespace

словарь

Информация о пространстве имён контейнера.

Возвращается: когда state=present

Пример: {"description": "", "environment_variables": {"MY_VAR": "my_value"}, "error_message": null, "id": "531a1fd7-98d2-4a74-ad77-d398324304b8", "name": "my-awesome-container-namespace", "organization_id": "e04e3bdc-015c-4514-afde-9389e9be24b0", "project_id": "d44cea58-dcb7-4c95-bff1-1105acb60a98", "region": "fr-par", "registry_endpoint": "", "registry_namespace_id": "", "secret_environment_variables": [{"key": "MY_SECRET_VAR", "value": "$argon2id$v=19$m=65536,t=1,p=2$tb6UwSPWx/rH5Vyxt9Ujfw$5ZlvaIjWwNDPxD9Rdght3NarJz4IETKjpvAU3mMSmFg"}], "status": "pending"}

Авторы

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_namespace_module.html