Documentation for Kubernetes v1.4 is no longer actively maintained. The version you are currently viewing is a static snapshot. For up-to-date documentation, see the latest version.

Edit This Page

Audit in Kubernetes

Kubernetes Audit provides a security-relevant chronological set of records documenting the sequence of activities that have affected system by individual users, administrators or other components of the system. It allows cluster administrator to answer the following questions: - what happened? - when did it happen? - who initiated it? - on what did it happen? - where was it observed? - from where was it initiated? - to where was it going?

NOTE: Currently, Kubernetes provides only basic audit capabilities, there is still a lot of work going on to provide fully featured auditing capabilities (see https://github.com/kubernetes/features/issues/22).

Kubernetes audit is part of kube-apiserver logging all requests coming to the server. Each audit log contains two entries:

  1. The request line containing:
    • unique id allowing to match the response line (see 2)
    • source ip of the request
    • HTTP method being invoked
    • original user invoking the operation
    • impersonated user for the operation
    • namespace of the request or
    • URI as requested
  2. The response line containing:
    • the unique id from 1
    • response code

Example output for user admin asking for a list of pods:

2016-09-07T13:03:57.400333046Z AUDIT: id="5c3b8227-4af9-4322-8a71-542231c3887b" ip="127.0.0.1" method="GET" user="admin" as="<self>" namespace="default" uri="/api/v1/namespaces/default/pods"
2016-09-07T13:03:57.400710987Z AUDIT: id="5c3b8227-4af9-4322-8a71-542231c3887b" response="200"

NOTE: The audit capabilities are available only for the secured endpoint of the API server.

Configuration

Kube-apiserver provides following options which are responsible for configuring where and how audit logs are handled:

If an audit log file already exists, Kubernetes appends new audit logs to that file. Otherwise, Kubernetes creates an audit log file at the location you specified in audit-log-path. If the audit log file exceeds the size you specify in audit-log-maxsize, Kubernetes will rename the current log file by appending the current timestamp on the file name (before the file extension) and create a new audit log file. Kubernetes may delete old log files when creating a new log file; you can configure how many files are retained and how old they can be by specifying the audit-log-maxbackup and audit-log-maxage options.

Analytics

Create an Issue Edit this Page