kubernetes.core.k8s – Query the K8s API

• Synopsis
• Requirements
• Parameters
• Notes
• Examples
• Return Values

Synopsis

• Uses the OpenShift Python client to fetch a specific object by name, all matching objects within a namespace, or all matching objects for all namespaces, as well as information about the cluster.
• Provides access the full range of K8s APIs.
• Enables authentication via config file, certificates, password or token.

Requirements

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

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

Parameters

Notes

Examples

- name: Fetch a list of namespaces
  set_fact:
    projects: "{{ lookup('kubernetes.core.k8s', api_version='v1', kind='Namespace') }}"

- name: Fetch all deployments
  set_fact:
    deployments: "{{ lookup('kubernetes.core.k8s', kind='Deployment') }}"

- name: Fetch all deployments in a namespace
  set_fact:
    deployments: "{{ lookup('kubernetes.core.k8s', kind='Deployment', namespace='testing') }}"

- name: Fetch a specific deployment by name
  set_fact:
    deployments: "{{ lookup('kubernetes.core.k8s', kind='Deployment', namespace='testing', resource_name='elastic') }}"

- name: Fetch with label selector
  set_fact:
    service: "{{ lookup('kubernetes.core.k8s', kind='Service', label_selector='app=galaxy') }}"

# Use parameters from a YAML config

- name: Load config from the Ansible controller filesystem
  set_fact:
    config: "{{ lookup('file', 'service.yml') | from_yaml }}"

- name: Using the config (loaded from a file in prior task), fetch the latest version of the object
  set_fact:
    service: "{{ lookup('kubernetes.core.k8s', resource_definition=config) }}"

- name: Use a config from the local filesystem
  set_fact:
    service: "{{ lookup('kubernetes.core.k8s', src='service.yml') }}"

Return Values

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