Informazioni sui modelli riutilizzabili

Durante lo sviluppo di un'app, molto probabilmente hai bisogno di architetture complesse. Per semplificare la replica e la risoluzione dei problemi del deployment, ti consigliamo di suddividere la configurazione in modelli.

Un modello è un file separato che definisce un insieme di risorse. Puoi riutilizzare i modelli in diversi deployment, per creare coerenza tra deployment complessi.

Puoi usare Python o Jinja2 per creare modelli per Deployment Manager. Ti consigliamo di utilizzare i modelli Python poiché Python offre una maggiore flessibilità e un numero maggiore di funzionalità per la scalabilità della tua app.

Modelli Python

Se scegli di scrivere modelli in Python, i modelli devono soddisfare i seguenti requisiti:

  • Il modello deve essere scritto in Python 3.x

  • Il modello deve definire un metodo denominato GenerateConfig(context) o generate_config(context). Se utilizzi entrambi i nomi dei metodi nello stesso modello, il metodo generate_config() avrà la precedenza.

    L'oggetto context contiene metadati sul deployment e sull'ambiente, come il nome del deployment, il progetto corrente e così via. Utilizzerai queste variabili specifiche per il deployment nei passaggi successivi.

  • Il metodo deve restituire un dizionario Python.

Analisi dei modelli di esempio

Dal repository di esempio, apri vm-template.py:

cd deploymentmanager-samples/examples/v2/step_by_step_guide/step5_create_a_template/python

nano vm-template.py  # use your preferred text editor

Questo modello definisce la prima macchina virtuale (VM) degli esempi precedenti:

# 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.

"""Creates the virtual machine."""

COMPUTE_URL_BASE = 'https://www.googleapis.com/compute/v1/'

def GenerateConfig(unused_context):
  """Creates the first virtual machine."""

  resources = [{
      'name': 'the-first-vm',
      'type': 'compute.v1.instance',
      'properties': {
          'zone': 'us-central1-f',
          'machineType': ''.join([COMPUTE_URL_BASE, 'projects/MY_PROJECT',
                                  '/zones/us-central1-f/',
                                  'machineTypes/f1-micro']),
          'disks': [{
              'deviceName': 'boot',
              'type': 'PERSISTENT',
              'boot': True,
              'autoDelete': True,
              'initializeParams': {
                  'sourceImage': ''.join([COMPUTE_URL_BASE, 'projects/',
                                          'debian-cloud/global/',
                                          'images/family/debian-11'])
              }
          }],
          'networkInterfaces': [{
              'network': '$(ref.a-new-network.selfLink)',
              'accessConfigs': [{
                  'name': 'External NAT',
                  'type': 'ONE_TO_ONE_NAT'
              }]
          }]
      }
  }]
  return {'resources': resources}

Apri il secondo modello, vm-template-2.py, che definisce la seconda VM:

# 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.

"""Creates the virtual machine."""

COMPUTE_URL_BASE = 'https://www.googleapis.com/compute/v1/'

def GenerateConfig(unused_context):
  """Creates the second virtual machine."""

  resources = [{
      'name': 'the-second-vm',
      'type': 'compute.v1.instance',
      'properties': {
          'zone': 'us-central1-f',
          'machineType': ''.join([COMPUTE_URL_BASE, 'projects/MY_PROJECT',
                                  '/zones/us-central1-f/',
                                  'machineTypes/g1-small']),
          'disks': [{
              'deviceName': 'boot',
              'type': 'PERSISTENT',
              'boot': True,
              'autoDelete': True,
              'initializeParams': {
                  'sourceImage': ''.join([COMPUTE_URL_BASE, 'projects/',
                                          'debian-cloud/global',
                                          '/images/family/debian-11'])
              }
          }],
          'networkInterfaces': [{
              'network': '$(ref.a-new-network.selfLink)',
              'accessConfigs': [{
                  'name': 'External NAT',
                  'type': 'ONE_TO_ONE_NAT'
              }]
          }]
      }
  }]
  return {'resources': resources}

In entrambi i modelli, sostituisci MY_PROJECT con il tuo ID progetto.

Importazione di modelli

Dopo aver creato i modelli, devi importarli nella tua configurazione. Apri il nuovo two-vms.yaml:

cd deploymentmanager-samples/examples/v2/step_by_step_guide/step5_create_a_template/python

nano two-vms.yaml  # use your preferred text editor

Questo file di configurazione ha una nuova sezione imports che chiama i due modelli di VM vm-template.py e vm-template-2.py:

# 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.

imports:
- path: vm-template.py
- path: vm-template-2.py

# In the resources section below, the properties of the resources are replaced
# with the names of the templates.
resources:
- name: vm-1
  type: vm-template.py
- name: vm-2
  type: vm-template-2.py
- name: a-new-network
  type: compute.v1.network
  properties:
    routingConfig:
      routingMode: REGIONAL
    autoCreateSubnetworks: true

Una nota sui nomi delle risorse

Quando utilizzi un modello, i nomi delle risorse vengono definiti utilizzando il campo name fornito nel modello, non il nome nel file di configurazione.

Ad esempio, in questo caso, le istanze VM vengono create utilizzando i nomi nei modelli, the-first-vm e the-second-vm. I valori vm-1 e vm-2, definiti nella configurazione, vengono utilizzati per denominare un'istanza del modello, ma non sono nomi di risorse.

È in corso il salvataggio della configurazione e il relativo deployment

Per eseguire il deployment della configurazione, esegui questo comando:

gcloud deployment-manager deployments create deployment-with-templates --config two-vms.yaml

Per visualizzare il deployment, esegui questo comando:

gcloud deployment-manager deployments describe deployment-with-templates

Prospettive future: uso di più modelli

Nel passaggio successivo, combini i modelli in modo che la configurazione chiami solo un modello per il deployment di tutte le risorse.

Eliminazione del deployment

Prima di procedere, ti consigliamo di eliminare il deployment per evitare addebiti. Non hai bisogno di questo deployment per il passaggio successivo. Esegui questo comando per eliminare il deployment:

gcloud deployment-manager deployments delete deployment-with-templates