- Docs »
- community.kubernetes.k8s_cluster_info – Describe Kubernetes (K8s) cluster, APIs available and their respective versions
-
You are reading an older version of the Ansible documentation. Use the version selection to the left if you want the latest stable released version.
community.kubernetes.k8s_cluster_info – Describe Kubernetes (K8s) cluster, APIs available and their respective versions
Note
This plugin is part of the community.kubernetes collection (version 1.1.1).
To install it use: ansible-galaxy collection install community.kubernetes
.
To use it in a playbook, specify: community.kubernetes.k8s_cluster_info
.
New in version 0.11.1: of community.kubernetes
Use the OpenShift Python client to perform read operations on K8s objects.
Authenticate using either a config file, certificates, password or token.
Supports check mode.
The below requirements are needed on the host that executes this module.
python >= 2.7
openshift >= 0.6
PyYAML >= 3.11
Parameter |
Choices/Defaults |
Comments |
api_key
string
|
|
Token used to authenticate with the API. Can also be specified via K8S_AUTH_API_KEY environment variable.
|
ca_cert
path
|
|
Path to a CA certificate used to authenticate with the API. The full certificate chain must be provided to avoid certificate validation errors. Can also be specified via K8S_AUTH_SSL_CA_CERT environment variable.
aliases: ssl_ca_cert
|
client_cert
path
|
|
Path to a certificate used to authenticate with the API. Can also be specified via K8S_AUTH_CERT_FILE environment variable.
aliases: cert_file
|
client_key
path
|
|
Path to a key file used to authenticate with the API. Can also be specified via K8S_AUTH_KEY_FILE environment variable.
aliases: key_file
|
context
string
|
|
The name of a context found in the config file. Can also be specified via K8S_AUTH_CONTEXT environment variable.
|
host
string
|
|
Provide a URL for accessing the API. Can also be specified via K8S_AUTH_HOST environment variable.
|
invalidate_cache
boolean
|
|
Invalidate cache before retrieving information about cluster.
|
kubeconfig
path
|
|
Path to an existing Kubernetes config file. If not provided, and no other connection options are provided, the openshift client will attempt to load the default configuration file from ~/.kube/config.json. Can also be specified via K8S_AUTH_KUBECONFIG environment variable.
|
password
string
|
|
Provide a password for authenticating with the API. Can also be specified via K8S_AUTH_PASSWORD environment variable.
Please read the description of the username option for a discussion of when this option is applicable.
|
persist_config
boolean
|
|
Whether or not to save the kube config refresh tokens. Can also be specified via K8S_AUTH_PERSIST_CONFIG environment variable.
When the k8s context is using a user credentials with refresh tokens (like oidc or gke/gcloud auth), the token is refreshed by the k8s python client library but not saved by default. So the old refresh token can expire and the next auth might fail. Setting this flag to true will tell the k8s python client to save the new refresh token to the kube config file.
Default to false.
Please note that the current version of the k8s python client library does not support setting this flag to True yet.
The fix for this k8s python library is here: https://github.com/kubernetes-client/python-base/pull/169
|
proxy
string
|
|
The URL of an HTTP proxy to use for the connection. Can also be specified via K8S_AUTH_PROXY environment variable.
Please note that this module does not pick up typical proxy settings from the environment (e.g. HTTP_PROXY).
|
username
string
|
|
Provide a username for authenticating with the API. Can also be specified via K8S_AUTH_USERNAME environment variable.
Please note that this only works with clusters configured to use HTTP Basic Auth. If your cluster has a different form of authentication (e.g. OAuth2 in OpenShift), this option will not work as expected and you should look into the k8s_auth module, as that might do what you need.
|
validate_certs
boolean
|
|
Whether or not to verify the API server's SSL certificates. Can also be specified via K8S_AUTH_VERIFY_SSL environment variable.
aliases: verify_ssl
|
Note
The OpenShift Python client wraps the K8s Python client, providing full access to all of the APIS and models available on both platforms. For API version details and additional information visit https://github.com/openshift/openshift-restclient-python
To avoid SSL certificate validation errors when validate_certs
is True, the full certificate chain for the API server must be provided via ca_cert
or in the kubeconfig file.
- name: Get Cluster information
community.kubernetes.k8s_cluster_info:
register: api_status
- name: Do not invalidate cache before getting information
community.kubernetes.k8s_cluster_info:
invalidate_cache: False
register: api_status
Common return values are documented here, the following are the fields unique to this module:
Key |
Returned |
Description |
apis
dictionary
|
success |
The API(s) that exists in dictionary
|
|
api_version
string
|
success |
API version
|
|
available_api_version
list
/ elements=string
|
success |
All available versions of the given API
|
|
categories
list
/ elements=string
|
success |
API categories
|
|
group_version
string
|
success |
Resource Group version
|
|
kind
string
|
success |
Resource kind
|
|
name
string
|
success |
Resource short name
|
|
namespaced
boolean
|
success |
If resource is namespaced
|
|
preferred
boolean
|
success |
If resource version preferred
|
|
preferred_api_version
string
|
success |
Preferred version of the given API
|
|
short_names
string
|
success |
Resource short names
|
|
singular_name
string
|
success |
Resource singular name
|
connection
dictionary
|
success |
Connection information
|
|
cert_file
string
|
success |
Path to client certificate.
|
|
host
string
|
success |
Host URL
|
|
password
string
|
success |
User password
|
|
proxy
string
|
success |
Proxy details
|
|
ssl_ca_cert
string
|
success |
Path to CA certificate
|
|
username
string
|
success |
Username
|
|
verify_ssl
boolean
|
success |
SSL verification status
|
version
dictionary
|
success |
Information about server and client version
|
|
client
string
|
success |
Client version
|
|
server
dictionary
|
success |
Server version
|