Spec-Zone.ru › Ansible

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

Примечание

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

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

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

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

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

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

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

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

Требования

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

  • PyYAML (если используется profile)

Параметры

Параметр

Комментарии

api_timeout

псевдонимы: timeout

integer

Тайм-аут HTTP-запроса к API Scaleway в секундах.

По умолчанию: 30

api_token

псевдонимы: oauth_token

string

Токен OAuth Scaleway.

Обязательный параметр, если не указан profile.

api_url

псевдонимы: base_url

string

URL API Scaleway.

По умолчанию: "https://api.scaleway.com"

description

string

Описание реестра контейнеров.

По умолчанию: ""

name

string / обязательный

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

privacy_policy

string

Политика видимости по умолчанию.

Любой пользователь может загружать образы из реестра public.

Варианты:

  • "public"
  • "private" ← (по умолчанию)

profile

псевдонимы: scw_profile

string

добавлено в community.general 12.2.0

Профиль конфигурации из файла конфигурации, из которого загружается токен OAuth Scaleway; используется вместо api_token.

Также можно задать SCW_PROFILE, чтобы использовать профиль конфигурации SCW CLI.

project_id

string / обязательный

Идентификатор проекта.

query_parameters

dictionary

Список параметров, передаваемых в строке запроса.

По умолчанию: {}

region

string / обязательный

Регион Scaleway (например, fr-par).

Варианты:

  • "fr-par"
  • "nl-ams"
  • "pl-waw"

state

string

Желаемое состояние реестра контейнеров.

Варианты:

  • "present" ← (по умолчанию)
  • "absent"

validate_certs

boolean

Проверять сертификаты SSL API Scaleway.

Варианты:

  • false
  • true ← (по умолчанию)

wait

boolean

Ожидать достижения ресурсом желаемого состояния перед возвратом.

Варианты:

  • false
  • true ← (по умолчанию)

wait_sleep_time

integer

Время ожидания перед каждой попыткой проверить состояние ресурса.

По умолчанию: 3

wait_timeout

integer

Время ожидания достижения ресурсом ожидаемого состояния.

По умолчанию: 300

Атрибуты

Атрибут

Поддержка

Описание

action_group

Группа действий: community.general.scaleway

добавлено в community.general 11.3.0

Используйте group/community.general.scaleway в module_defaults, чтобы задать значения по умолчанию для этого модуля.

check_mode

Поддержка: full

Может выполняться в режиме check_mode и возвращать прогноз изменения состояния, не изменяя целевой объект.

diff_mode

Поддержка: none

Возвращает сведения об изменениях (или возможных изменениях в 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

dictionary

Сведения о реестре контейнеров.

Возвращается: когда 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–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_registry_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API