Модуль community.general.scaleway_function — управление функциями Scaleway

Примечание

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

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

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

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

Добавлено в 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"`
description строка	Описание функции. По умолчанию: `""`
environment_variables словарь	Переменные среды функции. Передаются функции во время выполнения. По умолчанию: `{}`
function_timeout строка	Время, в течение которого обработчик может обрабатывать запрос, прежде чем его выполнение будет остановлено.
handler строка	Значение `module-name.export` в вашей функции.
max_scale целое число	Максимальное количество реплик функции.
memory_limit целое число	Ресурсы определяют характеристики производительности функции. Они выделяются функции во время выполнения.
min_scale целое число	Минимальное количество реплик функции.
name строка / обязательный	Имя функции.
namespace_id строка / обязательный	Идентификатор пространства имен функции.
privacy строка	Политики конфиденциальности определяют, можно ли выполнять функцию анонимно. Выберите `public`, чтобы разрешить анонимное выполнение, или `private`, чтобы защитить функцию с помощью механизма аутентификации, предоставляемого API Scaleway. Варианты: `"public"` ← (по умолчанию) `"private"`
profile псевдонимы: scw_profile строка добавлено в community.general 12.2.0	Профиль конфигурации из файла конфигурации, из которого загружается токен OAuth Scaleway; используется вместо `api_token`. Также можно задать `SCW_PROFILE`, чтобы использовать профиль конфигурации SCW CLI.
query_parameters словарь	Список параметров, передаваемых в строку запроса. По умолчанию: `{}`
redeploy логическое значение	Повторно развернуть функцию, если требуется обновление. Варианты: `false` ← (по умолчанию) `true`
region строка / обязательный	Регион Scaleway для использования (например, `fr-par`). Варианты: `"fr-par"` `"nl-ams"` `"pl-waw"`
runtime строка / обязательный	Среда выполнения функции. Список всех доступных сред выполнения см. на странице https://www.scaleway.com/en/docs/compute/functions/reference-content/functions-lifecycle/.
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	Поддержка: отсутствует	В режиме 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
  community.general.scaleway_function:
    namespace_id: '{{ scw_function_namespace }}'
    region: fr-par
    state: present
    name: my-awesome-function
    runtime: python3
    environment_variables:
      MY_VAR: my_value
    secret_environment_variables:
      MY_SECRET_VAR: my_secret_value
  register: function_creation_task

- name: Make sure function is deleted
  community.general.scaleway_function:
    namespace_id: '{{ scw_function_namespace }}'
    region: fr-par
    state: absent
    name: my-awesome-function

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

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

Ключ	Описание
function словарь	Информация о функции. Возвращается: если `state=present` Пример: {"cpu_limit": 140, "description": "Function used for testing scaleway_function ansible module", "domain_name": "fnansibletestfxamabuc-fn-ansible-test.functions.fnc.fr-par.scw.cloud", "environment_variables": {"MY_VAR": "my_value"}, "error_message": null, "handler": "handler.handle", "http_option": "", "id": "ceb64dc4-4464-4196-8e20-ecef705475d3", "max_scale": 5, "memory_limit": 256, "min_scale": 0, "name": "fn-ansible-test", "namespace_id": "82737d8d-0ebb-4d89-b0ad-625876eca50d", "privacy": "public", "region": "fr-par", "runtime": "python310", "runtime_message": "", "secret_environment_variables": [{"key": "MY_SECRET_VAR", "value": "$argon2id$v=19$m=65536,t=1,p=2$tb6UwSPWx/rH5Vyxt9Ujfw$5ZlvaIjWwNDPxD9Rdght3NarJz4IETKjpvAU3mMSmFg"}], "status": "created", "timeout": "300s"}

Ключ

Описание

function

словарь

Информация о функции.

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

Пример: {"cpu_limit": 140, "description": "Function used for testing scaleway_function ansible module", "domain_name": "fnansibletestfxamabuc-fn-ansible-test.functions.fnc.fr-par.scw.cloud", "environment_variables": {"MY_VAR": "my_value"}, "error_message": null, "handler": "handler.handle", "http_option": "", "id": "ceb64dc4-4464-4196-8e20-ecef705475d3", "max_scale": 5, "memory_limit": 256, "min_scale": 0, "name": "fn-ansible-test", "namespace_id": "82737d8d-0ebb-4d89-b0ad-625876eca50d", "privacy": "public", "region": "fr-par", "runtime": "python310", "runtime_message": "", "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_function_module.html