Turn on/off audit logging¶

By default, the Kubernetes cluster does not output audit log information. Through the following configuration, you can enable the audit log feature of Kubernetes.

Prepare the Policy file for the audit log
Configure the API server and enable audit logs
Reboot and verify

Prepare audit log policy file¶

The Policy configuration YAML file required for audit logging is as follows:

Click to view the policy YAML file of audit log

apiVersion: audit.k8s.io/v1
kind: Policy
# Don't generate audit events for all requests in RequestReceived stage.
omitStages:
  - "ResponseStarted"
  - "RequestReceived"
  - "Panic"
rules:
  # The following requests were manually identified as high-volume and low-risk,
  # so drop them.
  - level: None
    users: ["system:kube-proxy"]
    verbs: ["watch"]
    resources:
      -group: "" # core
        resources: ["endpoints", "services", "services/status"]
  - level: None
    # Ingress controller reads `configmaps/ingress-uid` through the unsecured port.
    # TODO(#46983): Change this to the ingress controller service account.
    users: ["system:unsecured"]
    namespaces: ["kube-system"]
    verbs: ["get"]
    resources:
      -group: "" # core
        resources: ["configmaps"]
  - level: None
    users: ["kubelet"] # legacy kubelet identity
    verbs: ["get"]
    resources:
      -group: "" # core
        resources: ["nodes", "nodes/status"]
  - level: None
    userGroups: ["system:nodes"]
    verbs: ["get"]
    resources:
      -group: "" # core
        resources: ["nodes", "nodes/status"]
  - level: None
    users:
      - system:kube-controller-manager
      - system:kube-scheduler
      - system:serviceaccount:kube-system:endpoint-controller
    verbs: ["get", "update"]
    namespaces: ["kube-system"]
    resources:
      -group: "" # core
        resources: ["endpoints"]
  - level: None
    users: ["system:apiserver"]
    verbs: ["get"]
    resources:
      -group: "" # core
        resources: ["namespaces", "namespaces/status", "namespaces/finalize"]
  # Don't log HPA fetching metrics.
  - level: None
    users:
      - system:kube-controller-manager
    verbs: ["get", "list"]
    resources:
      - group: "metrics.k8s.io"
  # Don't log these read-only URLs.
  - level: None
    nonResourceURLs:
      - /healthz*
      - /version
      - /swagger*
  # Don't log events requests.
  - level: None
    resources:
      -group: "" # core
        resources: ["events"]

  # new start
  # Ignore all APIs that access non-authenticated ports, usually system components such as Kube-Controller, etc.
  - level: None
    users: ["system:unsecured"]

  # Ignore kube-admin audit logs
  - level: None
    users: ["kube-admin"]
  # API need add that ignores all resource status updates
  - level: None
    resources:
    -group: "" # core
      resources: ["events", "nodes/status", "pods/status", "services/status"]
    - group: "authorization.k8s.io"
      resources: ["selfsubjectrulesreviews"]
  # ignore leases need add
  - level: None
    resources:
    - group: "coordination.k8s.io"
      resources: ["leases"]
  -level: Request
    verbs: ["create", "update", "patch", "delete"]
    users: ["kube-admin"]
  #new end

  # Secrets, ConfigMaps, and TokenReviews can contain sensitive & binary data,
  # so only log at the Metadata level.
  - level: Metadata
    resources:
      -group: "" # core
        resources: ["secrets", "configmaps"]
      -group: authentication.k8s.io
        resources: ["token reviews"]
    omitStages:
      - "RequestReceived"
  # Get responses can be large; skip them.
  -level: Request
    verbs: ["get", "list", "watch"]
    resources:
      -group: "" # core
      - group: "admissionregistration.k8s.io"
      - group: "apiextensions.k8s.io"
      - group: "apiregistration.k8s.io"
      -group: "apps"
      -group: "authentication.k8s.io"
      - group: "authorization.k8s.io"
      -group: "autoscaling"
      -group: "batch"
      - group: "certificates.k8s.io"
      -group: "extensions"
      - group: "metrics.k8s.io"
      - group: "networking.k8s.io"
      -group: "policy"
      - group: "rbac.authorization.k8s.io"
      - group: "settings.k8s.io"
      -group: "storage.k8s.io"
    omitStages:
      - "RequestReceived"
  # Default level for known APIs
  - level: RequestResponse
    resources:
      -group: "" # core
      - group: "admissionregistration.k8s.io"
      - group: "apiextensions.k8s.io"
      - group: "apiregistration.k8s.io"
      -group: "apps"
      -group: "authentication.k8s.io"
      - group: "authorization.k8s.io"
      -group: "autoscaling"
      -group: "batch"
      - group: "certificates.k8s.io"
      -group: "extensions"
      - group: "metrics.k8s.io"
      - group: "networking.k8s.io"
      -group: "policy"
      - group: "rbac.authorization.k8s.io"
      - group: "settings.k8s.io"
      -group: "storage.k8s.io"
    omitStages:
      - "RequestReceived"
  # Default level for all other requests.
  - level: Metadata
    omitStages:
      - "RequestReceived"

Put the above audit log file in /etc/kubernetes/audit-policy/ folder, and name it apiserver-audit-policy.yaml.

Configure the API server¶

Open the configuration file kube-apiserver.yaml of the API server, usually in the /etc/kubernetes/manifests/ folder, and add the following configuration information:

Please back up kube-apiserver.yaml before this step, and the backup file cannot be placed under /etc/kubernetes/manifests/, it is recommended to put it in /etc/kubernetes/tmp.

Add the command under spec.containers.command:

--audit-log-maxage=30
--audit-log-maxbackup=1
--audit-log-maxsize=100
--audit-log-path=/var/log/audit/kube-apiserver-audit.log
--audit-policy-file=/etc/kubernetes/audit-policy/apiserver-audit-policy.yaml

Add under spec.containers.volumeMounts:

- mountPath: /var/log/audit
  name: audit-logs
- mountPath: /etc/kubernetes/audit-policy
  name: audit-policy

Add under spec.volumes:

- hostPath:
    path: /var/log/kubernetes/audit
    type: ""
  name: audit-logs
- hostPath:
    path: /etc/kubernetes/audit-policy
    type: ""
  name: audit-policy

Test and verify¶

After a while, the API server will automatically restart, and check whether there is an audit log generated in the /var/log/kubernetes/audit directory.

If you want to close it, just remove the relevant commands in spec.containers.command.

Collect audit logs¶

Collect audit logs through FluentBit. By default, FluentBit will not collect log files (Kubernetes audit logs) under /var/log/kubernetes/audit.

To enable audit logging, follow these steps:

Save the current value

helm get values insight-agent -n insight-system -o yaml > insight-agent-values-bak.yaml

Get the current version number ${insight_version_code}, and then update the configuration

insight_version_code=`helm list -n insight-system |grep insight-agent | awk {'print $10'}`

helm upgrade --install --create-namespace --version ${insight_version_code} --cleanup-on-fail insight-agent insight-release/insight-agent -n insight-system -f insight-agent-values-bak.yaml --set global.exporters.auditLog.kubeAudit.enabled=true

If the upgrade fails because the version is not found, please check whether the helm repo used in the command has this version, if not, please try to update the helm repo and try again

helm repo update insight-release

Restart all Pods

Restart the FluentBit Pods of all master nodes, and the restarted FluentBit will collect logs under /var/log/kubernetes/audit.

In addition, if you want to stop the collection of audit logs for global management, you can run kubectl edit cm insight-agent-fluent-bit-config -n insight-system and delete the following INPUT:
```
[INPUT]
Name tail
Tag audit_log.ghippo.*
Parser docker
Path /var/log/containers/*_ghippo-system_audit-log*.log
DB /run/flb_audit.db
Mem_Buf_Limit 15MB
Buffer_Chunk_Size 1MB
Buffer_Max_Size 5MB
#DB.Sync Normal
Refresh_Interval 10
```

Turn on/off audit logging¶

Prepare audit log policy file¶

Configure the API server¶

Test and verify¶

Collect audit logs¶

Comments