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

Примечание

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

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

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

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

Новое в community.general 5.8.0

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

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

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

Параметры

Параметр	Комментарии
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 строка	Описание реестра контейнеров. По умолчанию: `""`
name строка / обязательно	Имя реестра контейнеров.
privacy_policy строка	Политика видимости по умолчанию. Каждый сможет извлекать образы из реестра `public`. Варианты: `"public"` `"private"` ← (по умолчанию)
project_id строка / обязательно	Идентификатор проекта.
query_parameters словарь	Список параметров, передаваемых в строку запроса. По умолчанию: `{}`
region строка / обязательно	Регион Scaleway для использования (например, `fr-par`). Варианты: `"fr-par"` `"nl-ams"` `"pl-waw"`
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`).

Примечания

Примечание

Также см. документацию 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 registry
  community.general.scaleway_container_registry:
    project_id: '{{ scw_project }}'
    state: present
    region: fr-par
    name: my-awesome-container-registry
  register: container_registry_creation_task

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

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

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

Ключ	Описание
container_registry словарь	Информация о реестре контейнеров. Возвращается: при `state=present` Пример: `{"created_at": "2022-10-14T09:51:07.949716Z", "description": "Managed by Ansible", "endpoint": "rg.fr-par.scw.cloud/my-awesome-registry", "id": "0d7d5270-7864-49c2-920b-9fd6731f3589", "image_count": 0, "is_public": false, "name": "my-awesome-registry", "organization_id": "10697b59-5c34-4d24-8d15-9ff2d3b89f58", "project_id": "3da4f0b2-06be-4773-8ec4-5dfa435381be", "region": "fr-par", "size": 0, "status": "ready", "status_message": "", "updated_at": "2022-10-14T09:51:07.949716Z"}`

Ключ

Описание

container_registry

словарь

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

Возвращается: при state=present

Пример: {"created_at": "2022-10-14T09:51:07.949716Z", "description": "Managed by Ansible", "endpoint": "rg.fr-par.scw.cloud/my-awesome-registry", "id": "0d7d5270-7864-49c2-920b-9fd6731f3589", "image_count": 0, "is_public": false, "name": "my-awesome-registry", "organization_id": "10697b59-5c34-4d24-8d15-9ff2d3b89f58", "project_id": "3da4f0b2-06be-4773-8ec4-5dfa435381be", "region": "fr-par", "size": 0, "status": "ready", "status_message": "", "updated_at": "2022-10-14T09:51:07.949716Z"}

Авторы

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