This document describes how to use Cloud Audit Logs for Anthos clusters on bare metal. Anthos clusters on bare metal uses Kubernetes Audit Logging, which keeps a chronological record of calls made to a cluster's Kubernetes API server. Audit logs are useful for investigating suspicious API requests and for collecting statistics.
About Cloud Audit Logs
Audit logs are written to Cloud Audit Logs in your Google Cloud project. Writing to Cloud Audit Logs has several benefits over writing to disk or capturing logs in an on-premises logging system:
- Audit logs for all Anthos clusters can be centralized.
- Log entries written to Cloud Audit Logs are immutable.
- Cloud Audit Logs entries are retained for 400 days.
- Cloud Audit Logs feature is included in the price of Anthos.
- You can configure Anthos clusters on bare metal to write logs to disk or to Cloud Audit Logs.
Disk-based audit logging
If Cloud Audit Logs is disabled explicitly, audit logs in Anthos clusters on bare metal are written to a persistent disk so that cluster restarts and upgrades don't cause the logs to disappear. Anthos clusters on bare metal retains up to 1 GiB of audit log entries.
Access the disk-based audit logs by logging into control plane Nodes. The logs
are located in the
Cloud Audit Logs
Admin Activity audit log entries from all Kubernetes API servers are sent to
Google Cloud, using the project and location that you specify when you
create a user cluster. To buffer and write log entries to Cloud Audit Logs,
Anthos clusters on bare metal deploys an
audit-proxy daemon set that runs on the
control plane nodes.
Cloud Audit Logs for Anthos clusters on bare metal has the following limitations:
- Data access logging is not supported.
- Modifying the Kubernetes audit policy is not supported.
- Cloud Audit Logs is not resilient to extended network outages. If the log entries cannot be exported to Google Cloud, they are cached in a 10 GiB disk buffer. If that buffer fills, then the oldest entries are dropped.
Creating a service account for Cloud Audit Logs
Before you can use Cloud Logging and Cloud Monitoring with Anthos clusters on bare metal, you must first configure the following:
Create a Cloud Monitoring Workspace within the Google Cloud project, if you don't have one already.
In the Google Cloud console, click the following button and follow the workflow.
Click the following buttons to enable the required APIs:
Assign the following IAM roles to the service account used by the Stackdriver agents:
Accessing Cloud Audit Logs
In the Google Cloud console, go to the Logs Explorer page in the Logging menu.
If the Legacy Logs Viewer page opens, choose Upgrade to the new Logs Explorer from the Upgrade drop-down menu.
Click Query to access the text box for submitting queries.
Fill the text box with the following query:
resource.type="k8s_cluster" logName="projects/PROJECT_ID/logs/externalaudit.googleapis.com%2Factivity" protoPayload.serviceName="anthosgke.googleapis.com"
PROJECT_IDwith your project ID.
Click Run query to display all audit logs from Anthos clusters on bare metal clusters that were configured to log in to this project.
List the first two log entries in your project's Admin Activity log that
apply to the
k8s_cluster resource type:
gcloud logging read \ 'logName="projects/PROJECT_ID/logs/externalaudit.googleapis.com%2Factivity" \ AND resource.type="k8s_cluster" \ AND protoPayload.serviceName="anthosgke.googleapis.com" ' \ --limit 2 \ --freshness 300d
PROJECT_ID with your project ID.
The output shows two log entries. Notice that for each log entry, the
logName field has the value
protoPayload.serviceName is equal to
The Kubernetes audit policy defines rules for which events are recorded as log entries and specifies what data the log entries should include. Changing this policy to modify Cloud Audit Logs behavior isn't supported currently.