ヘルパースクリプトの探索

ヘルパースクリプトまたはテンプレートモジュールは、特定の関数を実行してテンプレートを効率的に処理するヘルパーファイルです。たとえば、ヘルパースクリプトを使用すると、リソースのメタデータの解釈、ファイルの作成、サービスの起動を行うことができます。

ここでは、接頭辞と接尾辞を使用して仮想マシンに名前を付ける Python ヘルパースクリプトについて説明します。

始める前に

このガイドのコマンドラインの例を使用する場合、gcloud コマンドラインツールをインストールします。
このガイドの API の例を使用する場合は、API アクセスを設定します。

ヘルパースクリプトを開く

この例の基本ヘルパースクリプトは、仮想マシン（VM）の名前を生成します。スクリプトを表示するには、次のコマンドを実行します。

cd deploymentmanager-samples/examples/v2/step_by_step_guide/create_a_helper_script

nano common.py  # use your preferred text editor

GenerateMachineName() 関数は接頭辞と接尾辞を取得して、prefix-suffix という形式の名前を生成します。

"""Generates name of a VM."""


def GenerateMachineName(prefix, suffix):
  return prefix + "-" + suffix

テンプレートでのヘルパースクリプトの使用

vm-template.py で common.py を使用するには、テンプレートにいくつかの変更を行う必要があります。

変更を表示するには、vm-template.py を開きます。

nano vm-template.py

テンプレートのコード部分で、変更箇所が強調表示されています。

このテンプレートは、ファイルの先頭で common.py をインポートします。resources セクションで、VM の name フィールドが GenerateMachineName() を呼び出しています。

"""Creates the virtual machine."""

# `common.py` is imported below.
import common

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


def GenerateConfig(context):
  """Generates configuration of a VM."""
  resources = [{
      'name': common.GenerateMachineName('myfrontend', 'prod'),
      'type': 'compute.v1.instance',
      'properties': {
          'zone': 'us-central1-f',
          'machineType': COMPUTE_URL_BASE + 'projects/' + context.env['project']
                         + '/zones/us-central1-f/machineTypes/f1-micro',
          'disks': [{
              'deviceName': 'boot',
              'type': 'PERSISTENT',
              'boot': True,
              'autoDelete': True,
              'initializeParams': {
                  'sourceImage': COMPUTE_URL_BASE + 'projects/'
                                 'debian-cloud/global/images/family/debian-11'}
          }],
          'networkInterfaces': [{
              'network': COMPUTE_URL_BASE + 'projects/' + context.env['project']
                         + '/global/networks/default',
              'accessConfigs': [{
                  'name': 'External NAT',
                  'type': 'ONE_TO_ONE_NAT'
              }]
          }]
      }
  }]
  return {'resources': resources}

構成の変更の表示

更新された構成を表示するには、two-vms.yaml を開きます。

nano two-vms.yaml

また、ヘルパースクリプト common.py を構成にインポートする必要があります。

構成をデプロイします。

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

生成された名前を持つリソースを含むデプロイを表示するには、次のコマンドを実行します。

 gcloud deployment-manager deployments describe deployment-with-helper-script

デプロイの削除

費用の発生を防ぐため、デプロイを削除することをおすすめします。このデプロイは次のステップで必要ありません。次のコマンドを実行して、デプロイを削除します。

gcloud deployment-manager deployments delete deployment-with-helper-script

次のステップ: デプロイの更新

アプリの進化に合わせて、デプロイ内のリソースのプロパティを追加、削除、変更する方法について学習します。

テンプレートプロパティの理解と環境変数の使用

デプロイメントの更新

ヘルパー スクリプトの探索