Documentation

PLEASE NOTE: This document applies to latest version and not to the latest stable release v2.21

Documentation for other releases can be found by using the version selector in the top right of any doc page.

kubectl

Manage Kubernetes resources using kubectl.

Attributes

check_mode:
  support: full

Parameters

Parameter	Type	Values	Description
state	string	absent present	Desired state of the resource.
src	string		Path to a manifest file to apply/delete.
kind	string		Resource kind (deployment, pod, service, etc.).
name	string		Resource name.
namespace	string		Kubernetes namespace.
replicas	integer		Number of replicas (for scaling deployments).
force	boolean		Force deletion of resources.
context	string		Kubernetes context to use.
wait	boolean		Wait for the operation to complete.
wait_timeout	string		Timeout for wait operation (e.g., “60s”, “5m”).
cascade	string		Delete cascade policy (background, foreground, orphan).
grace_period	integer		Grace period for deletion (seconds).
selector	string		Label selector to filter resources.

Example

- name: Apply a manifest
  kubectl:
    state: present
    src: deployment.yaml

- name: Apply a manifest with definition
  kubectl:
    state: present
    definition:
      apiVersion: apps/v1
      kind: Deployment
      metadata:
        name: nginx-deployment
      spec:
        replicas: 3
        selector:
          matchLabels:
            app: nginx
        template:
          metadata:
            labels:
              app: nginx
          spec:
            containers:
              - name: nginx
                image: nginx:1.14.2
                ports:
                  - containerPort: 80

- name: Delete a resource
  kubectl:
    state: absent
    kind: deployment
    name: nginx-deployment

- name: Scale a deployment
  kubectl:
    state: present
    kind: deployment
    name: nginx-deployment
    replicas: 5

- name: Delete resources from a manifest
  kubectl:
    state: absent
    src: deployment.yaml

- name: Apply with namespace
  kubectl:
    state: present
    src: deployment.yaml
    namespace: mynamespace

- name: Force delete a pod
  kubectl:
    state: absent
    kind: pod
    name: stuck-pod
    force: true