community.general.scaleway_function 模块 – Scaleway 函数管理

注意

此模块是 community.general 集合 (版本 10.1.0) 的一部分。

如果您正在使用 ansible 包，则可能已安装此集合。它不包含在 ansible-core 中。要检查它是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用：ansible-galaxy collection install community.general。您需要其他要求才能使用此模块，有关详细信息，请参阅 要求。

要在 playbook 中使用它，请指定：community.general.scaleway_function。

community.general 6.0.0 中的新增功能

概要

  • 此模块管理 Scaleway 帐户上的函数。

要求

执行此模块的主机需要以下要求。

  • passlib[argon2] >= 1.7.4

参数

参数

注释

api_timeout

别名：timeout

整数

到 Scaleway API 的 HTTP 超时时间（秒）。

默认值： 30

api_token

别名：oauth_token

字符串 / 必填

Scaleway OAuth 令牌。

api_url

别名：base_url

字符串

Scaleway API URL。

默认值： "https://api.scaleway.com"

描述

字符串

函数的描述。

默认值： ""

environment_variables

字典

函数的环境变量。

在运行时注入到函数中。

默认值： {}

function_timeout

字符串

处理程序在停止之前可以花费在处理请求上的时间长度。

handler

字符串

函数中的 module-name.export 值。

max_scale

整数

函数的最大副本数。

memory_limit

整数

资源定义函数的性能特征。

它们在运行时分配给您的函数。

min_scale

整数

函数的最小副本数。

name

字符串 / 必填

函数的名称。

namespace_id

字符串 / 必填

函数命名空间标识符。

privacy

字符串

隐私策略定义函数是否可以匿名执行。

选择 public 以启用匿名执行，或选择 private 以使用 Scaleway API 提供的身份验证机制来保护您的函数。

选项

  • "public" ← (默认)

  • "private"

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

字典

函数的秘密环境变量。

更新这些值不会在 Ansible 中输出 changed 状态。

在运行时注入到函数中。

默认值： {}

state

字符串

指示函数的所需状态。

选项

  • "present" ← (默认)

  • "absent"

validate_certs

布尔值

验证 Scaleway API 的 SSL 证书。

选项

  • false

  • true ← (默认)

wait

布尔值

等待资源达到其所需状态后再返回。

选项

  • false

  • true ← (默认)

wait_sleep_time

整数

每次尝试检查资源状态之前等待的时间。

默认值： 3

wait_timeout

整数

等待资源达到预期状态的时间。

默认值： 300

属性

属性

支持

描述

check_mode

支持：完全支持

可以在 check_mode 模式下运行，并在不修改目标的情况下返回更改状态预测。

diff_mode

支持：不支持

在 diff 模式下，将返回有关已更改内容（或可能需要在 check_mode 模式下更改的内容）的详细信息。

备注

注意

示例

- 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

返回值

常用返回值已在此处记录，以下是此模块特有的字段

键

描述

函数

字典

函数信息。

返回：当 state=present 时

示例：{"cpu_limit": 140, "description": "用于测试 scaleway_function ansible 模块的函数", "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)