VM-Startroutinen konfigurieren

Version 1.16 

• Neueste
• Version 1.16
• Frühere Versionen (nicht unterstützt)

Vorschau

Dieses Produkt oder diese Funktion unterliegt den „Nutzungsbedingungen für Pre-GA-Angebote“ im Abschnitt „Allgemeine Nutzungsbedingungen“ der dienstspezifischen Nutzungsbedingungen. Pre-GA-Produkte und -Funktionen sind unverändert verfügbar und werden möglicherweise nur eingeschränkt unterstützt. Weitere Informationen finden Sie in den Beschreibungen der Startphase.

Wenn Sie GKE on Bare Metal Version 1.13.0 und höher verwenden, können Sie Startroutinen angeben, um die Initialisierung Ihrer VM beim Start anzupassen. Sie können Ihre VM so konfigurieren, dass Sie SSH-Schlüssel erstellen, Nutzer und Passwörter hinzufügen, Pakete installieren, Dateien schreiben, Netzwerkeinstellungen konfigurieren und vieles mehr.

Diese Startaufgaben werden entweder mit der cloud-init API oder mit der Startskript API konfiguriert (nicht mit beiden). Diese Startanweisungen sind in der YAML-Manifestdatei VirtualMachine angegeben und werden bei jedem Start Ihrer VM automatisch ausgeführt.

Vorbereitung

Damit Sie eine VM mit Startanweisungen konfigurieren können, müssen die folgenden Voraussetzungen erfüllt sein:

• VM-Laufzeit auf GDC aktivieren

• Verwenden Sie ein verifiziertes Linux-Gastbetriebssystem und legen Sie osType im VM-Manifest auf Linux fest. Windows-Gastbetriebssysteme werden für diese Funktion nicht unterstützt, da sie cloud-init nicht unterstützen.

• Prüfen Sie, ob auf dem Gastbetriebssystem cloud-init installiert ist. Die neuesten Linux-Betriebssysteme enthalten cloud-init.

In den folgenden Abschnitten wird beschrieben, wie Sie im VM-Manifest Startroutinen mit der cloud-init API oder mit Startskripts angeben.

Mit der cloud-init API VMs initialisieren

Cloud-init wird häufig für die Initialisierung von Cloud-Instanzen und zur Anpassung von VMs während des Starts verwendet. Die VM-Initialisierung umfasst in der Regel Aufgaben wie Paketinstallationen, Repository-Einrichtung, SSH-Schlüssel-Erstellung, das Ausschreiben von Daten in Dateien und das Einrichten anderer Aspekte Ihrer VM. Sie binden die YAML-Konfigurationsdatei mit Cloud-init in die benutzerdefinierte Ressource VirtualMachine mit dem Feld spec.cloudInit ein. Beim Start der VM-Instanz liest cloud-init die bereitgestellten Daten und initialisiert die VM entsprechend.

Beachten Sie die folgenden Details unserer cloud-init-Implementierung:

• Sie geben cloud-init-Daten im YAML-Manifest VirtualMachine an, wenn Sie eine VM erstellen oder aktualisieren. Eine Anleitung zum Erstellen einer VM durch Anwenden eines Manifests finden Sie in der Anleitung: Linux-VM in der VM-Laufzeit auf GDC erstellen und verwalten.

• Wir verwenden in der VM-Spezifikation die Datenquelle NoCloud spec.cloudInit.noCloud.

• Nutzerdaten und Netzwerkdaten geben Sie im Manifest VirtualMachine in separaten Abschnitten an. Die Abschnittsbenennung und -struktur hängen vom Datenformat ab, das Sie verwenden.

• Sie können cloud-init-Konfigurationsinformationen in den folgenden Datenformaten angeben:

  • Text entfernen
  • Base64-codierter String
  • Kubernetes Secret

Hinweis :Sie können nicht sowohl cloud-init-API-Anweisungen (spec.cloudInit) als auch Startskripts (spec.startupScripts) im selben VirtualMachine-Manifest angeben.

Um Ihnen den Einstieg zu erleichtern, haben wir einige Konfigurationsbeispiele für gängige VM-Initialisierungsaufgaben bereitgestellt.

Cloud-init-Nutzerdaten

Die VM-Laufzeit auf GDC unterstützt cloud-init-Nutzerdaten in der cloud-config-Syntax. Beginnen Sie daher Ihre Nutzerdaten mit #cloud-config. Sie können die Nutzerdaten als Klartext, als Base64-codierten String oder als Kubernetes-Secret formatieren.

Hinweis: Bei Verwendung von Klartext oder einem base64-codierten String beträgt die maximal zulässige Größe 2.048 Byte. Wenn die Größe der Nutzerdaten größer oder gleich 2.048 Byte ist, geben Sie sie als Kubernetes-Secret an.

Weitere Informationen zur Syntax von Nutzerdaten und zur Modulreferenz finden Sie in der Cloud-init-Dokumentation.

Nutzerdaten als Klartext mit Cloud initieren

Das folgende Beispielmanifest zeigt, wie Nutzerdaten als Klartext angegeben werden. In diesem Fall führt cloud-init beim Start der VM einen Befehl aus:

apiVersion: vm.cluster.gke.io/v1
kind: VirtualMachine
metadata:
  name: "my-vm"
spec:
  ...
  cloudInit:
    noCloud:
      userData: |
        #cloud-config
        runcmd:
          - echo hello

Cloud-init-Nutzerdaten als base64-codierter String

Das folgende Beispiel zeigt, wie Nutzerdaten im base64-codierten Format angegeben werden. In diesem Beispiel bestehen die Nutzerdaten aus demselben echo hello-Befehl wie im Klartextbeispiel:

apiVersion: vm.cluster.gke.io/v1
kind: VirtualMachine
metadata:
  name: "my-vm"
spec:
  ...
  cloudInit:
    noCloud:
      userDataBase64: I2Nsb3VkLWNvbmZpZwpydW5jbWQ6CiAgLSBlY2hvIGhlbGxvCg==

Cloud-init-Nutzerdaten als Kubernetes-Secret

Das folgende Beispiel zeigt ein YAML-Manifest für VirtualMachine und Secret. Der Abschnitt spec.cloudInit.noCloud.secretRef in der Konfiguration VirtualMachine gibt an, dass sich die cloud-init-Nutzerdaten in einem Kubernetes-Secret mit dem Namen my-sec befinden. In der entsprechenden Secret-Konfiguration werden die Nutzerdaten als Schlüssel/Wert-Paar angegeben. Der base64-codierte Wert ist in diesem Fall die cloud-init-Nutzerdaten in der cloud-config-Syntax.

Verwenden Sie im referenzierten Secret den Datenschlüssel userData (angezeigt) oder userdata, um die cloud-init-Nutzerdaten anzugeben.

In diesem Beispiel bestehen die Nutzerdaten aus demselben echo hello-Befehl wie im Klartextbeispiel:

apiVersion: vm.cluster.gke.io/v1
kind: VirtualMachine
metadata:
  name: "my-vm"
spec:
  ...
  cloudInit:
    noCloud:
      secretRef:
        name: my-sec
---
apiVersion: v1
kind: Secret
type: Opaque
metadata:
  name: my-sec
data:
  userData: I2Nsb3VkLWNvbmZpZwpydW5jbWQ6CiAgLSBlY2hvIGhlbGxvCg==

Wenn das referenzierte Secret nicht gefunden wird oder der Datenschlüssel userData oder userdata nicht im Secret vorhanden ist, beachten Sie das folgende VM-Startverhalten:

• Zum Erstellen einer VM wird die VM mit einer detaillierten Begründung und Meldung in den Status ErrorConfiguration versetzt.

• In anderen Fällen verwendet die VM weiterhin die alten cloud-init-Nutzerdaten, bis die VM richtig konfiguriert ist. Daher werden Updates durch den Gast-Agent erst dann wirksam, wenn die VM richtig konfiguriert ist.

Verwenden Sie den folgenden Befehl, um VM-Informationen abzurufen, einschließlich der verwendeten cloud-init-Nutzerdaten:

kubectl get vm VM_NAME -o yaml --kubeconfig KUBECONFIG_PATH

Ersetzen Sie Folgendes:

• VM_NAME ist der Name Ihrer VM.

• KUBECONFIG_PATH: der Pfad zur kubeconfig-Datei für den Cluster, der Ihre VM enthält.

Verwenden Sie entweder kubectl get event oder kubectl describe gvm, um das zugehörige Kubernetes-Warnungsereignis abzurufen.

Cloud-init-Netzwerkdaten

Ähnlich wie Nutzerdaten können Sie die Netzwerkdaten als Klartext, als Base64-codierten String oder als Kubernetes-Secret formatieren. Im Gegensatz zu Nutzerdaten verwenden Netzwerkdaten keine cloud-config-Syntax.

Bei Verwendung von Klartext oder einem base64-codierten String beträgt die maximal zulässige Größe 2.048 Byte. Wenn die Größe der Nutzerdaten größer oder gleich 2.048 Byte ist, geben Sie sie als Kubernetes-Secret an.

Weitere Informationen zur Syntax von Netzwerkdaten und zugehörige Details finden Sie unter Netzwerkkonfiguration Version 2 in der Cloud-init-Dokumentation.

Tipp: In den folgenden Abschnitten wird gezeigt, wie Sie cloud-init-Netzwerkdaten in der VirtualMachine-Konfiguration in verschiedenen Formaten angeben. In den Netzwerkdaten aus dem Beispiel wird DHCP für alle Ethernet-Geräte aktiviert, deren Namen mit einem „e“ beginnen. Diese spezielle cloud-init-Anweisung zum Aktivieren von DHCP wird automatisch in die VM eingebettet, sodass Sie sie nicht selbst angeben müssen.

Cloud-init-Netzwerkdaten als Klartext

Das folgende Beispielmanifest zeigt, wie Netzwerkdaten als Klartext angegeben werden. In diesem Fall aktiviert cloud-init DHCP für alle Ethernet-Geräte, deren Namen mit einem "e" (e*) beginnen:

apiVersion: vm.cluster.gke.io/v1
kind: VirtualMachine
metadata:
  name: "my-vm"
spec:
  ...
  cloudInit:
    noCloud:
      userData: |
        #cloud-config
        runcmd:
          - echo hello
      networkData: |
        version: 2
        ethernets:
          alleths:
            match:
              name: e*
            dhcp4: true

Cloud-init-Netzwerkdaten als base64-codierter String

Das folgende Beispiel zeigt, wie Netzwerkdaten im base64-codierten Format angegeben werden. In diesem Beispiel bestehen die Netzwerkdaten aus derselben DHCP-Konfiguration wie im Klartextbeispiel:

apiVersion: vm.cluster.gke.io/v1
kind: VirtualMachine
metadata:
  name: "my-vm"
spec:
  ...
  cloudInit:
    noCloud:
      networkDataBase64: dmVyc2lvbjogMgpldGhlcm5ldHM6CiAgYWxsZXRoczoKICAgIG1hdGNoOgogICAgICBuYW1lOiBlKgogICAgZGhjcDQ6IHRydWUK

Cloud-init-Netzwerkdaten als Kubernetes-Secret

Das folgende Beispiel zeigt ein YAML-Manifest für VirtualMachine und Secret. Der Abschnitt spec.cloudInit.noCloud.networkDataSecretRef in der Konfiguration VirtualMachine gibt an, dass sich die cloud-init-Netzwerkdaten in einem Kubernetes-Secret mit dem Namen my-sec befinden. In der entsprechenden Secret-Konfiguration werden die Netzwerkdaten als Schlüssel/Wert-Paar angegeben. Der base64-codierte Wert sind in diesem Fall die cloud-init-Netzwerkdaten.

Verwenden Sie im referenzierten Secret den Datenschlüssel networkData (angezeigt) oder networkdata, um die cloud-init-Netzwerkdaten anzugeben.

In diesem Beispiel bestehen die Netzwerkdaten aus derselben DHCP-Konfiguration wie im Klartextbeispiel:

apiVersion: vm.cluster.gke.io/v1
kind: VirtualMachine
metadata:
  name: "my-vm"
spec:
  ...
  cloudInit:
    noCloud:
      networkDataSecretRef:
        name: my-sec
---
apiVersion: v1
kind: Secret
type: Opaque
metadata:
  name: my-sec
data:
  networkData: dmVyc2lvbjogMgpldGhlcm5ldHM6CiAgYWxsZXRoczoKICAgIG1hdGNoOgogICAgICBuYW1lOiBlKgogICAgZGhjcDQ6IHRydWUK

Cloud-init-Beispiele

Die folgenden Abschnitte enthalten Klartextbeispiele für einige häufige Anwendungsfälle für die VM-Initialisierung mit cloud-init:

• Autorisierte SSH-Schlüssel konfigurieren
• Neuen Nutzer hinzufügen
• Befehle beim ersten Start ausführen
• Dateien schreiben

Autorisierte SSH-Schlüssel konfigurieren

Im folgenden Beispiel für Nutzerdaten wird dem Standardnutzer der autorisierte SSH-Schlüssel ssh-rsa AAAAB3NzaK8L93bWxnyp zugewiesen.

apiVersion: vm.cluster.gke.io/v1
kind: VirtualMachine
metadata:
  name: "my-vm"
spec:
  ...
  cloudInit:
    noCloud:
      userData: |
        #cloud-config
        ssh_authorized_keys:
          - ssh-rsa AAAAB3NzaK8L93bWxnyp

Neue Nutzer hinzufügen

Im folgenden Beispiel für Nutzerdaten wird ein Nutzer test erstellt und test vollständigen sudo-Zugriff gewährt. In diesem Beispiel wird dem Nutzer ein nicht ablaufendes Passwort von pwd zugewiesen.

apiVersion: vm.cluster.gke.io/v1
kind: VirtualMachine
metadata:
  name: "my-vm"
spec:
  ...
  cloudInit:
    noCloud:
      userData: |
        #cloud-config
        users:
        - default
        - name: test
          sudo: ALL=(ALL) NOPASSWD:ALL
        chpasswd:
          list: |
            test:pwd
          expire: False

Befehle beim ersten Start ausführen

Im folgenden Beispiel für Nutzerdaten werden die Befehle echo und ls ausgeführt. Sie können Befehle verwenden, um beim Start der VM Pakete und mehr zu installieren.

apiVersion: vm.cluster.gke.io/v1
kind: VirtualMachine
metadata:
  name: "my-vm"
spec:
  ...
  cloudInit:
    noCloud:
      userData: |
        #cloud-config
        runcmd:
          - [ echo, hello ]
          - [ ls, -l, / ]

Dateien schreiben

Im folgenden Beispiel für Nutzerdaten wird ein Bash-Skript in die Datei test im Verzeichnis /var/lib/google Ihrer VM geschrieben. Mit den cloud-init-Anweisungen werden die Dateiberechtigungen zum Lesen, Schreiben und Ausführen (0744) für den Dateiinhaber festgelegt.

apiVersion: vm.cluster.gke.io/v1
kind: VirtualMachine
metadata:
  name: "my-vm"
spec:
  ...
  cloudInit:
    noCloud:
      userData: |
        #cloud-config
        write_files:
        - path: /var/lib/google/test
          permissions: 0744
          content: |
            #!/bin/bash
            echo hello

Fehlerbehebung bei Cloud-init

Wenn Probleme mit der VM-Initialisierung auftreten und Sie cloud-init verwenden, prüfen Sie die folgenden cloud-init-Logs in der VM:

• /var/log/cloud-init.log: Standardmäßig schreibt cloud-init alle Ereignisse mit einer Ebene von DEBUG oder höher in dieses Log.

• /var/log/cloud-init-output.log: Standardmäßig leitet cloud-init sowohl stdout als auch stderr aus allen cloud-init-Phasen an dieses Log weiter.

Startskripts zum Initialisieren von VMs verwenden

Startskripts führen Aufgaben während des Startvorgangs einer VM-Instanz aus. Sie können im Abschnitt spec.startupScripts der Spezifikation VirtualMachine ein oder mehrere Skripts angeben. Zum Initialisieren Ihrer VM können Startskripts verwendet werden. Die VM-Initialisierung umfasst in der Regel Aufgaben wie Paketinstallationen, Repository-Einrichtung, SSH-Schlüssel-Erstellung, das Ausschreiben von Daten in Dateien und das Einrichten anderer Aspekte Ihrer VM.

Beachten Sie die folgenden Informationen zu Startskripts:

• Sie geben Startskripts im YAML-Manifest VirtualMachine an, wenn Sie eine VM erstellen oder aktualisieren. Eine Anleitung zum Erstellen einer VM durch Anwenden eines Manifests finden Sie in der Anleitung: Linux-VM in der VM-Laufzeit auf GDC erstellen und verwalten.

• Die angegebenen Skripts werden bei jedem Start der VM ausgeführt.

• Fügen Sie am Anfang des Skripts #!/bin/... ein, um den Skriptinterpreter anzugeben. Fügen Sie beispielsweise #!/bin/bash ein, um das Skript mit der Bash-Shell auszuführen.

• Sie können nicht gleichzeitig cloud-init API-Anweisungen (spec.cloudInit) und Startskripts (spec.startupScripts) im selben VirtualMachine-Manifest angeben.

Hinweis: Wenn Sie GKE on Bare Metal Version 1.13.0 verwenden, müssen Sie die VM zweimal starten, damit Startskripts unter bestimmten Umständen wirksam werden. Dieses VM-Startverhalten gilt nur, wenn Sie eine vorhandene VM ohne Startskripts aktualisieren. Dieses Problem wurde in GKE on Bare Metal-Version 1.13.1 und höher behoben.

Skriptformate

Sie können Startskripts in den folgenden Datenformaten angeben:

• Text entfernen
• Base64-codierter String
• Kubernetes Secret

Beachten Sie die folgenden Regeln für die Arbeit mit verschiedenen Skriptformaten:

• Bei Verwendung von Klartext oder einem base64-codierten String beträgt die maximal zulässige Größe für Skriptinhalte 2.048 Byte. Wenn der Inhalt Ihres Skripts 2.048 Byte groß oder größer als 2.048 Byte ist, geben Sie Skripts als Kubernetes-Secret an.

• Verwenden Sie bei Verwendung eines Kubernetes-Secrets den Datenschlüssel script im referenzierten Secret, um den Skriptinhalt anzugeben.

• Wenn ein referenziertes Secret nicht gefunden wird oder der Datenschlüssel script nicht im referenzierten Secret vorhanden ist, führt die VM das Skript weiter aus. Die VM schreibt oder aktualisiert den Skriptinhalt jedoch nicht. In diesem Fall finden Sie das Kubernetes-Warnungsereignis entweder mit kubectl get event oder kubectl describe gvm.

Das folgende YAML-Beispielmanifest VirtualMachine enthält drei Skripts, eines in jedem der unterstützten Formate. In diesem Fall führt jedes Skript den echo hello-Befehl aus myscript1 aus, dem Klartextbeispiel.

apiVersion: vm.cluster.gke.io/v1
kind: VirtualMachine
metadata:
  name: "my-vm"
spec:
  ...
  startupScripts:
  - name: myscript1
    script: |
      #!/bin/bash
      echo hello
  - name: myscript2
    scriptBase64: IyEvYmluL2Jhc2gKICAgICAgZWNobyBoZWxsbwo=
  - name: myscript3
    scriptSecretRef:
      name: my-sec
---
apiVersion: v1
kind: Secret
type: Opaque
metadata:
  name: my-sec
data:
  script: IyEvYmluL2Jhc2gKICAgICAgZWNobyBoZWxsbwo=

Fehlerbehebung bei Skripts

Führen Sie den folgenden Befehl aus, um die Skriptergebnisse oder Logs zu prüfen:

journalctl -u cloud-final

Die Logeinträge des Startskripts beginnen mit dem folgenden Text:

started to run the command /var/lib/google/startup-scripts/SCRIPT_NAME ...

Der Logeintrag enthält den Namen des Startskripts SCRIPT_NAME.