k8s - Manage Kubernetes (K8s) objects

• Synopsis
  • Requirements
• Parameters
• Notes
• Examples
• Return Values
• Status
• Maintenance
  • Author

Synopsis

• Use the OpenShift Python client to perform CRUD operations on K8s objects.
• Pass the object definition from a source file or inline. See examples for reading files and using Jinja templates.
• Access to the full range of K8s APIs.
• Authenticate using either a config file, certificates, password or token.
• Supports check mode.

Aliases: k8s_raw,openshift_raw

Requirements

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

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

Parameters

Notes

Examples

- name: Create a k8s namespace
  k8s:
    name: testing
    api_version: v1
    kind: Namespace
    state: present

- name: Create a Service object from an inline definition
  k8s:
    state: present
    definition:
      apiVersion: v1
      kind: Service
      metadata:
        name: web
        namespace: testing
        labels:
          app: galaxy
          service: web
      spec:
        selector:
          app: galaxy
          service: web
        ports:
        - protocol: TCP
          targetPort: 8000
          name: port-8000-tcp
          port: 8000

- name: Create a Service object by reading the definition from a file
  k8s:
    state: present
    src: /testing/service.yml

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

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

- name: Remove an existing Service object
  k8s:
    state: absent
    api_version: v1
    kind: Service
    namespace: testing
    name: web

# Passing the object definition from a file

- name: Create a Deployment by reading the definition from a local file
  k8s:
    state: present
    src: /testing/deployment.yml

- name: Read definition file from the Ansible controller file system
  k8s:
    state: present
    definition: "{{ lookup('file', '/testing/deployment.yml') | from_yaml }}"

- name: Read definition file from the Ansible controller file system after Jinja templating
  k8s:
    state: present
    definition: "{{ lookup('template', '/testing/deployment.yml') | from_yaml }}"

Return Values

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

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

• Chris Houseknecht (@chouseknecht)
• Fabian von Feilitzsch (@fabianvf)