kubevirt.core.kubevirt 库存 – KubeVirt VirtualMachines 和 VirtualMachineInstances 的库存源

注意

此库存插件是 kubevirt.core 集合（版本 2.1.0）的一部分。

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

要安装它，请使用：ansible-galaxy collection install kubevirt.core。您需要进一步的要求才能使用此库存插件，有关详细信息，请参阅要求。

要在剧本中使用它，请指定：kubevirt.core.kubevirt。

概要 

从一个或多个命名空间中获取虚拟机，并带有可选的标签选择器。
按集群名称、命名空间和标签分组。
使用 *.kubevirt.[yml|yaml] YAML 配置文件来设置参数值。
默认情况下，它使用 _~/.kube/config_ 中的活动上下文，并将返回活动用户有权访问的所有命名空间的所有虚拟机。

要求 

以下要求需要在执行此库存的本地控制器节点上满足。

python >= 3.9
kubernetes >= 28.1.0
PyYAML >= 3.11

参数 

参数	注释
api_key 字符串	用于向 API 进行身份验证的令牌。也可以通过 `K8S_AUTH_API_KEY` 环境变量指定。
api_version 字符串	指定使用的 KubeVirt API 版本。默认值： `"kubevirt.io/v1"`
append_base_domain 布尔值	将集群的基本域附加到从类型为 `NodePort` 的 SSH `Services` 构建的主机名。选项 `false` ←（默认） `true`
base_domain 字符串	覆盖用于构造主机名的基本域。如果设置了 `append_base_domain`，则用于 `kubesecondarydns` 或类型为 `NodePort` 的 `Services`。
ca_cert 别名：ssl_ca_cert 路径	用于向 API 进行身份验证的 CA 证书的路径。必须提供完整的证书链，以避免证书验证错误。也可以通过 `K8S_AUTH_SSL_CA_CERT` 环境变量指定。
cache 布尔值	切换以启用/禁用库存源数据的缓存，需要设置缓存插件才能工作。选项 `false` ←（默认） `true` 配置 INI 条目 [inventory] cache = false 环境变量：`ANSIBLE_INVENTORY_CACHE`
cache_connection 字符串	缓存连接数据或路径，请阅读缓存插件文档以获取详细信息。配置 INI 条目 [defaults] fact_caching_connection = VALUE [inventory] cache_connection = VALUE 环境变量：`ANSIBLE_CACHE_PLUGIN_CONNECTION` 环境变量：`ANSIBLE_INVENTORY_CACHE_CONNECTION`
cache_plugin 字符串	用于库存源数据的缓存插件。默认值： `"memory"` 配置 INI 条目 [defaults] fact_caching = memory [inventory] cache_plugin = memory 环境变量：`ANSIBLE_CACHE_PLUGIN` 环境变量：`ANSIBLE_INVENTORY_CACHE_PLUGIN`
cache_prefix 字符串	用于缓存插件文件/表的前缀。默认值： `"ansible_inventory_"` 配置 INI 条目 [defaults] fact_caching_prefix = ansible_inventory_ [inventory] cache_prefix = ansible_inventory_ 环境变量：`ANSIBLE_CACHE_PLUGIN_PREFIX` 环境变量：`ANSIBLE_INVENTORY_CACHE_PLUGIN_PREFIX`
cache_timeout 整数	缓存持续时间（以秒为单位）。默认值： `3600` 配置 INI 条目 [defaults] fact_caching_timeout = 3600 [inventory] cache_timeout = 3600 环境变量：`ANSIBLE_CACHE_PLUGIN_TIMEOUT` 环境变量：`ANSIBLE_INVENTORY_CACHE_TIMEOUT`
client_cert 别名：cert_file 路径	用于向 API 进行身份验证的证书的路径。也可以通过 `K8S_AUTH_CERT_FILE` 环境变量指定。
client_key 别名：key_file 路径	用于向 API 进行身份验证的密钥文件的路径。也可以通过 `K8S_AUTH_KEY_FILE` 环境变量指定。
compose 字典	从 jinja2 表达式创建变量。默认值： `{}`
connections 字符串	可选的集群连接设置列表。此参数已弃用。将您的连接拆分为多个配置文件，并将每个连接的参数移动到配置顶层。在版本 `1.5.0` 中已弃用，将在版本 `3.0.0` 中删除。
上下文字符串	配置文件中找到的上下文的名称。也可以通过 `K8S_AUTH_CONTEXT` 环境变量指定。
create_groups 布尔值	启用从 `VirtualMachines` 和 `VirtualMachineInstances` 上的标签创建组。选项 `false` ←（默认） `true`
groups 字典	根据 Jinja2 条件将主机添加到组。默认值： `{}`
host 字符串	提供用于访问 API 的 URL。也可以通过 `K8S_AUTH_HOST` 环境变量指定。
host_format 字符串	指定清单组中主机的格式。可用的说明符：`name`, `namespace` 和 `uid`。默认值: `"{namespace}-{name}"`
impersonate_groups list / elements=string	操作要模拟的组。也可以通过 `K8S_AUTH_IMPERSONATE_GROUPS` 环境变量指定，例如 `Group1,Group2`。
impersonate_user 字符串	操作要模拟的用户名。也可以通过 `K8S_AUTH_IMPERSONATE_USER` 环境变量指定。
keyed_groups list / elements=dictionary	根据变量的值将主机添加到组。默认值: `[]`
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` ← (默认)
kube_secondary_dns 布尔值	在使用辅助网络接口时启用 `kubesecondarydns` 派生的主机名。选项 `false` ←（默认） `true`
kubeconfig any	现有 Kubernetes 配置文件的路径。如果未提供，并且未提供其他连接选项，则 Kubernetes 客户端将尝试从 ~/.kube/config 加载默认配置文件。也可以通过 `K8S_AUTH_KUBECONFIG` 环境变量指定。可以使用分隔符 `;` (对于 Windows 平台) 或 `:` (对于其他平台) 提供多个 Kubernetes 配置文件。 kubernetes 配置可以作为字典提供。此功能需要 python kubernetes 客户端版本 >= 17.17.0。
label_selector 字符串	定义一个标签选择器，以选择所获取的虚拟机子集。
leading_separator 布尔值在 ansible-core 2.11 中添加	与 `keyed_groups` 结合使用。默认情况下，没有提供前缀或分隔符的键组将具有一个以下划线开头的名称。这是因为默认前缀是 `""`，默认分隔符是 `"_"`。如果未提供前缀，请将此选项设置为 `false` 以省略前导下划线 (或其他分隔符)。如果组名是从映射派生的，则仍然使用分隔符来连接项目。要完全不在组名中使用分隔符，请将键组的分隔符设置为空字符串。选项 `false` `true` ← (默认)
name 字符串	要分配给群集的可选名称。如果未提供，则会从服务器和端口构造名称。
namespaces 字符串	命名空间列表。如果未指定，将从用户有权访问的所有命名空间中获取虚拟机。
network_name 别名: interface_name 字符串	如果多个网络连接到一个虚拟机，请定义应返回哪个接口作为主 IP 地址。
no_proxy 字符串	不应通过代理的以逗号分隔的主机/域名/IP/CIDR 列表。也可以通过 `K8S_AUTH_NO_PROXY` 环境变量指定。请注意，此模块不会从环境中获取典型的代理设置 (例如 `NO_PROXY`)。此功能需要 `kubernetes>=19.15.0`。当 kubernetes 库的版本低于 19.15.0 时，即使在正确设置了 no_proxy 的情况下也会失败。示例值为 `localhost,.local,.example.com,127.0.0.1,127.0.0.0/8,10.0.0.0/8,172.16.0.0/12,192.168.0.0/16`。
password 字符串	提供用于向 API 进行身份验证的密码。也可以通过 `K8S_AUTH_PASSWORD` 环境变量指定。请阅读 `username` 选项的描述，以了解此选项何时适用。
persist_config 布尔值	是否保存 kube config 刷新令牌。也可以通过 `K8S_AUTH_PERSIST_CONFIG` 环境变量指定。当 k8s 上下文使用具有刷新令牌的用户凭据 (如 oidc 或 gke/gcloud auth) 时，令牌由 k8s python 客户端库刷新，但默认情况下不保存。因此，旧的刷新令牌可能会过期，并且下一次身份验证可能会失败。将此标志设置为 true 将告诉 k8s python 客户端将新的刷新令牌保存到 kube 配置文件中。默认情况下禁用。选项 `false` `true`
plugin string / 必需	确保这是 kubevirt.core.kubevirt 插件的源文件的令牌。选项 `"kubevirt"` `"kubevirt.core.kubevirt"`
proxy 字符串	用于连接的 HTTP 代理的 URL。也可以通过 `K8S_AUTH_PROXY` 环境变量指定。请注意，此模块不会从环境中获取典型的代理设置 (例如 `HTTP_PROXY`)。
proxy_headers 字典	用于 HTTP 代理的标头。文档可在此处找到 https://urllib3.readthedocs.io/en/latest/reference/urllib3.util.html?highlight=proxy_headers#urllib3.util.make_headers。
basic_auth 字符串	用于基本身份验证标头的以冒号分隔的 username:password。也可以通过 `K8S_AUTH_PROXY_HEADERS_BASIC_AUTH` 环境变量指定。
proxy_basic_auth 字符串	用于代理基本身份验证标头的以冒号分隔的 username:password。也可以通过 `K8S_AUTH_PROXY_HEADERS_PROXY_BASIC_AUTH` 环境变量指定。
user_agent 字符串	表示你想要的 user-agent 的字符串，例如 foo/1.0。也可以通过 `K8S_AUTH_PROXY_HEADERS_USER_AGENT` 环境变量指定。
strict 布尔值	如果 `yes` 将无效条目视为致命错误，否则跳过并继续。由于可以在表达式中使用事实，因此它们可能并非始终可用，并且默认情况下我们会忽略这些错误。选项 `false` ←（默认） `true`
use_extra_vars 布尔值在 ansible-core 2.11 中添加	将额外变量合并到可用于合成的变量中 (优先级最高)。选项 `false` ←（默认） `true` 配置 INI 条目 [inventory_plugins] use_extra_vars = false 环境变量：`ANSIBLE_INVENTORY_USE_EXTRA_VARS`
use_service 布尔值	启用使用 `Services` 来建立与虚拟机的 SSH 连接。仅当未提供 `network_name` 时，才会使用服务。选项 `false` `true` ← (默认)
username 字符串	提供用于 API 身份验证的用户名。也可以通过 `K8S_AUTH_USERNAME` 环境变量指定。
validate_certs 别名：verify_ssl 布尔值	是否验证 API 服务器的 SSL 证书。也可以通过 `K8S_AUTH_VERIFY_SSL` 环境变量指定。选项 `false` `true`

注意 

注意

为了避免在 validate_certs=yes 时出现 SSL 证书验证错误，必须通过 ca_cert 或在 kubeconfig 文件中提供 API 服务器的完整证书链。

示例 

# Filename must end with kubevirt.[yml|yaml]

# Authenticate with token and return all virtual machines from all accessible namespaces
- plugin: kubevirt.core.kubevirt
  host: https://192.168.64.4:8443
  api_key: xxxxxxxxxxxxxxxx
  validate_certs: false

# Use default ~/.kube/config and return virtual machines from namespace testing connected to network bridge-network
- plugin: kubevirt.core.kubevirt
  namespaces:
    - testing
  network_name: bridge-network

# Use default ~/.kube/config and return virtual machines from namespace testing with label app=test
- plugin: kubevirt.core.kubevirt
  namespaces:
    - testing
  label_selector: app=test

# Use a custom config file and a specific context
- plugin: kubevirt.core.kubevirt
  kubeconfig: /path/to/config
  context: 'awx/192-168-64-4:8443/developer'

作者

KubeVirt.io 项目

提示

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