Audit-Logging

Überblick

GKE on VMware unterstützt Audit-Logging sowohl auf Cloud API- als auch auf Kubernetes-Clusterebene. Dieses Dokument enthält Informationen zum Audit-Logging von Kubernetes-Clustern. Informationen zum Cloud API-Audit-Logging finden Sie unter Informationen zum Cloud API-Audit-Logging.

GKE on VMware nutzt Kubernetes Audit Logging, das eine chronologische Aufzeichnung der Aufrufe an den Kubernetes API-Server eines Clusters speichert. Audit-Logs sind nützlich, um verdächtige API-Anfragen zu untersuchen und Statistiken zu erfassen.

Sie können einen Cluster so konfigurieren, dass Audit-Logs auf ein Laufwerk oder in Cloud-Audit-Logs in einem Google Cloud-Projekt geschrieben werden. Das Schreiben in Cloud-Audit-Logs hat mehrere Vorteile gegenüber dem Schreiben auf Laufwerke oder sogar dem Erfassen von Logs in einem lokalen Logging-System:

  • Audit-Logs für alle GKE-Cluster können zentralisiert werden.
  • In Cloud-Audit-Logs geschriebene Logeinträge sind unveränderlich.
  • Cloud-Audit-Logeinträge werden 400 Tage lang aufbewahrt.
  • Cloud-Audit-Logs sind im Preis von Anthos enthalten.

Audit-Logging auf Laufwerken

Standardmäßig werden Audit-Logs in einen nichtflüchtigen Speicher geschrieben, sodass VM-Neustarts und -Upgrades nicht zum Verschwinden der Logs führen. GKE on VMware speichert bis zu 12 GB an Audit-Logeinträgen.

Cloud-Audit-Logs

Wenn Sie Cloud-Audit-Logs für einen Cluster aktivieren, werden Audit-Logeinträge zu Administratoraktivitäten vom Kubernetes API-Server des Clusters an Google Cloud gesendet. Dazu wird das Google Cloud-Projekt verwendet, das Sie im Feld cloudAuditLogging.projectID Ihrer Clusterkonfigurationsdatei angeben. Dieses Google Cloud-Projekt wird als Audit-Logging-Projekt bezeichnet.

Das Audit-Logging-Projekt muss mit dem Flotten-Hostprojekt übereinstimmen.

Zum Zwischenspeichern und Schreiben von Logeinträgen in Cloud-Audit-Logs stellt GKE on VMware einen audit-proxy-Pod im Administratorcluster bereit. Diese Komponente ist auch als Sidecar-Container in Nutzerclustern verfügbar.

Beschränkungen

Die aktuelle Version von Cloud-Audit-Logs für GKE on VMware unterliegt mehreren Einschränkungen:

  • Das Datenzugriffs-Logging (get, list, watch-Anfragen) wird nicht unterstützt.

  • Das Ändern der Audit-Richtlinie von Kubernetes wird nicht unterstützt.

  • Cloud-Audit-Logs sind gegenüber erweiterten Netzwerkausfällen nicht resilient. Wenn die Logeinträge nicht in Google Cloud exportiert werden können, werden sie in einem 10-GB-Zwischenspeicher im Cache gespeichert. Wenn dieser Zwischenspeicher voll ist, werden die nachfolgenden Einträge gelöscht.

Anthos Audit API aktivieren

Aktivieren Sie die Anthos Audit API in Ihrem Audit-Logging-Projekt.

Anthos Audit API aktivieren

Dienstkonto für Cloud-Audit-Logs erstellen

Sie haben bereits ein oder mehrere Dienstkonten, die Sie für die Verwendung mit GKE on VMware erstellt haben. Für dieses Feature müssen Sie ein zusätzliches Dienstkonto erstellen, das als Audit-Logging-Dienstkonto bezeichnet wird.

  1. Erstellen Sie Ihr Audit-Logging-Dienstkonto:

    gcloud iam service-accounts create audit-logging-service-account

  2. Erstellen Sie eine JSON-Schlüsseldatei für Ihr Cloud-Audit-Log-Dienstkonto:

    gcloud iam service-accounts keys create audit-logging-key.json \
   --iam-account AUDIT_LOGGING_SERVICE_ACCOUNT_EMAIL

    Dabei ist AUDIT_LOGGING_SERVICE_ACCOUNT_EMAIL die E-Mail-Adresse Ihres Dienstkontos.

  3. Speichern Sie audit-logging-key.json auf der Administrator-Workstation am selben Speicherort wie Ihre anderen Dienstkontoschlüssel.

Administratorcluster mit aktivierten Cloud-Audit-Logs erstellen

Sie können Cloud-Audit-Logs nur dann für einen Administratorcluster aktivieren, wenn Sie den Administratorcluster erstellen. Sie können einen vorhandenen Administratorcluster nicht ändern, um Cloud-Audit-Logs zu aktivieren.

  1. Weitere Informationen finden Sie unter Administratorcluster erstellen.

  2. Füllen Sie in der Konfigurationsdatei für den Administratorcluster den Abschnitt cloudAuditLogging aus.

  3. Legen Sie für cloudAuditLogging.projectID die ID Ihres Audit-Logging-Projekts fest.

  4. Legen Sie für cloudAuditLogging.clusterLocation eine Google Cloud-Region fest, in der Audit-Logs gespeichert werden sollen. Wählen Sie zum Verbessern der Latenz eine Region in der Nähe Ihres lokalen Rechenzentrums aus.

  5. Legen Sie cloudAuditLogging.serviceAccountKeyPath auf den Pfad der JSON-Schlüsseldatei für Ihr Audit-Logging-Dienstkonto fest.

Beispiel:

cloudAuditLogging:
  projectID: "my-project"
  clusterLocation: "us-west1"
  serviceAccountKeyPath: "/my-key-folder/audit-logging-key.json"

Setzen Sie die Clustererstellung wie gewohnt fort.

Nutzercluster mit aktivierten Cloud-Audit-Logs erstellen

  1. Weitere Informationen finden Sie unter Nutzercluster erstellen.

  2. Füllen Sie in der Nutzercluster-Konfigurationsdatei den Abschnitt cloudAuditLogging aus.

  3. Legen Sie für cloudAuditLogging.projectID die ID Ihres Audit-Logging-Projekts fest.

  4. Legen Sie für cloudAuditLogging.clusterLocation eine Google Cloud-Region fest, in der Audit-Logs gespeichert werden sollen. Wählen Sie zum Verbessern der Latenz eine Region in der Nähe Ihres lokalen Rechenzentrums aus.

  5. Legen Sie für cloudAuditLogging.serviceAccounKeyPath den Pfad der JSON-Schlüsseldatei für Ihr Cloud-Audit-Log-Dienstkonto fest.

  6. Prüfen Sie, ob der Abschnitt gkeConnect ausgefüllt ist und gkeConnect.projectID mit cloudAuditLogging.projectID übereinstimmt.

Beispiel:

gkeConnect:
  projectID: "my-project"
  registerServiceAccountKeyPath: "/my-key-fokder/connect-register-key.json"

cloudAuditLogging:
  projectID: "my-project"
  clusterLocation: "us-west1"
  serviceAccountKeyPath: "/my-key-folder/audit-logging-key.json"

Setzen Sie die Clustererstellung wie gewohnt fort.

Cloud-Audit-Logs für einen vorhandenen Nutzercluster aktivieren

Cloud-Audit-Logs können nur in dem Google Cloud-Projekt aktiviert werden, in dem der Nutzercluster registriert ist.

Wenn ein vorhandener Nutzercluster nicht registriert ist, registrieren Sie ihn anhand der folgenden Schritte, bevor Sie Cloud-Audit-Logs aktivieren:

  1. Fügen Sie der Nutzercluster-Konfigurationsdatei den Abschnitt gkeConnect hinzu. Beispiel:

    gkeConnect:
  projectID: "my-project"
  registerServiceAccountKeyPath: "/my-key-fokder/connect-register-key.json"

  2. Aktualisieren Sie den Cluster:

    gkectl update cluster --config USER_CLUSTER_CONFIG --kubeconfig ADMIN_CLUSTER_KUBECONFIG

Nach der Registrierung des Nutzerclusters führen Sie die folgenden Schritte aus, um Cloud-Audit-Logs zu aktivieren:

  1. Füllen Sie den Abschnitt cloudAuditLogging in der Nutzercluster-Konfigurationsdatei aus. Weitere Informationen zu den einzelnen Feldern finden Sie unter Nutzercluster mit aktivierten Cloud-Audit-Logs erstellen. Die projectID im Abschnitt cloudAuditLogging muss mit der ID im Abschnitt gkeConnect übereinstimmen.

  2. Aktualisieren Sie den Cluster:

    gkectl update cluster --config USER_CLUSTER_CONFIG --kubeconfig ADMIN_CLUSTER_KUBECONFIG

Cloud-Audit-Logs für einen vorhandenen Nutzercluster deaktivieren

  1. Löschen Sie in der Nutzercluster-Konfigurationsdatei den Abschnitt cloudAuditLogging.

  2. Aktualisieren Sie den Nutzercluster:

gkectl update cluster --kubeconfig [ADMIN_CLUSTER_KUBECONFIG] --config [USER_CLUSTER_CONFIG]

Auf Audit-Logs zugreifen

Audit-Logging auf Laufwerken

Die Audit-Logs für den Administratorcluster finden Sie auf den Knoten der Steuerungsebene unter /var/log/kube-audit/kube-apiserver-audit.log. Die Audit-Logs für den Nutzercluster befinden sich in der PersistentVolumeClaim mit dem Namen kube-audit-kube-apiserver-0. Sie können in Ihren eigenen Pods über volumes-Einträge auf diese Daten zugreifen:

Fügen Sie diesen Eintrag für den Administratorcluster hinzu: 

    volumes:
    - name: kube-audit
      hostPath:
        path: /var/log/kube-audit
        type: ""

Fügen Sie diesen Eintrag für den Nutzercluster hinzu: 

    volumes:
    - name: kube-audit
      persistentVolumeClaim:
        claimName: kube-audit-kube-apiserver-0

Wenn Sie den Pod auf dem entsprechenden Knoten des Administratorclusters (und nur auf diesem Knoten) planen möchten, müssen Sie der Pod-Spezifikation die Abschnitte nodeSelector und tolerations hinzufügen:

    spec:
      nodeSelector:
        node-role.kubernetes.io/master: ''
      tolerations:
      - key: node-role.kubernetes.io/master
        value: ""
        effect: NoSchedule

Legen Sie für den Nutzercluster namespace als Namen des Nutzerclusters fest und legen Sie dann nodeName auf denselben Wert wie kube-apiserver-0 fest:

   spec:
     nodeName: NODE_NAME

Führen Sie den folgenden Befehl aus, um auf den nodeName von kube-apiserver-0 zu verweisen:

kubectl get pod kube-apiserver-0 -n USER_CLUSTER_NAME --kubeconfig kubeconfig -o jsonpath='{.spec.nodeName}'

Der Dateiname jedes Audit-Logs enthält einen Zeitstempel, der angibt, wann die Datei rotiert wurde. Eine Datei enthält Audit-Logs bis zu diesem Zeitpunkt.

Cloud-Audit-Logs

Console

  1. Rufen Sie in der Google Cloud Console im Menü Logging die Seite Logs auf.

    Zur Seite "Logs"

  2. Klicken Sie oberhalb der gerade erwähnten Drop-down-Menüs im Feld Nach Label oder Textsuche filtern auf den Abwärtspfeil, um das Drop-down-Menü zu öffnen. Wählen Sie im Menü den Eintrag In erweiterten Filter umwandeln aus.

  3. Füllen Sie das Textfeld mit dem folgenden Filter aus:

    resource.type="k8s_cluster"
logName="projects/PROJECT_ID/logs/externalaudit.googleapis.com%2Factivity"
protoPayload.serviceName="anthosgke.googleapis.com"

  4. Klicken Sie auf Filter senden, um alle Audit-Logs aus GKE on VMware-Clustern aufzurufen, die für die Anmeldung bei diesem Projekt konfiguriert wurden.

gcloud

Listen Sie die ersten beiden Logeinträge im Administratoraktivitätslog des Projekts auf, die sich auf den Ressourcentyp k8s_cluster beziehen:

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

Dabei ist PROJECT_ID Ihre Projekt-ID.

Es werden zwei Logeinträge ausgegeben. Beachten Sie, dass das Feld logName für jeden Logeintrag den Wert projects/PROJECT_ID/logs/externalaudit.googleapis.com%2Factivity hat und protoPayload.serviceName gleich anthosgke.googleapis.com ist.

Audit-Richtlinie

Das Verhalten von Cloud-Audit-Logs wird durch eine statisch konfigurierte Audit-Logging-Richtlinie von Kubernetes bestimmt. Das Ändern dieser Richtlinie wird derzeit nicht unterstützt, wird aber in einer zukünftigen Version möglich sein.