Creazione di un modello di base

Un file di configurazione di base potrebbe essere sufficiente per carichi di lavoro semplici, ma per per architetture complesse o per le configurazioni che prevedi di riutilizzare, suddividere la configurazione in modelli.

Un modello è un file separato che viene importato e utilizzato come tipo in un configurazione. Puoi utilizzare tutti i modelli che vuoi in una configurazione.

I modelli ti consentono di separare la configurazione in diverse parti, che puoi utilizzare e riutilizzare in diversi deployment. I modelli possono essere quanto più generali o specifici in base alle tue esigenze. Con i modelli, puoi anche usufruire di funzionalità come proprietà dei modelli, variabili di ambiente, moduli e altre funzionalità dei modelli per creare file di configurazione e modelli dinamici.

Per esempi di modelli che puoi utilizzare nei tuoi deployment, consulta il repository GitHub di Deployment Manager.

Prima di iniziare

Sintassi del modello

I modelli possono essere scritti in Jinja 2.10.x o Python 3.x. Jinja è più simile alla sintassi YAML, quindi potrebbe essere più facile scrivere i modelli in Jinja se hai più dimestichezza con YAML.

Puoi anche scrivere file di modello in Python e sfruttare Python per generare in modo programmatico parti dei modelli. Ad esempio, puoi utilizzare tramite le librerie Python per formattare le definizioni dei modelli. Se hai familiarità con Python, questo potrebbe essere un formato più adatto a te.

Deployment Manager accetta modelli sia Jinja che Python. Puoi importare i 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:

# Copyright 2016 Google Inc. All rights reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

resources:
- name: vm-created-by-deployment-manager
  type: compute.v1.instance
  properties:
    zone: us-central1-a
    machineType: zones/us-central1-a/machineTypes/n1-standard-1
    disks:
    - deviceName: boot
      type: PERSISTENT
      boot: true
      autoDelete: true
      initializeParams:
        sourceImage: projects/debian-cloud/global/images/family/debian-11
    networkInterfaces:
    - network: global/networks/default

Questa configurazione è valida, ma puoi semplificarla ulteriormente suddividendo le varie parti in singoli file modello che puoi riutilizzare. Per creare un modello in base alla configurazione precedente, estrai la sezione relativa alla risorsa in questione e crea un nuovo file Jinja o Python.

I seguenti snippet mostrano le sezioni dei modelli che possono semplificare per il deployment. Per i modelli completi, fai clic su Visualizza su GitHub.

Jinja 

- name: vm-template
  type: compute.v1.instance
  properties:
    zone: us-central1-a
    machineType: zones/us-central1-a/machineTypes/n1-standard-1
    disks:
    - deviceName: boot
      type: PERSISTENT
      boot: true
      autoDelete: true
      initializeParams:
        sourceImage: projects/debian-cloud/global/images/family/debian-11
    networkInterfaces:
    - network: global/networks/default

Python

I modelli Python devono soddisfare i seguenti requisiti:

A parte questo, spetta a te generare i contenuti del tuo modello.

Esempio

resources.append({
    'name': 'vm-template',
    'type': 'compute.v1.instance',
    'properties': {
        'zone': 'us-central1-a',
        'machineType': 'zones/us-central1-a/machineTypes/n1-standard-1',
        'disks': [{
            'deviceName': 'boot',
            'type': 'PERSISTENT',
            'boot': True,
            'autoDelete': True,
            'initializeParams': {
                'sourceImage':
                    'projects/debian-cloud/global/images/family/debian-11'
            }
        }],
        'networkInterfaces': [{
            'network': 'global/networks/default'
        }]
    }
})

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 alla configurazione, seguita dal percorso relativo o assoluto dalla directory corrente. Ad esempio, può importare il modello di macchina virtuale dal passaggio precedente aggiungendo riga seguente 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 un alias per il file. Puoi utilizzare questo nome per fare riferimento al modello in un secondo momento. Se non specifichi il nome, è possibile fare riferimento al modello utilizzando path.

imports:
  - path: path/to/my_vm_template.jinja
    name: my_renamed_template.jinja

Puoi combinare le importazioni di più modelli, indipendentemente dal fatto che siano in 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 configurazione:

imports:
  - path: path/to/my_vm_template.jinja
  - path: special_vm.py
  - path: base_vm.jinja

Puoi anche importare file di testo per inserire i contenuti in linea. Ad esempio, se crei un file denominato resource_type.txt con la stringa seguente:

compute.v1.instance

Importalo nella tua configurazione e fornisci i contenuti in linea 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

Modelli di deployment

Dopo aver importato un modello, utilizzalo come tipo nella configurazione:

Jinja 

imports:
- path: vm-template.jinja

resources:
- name: my-vm
  type: vm-template.jinja

Python 

imports:
- path: vm-template.py

resources:
- name: my-vm
  type: vm-template.py

Se non hai fornito 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 dei modelli direttamente con lo strumento a riga di comando

Anziché creare un file di configurazione di primo livello, Deployment Manager offre 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 dalla riga di comando utilizzando il metodo --properties Segnala:

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: 3 viene trasmesso sotto forma di numero intero. Se vuoi specificarla come stringa, inserisci il carattere di escape singolo. tra virgolette intorno al valore, version: \'3\'.

  • I valori booleani non fanno distinzione tra maiuscole e minuscole, pertanto TRUE, true e True vengono trattati allo stesso modo.

  • Devi trasmettere tutte le proprietà obbligatorie definite dal modello. Non puoi fornire solo un sottoinsieme di proprietà. Se alcune proprietà hanno impostazioni predefinite puoi omettere la proprietà dalla riga di comando.

Per specificare più proprietà, fornisci coppie chiave-valore separate da virgole. Non importa in quale ordine 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 che hai fornito. Puoi verificare che il deployment sia stato creato utilizzando la console Google Cloud o l'interfaccia a riga di comando gcloud. Per informazioni su come visualizzare un deployment, consulta Visualizzare un manifest.

Passaggi successivi