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

Примечание

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

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

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

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

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

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

Описание

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

Требования

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

passlib[argon2] >= 1.7.4

Параметры

Параметр	Комментарии
api_timeout псевдонимы: timeout целое число	Таймаут HTTP запросов к API Scaleway в секундах. По умолчанию: `30`
api_token псевдонимы: oauth_token строка / обязательно	Токен Scaleway OAuth.
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"`
query_parameters словарь	Список параметров, передаваемых в строку запроса. По умолчанию: `{}`
redeploy логическое	Переразвернуть функцию, если требуется обновление. Доступные значения: `false` ← (по умолчанию) `true`
region строка / обязательно	Регион Scaleway для использования (например, `fr-par`). Доступные значения: `"fr-par"` `"nl-ams"` `"pl-waw"`
runtime строка / обязательно	СРОВ функции См. https://www.scaleway.com/ru/docs/compute/functions/reference-content/functions-lifecycle/ для всех доступных сред выполнения
secret_environment_variables словарь	Секретные переменные окружения функции. Обновление этих значений не выведет состояние `changed` в Ansible. Вводятся в функцию во время выполнения. По умолчанию: `{}`
state строка	Укажите желаемое состояние функции. Доступные значения: `"present"` ← (по умолчанию) `"absent"`
validate_certs логическое	Проверить SSL-сертификаты API Scaleway. Доступные значения: `false` `true` ← (по умолчанию)

wait boolean	Дождаться, чтобы ресурс достиг желаемого состояния перед возвратом. Варианты: `false` `true` ← (по умолчанию)
wait_sleep_time integer	Время ожидания перед каждой попыткой проверки состояния ресурса. По умолчанию: `3`
wait_timeout integer	Время ожидания, пока ресурс достигнет ожидаемого состояния. По умолчанию: `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 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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/general/scaleway_function_module.html