Le routine di avvio ti consentono di personalizzare l'inizializzazione delle macchine virtuali (VM) Linux in Google Distributed Cloud. Puoi configurare la VM in modo che crei chiavi SSH, aggiunga utenti e password, installi pacchetti, scriva file e configuri le impostazioni di rete.
Puoi specificare le routine di avvio nel manifest YAML VirtualMachine utilizzando l'API cloud-init o l'API degli script di avvio, ma non entrambe. Queste routine vengono eseguite automaticamente ogni volta che la VM viene avviata.
Prerequisiti
Per configurare una VM con istruzioni di avvio, devi soddisfare i seguenti prerequisiti:
Utilizza un sistema operativo guest Linux verificato e imposta
osTypesuLinuxnel manifest della VM. I sistemi operativi guest Windows non sono supportati per questa funzionalità, poiché non supportano cloud-init.Assicurati che nel sistema operativo guest sia installato cloud-init. La maggior parte dei sistemi operativi Linux recenti include cloud-init.
Le sezioni seguenti 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 viene comunemente utilizzato per l'inizializzazione delle istanze cloud e per la personalizzazione delle VM durante l'avvio. L'inizializzazione della VM in genere prevede attività come l'installazione di pacchetti,
la configurazione dei repository, la creazione di chiavi SSH, la scrittura di dati nei file e la configurazione di
altri aspetti della VM. Puoi incorporare il file YAML di configurazione di 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.
Tieni presenti i seguenti dettagli della nostra implementazione di cloud-init:
Specifica i dati cloud-init nel manifest YAML
VirtualMachinequando crei o aggiorni una VM. Per istruzioni su come creare una VM applicando un manifest, consulta Tutorial: crea e gestisci una VM Linux in VM Runtime on GDC.Nella nostra specifica della VM utilizziamo l'origine dati
NoCloud,spec.cloudInit.noCloud.I dati utente e i dati di rete vengono specificati 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 di cloud-init nei seguenti formati dei dati:
- Cancella testo
- Stringa con codifica Base64
- Secret Kubernetes
Per aiutarti a iniziare, abbiamo fornito alcuni esempi di configurazione per le attività comuni di inizializzazione delle VM.
Dati utente cloud-init
VM Runtime on 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 non crittografato, stringa con codifica base64 o secret di Kubernetes.
Per ulteriori informazioni sulla sintassi dei dati utente e sul riferimento ai moduli, consulta la documentazione di cloud-init.
Dati utente cloud-init in testo non crittografato
Il seguente manifest di esempio mostra come specificare i dati utente in testo non crittografato. 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 non crittografato:
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 per un VirtualMachine e 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. In questo caso, il valore con codifica Base64 corrisponde ai dati utente cloud-init nella sintassi cloud-config.
Nel secret di 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 non crittografato:
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, questa viene impostata su uno stato
ErrorConfigurationcon un motivo e un messaggio dettagliati.In altri casi, la VM continua a utilizzare i dati utente cloud-init precedenti finché non viene configurata correttamente. Di conseguenza, gli aggiornamenti per l'attivazione o la disattivazione dell'agente guest non hanno 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 del cluster contenente la 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 non crittografato, una stringa con codifica base64 o un secret Kubernetes. A differenza dei dati utente, i dati di rete non utilizzano la sintassi cloud-config.
Quando utilizzi testo non crittografato o una stringa con codifica Base64, la dimensione massima consentita è 2048 byte. Se la dimensione dei dati utente è vicina o superiore a 2048 byte, specificala come secret Kubernetes.
Per ulteriori informazioni sulla sintassi dei dati di rete e sui dettagli correlati, consulta Networking Config Version 2 nella documentazione di cloud-init.
Dati di rete cloud-init in testo non crittografato
Il seguente manifest di esempio mostra come specificare i dati di rete come testo non crittografato.
In questo caso, cloud-init attiva il DHCP per tutti i dispositivi Ethernet con nomi che 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 non crittografato:
apiVersion: vm.cluster.gke.io/v1
kind: VirtualMachine
metadata:
name: "my-vm"
spec:
...
cloudInit:
noCloud:
networkDataBase64: dmVyc2lvbjogMgpldGhlcm5ldHM6CiAgYWxsZXRoczoKICAgIG1hdGNoOgogICAgICBuYW1lOiBlKgogICAgZGhjcDQ6IHRydWUK
Dati di rete cloud-init come secret Kubernetes
L'esempio seguente mostra un manifest YAML per un VirtualMachine e 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. In questo caso, il valore con codifica Base64 corrisponde ai dati di rete cloud-init.
Nel secret di 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 non crittografato:
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 sezioni seguenti contengono esempi di testo non crittografato di alcuni casi d'uso comuni per l'inizializzazione delle VM con cloud-init:
- Configura le chiavi SSH autorizzate
- Aggiungi un nuovo utente
- Esegui i comandi al primo avvio
- Scrivi file
Configura le chiavi SSH autorizzate
L'esempio di dati utente seguente 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
L'esempio di dati utente seguente crea un utente test e concede a test l'accesso sudo completo. Questo esempio assegna all'utente una password senza scadenza 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
L'esempio di dati utente seguente esegue un comando echo e un comando ls. Puoi utilizzare i comandi per installare pacchetti e altro ancora 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, / ]
Scrivere file
L'esempio di dati utente seguente scrive uno script bash nel file test nella directory /var/lib/google della VM. Le istruzioni cloud-init impostano le autorizzazioni dei file su 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 di cloud-init nella VM:
/var/log/cloud-init.log: per impostazione predefinita, cloud-init scrive in questo log tutti gli eventi con un livelloDEBUGo superiore./var/log/cloud-init-output.log: per impostazione predefinita, cloud-init indirizza sia stdout che stderr da tutte le fasi di 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 della specifica VirtualMachine. Gli script di avvio possono essere utilizzati per inizializzare la VM. L'inizializzazione della VM in genere prevede attività come l'installazione di pacchetti,
la configurazione dei repository, la creazione di chiavi SSH, la scrittura di dati nei file e la configurazione di
altri aspetti della VM.
Tieni presenti i seguenti dettagli relativi agli script di avvio:
Puoi specificare gli script di avvio nel manifest YAML
VirtualMachinequando crei o aggiorni una VM. Per istruzioni su come creare una VM applicando un manifest, consulta Tutorial: crea e gestisci una VM Linux in VM Runtime on GDC.Gli script specificati vengono eseguiti ogni volta che la VM viene avviata.
Includi
#!/bin/...nella parte superiore dello script per indicare l'interprete dello script. Ad esempio, includi#!/bin/bashper eseguire lo script con la shell Bash.Non puoi specificare sia le direttive dell'API cloud-init (
spec.cloudInit) sia gli script di avvio (spec.startupScripts) nello stesso manifestVirtualMachine.
Formati degli 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 diversi formati di script:
Quando utilizzi testo non crittografato o una stringa con codifica base64, la dimensione massima consentita per i contenuti dello script è di 2048 byte. Se le dimensioni dei contenuti dello script sono vicine o superiori a 2048 byte, specifica gli script come secret di Kubernetes.
Quando utilizzi un secret di Kubernetes, utilizza la chiave dati
scriptnel secret di riferimento per specificare i contenuti dello script.Se un secret a cui viene fatto riferimento non viene trovato o se la chiave dati
scriptnon esiste nel secret a cui viene fatto riferimento, la VM continua a eseguire lo script. Tuttavia, la VM non scrive né aggiorna i contenuti dello script. In questo caso, puoi trovare l'evento di avviso di Kubernetes conkubectl get eventokubectl describe gvm.
Il seguente manifest YAML VirtualMachine di esempio contiene tre script, uno per ciascuno dei formati supportati. In questo caso, ogni script esegue il comando echo
hello mostrato in myscript1, l'esempio di testo non crittografato.
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 relativi agli 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.