Un file di configurazione di base potrebbe essere sufficiente per carichi di lavoro semplici, ma per architetture più complesse o per configurazioni che prevedi di riutilizzare, puoi suddividere la configurazione in modelli.
Un modello è un file separato che viene importato e utilizzato come tipo in una configurazione. Puoi utilizzare tutti i modelli che vuoi in una configurazione.
I modelli consentono di separare la configurazione in diverse parti che puoi utilizzare e riutilizzare in deployment diversi. I modelli possono essere generici o specifici, in base alle tue esigenze. Con i modelli, puoi inoltre sfruttare funzionalità come le proprietà del modello, le variabili di ambiente, i moduli e altre funzionalità dei modelli per creare file di configurazione e modello dinamici.
Per esempi di modelli che puoi utilizzare nei tuoi deployment, consulta il repository GitHub di Deployment Manager.
Prima di iniziare
- Se vuoi utilizzare gli esempi di riga di comando di questa guida, installa lo strumento a riga di comando "gcloud".
- Se vuoi utilizzare gli esempi di API riportati in questa guida, configura l'accesso API.
- Scopri come creare una configurazione di base.
Sintassi del modello
I modelli possono essere scritti in Jinja 2.10.x o Python 3.x. Jinja esegue una mappatura più fedele alla sintassi YAML, quindi potrebbe essere più semplice scrivere modelli in Jinja se hai più familiarità con YAML.
Puoi anche scrivere file modello in Python e sfruttare Python per generare a livello di programmazione parti dei modelli. Ad esempio, puoi utilizzare le librerie Python per formattare le definizioni dei modelli. Se hai familiarità con Python, questo formato potrebbe essere più adatto alle tue esigenze.
Deployment Manager accetta i modelli Jinja e Python. Puoi importare modelli in entrambe le lingue nella stessa configurazione.
Creazione di un modello di base
Un modello è un file creato da te, scritto in Jinja o Python. Ad esempio, considera il seguente file di configurazione:
ma puoi semplificarla ulteriormente suddividendola come singoli file modello riutilizzabili. Per creare un modello basato sulla configurazione precedente, estrai la sezione per la risorsa in questione e crea un nuovo file Jinja o Python.
I seguenti snippet mostrano le sezioni dei modelli che possono semplificare il deployment. Per i modelli completi, fai clic su Visualizza su GitHub.
Jinja
Python
I modelli Python devono soddisfare i seguenti requisiti:
Il modello deve definire un metodo denominato
GenerateConfig(context)ogenerate_config(context). Se utilizzi entrambi i nomi dei metodi nello stesso modello, il metodogenerate_config()ha la precedenza.L'oggetto
contextcontiene metadati sul deployment e sull'ambiente, come il nome del deployment, il progetto corrente e così via. Scopri di più sull'utilizzo delle variabili di ambiente specifiche per il deployment.Il metodo deve restituire un dizionario Python.
A parte questo, spetta a te generare i contenuti del modello.
Esempio
Per l'esempio completo di Python, consulta il repository GitHub di Deployment Manager.
Importazione del modello
Dopo aver creato un modello, importalo nel file di configurazione per utilizzarlo.
Per importare un modello, aggiungi una sezione imports nella configurazione, seguita dal percorso relativo o assoluto della directory corrente. Ad esempio, puoi importare il modello di macchina virtuale dal passaggio precedente aggiungendo la seguente riga all'inizio della configurazione:
imports:
- path: path/to/my_vm_template.jinja
Se hai un percorso file lungo, puoi fornire una proprietà name facoltativa come
alias per il file. Puoi usare questo nome per fare riferimento
al modello in un secondo momento. Se non fornisci il nome, è possibile fare riferimento al modello utilizzando path.
imports:
- path: path/to/my_vm_template.jinja
name: my_renamed_template.jinja
Puoi combinare e abbinare le importazioni di più modelli, indipendentemente dal fatto che siano Jinja o Python:
imports:
- path: path/to/my_vm_template.jinja
name: my_renamed_template.jinja
- path: special_vm.py
Se il modello utilizza altri modelli come dipendenze, importa anche i modelli dipendenti nella tua configurazione:
imports:
- path: path/to/my_vm_template.jinja
- path: special_vm.py
- path: base_vm.jinja
Puoi anche importare file di testo per integrare i contenuti. Ad esempio, se crei un file denominato resource_type.txt con la seguente stringa:
compute.v1.instance
Importalo nella tua configurazione e fornisci i contenuti incorporati in questo modo:
imports:
- path: resource_type.txt
resources:
- name: my-vm
type: {{ imports["resource_type.txt"] }} # Resolves to "compute.v1.instance"
properties:
zone: us-central1-a
machineType: zones/us-central1-a/machineTypes/f1-micro
disks:
- deviceName: boot
type: PERSISTENT
boot: true
autoDelete: true
initializeParams:
sourceImage: projects/debian-cloud/global/images/family/debian-9
networkInterfaces:
- network: global/networks/default
accessConfigs:
- name: External NAT
type: ONE_TO_ONE_NAT
Deployment dei modelli
Dopo aver importato un modello, utilizzalo come tipo nella configurazione:
Jinja
Python
Se non hai specificato un nome per il modello, chiamalo utilizzando il percorso del modello:
imports:
- path: path/to/my_vm_template.jinja
resources:
- name: my-first-virtual-machine
type: path/to/my_vm_template.jinja
Deployment diretto dei modelli con lo strumento a riga di comando
Anziché creare un file di configurazione di primo livello, Deployment Manager offre la possibilità di eseguire il deployment di un modello direttamente in Google Cloud CLI.
Ad esempio, la seguente richiesta esegue il deployment di un modello chiamato vm-template.jinja:
gcloud deployment-manager deployments create a-single-vm --template vm-template.jinja
Se il modello ha proprietà modello, puoi impostare queste proprietà anche nella riga di comando utilizzando il flag --properties:
gcloud deployment-manager deployments create my-igm \
--template vm-template.jinja \
--properties zone:us-central1-a
Tieni presente che:
Tutti i valori vengono analizzati come valori YAML. Ad esempio,
version: 3viene trasmesso come numero intero. Se vuoi specificarlo come stringa, inserisci il valoreversion: \'3\'tra virgolette singole con caratteri di escape.I valori booleani non fanno distinzione tra maiuscole e minuscole, pertanto
TRUE,trueeTruevengono trattati allo stesso modo.Devi trasmettere tutte le proprietà obbligatorie definite dal modello. Non puoi fornire solo un sottoinsieme delle proprietà. Se alcune proprietà hanno valori predefiniti, puoi ometterla dalla riga di comando.
Per specificare più proprietà, fornisci coppie chiave-valore separate da virgole. Non è importante nell'ordine in cui specifichi le coppie. Ad esempio:
gcloud deployment-manager deployments create my-igm
--template vm-template.jinja
--properties zone:us-central1-a,machineType:n1-standard-1,image:debian-9
Dopo aver eseguito questo comando, Deployment Manager crea un deployment utilizzando il modello fornito. Puoi confermare che il deployment sia stato creato utilizzando la console Google Cloud o gcloud CLI. Per informazioni sulla visualizzazione di un deployment, consulta Visualizzazione di un manifest.
Passaggi successivi
- Per esempi di modelli pronti per la produzione, consulta gli esempi di Cloud Foundation Toolkit in GitHub.
- Utilizza le proprietà del modello per astrarre ulteriormente i contenuti.
- Compilare le informazioni sui progetti e sui deployment utilizzando le variabili di ambiente.
- Aggiungi definitivamente un modello al tuo progetto come tipo composito.