Configura le routine di avvio delle VM

Anteprima

Questo prodotto o funzionalità è soggetto ai "Termini delle Offerte pre-GA" nella sezione Termini generali del servizio dei Termini specifici del servizio. I prodotti e le funzionalità pre-GA sono disponibili "così come sono" e potrebbero avere un supporto limitato. Per saperne di più, consulta le descrizioni della fase di lancio.

Quando utilizzi Google Distributed Cloud versione 1.13.0 e successive, puoi specificare le routine di avvio per personalizzare l'inizializzazione della VM all'avvio. Puoi configurare la VM per creare chiavi SSH, aggiungere utenti e password, installare pacchetti, scrivere file, configurare le impostazioni di rete e altro ancora.

Queste attività di avvio sono configurate con l'API cloud-init o con l'API degli script di avvio (non entrambe). Queste istruzioni di avvio sono specificate nel file manifest YAML di VirtualMachine e vengono eseguite automaticamente a ogni avvio della VM.

Prerequisiti

Per configurare una VM con istruzioni di avvio, devi soddisfare i seguenti prerequisiti:

• Abilita il runtime VM su GDC.

• Utilizza un sistema operativo guest Linux verificato e imposta osType su Linux nel manifest della VM. I sistemi operativi guest di Windows non sono supportati per questa funzionalità, poiché non supportano cloud-init.

• Assicurati che nel sistema operativo guest sia installato cloud-init. I sistemi operativi Linux più recenti includono cloud-init.

Le seguenti sezioni descrivono come specificare le routine di avvio nel manifest della VM con l'API cloud-init o gli script di avvio.

Utilizza l'API cloud-init per inizializzare le VM

Cloud-init è comunemente utilizzato per l'inizializzazione delle istanze cloud e per la personalizzazione delle VM durante l'avvio. L'inizializzazione delle VM in genere prevede attività come l'installazione dei pacchetti, la configurazione del repository, la creazione di chiavi SSH, la scrittura dei dati nei file e la configurazione di altri aspetti della VM. Incorpora il codice YAML della configurazione cloud-init nella risorsa personalizzata VirtualMachine con il campo spec.cloudInit. All'avvio dell'istanza VM, cloud-init legge i dati forniti e inizializza la VM di conseguenza.

Prendi in considerazione i seguenti dettagli della nostra implementazione cloud-init:

• Puoi specificare i dati cloud-init nel manifest YAML VirtualMachine quando crei o aggiorni una VM. Per istruzioni su come creare una VM applicando un manifest, consulta Tutorial: creare e gestire una VM Linux nel runtime VM su GDC.

• Nelle nostre specifiche della VM viene utilizzata l'origine dati NoCloud, spec.cloudInit.noCloud.

• Puoi specificare i dati utente e i dati di rete in sezioni separate del manifest VirtualMachine. La denominazione e la struttura delle sezioni dipendono dal formato dei dati che decidi di utilizzare.

• Puoi specificare le informazioni di configurazione cloud-init nei seguenti formati di dati:

  • Cancella testo
  • Stringa con codifica Base64
  • Secret Kubernetes

Nota: non puoi specificare sia le istruzioni API cloud-init (spec.cloudInit) sia gli script di avvio (spec.startupScripts) nello stesso manifest dell'VirtualMachine.

Per aiutarti a iniziare, abbiamo fornito alcuni esempi di configurazione per le attività più comuni di inizializzazione delle VM.

Dati utente Cloud-init

Il runtime VM su GDC supporta i dati utente cloud-init nella sintassi cloud-config, quindi inizia i dati utente con #cloud-config. Puoi formattare i dati utente come testo chiaro, stringa con codifica Base64 o Secret Kubernetes.

Nota: se utilizzi un testo in chiaro o una stringa con codifica base64, la dimensione massima consentita è di 2048 byte. Se la dimensione dei dati utente è vicina o superiore a 2048 byte, specificala come secret di Kubernetes.

Per ulteriori informazioni sulla sintassi dei dati utente e sui riferimenti ai moduli, consulta la documentazione di cloud-init.

Dati utente Cloud-init come testo in chiaro

Il seguente esempio di file manifest mostra come specificare i dati utente come testo in chiaro. In questo caso, cloud-init esegue un comando all'avvio della VM:

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

Dati utente Cloud-init come stringa con codifica Base64

L'esempio seguente mostra come specificare i dati utente in formato con codifica Base64. In questo esempio, i dati utente sono costituiti dallo stesso comando echo hello dell'esempio di testo in chiaro:

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

Dati utente Cloud-init come secret di Kubernetes

L'esempio seguente mostra un manifest YAML sia per VirtualMachine sia per un Secret. La sezione spec.cloudInit.noCloud.secretRef nella configurazione VirtualMachine indica che i dati utente cloud-init si trovano in un secret Kubernetes denominato my-sec. La configurazione Secret corrispondente specifica i dati utente come coppia chiave-valore. Il valore con codifica Base64 in questo caso corrisponde ai dati utente cloud-init nella sintassi cloud-config.

Nel secret a cui viene fatto riferimento, utilizza la chiave dati userData (mostrata) o userdata per specificare i dati utente cloud-init.

In questo esempio, i dati utente sono costituiti dallo stesso comando echo hello dell'esempio di testo in chiaro:

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==

Se il secret a cui viene fatto riferimento non viene trovato o la chiave dati userData o userdata non esiste nel secret, tieni presente il seguente comportamento di avvio della VM:

• Per la creazione di una VM, la VM viene messa in stato ErrorConfiguration con un motivo e un messaggio dettagliati.

• In altri casi, la VM continua a utilizzare i vecchi dati utente cloud-init finché la VM non viene configurata correttamente. Di conseguenza, l'abilitazione o la disabilitazione degli aggiornamenti dell'agente guest non ha effetto finché la VM non viene configurata correttamente.

Per recuperare le informazioni sulla VM, inclusi i dati utente cloud-init utilizzati, utilizza il seguente comando:

kubectl get vm VM_NAME -o yaml --kubeconfig KUBECONFIG_PATH

Sostituisci quanto segue:

• VM_NAME: il nome della VM.

• KUBECONFIG_PATH: il percorso del file kubeconfig per il cluster contenente la tua VM.

Per recuperare l'evento di avviso Kubernetes correlato, utilizza kubectl get event o kubectl describe gvm.

Dati di rete Cloud-init

Come per i dati utente, puoi formattare i dati di rete come testo in chiaro, una stringa con codifica Base64 o Secret Kubernetes. A differenza dei dati utente, quelli di rete non usano la sintassi cloud-config.

Se utilizzi un testo in chiaro o una stringa con codifica base64, la dimensione massima consentita è di 2048 byte. Se la dimensione dei dati utente è vicina o superiore a 2048 byte, specificala come secret di Kubernetes.

Per ulteriori informazioni sulla sintassi dei dati di rete e sui relativi dettagli, consulta Networking Config Version 2 nella documentazione cloud-init.

Suggerimento: le sezioni seguenti illustrano come specificare i dati di rete cloud-init nella configurazione VirtualMachine in formati diversi. I dati di rete di esempio attivano il protocollo DHCP per tutti i dispositivi Ethernet i cui nomi iniziano con "e". Questa direttiva cloud-init specifica per abilitare il protocollo DHCP è incorporata automaticamente nella VM, quindi non devi specificarla personalmente.

Dati di rete Cloud-init come testo in chiaro

Il seguente esempio di manifest mostra come specificare i dati di rete come testo in chiaro. In questo caso, cloud-init attiva il protocollo DHCP per tutti i dispositivi Ethernet i cui nomi iniziano con "e" (e*):

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

Dati di rete cloud-init come stringa con codifica Base64

L'esempio seguente mostra come specificare i dati di rete in formato con codifica Base64. In questo esempio, i dati di rete sono costituiti dalla stessa configurazione DHCP specificata nell'esempio di testo in chiaro:

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

Dati di rete Cloud-init come secret di Kubernetes

L'esempio seguente mostra un manifest YAML sia per VirtualMachine sia per un Secret. La sezione spec.cloudInit.noCloud.networkDataSecretRef nella configurazione VirtualMachine indica che i dati di rete cloud-init si trovano in un secret Kubernetes denominato my-sec. La configurazione Secret corrispondente specifica i dati di rete come coppia chiave-valore. Il valore con codifica Base64 in questo caso è i dati di rete cloud-init.

Nel secret a cui viene fatto riferimento, utilizza la chiave dati networkData (mostrata) o networkdata per specificare i dati di rete cloud-init.

In questo esempio, i dati di rete sono costituiti dalla stessa configurazione DHCP specificata nell'esempio di testo in chiaro:

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

Esempi di Cloud-init

Le seguenti sezioni contengono esempi di testo chiaro di alcuni casi d'uso comuni per l'inizializzazione delle VM con cloud-init:

• Configura chiavi SSH autorizzate
• Aggiungere un nuovo utente
• Eseguire i comandi al primo avvio
• Scrivi file

Configura chiavi SSH autorizzate

Il seguente esempio di dati utente assegna la chiave SSH autorizzata ssh-rsa AAAAB3NzaK8L93bWxnyp all'utente predefinito.

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

Aggiungere un nuovo utente

Il seguente esempio di dati utente crea l'utente test e concede a test l'accesso sudo completo. In questo esempio viene assegnata all'utente una password non in scadenza di pwd.

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

Esegui i comandi al primo avvio

Il seguente esempio di dati utente esegue un comando echo e un comando ls. Puoi utilizzare i comandi per installare pacchetti e altro all'avvio della VM.

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

Scrivi file

Il seguente esempio di dati utente scrive uno script Bash nel file test nella directory /var/lib/google della VM. Le istruzioni cloud-init impostano le autorizzazioni dei file in lettura, scrittura ed esecuzione (0744) per il proprietario del file.

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

Risoluzione dei problemi di cloud-init

Se riscontri problemi con l'inizializzazione della VM e utilizzi cloud-init, controlla i seguenti log cloud-init nella VM:

• /var/log/cloud-init.log: per impostazione predefinita, cloud-init scrive tutti gli eventi con un livello pari o superiore a DEBUG in questo log.

• /var/log/cloud-init-output.log: per impostazione predefinita, cloud-init indirizza sia stdout che stderr da tutte le fasi cloud-init a questo log.

Utilizza gli script di avvio per inizializzare le VM

Gli script di avvio eseguono attività durante il processo di avvio di un'istanza di macchina virtuale (VM). Puoi specificare uno o più script nella sezione spec.startupScripts delle specifiche VirtualMachine. Gli script di avvio possono essere utilizzati per inizializzare la VM. L'inizializzazione delle VM in genere prevede attività come l'installazione dei pacchetti, la configurazione del repository, la creazione di chiavi SSH, la scrittura dei dati nei file e la configurazione di altri aspetti della VM.

Tieni presenti i seguenti dettagli per gli script di avvio:

• Puoi specificare gli script di avvio nel manifest YAML VirtualMachine quando crei o aggiorni una VM. Per istruzioni su come creare una VM applicando un manifest, consulta Tutorial: creare e gestire una VM Linux nel runtime VM su GDC.

• Gli script specificati vengono eseguiti a ogni avvio della VM.

• Includi #!/bin/... nella parte superiore dello script per indicare l'interprete di script. Ad esempio, includi #!/bin/bash per eseguire lo script con la shell bash.

• Non puoi specificare sia le istruzioni API cloud-init (spec.cloudInit) sia gli script di avvio (spec.startupScripts) nello stesso manifest di VirtualMachine.

Nota: se utilizzi Google Distributed Cloud versione 1.13.0, devi avviare la VM due volte affinché gli script di avvio abbiano effetto in circostanze specifiche. Questo comportamento di avvio della VM si applica solo quando aggiorni una VM esistente che non ha script di avvio per includere script di avvio. Il problema è stato risolto in Google Distributed Cloud 1.13.1 e versioni successive.

Formati script

Puoi specificare gli script di avvio nei seguenti formati di dati:

• Cancella testo
• Stringa con codifica Base64
• Secret Kubernetes

Tieni presente le seguenti regole per lavorare con formati di script diversi:

• Se utilizzi un testo in chiaro o una stringa con codifica Base64, la dimensione massima consentita per i contenuti dello script è di 2048 byte. Se la dimensione del contenuto dello script è vicina o superiore a 2048 byte, specifica gli script come secret di Kubernetes.

• Quando utilizzi un secret di Kubernetes, utilizza la chiave dati script nel secret di riferimento per specificare il contenuto dello script.

• Se non viene trovato un secret a cui viene fatto riferimento o la chiave dati script non esiste nel secret a cui viene fatto riferimento, la VM continua a eseguire lo script. La VM non scrive o aggiorna i contenuti dello script. In questo caso, puoi trovare l'evento di avviso di Kubernetes con kubectl get event o kubectl describe gvm.

Il seguente esempio di manifest YAML VirtualMachine contiene tre script, uno in ognuno dei formati supportati. In questo caso, ogni script esegue il comando echo hello mostrato in myscript1, l'esempio in chiaro.

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=

Risoluzione dei problemi di script

Per controllare i risultati o i log dello script, esegui questo comando:

journalctl -u cloud-final

Le voci di log dello script di avvio iniziano con il seguente testo:

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

La voce di log include SCRIPT_NAME, il nome dello script di avvio.