ansible / ansible.builtin / v2.9.27 / module / k8s_auth Authenticate to Kubernetes clusters which require an explicit login step | "added in version" 2.8 of ansible.builtin" Authors: KubeVirt Team (@kubevirt) preview | supported by communityansible.builtin.k8s_auth (v2.9.27) — module
pip
Install with pip install ansible==2.9.27
This module handles authenticating to Kubernetes clusters requiring I(explicit) authentication procedures, meaning ones where a client logs in (obtains an authentication token), performs API operations using said token and then logs out (revokes the token). An example of a Kubernetes distribution requiring this module is OpenShift.
On the other hand a popular configuration for username+password authentication is one utilizing HTTP Basic Auth, which does not involve any additional login/logout steps (instead login credentials can be attached to each and every API call performed) and as such is handled directly by the C(k8s) module (and other resource–specific modules) by utilizing the C(host), C(username) and C(password) parameters. Please consult your preferred module's documentation for more details.
- hosts: localhost module_defaults: group/k8s: host: https://k8s.example.com/ ca_cert: ca.pem tasks: - block: # It's good practice to store login credentials in a secure vault and not # directly in playbooks. - include_vars: k8s_passwords.yml - name: Log in (obtain access token) k8s_auth: username: admin password: "{{ k8s_admin_password }}" register: k8s_auth_results # Previous task provides the token/api_key, while all other parameters # are taken from module_defaults - name: Get a list of all pods from any namespace k8s_info: api_key: "{{ k8s_auth_results.k8s_auth.api_key }}" kind: Pod register: pod_list always: - name: If login succeeded, try to log out (revoke access token) when: k8s_auth_results.k8s_auth.api_key is defined k8s_auth: state: absent api_key: "{{ k8s_auth_results.k8s_auth.api_key }}"
host: description: - Provide a URL for accessing the API server. required: true state: choices: - present - absent default: present description: - If set to I(present) connect to the API server using the URL specified in C(host) and attempt to log in. - If set to I(absent) attempt to log out by revoking the authentication token specified in C(api_key). api_key: description: - When C(state) is set to I(absent), this specifies the token to revoke. ca_cert: aliases: - ssl_ca_cert description: - Path to a CA certificate file used to verify connection to the API server. The full certificate chain must be provided to avoid certificate validation errors. password: description: - Provide a password for authenticating with the API server. username: description: - Provide a username for authenticating with the API server. validate_certs: aliases: - verify_ssl default: true description: - Whether or not to verify the API server's SSL certificates. type: bool
k8s_auth: contains: api_key: description: Authentication token. returned: success type: str ca_cert: description: Path to a CA certificate file used to verify connection to the API server. returned: success type: str host: description: URL for accessing the API server. returned: success type: str username: description: Username for authenticating with the API server. returned: success type: str validate_certs: description: Whether or not to verify the API server's SSL certificates. returned: success type: bool description: Kubernetes authentication facts. returned: success type: complex