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

参数

参数

注释

api_timeout

别名:timeout

整数

到 Scaleway API 的 HTTP 超时时间(秒)。

默认值: 30

api_token

别名:oauth_token

字符串 / 必需

Scaleway OAuth 令牌。

api_url

别名:base_url

字符串

Scaleway API URL。

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

description

字符串

容器命名空间的描述。

默认值: ""

environment_variables

字典

容器命名空间的环境变量。

在运行时注入到容器中。

默认值: {}

name

字符串 / 必需

容器命名空间的名称。

project_id

字符串 / 必需

项目标识符。

query_parameters

字典

传递给查询字符串的参数列表。

默认值: {}

region

字符串 / 必需

要使用的 Scaleway 区域(例如 fr-par)。

选项

  • "fr-par"

  • "nl-ams"

  • "pl-waw"

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 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

返回值

常见的返回值已在此处记录,以下是此模块独有的字段:

描述

container_namespace

字典

容器命名空间信息。

返回值:state=present

示例:{"description": "", "environment_variables": {"MY_VAR": "my_value"}, "error_message": null, "id": "531a1fd7-98d2-4a74-ad77-d398324304b8", "name": "my-awesome-container-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)