Try SpotterManage Kubernetes (K8s) objects
| "added in version" 2.6 of ansible.builtin"
Authors: Chris Houseknecht (@chouseknecht), Fabian von Feilitzsch (@fabianvf)
preview | supported by community
pipInstall with pip install ansible==2.9.4
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 or vault-encrypted files.
Access to the full range of K8s APIs.
Use the M(k8s_info) module to obtain a list of items about an object of type C(kind)
Authenticate using either a config file, certificates, password or token.
Supports check mode.
- 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: 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.
If the definition file has been encrypted with Ansible Vault it will automatically be decrypted.
k8s:
state: present
definition: "{{ lookup('file', '/testing/deployment.yml') }}"
- name: Read definition file from the Ansible controller file system after Jinja templating
k8s:
state: present
definition: "{{ lookup('template', '/testing/deployment.yml') }}"
- name: fail on validation errors
k8s:
state: present
definition: "{{ lookup('template', '/testing/deployment.yml') }}"
validate:
fail_on_error: yes
- name: warn on validation errors, check for unexpected properties
k8s:
state: present
definition: "{{ lookup('template', '/testing/deployment.yml') }}"
validate:
fail_on_error: no
strict: yes
src:
description:
- 'Provide a path to a file containing a valid YAML definition of an object or objects
to be created or updated. Mutually exclusive with I(resource_definition). NOTE:
I(kind), I(api_version), I(name), and I(namespace) will be overwritten by corresponding
values found in the configuration read in from the I(src) file.'
- Reads from the local file system. To read from the Ansible controller's file system,
including vaulted files, use the file lookup plugin or template lookup plugin, combined
with the from_yaml filter, and pass the result to I(resource_definition). See Examples
below.
- Mutually exclusive with I(template) in case of M(k8s) module.
type: path
host:
description:
- Provide a URL for accessing the API. Can also be specified via K8S_AUTH_HOST environment
variable.
type: str
kind:
description:
- Use to specify an object model.
- Use to create, delete, or discover an object without providing a full resource definition.
- Use in conjunction with I(api_version), I(name), and I(namespace) to identify a
specific object.
- If I(resource definition) is provided, the I(kind) value from the I(resource_definition)
will override this option.
type: str
name:
description:
- Use to specify an object name.
- Use to create, delete, or discover an object without providing a full resource definition.
- Use in conjunction with I(api_version), I(kind) and I(namespace) to identify a specific
object.
- If I(resource definition) is provided, the I(metadata.name) value from the I(resource_definition)
will override this option.
type: str
wait:
default: false
description:
- Whether to wait for certain resource kinds to end up in the desired state. By default
the module exits once Kubernetes has received the request
- Implemented for C(state=present) for C(Deployment), C(DaemonSet) and C(Pod), and
for C(state=absent) for all resource kinds.
- For resource kinds without an implementation, C(wait) returns immediately unless
C(wait_condition) is set.
type: bool
version_added: '2.8'
version_added_collection: ansible.builtin
apply:
description:
- C(apply) compares the desired resource definition with the previously supplied resource
definition, ignoring properties that are automatically generated
- C(apply) works better with Services than 'force=yes'
- mutually exclusive with C(merge_type)
type: bool
version_added: '2.9'
version_added_collection: ansible.builtin
force:
default: false
description:
- If set to C(yes), and I(state) is C(present), an existing object will be replaced.
type: bool
proxy:
description:
- The URL of an HTTP proxy to use for the connection. Can also be specified via K8S_AUTH_PROXY
environment variable.
- Please note that this module does not pick up typical proxy settings from the environment
(e.g. HTTP_PROXY).
type: str
state:
choices:
- absent
- present
default: present
description:
- Determines if an object should be created, patched, or deleted. When set to C(present),
an object will be created, if it does not already exist. If set to C(absent), an
existing object will be deleted. If set to C(present), an existing object will be
patched, if its attributes differ from those specified using I(resource_definition)
or I(src).
type: str
api_key:
description:
- Token used to authenticate with the API. Can also be specified via K8S_AUTH_API_KEY
environment variable.
type: str
ca_cert:
aliases:
- ssl_ca_cert
description:
- 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.
type: path
context:
description:
- The name of a context found in the config file. Can also be specified via K8S_AUTH_CONTEXT
environment variable.
type: str
password:
description:
- Provide a password for authenticating with the API. Can also be specified via K8S_AUTH_PASSWORD
environment variable.
- Please read the description of the C(username) option for a discussion of when this
option is applicable.
type: str
username:
description:
- Provide a username for authenticating with the API. Can also be specified via K8S_AUTH_USERNAME
environment variable.
- Please note that this only works with clusters configured to use HTTP Basic Auth.
If your cluster has a different form of authentication (e.g. OAuth2 in OpenShift),
this option will not work as expected and you should look into the C(k8s_auth) module,
as that might do what you need.
type: str
validate:
description:
- how (if at all) to validate the resource definition against the kubernetes schema.
Requires the kubernetes-validate python module
suboptions:
fail_on_error:
description: whether to fail on validation errors.
required: true
type: bool
strict:
default: false
description: whether to fail when passing unexpected properties
type: bool
version:
description: version of Kubernetes to validate against. defaults to Kubernetes
server version
version_added: '2.8'
version_added_collection: ansible.builtin
namespace:
description:
- Use to specify an object namespace.
- Useful when creating, deleting, or discovering an object without providing a full
resource definition.
- Use in conjunction with I(api_version), I(kind), and I(name) to identify a specific
object.
- If I(resource definition) is provided, the I(metadata.namespace) value from the
I(resource_definition) will override this option.
type: str
client_key:
aliases:
- key_file
description:
- Path to a key file used to authenticate with the API. Can also be specified via
K8S_AUTH_KEY_FILE environment variable.
type: path
kubeconfig:
description:
- 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 I(~/.kube/config.json). Can also be specified via K8S_AUTH_KUBECONFIG
environment variable.
type: path
merge_type:
choices:
- json
- merge
- strategic-merge
description:
- Whether to override the default patch merge approach with a specific type. By default,
the strategic merge will typically be used.
- For example, Custom Resource Definitions typically aren't updatable by the usual
strategic merge. You may want to use C(merge) if you see "strategic merge patch
format is not supported"
- See U(https://kubernetes.io/docs/tasks/run-application/update-api-object-kubectl-patch/#use-a-json-merge-patch-to-update-a-deployment)
- Requires openshift >= 0.6.2
- If more than one merge_type is given, the merge_types will be tried in order
- If openshift >= 0.6.2, this defaults to C(['strategic-merge', 'merge']), which is
ideal for using the same parameters on resource kinds that combine Custom Resources
and built-in resources. For openshift < 0.6.2, the default is simply C(strategic-merge).
- mutually exclusive with C(apply)
type: list
version_added: '2.7'
version_added_collection: ansible.builtin
wait_sleep:
default: 5
description:
- Number of seconds to sleep between checks.
version_added: '2.9'
version_added_collection: ansible.builtin
api_version:
aliases:
- api
- version
default: v1
description:
- Use to specify the API version.
- Use to create, delete, or discover an object without providing a full resource definition.
- Use in conjunction with I(kind), I(name), and I(namespace) to identify a specific
object.
- If I(resource definition) is provided, the I(apiVersion) value from the I(resource_definition)
will override this option.
type: str
append_hash:
description:
- Whether to append a hash to a resource name for immutability purposes
- Applies only to ConfigMap and Secret resources
- The parameter will be silently ignored for other resource kinds
- The full definition of an object is needed to generate the hash - this means that
deleting an object created with append_hash will only work if the same object is
passed with state=absent (alternatively, just use state=absent with the name including
the generated hash and append_hash=no)
type: bool
version_added: '2.8'
version_added_collection: ansible.builtin
client_cert:
aliases:
- cert_file
description:
- Path to a certificate used to authenticate with the API. Can also be specified via
K8S_AUTH_CERT_FILE environment variable.
type: path
wait_timeout:
default: 120
description:
- How long in seconds to wait for the resource to end up in the desired state. Ignored
if C(wait) is not set.
version_added: '2.8'
version_added_collection: ansible.builtin
persist_config:
description:
- Whether or not to save the kube config refresh tokens. Can also be specified via
K8S_AUTH_PERSIST_CONFIG environment variable.
- When the k8s context is using a user credentials with refresh tokens (like oidc
or gke/gcloud auth), the token is refreshed by the k8s python client library but
not saved by default. So the old refresh token can expire and the next auth might
fail. Setting this flag to true will tell the k8s python client to save the new
refresh token to the kube config file.
- Default to false.
- Please note that the current version of the k8s python client library does not support
setting this flag to True yet.
- 'The fix for this k8s python library is here: https://github.com/kubernetes-client/python-base/pull/169'
type: bool
validate_certs:
aliases:
- verify_ssl
description:
- Whether or not to verify the API server's SSL certificates. Can also be specified
via K8S_AUTH_VERIFY_SSL environment variable.
type: bool
wait_condition:
description:
- Specifies a custom condition on the status to wait for. Ignored if C(wait) is not
set or is set to False.
suboptions:
reason:
description:
- The value of the reason field in your desired condition
- For example, if a C(Deployment) is paused, The C(Progressing) c(type) will have
the C(DeploymentPaused) reason.
- The possible reasons in a condition are specific to each resource type in Kubernetes.
See the API documentation of the status field for a given resource to see possible
choices.
status:
choices:
- true
- false
- Unknown
description:
- The value of the status field in your desired condition.
- For example, if a C(Deployment) is paused, the C(Progressing) C(type) will have
the C(Unknown) status.
type:
description:
- The type of condition to wait for. For example, the C(Pod) resource will set
the C(Ready) condition (among others)
- Required if you are specifying a C(wait_condition). If left empty, the C(wait_condition)
field will be ignored.
- The possible types for a condition are specific to each resource type in Kubernetes.
See the API documentation of the status field for a given resource to see possible
choices.
version_added: '2.8'
version_added_collection: ansible.builtin
resource_definition:
aliases:
- definition
- inline
description:
- Provide a valid YAML definition (either as a string, list, or dict) for an object
when creating or updating.
- 'NOTE: I(kind), I(api_version), I(name), and I(namespace) will be overwritten by
corresponding values found in the provided I(resource_definition).'
result:
contains:
api_version:
description: The versioned schema of this representation of an object.
returned: success
type: str
duration:
description: elapsed time of task in seconds
returned: when C(wait) is true
sample: 48
type: int
items:
description: Returned only when multiple yaml documents are passed to src or
resource_definition
returned: when resource_definition or src contains list of objects
type: list
kind:
description: Represents the REST resource this object represents.
returned: success
type: str
metadata:
description: Standard object metadata. Includes name, namespace, annotations,
labels, etc.
returned: success
type: complex
spec:
description: Specific attributes of the object. Will vary based on the I(api_version)
and I(kind).
returned: success
type: complex
status:
description: Current status details for the object.
returned: success
type: complex
description:
- The created, patched, or otherwise present object. Will be empty in the case of
a deletion.
returned: success
type: complex