W3cubDocs

/Ansible

community.kubernetes.k8s_log – Fetch logs from Kubernetes resources

Note

This plugin is part of the community.kubernetes collection (version 1.2.1).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install community.kubernetes.

To use it in a playbook, specify: community.kubernetes.k8s_log.

New in version 0.10.0: of community.kubernetes

Synopsis

  • Use the OpenShift Python client to perform read operations on K8s log endpoints.
  • Authenticate using either a config file, certificates, password or token.
  • Supports check mode.
  • Analogous to kubectl logs or oc logs

Note

This module has a corresponding action plugin.

Requirements

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

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

Parameters

Parameter Choices/Defaults Comments
api_key
string
Token used to authenticate with the API. Can also be specified via K8S_AUTH_API_KEY environment variable.
api_version
string
Default:
"v1"
Use to specify the API version.
Use to create, delete, or discover an object without providing a full resource definition.
Use in conjunction with kind, name, and namespace to identify a specific object.
If resource definition is provided, the apiVersion value from the resource_definition will override this option.

aliases: api, version
ca_cert
path
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.

aliases: ssl_ca_cert
client_cert
path
Path to a certificate used to authenticate with the API. Can also be specified via K8S_AUTH_CERT_FILE environment variable.

aliases: cert_file
client_key
path
Path to a key file used to authenticate with the API. Can also be specified via K8S_AUTH_KEY_FILE environment variable.

aliases: key_file
container
string
Use to specify the container within a pod to grab the log from.
If there is only one container, this will default to that container.
If there is more than one container, this option is required.
context
string
The name of a context found in the config file. Can also be specified via K8S_AUTH_CONTEXT environment variable.
host
string
Provide a URL for accessing the API. Can also be specified via K8S_AUTH_HOST environment variable.
kind
string
Default:
"Pod"
Use to specify an object model.
Use in conjunction with api_version, name, and namespace to identify a specific object.
If using label_selectors, cannot be overridden.
kubeconfig
path
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 ~/.kube/config.json. Can also be specified via K8S_AUTH_KUBECONFIG environment variable.
label_selectors
list / elements=string
List of label selectors to use to filter results
Only one of name or label_selectors may be provided.
name
string
Use to specify an object name.
Use in conjunction with api_version, kind and namespace to identify a specific object.
Only one of name or label_selectors may be provided.
namespace
string
Use to specify an object namespace.
Useful when creating, deleting, or discovering an object without providing a full resource definition.
Use in conjunction with api_version, kind, and name to identify a specific object.
If resource definition is provided, the metadata.namespace value from the resource_definition will override this option.
password
string
Provide a password for authenticating with the API. Can also be specified via K8S_AUTH_PASSWORD environment variable.
Please read the description of the username option for a discussion of when this option is applicable.
persist_config
boolean
    Choices:
  • no
  • yes
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
proxy
string
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).
username
string
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 k8s_auth module, as that might do what you need.
validate_certs
boolean
    Choices:
  • no
  • yes
Whether or not to verify the API server's SSL certificates. Can also be specified via K8S_AUTH_VERIFY_SSL environment variable.

aliases: verify_ssl

Notes

Note

  • The OpenShift Python client wraps the K8s Python client, providing full access to all of the APIS and models available on both platforms. For API version details and additional information visit https://github.com/openshift/openshift-restclient-python
  • To avoid SSL certificate validation errors when validate_certs is True, the full certificate chain for the API server must be provided via ca_cert or in the kubeconfig file.

Examples

- name: Get a log from a Pod
  community.kubernetes.k8s_log:
    name: example-1
    namespace: testing
  register: log

# This will get the log from the first Pod found matching the selector
- name: Log a Pod matching a label selector
  community.kubernetes.k8s_log:
    namespace: testing
    label_selectors:
    - app=example
  register: log

# This will get the log from a single Pod managed by this Deployment
- name: Get a log from a Deployment
  community.kubernetes.k8s_log:
    api_version: apps/v1
    kind: Deployment
    namespace: testing
    name: example
  register: log

# This will get the log from a single Pod managed by this DeploymentConfig
- name: Get a log from a DeploymentConfig
  community.kubernetes.k8s_log:
    api_version: apps.openshift.io/v1
    kind: DeploymentConfig
    namespace: testing
    name: example
  register: log

Return Values

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

Key Returned Description
log
string
success
The text log of the object
log_lines
list / elements=string
success
The log of the object, split on newlines


Authors

  • Fabian von Feilitzsch (@fabianvf)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/kubernetes/k8s_log_module.html