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

注意

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

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

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

要在 playbook 中使用它，请指定： 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清单脚本中选项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地址的服务器（无论它是私有的还是公共的）。

选项

  • 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

提示

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