Documentation

k8s_facts - Describe Kubernetes (K8s) objects

New in version 2.7.

Synopsis

  • Use the OpenShift Python client to perform read operations on K8s objects.
  • Access to the full range of K8s APIs.
  • Authenticate using either a config file, certificates, password or token.
  • Supports check mode.

Requirements

The below requirements are needed on the host that executes this module.

  • python >= 2.7
  • openshift >= 0.6
  • PyYAML >= 3.11

Parameters

Parameter Choices/Defaults Comments
api_key
Token used to authenticate with the API. Can also be specified via K8S_AUTH_API_KEY environment variable.
api_version Default:
v1
Use to specify the API version. in conjunction with kind, name, and namespace to identify a specific object.

aliases: api, version
cert_file
Path to a certificate used to authenticate with the API. Can also be specified via K8S_AUTH_CERT_FILE environment variable.
context
The name of a context found in the config file. Can also be specified via K8S_AUTH_CONTEXT environment variable.
field_selectors
List of field selectors to use to filter results
host
Provide a URL for accessing the API. Can also be specified via K8S_AUTH_HOST environment variable.
key_file
Path to a key file used to authenticate with the API. Can also be specified via K8S_AUTH_HOST environment variable.
kind
required
Use to specify an object model. Use in conjunction with api_version, name, and namespace to identify a specific object.
kubeconfig
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.
label_selectors
List of label selectors to use to filter results
name
Use to specify an object name. Use in conjunction with api_version, kind and namespace to identify a specific object.
namespace
Use to specify an object namespace. Use in conjunction with api_version, kind, and name to identify a specfic object.
password
Provide a password for authenticating with the API. Can also be specified via K8S_AUTH_PASSWORD environment variable.
ssl_ca_cert
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.
username
Provide a username for authenticating with the API. Can also be specified via K8S_AUTH_USERNAME environment variable.
verify_ssl
bool
    Choices:
  • no
  • yes
Whether or not to verify the API server's SSL certificates. Can also be specified via K8S_AUTH_VERIFY_SSL environment variable.

Notes

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 verify_ssl is True, the full certificate chain for the API server must be provided via ssl_ca_cert or in the kubeconfig file.

Examples

- name: Get an existing Service object
  k8s_facts:
    api_version: v1
    kind: Service
    name: web
    namespace: testing
  register: web_service

- name: Get a list of all service objects
  k8s_facts:
    api_version: v1
    kind: Service
    namespace: testing
  register: service_list

- name: Get a list of all pods from any namespace
  k8s_facts:
    kind: Pod
  register: pod_list

- name: Search for all Pods labelled app=web
  k8s_facts:
    kind: Pod
    label_selectors:
      - app = web
      - tier in (dev, test)

- name: Search for all running pods
  k8s_facts:
    kind: Pod
    field_selectors:
      - status.phase = running

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
resources
complex
success
The object(s) that exists

  status
dict
success
Current status details for the object.

  kind
str
success
Represents the REST resource this object represents.

  spec
dict
success
Specific attributes of the object. Will vary based on the api_version and kind.

  api_version
str
success
The versioned schema of this representation of an object.

  metadata
dict
success
Standard object metadata. Includes name, namespace, annotations, labels, etc.



Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Maintenance

This module is flagged as community which means that it is maintained by the Ansible Community. See Module Maintenance & Support for more info.

For a list of other modules that are also maintained by the Ansible Community, see here.

Author

  • Will Thames (@willthames)

Hint

If you notice any issues in this documentation you can edit this document to improve it.