community / community.kubernetes / 1.2.1 / module / k8s_cluster_info Describe Kubernetes (K8s) cluster, APIs available and their respective versions | "added in version" 0.11.1 of community.kubernetes" Authors: Abhijeet Kasurde (@Akasurde) This plugin has a corresponding action plugin.community.kubernetes.k8s_cluster_info (1.2.1) — module
Install with ansible-galaxy collection install community.kubernetes:==1.2.1
collections: - name: community.kubernetes version: 1.2.1
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.
- 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
host: description: - Provide a URL for accessing the API. Can also be specified via K8S_AUTH_HOST environment variable. type: str proxy: description: - 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). type: str api_key: description: - Token used to authenticate with the API. Can also be specified via K8S_AUTH_API_KEY environment variable. type: str ca_cert: aliases: - ssl_ca_cert description: - 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. type: path context: description: - The name of a context found in the config file. Can also be specified via K8S_AUTH_CONTEXT environment variable. type: str password: description: - Provide a password for authenticating with the API. Can also be specified via K8S_AUTH_PASSWORD environment variable. - Please read the description of the C(username) option for a discussion of when this option is applicable. type: str username: description: - 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 C(k8s_auth) module, as that might do what you need. type: str client_key: aliases: - key_file description: - Path to a key file used to authenticate with the API. Can also be specified via K8S_AUTH_KEY_FILE environment variable. type: path kubeconfig: description: - 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 I(~/.kube/config.json). Can also be specified via K8S_AUTH_KUBECONFIG environment variable. type: path client_cert: aliases: - cert_file description: - Path to a certificate used to authenticate with the API. Can also be specified via K8S_AUTH_CERT_FILE environment variable. type: path persist_config: description: - 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' type: bool validate_certs: aliases: - verify_ssl description: - Whether or not to verify the API server's SSL certificates. Can also be specified via K8S_AUTH_VERIFY_SSL environment variable. type: bool invalidate_cache: default: true description: - Invalidate cache before retrieving information about cluster. type: bool
apis: contains: api_version: description: API version returned: success type: str available_api_version: description: All available versions of the given API returned: success type: list categories: description: API categories returned: success type: list group_version: description: Resource Group version returned: success type: str kind: description: Resource kind returned: success type: str name: description: Resource short name returned: success type: str namespaced: description: If resource is namespaced returned: success type: bool preferred: description: If resource version preferred returned: success type: bool preferred_api_version: description: Preferred version of the given API returned: success type: str short_names: description: Resource short names returned: success type: str singular_name: description: Resource singular name returned: success type: str description: - The API(s) that exists in dictionary returned: success type: dict connection: contains: cert_file: description: - Path to client certificate. returned: success type: str host: description: - Host URL returned: success type: str password: description: - User password returned: success type: str proxy: description: - Proxy details returned: success type: str ssl_ca_cert: description: - Path to CA certificate returned: success type: str username: description: - Username returned: success type: str verify_ssl: description: - SSL verification status returned: success type: bool description: - Connection information returned: success type: dict version: contains: client: description: Client version returned: success type: str server: description: Server version returned: success type: dict description: - Information about server and client version returned: success type: dict