openstack.cloud.openstack清单 – OpenStack清单源

注意

此清单插件是openstack.cloud集合 (版本 2.3.0)的一部分。

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

要安装它，请使用：ansible-galaxy collection install openstack.cloud。您需要其他需求才能使用此清单插件，请参阅需求了解详情。

要在剧本中使用它，请指定：openstack.cloud.openstack。

概要

  • 从OpenStack云收集服务器并将它们作为Ansible主机添加到您的清单中。

  • 使用YAML配置文件openstack.{yaml,yml}配置此清单插件。

  • 从标准YAML配置文件clouds{,-public}.yaml中使用云凭据。

需求

以下需求是在执行此清单的本地控制器节点上需要的。

  • python >= 3.6

  • openstacksdk >= 1.0.0

参数

参数

注释

all_projects

布尔值

列出所有项目中的服务器

选项

  • false ← (默认值)

  • true

cache

布尔值

切换以启用/禁用清单源数据的缓存，需要设置缓存插件才能工作。

选项

  • false ← (默认值)

  • true

配置

cache_connection

字符串

缓存连接数据或路径，请参阅缓存插件文档了解详情。

配置

cache_plugin

字符串

要用于清单源数据的缓存插件。

默认值： "memory"

配置

cache_prefix

字符串

用于缓存插件文件/表的前缀

默认值： "ansible_inventory_"

配置

cache_timeout

整数

缓存持续时间（秒）

默认值： 3600

配置

clouds_yaml_path

列表 / 元素=字符串

覆盖clouds.yaml文件的路径。

如果给出此值，则将首先搜索它。

云凭据的搜索路径与文件/etc/ansible/openstack.{yaml,yml}互补。

默认搜索路径记录在https://docs.openstack.org/os-client-config/latest/user/configuration.html#config-files中。

配置

compose

字典

从jinja2表达式创建变量。

默认值： {}

expand_hostvars

布尔值

使用对OpenStack服务的附加查询来丰富服务器事实。这包括对Cinder和Neutron的请求，对于拥有许多服务器的云来说，这可能非常耗时。

expand_hostvars的默认值与传统openstack.py清单脚本中expand_hostvars选项的默认值相反。

选项

  • false ← (默认值)

  • true

fail_on_errors

布尔值

当连接到云失败时（例如，由于凭据错误或连接问题），清单脚本是否失败并返回任何主机。

当fail_on_errors为false时，此清单脚本将尽力返回它可以从云中获取的所有主机。

fail_on_errors的默认值与传统openstack.py清单脚本中fail_on_errors选项的默认值相反。

选项

  • false ← (默认值)

  • true

groups

字典

根据Jinja2条件将主机添加到组。

默认值： {}

inventory_hostname

字符串

注册为清单主机名。

设置为 uuid 时，将使用服务器的 ID，并为服务器名称创建一个组。

设置为 name 时，将使用服务器的名称。当多个服务器共享相同的名称时，将使用服务器的 ID。

inventory_hostname 的默认值与旧版 openstack.py inventory 脚本中 use_hostnames 选项的默认值相反。

选项

  • "name" ← (默认)

  • "uuid"

keyed_groups

列表 / 元素=字典

基于变量的值将主机添加到组。

默认值： []

default_value

字符串

在 ansible-core 2.12 中添加

当主机变量的值为空字符串时的默认值。

此选项与 keyed_groups[].trailing_separator 互斥。

key

字符串

用于生成组的输入字典中的键

parent_group

字符串

键控组的父组

prefix

字符串

键控组名将以此前缀开头

默认值： ""

separator

字符串

用于构建键控组名的分隔符

默认值： "_"

trailing_separator

布尔值

在 ansible-core 2.12 中添加

将此选项设置为 False 以省略在主机变量值为空字符串时 keyed_groups[].separator。

此选项与 keyed_groups[].default_value 互斥。

选项

  • false

  • true ← (默认)

leading_separator

布尔值

在 ansible-core 2.11 中添加

与 keyed_groups 结合使用。

默认情况下，未提供前缀或分隔符的键控组的名称将以下划线开头。

这是因为默认前缀为“”而默认分隔符为“_”。

如果未给出前缀，则将此选项设置为 False 以省略前导下划线（或其他分隔符）。

如果组名来自映射，则仍然使用分隔符来连接项目。

为了根本不使用组名中的分隔符，请将键控组的分隔符设置为空字符串。

选项

  • false

  • true ← (默认)

legacy_groups

布尔值

自动根据主机变量创建组。

选项

  • false

  • true ← (默认)

only_clouds

列表 / 元素=字符串

将联系 clouds.yaml 中的云列表以使用，而不是使用所有云。

默认值： []

plugin

字符串 / 必需

标记给定 YAML 配置文件作为此清单插件的有效输入文件的令牌。

选项

  • "openstack"

  • "openstack.cloud.openstack"

private

布尔值

如果可用，使用服务器的专用接口来确定 Ansible 主机的 IP 地址。

当从云中的服务器运行 Ansible 并希望确保服务器仅通过专用网络进行通信时，使用 private 会很有帮助。

选项

  • false ← (默认值)

  • true

show_all

布尔值

是否应列出所有服务器。

当 show_all 为 false 时，将仅列出具有有效 IP 地址的服务器（无论它是专用还是公共 IP 地址）。

选项

  • false ← (默认值)

  • true

strict

布尔值

如果为 yes，则将无效条目设为致命错误，否则跳过并继续。

由于可以在表达式中使用事实，因此它们可能并不总是可用，因此我们默认忽略这些错误。

选项

  • false ← (默认值)

  • true

use_extra_vars

布尔值

在 ansible-core 2.11 中添加

将额外的变量合并到可用于组合的变量中（最高优先级）。

选项

  • false ← (默认值)

  • true

配置

use_names

布尔值

当 use_names 为 false（其默认值）时，服务器的第一个浮动 IP 地址将用于事实 ansible_host 和 ansible_ssh_host。当没有浮动 IP 地址连接到服务器时，将改为使用其第一个非浮动 IP 地址。如果没有任何地址连接到服务器，则这两个事实都不会定义。

当 use_names 为 true 时，服务器名称将用于 ansible_host 和 ansible_ssh_host 事实。这对于跳转主机或堡垒主机非常有用，其中每个服务器名称实际上都是服务器的 FQDN。

选项

  • false ← (默认值)

  • true

示例

# Create a file called openstack.yaml, add the following content and run
# $> ansible-inventory --list -vvv -i openstack.yaml
plugin: openstack.cloud.openstack

all_projects: false
expand_hostvars: true
fail_on_errors: true
only_clouds:
  - "devstack-admin"
strict: true

作者

  • OpenStack Ansible SIG

提示

每个条目类型的配置项具有从低到高的优先级顺序。例如，列表中较低的变量将覆盖较高的变量。