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

Примечание

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

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

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

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

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

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

Обзор

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

Требования

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

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

Параметры

Параметр	Комментарии
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	Описание пространства имен функций. По умолчанию: `""`
environment_variables dictionary	Переменные среды пространства имен функций. Передаются функциям во время выполнения. По умолчанию: `{}`
name string / обязательный	Имя пространства имен функций.
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"`
secret_environment_variables dictionary	Секретные переменные среды пространства имен функций. При обновлении этих значений состояние `changed` в Ansible не выводится. Передаются функциям во время выполнения. По умолчанию: `{}`
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	В режиме diff возвращает сведения об изменениях (или возможных изменениях в `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 function namespace
  community.general.scaleway_function_namespace:
    project_id: '{{ scw_project }}'
    state: present
    region: fr-par
    name: my-awesome-function-namespace
    environment_variables:
      MY_VAR: my_value
    secret_environment_variables:
      MY_SECRET_VAR: my_secret_value
  register: function_namespace_creation_task

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

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

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

Ключ	Описание
function_namespace dictionary	Информация о пространстве имен функций. Возвращается: если `state=present` Пример: {"description": "", "environment_variables": {"MY_VAR": "my_value"}, "error_message": null, "id": "531a1fd7-98d2-4a74-ad77-d398324304b8", "name": "my-awesome-function-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"}

Ключ

Описание

function_namespace

dictionary

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

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

Пример: {"description": "", "environment_variables": {"MY_VAR": "my_value"}, "error_message": null, "id": "531a1fd7-98d2-4a74-ad77-d398324304b8", "name": "my-awesome-function-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–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/community/general/scaleway_function_namespace_module.html