Compreender os modelos reutilizáveis

Ao desenvolver uma app, é muito provável que precise de arquiteturas complexas. Para facilitar a replicação e a resolução de problemas da implementação, recomendamos que divida a configuração em modelos.

Um modelo é um ficheiro separado que define um conjunto de recursos. Pode reutilizar modelos em diferentes implementações, o que cria consistência em implementações complexas.

Pode usar Python ou Jinja2 para criar modelos para o Deployment Manager. Recomendamos que use modelos Python, porque o Python permite uma maior flexibilidade e mais funcionalidades à medida que expande a sua app.

Modelos Python

Se optar por escrever modelos em Python, os seus modelos têm de cumprir estes requisitos:

  • O modelo tem de ser escrito em Python 3.x

  • O modelo tem de definir um método denominado GenerateConfig(context) ou generate_config(context). Se usar ambos os nomes de métodos no mesmo modelo, o método generate_config() tem prioridade.

    O objeto context contém metadados sobre a implementação e o seu ambiente, como o nome da implementação, o projeto atual, etc. Vai usar estas variáveis específicas da implementação nos passos posteriores.

  • O método tem de devolver um dicionário Python.

Examinar modelos de exemplo

No repositório de amostras, abra 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

Este modelo define a primeira máquina virtual (VM) dos exemplos anteriores:

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

Abra o segundo modelo, vm-template-2.py, que define a segunda 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}

Em ambos os modelos, substitua MY_PROJECT pelo ID do seu projeto.

Importar modelos

Depois de criar modelos, tem de os importar para a sua configuração. Abra o novo 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

Este ficheiro de configuração tem uma nova secção imports que chama os dois modelos de 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

Uma nota sobre os nomes de recursos

Quando usa um modelo, os nomes dos recursos são definidos através do campo name fornecido no modelo e não do nome no ficheiro de configuração.

Por exemplo, neste caso, as instâncias de VM são criadas com os nomes nos modelos, the-first-vm e the-second-vm. Os valores vm-1 e vm-2, definidos na configuração, são usados para dar um nome a uma instanciação do modelo, mas não são nomes de recursos.

Guardar a configuração e implementá-la

Para implementar a configuração, execute este comando:

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

Para ver a sua implementação, execute este comando:

gcloud deployment-manager deployments describe deployment-with-templates

Olhando para o futuro: usar vários modelos

No passo seguinte, combine modelos para que a sua configuração chame apenas um modelo para implementar todos os seus recursos.

Eliminar a implementação

Antes de continuar, recomendamos que elimine a implementação para evitar custos. Não precisa desta implementação para o passo seguinte. Execute o seguinte comando para eliminar a implementação:

gcloud deployment-manager deployments delete deployment-with-templates