community.okd.openshift 库存 – OpenShift 库存源

注意

此库存插件是 community.okd 集合(版本 4.0.0)的一部分。

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

要安装它,请使用: ansible-galaxy collection install community.okd。您需要其他要求才能使用此库存插件,有关详细信息,请参阅 要求

要在 playbook 中使用它,请指定: community.okd.openshift

已弃用

在以下版本中删除:

版本 5.0.0

原因:

正如在 https://github.com/ansible-collections/kubernetes.core/issues/31 中讨论的那样,我们决定在 5.0.0 版本中删除 openshift 库存插件。

替代方案:

改用 kubernetes.core.k8s_infoansible.builtin.add_host

概要

  • 获取一个或多个集群的容器、服务和路由

  • 按集群名称、命名空间、namespace_services、namespace_pods、namespace_routes 和标签分组

  • 使用 openshift.(yml|yaml) YAML 配置文件设置参数值。

要求

本地控制器节点(执行此库存)需要以下要求。

  • python >= 3.6

  • kubernetes >= 12.0.0

  • PyYAML >= 3.11

参数

参数

注释

connections

字符串

集群连接设置的可选列表。如果没有提供连接,则将使用默认的 ~/.kube/config 和活动上下文,并且将返回活动用户有权访问的所有命名空间的对象。

api_key

字符串

用于向 API 进行身份验证的令牌。也可以通过 K8S_AUTH_API_KEY 环境变量指定。

ca_cert

别名:ssl_ca_cert

字符串

用于向 API 进行身份验证的 CA 证书的路径。也可以通过 K8S_AUTH_SSL_CA_CERT 环境变量指定。

client_cert

别名:cert_file

字符串

用于向 API 进行身份验证的证书的路径。也可以通过 K8S_AUTH_CERT_FILE 环境变量指定。

client_key

别名:key_file

字符串

用于向 API 进行身份验证的密钥文件的路径。也可以通过 K8S_AUTH_KEY_FILE 环境变量指定。

context

字符串

配置文件中找到的上下文的名称。也可以通过 K8S_AUTH_CONTEXT 环境变量指定。

host

字符串

提供用于访问 API 的 URL。也可以通过 K8S_AUTH_HOST 环境变量指定。

kubeconfig

字符串

现有 Kubernetes 配置文件的路径。如果未提供,并且未提供其他连接选项,Kubernetes 客户端将尝试从 ~/.kube/config 加载默认配置文件。也可以通过 K8S_AUTH_KUBECONFIG 环境变量指定。

name

字符串

为集群分配的可选名称。如果未提供,则从服务器和端口构造名称。

namespaces

字符串

命名空间列表。如果未指定,将获取用户有权访问的所有命名空间的所有容器。

password

字符串

提供用于向 API 进行身份验证的密码。也可以通过 K8S_AUTH_PASSWORD 环境变量指定。

username

字符串

提供用于向 API 进行身份验证的用户名。也可以通过 K8S_AUTH_USERNAME 环境变量指定。

validate_certs

别名:verify_ssl

布尔值

是否验证 API 服务器的 SSL 证书。也可以通过 K8S_AUTH_VERIFY_SSL 环境变量指定。

选择

  • false

  • true

plugin

字符串 / 必需

确保这是“openshift”插件的源文件的令牌。

选择

  • "openshift"

  • "community.okd.openshift"

示例

# File must be named openshift.yaml or openshift.yml

- name: Authenticate with token, and return all pods and services for all namespaces
  plugin: community.okd.openshift
  connections:
    - host: https://192.168.64.4:8443
      api_key: xxxxxxxxxxxxxxxx
      verify_ssl: false

- name: Use default config (~/.kube/config) file and active context, and return objects for a specific namespace
  plugin: community.okd.openshift
  connections:
    - namespaces:
        - testing

- name: Use a custom config file, and a specific context.
  plugin: community.okd.openshift
  connections:
    - kubeconfig: /path/to/config
      context: 'awx/192-168-64-4:8443/developer'

状态

  • 此库存将在 5.0.0 版本中删除。[已弃用]

  • 更多信息请参阅 已弃用

作者

  • Chris Houseknecht (@chouseknecht)

提示

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