kubernetes / kubernetes.core / 3.0.1 / module / k8s_drain Drain, Cordon, or Uncordon node in k8s cluster | "added in version" 2.2.0 of kubernetes.core" Authors: Aubin Bikouo (@abikouo) This plugin has a corresponding action plugin.kubernetes.core.k8s_drain (3.0.1) — module
Install with ansible-galaxy collection install kubernetes.core:==3.0.1
collections: - name: kubernetes.core version: 3.0.1
Drain node in preparation for maintenance same as kubectl drain.
Cordon will mark the node as unschedulable.
Uncordon will mark the node as schedulable.
The given node will be marked unschedulable to prevent new pods from arriving.
Then drain deletes all pods except mirror pods (which cannot be deleted through the API server).
- name: Drain node "foo", even if there are pods not managed by a ReplicationController, Job, or DaemonSet on it. kubernetes.core.k8s_drain: state: drain name: foo force: yes
- name: Drain node "foo", but abort if there are pods not managed by a ReplicationController, Job, or DaemonSet, and use a grace period of 15 minutes. kubernetes.core.k8s_drain: state: drain name: foo delete_options: terminate_grace_period: 900
- name: Mark node "foo" as schedulable. kubernetes.core.k8s_drain: state: uncordon name: foo
- name: Mark node "foo" as unschedulable. kubernetes.core.k8s_drain: state: cordon name: foo
- name: Drain node "foo" using label selector to filter the list of pods to be drained. kubernetes.core.k8s_drain: state: drain name: foo pod_selectors: - 'app!=csi-attacher' - 'app!=csi-provisioner'
host: description: - Provide a URL for accessing the API. Can also be specified via K8S_AUTH_HOST environment variable. type: str name: description: - The name of the node. required: true type: str 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: - cordon - drain - uncordon default: drain description: - Determines whether to drain, cordon, or uncordon node. 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 no_proxy: description: - The comma separated list of hosts/domains/IP/CIDR that shouldn't go through proxy. Can also be specified via K8S_AUTH_NO_PROXY environment variable. - Please note that this module does not pick up typical proxy settings from the environment (e.g. NO_PROXY). - This feature requires kubernetes>=19.15.0. When kubernetes library is less than 19.15.0, it fails even no_proxy set in correct. - example value is "localhost,.local,.example.com,127.0.0.1,127.0.0.0/8,10.0.0.0/8,172.16.0.0/12,192.168.0.0/16" type: str version_added: 2.3.0 version_added_collection: kubernetes.core 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 M(community.okd.k8s_auth) module, as that might do what you need. 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 Kubernetes client will attempt to load the default configuration file from I(~/.kube/config). Can also be specified via K8S_AUTH_KUBECONFIG environment variable. - Multiple Kubernetes config file can be provided using separator ';' for Windows platform or ':' for others platforms. - The kubernetes configuration can be provided as dictionary. This feature requires a python kubernetes client version >= 17.17.0. Added in version 2.2.0. type: raw 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 pod_selectors: aliases: - label_selectors description: - Label selector to filter pods on the node. - This option has effect only when C(state) is set to I(drain). elements: str type: list version_added: 2.5.0 version_added_collection: kubernetes.core proxy_headers: description: - The Header used for the HTTP proxy. - Documentation can be found here U(https://urllib3.readthedocs.io/en/latest/reference/urllib3.util.html?highlight=proxy_headers#urllib3.util.make_headers). suboptions: basic_auth: description: - Colon-separated username:password for basic authentication header. - Can also be specified via K8S_AUTH_PROXY_HEADERS_BASIC_AUTH environment. type: str proxy_basic_auth: description: - Colon-separated username:password for proxy basic authentication header. - Can also be specified via K8S_AUTH_PROXY_HEADERS_PROXY_BASIC_AUTH environment. type: str user_agent: description: - String representing the user-agent you want, such as foo/1.0. - Can also be specified via K8S_AUTH_PROXY_HEADERS_USER_AGENT environment. type: str type: dict version_added: 2.0.0 version_added_collection: kubernetes.core delete_options: default: {} description: - Specify options to delete pods. - This option has effect only when C(state) is set to I(drain). suboptions: delete_emptydir_data: default: false description: - Continue even if there are pods using emptyDir (local data that will be deleted when the node is drained). type: bool version_added: 2.3.0 version_added_collection: kubernetes.core disable_eviction: default: false description: - Forces drain to use delete rather than evict. type: bool force: default: false description: - Continue even if there are pods not managed by a ReplicationController, Job, or DaemonSet. type: bool ignore_daemonsets: default: false description: - Ignore DaemonSet-managed pods. type: bool terminate_grace_period: description: - Specify how many seconds to wait before forcefully terminating. - If not specified, the default grace period for the object type will be used. - The value zero indicates delete immediately. required: false type: int wait_sleep: default: 5 description: - Number of seconds to sleep between checks. - Ignored if C(wait_timeout) is not set. type: int wait_timeout: description: - The length of time to wait in seconds for pod to be deleted before giving up, zero means infinite. type: int type: dict 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 impersonate_user: description: - Username to impersonate for the operation. - Can also be specified via K8S_AUTH_IMPERSONATE_USER environment. type: str version_added: 2.3.0 version_added_collection: kubernetes.core impersonate_groups: description: - Group(s) to impersonate for the operation. - 'Can also be specified via K8S_AUTH_IMPERSONATE_GROUPS environment. Example: Group1,Group2' elements: str type: list version_added: 2.3.0 version_added_collection: kubernetes.core
result: description: - The node status and the number of pods deleted. returned: success type: str