openstack.cloud.endpoint 模块 – 管理 OpenStack Identity 服务端点

注意

此模块是 openstack.cloud 集合 (版本 2.3.0) 的一部分。

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

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

要在 playbook 中使用它，请指定：openstack.cloud.endpoint。

概要

  • 创建、更新或删除 OpenStack Identity 服务端点。如果存在具有相同 _service_、_interface_ 和 _region_ 组合的服务，则将更新 _url_、_enabled_ 和 _state_ (present 或 absent)。

需求

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

  • python >= 3.6

  • openstacksdk >= 1.0.0

参数

参数

注释

api_timeout

整数

套接字层在 API 调用超时之前应等待多长时间。如果省略此项，则不会将任何内容传递给 requests 库。

auth

字典

包含云的认证插件策略所需的认证信息的字典。对于默认的 _password_ 插件，这将包含 _auth_url_、_username_、_password_、_project_name_ 以及云支持的任何有关域的信息（例如，_user_domain_name_ 或 _project_domain_name_）。对于其他插件，此参数需要包含该认证插件所需的任何参数。如果提供了命名云或存在 OpenStack OS_* 环境变量，则不需要此参数。

auth_type

字符串

要使用的认证插件的名称。如果云使用密码认证以外的其他认证方式，则应在此处指示插件的名称，并相应地更新 _auth_ 参数的内容。

ca_cert

别名：cacert

字符串

可用于验证 SSL API 请求的 CA 证书捆绑包的路径。

client_cert

别名：cert

字符串

用作 SSL 事务一部分的客户端证书的路径。

client_key

别名：key

字符串

用作 SSL 事务一部分的客户端密钥的路径。

cloud

任意

要操作的命名云或云配置。如果 _cloud_ 是字符串，则它引用在 OpenStack clouds.yaml 文件中定义的命名云配置。为 _auth_ 和 _auth_type_ 提供默认值。如果提供了 _auth_ 或存在 OpenStack OS_* 环境变量，则不需要此参数。如果 _cloud_ 是字典，则它包含完整的云配置，就像 clouds.yaml 的一部分一样。

enabled

布尔值

服务是否已启用。

选项

  • false

  • true ← (默认)

endpoint_interface

字符串 / 必需

服务的接口。

选项

  • "admin"

  • "public"

  • "internal"

interface

别名：endpoint_type

字符串

要从服务目录中获取的端点 URL 类型。

选项

  • "admin"

  • "internal"

  • "public" ← (默认)

region

字符串

服务所属区域的 ID。请注意，_region_ 用于身份验证。

region_name

字符串

区域名称。

sdk_log_level

字符串

OpenStackSDK 的日志级别

选项

  • "INFO" ← (默认)

  • "DEBUG"

sdk_log_path

字符串

OpenStackSDK 日志文件的路径。如果为空，则不写入日志

service

字符串 / 必需

服务的名称或 ID。

state

字符串

资源应该是 present 还是 absent。

选项

  • "present" ← (默认)

  • "absent"

timeout

整数

ansible 应该等待请求的资源完成多长时间。

默认： 180

url

字符串 / 必需

服务的 URL。

validate_certs

别名：verify

布尔值

是否应验证 SSL API 请求。

在 Ansible 2.3 之前，默认为 true。

选项

  • false

  • true

wait

布尔值

ansible 是否应等到请求的资源完成。

选项

  • false

  • true ← (默认)

备注

注意

  • 可以使用标准的 OpenStack 环境变量（例如 OS_USERNAME），而不必提供显式值。

  • 身份验证信息由 openstacksdk 驱动，这意味着值可以来自 /etc/ansible/openstack.yaml、/etc/openstack/clouds.yaml 或 ~/.config/openstack/clouds.yaml 中的 yaml 配置文件，然后来自标准环境变量，最后来自 playbook 中的显式参数。更多信息可以在 https://docs.openstack.org/openstacksdk/ 找到。

示例

- name: Create a service for glance
  openstack.cloud.endpoint:
     cloud: mycloud
     service: glance
     endpoint_interface: public
     url: http://controller:9292
     region: RegionOne
     state: present

- name: Delete a service for nova
  openstack.cloud.endpoint:
     cloud: mycloud
     service: nova
     endpoint_interface: public
     region: RegionOne
     state: absent

返回值

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

键

描述

endpoint

字典

描述端点的字典。

返回：当 _state_ 为 present 时成功。

id

字符串

端点 ID。

返回：成功

示例： "3292f020780b4d5baf27ff7e1d224c44"

interface

字符串

端点接口。

返回：成功

示例： "public"

is_enabled

布尔值

服务状态。

返回：成功

示例： true

字符串

端点的链接

返回：成功

示例： "http://controller/identity/v3/endpoints/123"

name

字符串

端点名称

返回：成功

示例： "cinder"

region_id

字符串

区域ID。

返回：成功

示例： "RegionOne"

service_id

字符串

服务ID。

返回：成功

示例： "b91f1318f735494a825a55388ee118f3"

url

字符串

服务URL。

返回：成功

示例： "http://controller:9292"

作者

  • OpenStack Ansible SIG