kubernetes.core.k8s inventory – Kubernetes (K8s) inventory source

Note

This inventory plugin is part of the kubernetes.core collection (version 5.0.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install kubernetes.core. You need further requirements to be able to use this inventory plugin, see Requirements for details.

To use it in a playbook, specify: kubernetes.core.k8s.

DEPRECATED

Removed in:

version 6.0.0

Why:

As discussed in https://github.com/ansible-collections/kubernetes.core/issues/31, we decided to remove the k8s inventory plugin in release 6.0.0.

Alternative:

Use kubernetes.core.k8s_info and ansible.builtin.add_host instead.

Synopsis

  • Fetch containers and services for one or more clusters.

  • Groups by cluster name, namespace, namespace_services, namespace_pods, and labels.

  • Uses the kubectl connection plugin to access the Kubernetes cluster.

  • Uses k8s.(yml|yaml) YAML configuration file to set parameter values.

Requirements

The below requirements are needed on the local controller node that executes this inventory.

  • python >= 3.9

  • kubernetes >= 24.2.0

  • PyYAML >= 3.11

Parameters

Parameter

Comments

connections

string

Optional list of cluster connection settings. If no connections are provided, the default ~/.kube/config and active context will be used, and objects will be returned for all namespaces the active user is authorized to access.

api_key

string

Token used to authenticate with the API. Can also be specified via K8S_AUTH_API_KEY environment variable.

ca_cert

aliases: ssl_ca_cert

string

Path to a CA certificate used to authenticate with the API. Can also be specified via K8S_AUTH_SSL_CA_CERT environment variable.

client_cert

aliases: cert_file

string

Path to a certificate used to authenticate with the API. Can also be specified via K8S_AUTH_CERT_FILE environment variable.

client_key

aliases: key_file

string

Path to a key file used to authenticate with the API. Can also be specified via K8S_AUTH_KEY_FILE environment variable.

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.

kubeconfig

string

Path to an existing Kubernetes config file. If not provided, and no other connection options are provided, the Kubernetes client will attempt to load the default configuration file from ~/.kube/config. Can also be specified via K8S_AUTH_KUBECONFIG environment variable.

name

string

Optional name to assign to the cluster. If not provided, a name is constructed from the server and port.

namespaces

string

List of namespaces. If not specified, will fetch all containers for all namespaces user is authorized to access.

password

string

Provide a password for authenticating with the API. Can also be specified via K8S_AUTH_PASSWORD environment variable.

username

string

Provide a username for authenticating with the API. Can also be specified via K8S_AUTH_USERNAME environment variable.

validate_certs

aliases: verify_ssl

boolean

Whether or not to verify the API server’s SSL certificates. Can also be specified via K8S_AUTH_VERIFY_SSL environment variable.

Choices:

  • false

  • true

plugin

string / required

token that ensures this is a source file for the ‘k8s’ plugin.

Choices:

  • "kubernetes.core.k8s"

  • "k8s"

  • "community.kubernetes.k8s"

Examples

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

- name: Authenticate with token, and return all pods and services for all namespaces
  plugin: kubernetes.core.k8s
  connections:
    - host: https://192.168.64.4:8443
      api_key: xxxxxxxxxxxxxxxx
      validate_certs: false

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

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

Status

  • This inventory will be removed in version 6.0.0. [deprecated]

  • For more information see DEPRECATED.

Authors

  • Chris Houseknecht (@chouseknecht)

  • Fabian von Feilitzsch (@fabianvf)

Hint

Configuration entries for each entry type have a low to high priority order. For example, a variable that is lower in the list will override a variable that is higher up.