community.general.scaleway_container_namespace 模块 – Scaleway 容器命名空间管理
注意
此模块是 community.general 集合 (版本 10.1.0) 的一部分。
如果您使用的是 ansible
包,则可能已经安装了此集合。它不包含在 ansible-core
中。要检查是否已安装,请运行 ansible-galaxy collection list
。
要安装它,请使用:ansible-galaxy collection install community.general
。您需要其他要求才能使用此模块,请参阅 要求 获取详细信息。
要在 playbook 中使用它,请指定:community.general.scaleway_container_namespace
。
community.general 6.0.0 中的新增功能
概要
此模块管理 Scaleway 帐户上的容器命名空间。
要求
执行此模块的主机需要以下要求。
passlib[argon2] >= 1.7.4
参数
参数 |
注释 |
---|---|
到 Scaleway API 的 HTTP 超时时间(秒)。 默认值: |
|
Scaleway OAuth 令牌。 |
|
Scaleway API URL。 默认值: |
|
容器命名空间的描述。 默认值: |
|
容器命名空间的环境变量。 在运行时注入到容器中。 默认值: |
|
容器命名空间的名称。 |
|
项目标识符。 |
|
传递给查询字符串的参数列表。 默认值: |
|
要使用的 Scaleway 区域(例如 选项
|
|
容器命名空间的秘密环境变量。 更新这些值不会在 Ansible 中输出 在运行时注入到容器中。 默认值: |
|
指示容器命名空间的所需状态。 选项
|
|
验证 Scaleway API 的 SSL 证书。 选项
|
|
等待资源达到其所需状态后再返回。 选项
|
|
每次尝试检查资源状态之前等待的时间。 默认值: |
|
等待资源达到预期状态的时间。 默认值: |
属性
属性 |
支持 |
描述 |
---|---|---|
支持:完全支持 |
可以在 |
|
支持:不支持 |
在 diff 模式下,将返回有关已更改内容(或可能需要在 |
备注
注意
另请参见 https://developer.scaleway.com/ 上的 API 文档。
如果模块中未设置
api_token
,则可以使用以下环境变量,优先级从高到低依次为SCW_TOKEN
、SCW_API_KEY
、SCW_OAUTH_TOKEN
或SCW_API_TOKEN
。如果要使用不同的
api_url
,也可以设置SCW_API_URL
环境变量。
示例
- name: Create a container namespace
community.general.scaleway_container_namespace:
project_id: '{{ scw_project }}'
state: present
region: fr-par
name: my-awesome-container-namespace
environment_variables:
MY_VAR: my_value
secret_environment_variables:
MY_SECRET_VAR: my_secret_value
register: container_namespace_creation_task
- name: Make sure container namespace is deleted
community.general.scaleway_container_namespace:
project_id: '{{ scw_project }}'
state: absent
region: fr-par
name: my-awesome-container-namespace
返回值
常见的返回值已在此处记录,以下是此模块独有的字段:
键 |
描述 |
---|---|
容器命名空间信息。 返回值:当 示例: |