アプリケーション テンプレートを設計する

管理者は、各開発チームが推奨するアーキテクチャを使用できるように、アプリケーション テンプレートを作成します。これにより、デベロッパーがアプリケーションのデプロイで使用するリソースと構成を管理できます。

アプリ テンプレートを作成すると、スペース内の他のユーザーがアクセスできるようになります。テンプレートをカタログに追加して、他のスペースと共有することもできます。

デベロッパーは、このテンプレートを使用してアプリケーションを作成してデプロイできます。デベロッパーは、アプリケーションを作成する際に、テンプレートから各コンポーネントを構成できますが、コンポーネントを追加または削除することはできません。このテンプレートは Terraform コードを生成します。開発者は、App Design Center からこのコードをダウンロードまたはデプロイできます。

このドキュメントでは、App Design Center を使用してアプリケーション テンプレートを設計、構成、共有する方法について説明します。

始める前に

アプリ対応フォルダまたは管理プロジェクトに、次のいずれかのロールが必要です。

  • App Design Center 管理者(roles/designcenter.admin
  • App Design Center ユーザー(roles/designcenter.user

アプリケーション テンプレートを作成する

アプリケーション テンプレートを作成して、アーキテクチャ設計を開発チームと共有します。テンプレートのデザインには、次のコンポーネントを追加できます。

  • アセット: 他のリソースの制御に役立つ上位レベルのリソース。たとえば、サービス アカウントなどです。

  • サービス: ネットワーク経由で使用されるネットワーク インターフェースまたは API インターフェース。たとえば、Cloud Storage や Vertex AI などがあります。

  • ワークロード: ビジネス機能を実行するバイナリ デプロイ。例としては、Cloud Run や Compute Engine などがあります。

次のコンポーネントから選択できます。

テンプレートを設計すると、App Design Center は設計と構成の詳細を反映する Terraform コードを生成します。

テンプレートの詳細を指定する

テンプレートの詳細を指定すると、テンプレートを分類して、デベロッパーがテンプレートを使用するかどうかを判断するのに役立ちます。

テンプレートの詳細を入力する手順は次のとおりです。

デザイン キャンバス

  1. ナビゲーション メニューで [テンプレート] をクリックします。

    [テンプレート] に移動

  2. [テンプレートを作成] をクリックします。

  3. [テンプレート ID] フィールドに、テンプレートの一意の識別子を入力します。このフィールドは必須です。

  4. [テンプレート名] フィールドに、 Google Cloud コンソールに表示する人間が読める識別子を入力します。

    名前を指定しない場合、テンプレート ID がこのフィールドにコピーされます。

  5. [説明] フィールドに、アプリの目的の簡単な説明を入力します。

  6. [テンプレートを作成] をクリックします。デザイン キャンバスが表示されます。

gcloud CLI

新しいアプリケーション テンプレートを作成します。

gcloud design-center spaces application-templates create APPLICATION_TEMPLATE \
--project=PROJECT \
--location=LOCATION \
--space=SPACE \
--display-name=DISPLAY_NAME \
--description=DESCRIPTION

次のように置き換えます。

  • APPLICATION_TEMPLATE: 作成するアプリケーション テンプレートのテンプレート ID。
  • PROJECT: 管理プロジェクト ID。
  • LOCATION: アプリケーション テンプレートのリージョン。
  • SPACE: スペース ID。
  • DISPLAY_NAME: Google Cloud コンソールに表示する名前。
  • DESCRIPTION: 簡単な説明。

詳細については、gcloud design-center spaces application-templates create をご覧ください。

テンプレートを設計する

デザイン キャンバスでコンポーネントを追加して接続し、テンプレートをデザインします。次の例には、3 つの接続コンポーネントが含まれています。

デザイン キャンバスに表示された 3 層ウェブ アプリケーション。このアプリケーションには、フロントエンド、バックエンド、データベースのコンポーネントが含まれています。

次の開始点にコンポーネントを追加して、テンプレートを設計できます。

テンプレートを設計する手順は次のとおりです。

デザイン キャンバス

  1. デザイン キャンバスで、[デザイン] が選択されていることを確認します。

  2. 始めるには、次のいずれかの操作を行います。

    • 最初から作成するには、[コンポーネント] 領域でコンポーネントをクリックして、キャンバス領域に追加します。

    • Google 提供のテンプレートから始めるには、テンプレート名をクリックします。

    • 自然言語チャットを使用してテンプレートを生成するには、[Gemini を使用したカスタム アプリケーション] をクリックします。

  3. コンポーネント間の通信チャネルを作成するには、次のいずれかを行います。

    • キャンバス上の 2 つのコンポーネントを接続するには、コンポーネントの青い点から別のコンポーネントの青い点までドラッグします。

    • 既存のコンポーネントに追加するには、 [追加] をクリックして、追加するコンポーネントを選択します。

    接続の詳細については、各サポートされているリソースの構成ドキュメントをご覧ください。

  4. コンポーネントまたは接続を削除する手順は次のとおりです。

    1. キャンバスで、コンポーネントまたは接続をクリックします。

    2. [構成] 領域で、[削除] をクリックします。

    3. フィールドに「delete」と入力します。

    4. [削除] をクリックします。

gcloud CLI

  1. テンプレートに追加する Google カタログ コンポーネントのテンプレート リビジョン URI を特定します。

    gcloud design-center spaces shared-templates list \
    --google-catalog \
    --location=us-central1
    

    詳細については、gcloud design-center spaces shared-templates list をご覧ください。

  2. アプリケーション テンプレートにコンポーネントを追加します。

    gcloud design-center spaces application-templates components create COMPONENT \
    --project=PROJECT \
    --location=LOCATION \
    --space=SPACE \
    --application-template=APPLICATION_TEMPLATE \
    --shared-template-revision-uri=SHARED_TEMPLATE_URI
    

    次のように置き換えます。

    • COMPONENT: テンプレートに追加するコンポーネントのコンポーネント ID。
    • PROJECT: 管理プロジェクト ID。
    • LOCATION: アプリケーション テンプレートのリージョン。
    • SPACE: スペース ID。
    • APPLICATION_TEMPLATE: コンポーネントを追加するアプリケーション テンプレートのテンプレート ID。
    • SHARED_TEMPLATE_URI: コンポーネントの共有テンプレート URI。例: projects/my-project/locations/us-central1/spaces/my-space/sharedTemplates/my-shared-template/revisions/rev1

    詳細については、gcloud design-center spaces application-templates components create をご覧ください。

  3. テンプレートに 2 つ目のコンポーネントを追加します。

    gcloud design-center spaces application-templates components create COMPONENT_2 \
    --project=PROJECT \
    --location=LOCATION \
    --space=SPACE \
    --application-template=APPLICATION_TEMPLATE \
    --shared-template-revision-uri=SHARED_TEMPLATE_URI_2
    

    次のように置き換えます。

    • COMPONENT_2: テンプレートに追加する 2 番目のコンポーネントのコンポーネント ID。
    • PROJECT: 管理プロジェクト ID。
    • LOCATION: アプリケーション テンプレートのリージョン。
    • SPACE: スペース ID。
    • APPLICATION_TEMPLATE: コンポーネントを追加するアプリケーション テンプレートのテンプレート ID。
    • SHARED_TEMPLATE_URI_2: 2 番目のコンポーネントの共有テンプレート URI。例: projects/my-project/locations/us-central1/spaces/my-space/sharedTemplates/my-shared-template/revisions/rev1

    詳細については、gcloud design-center spaces application-templates components create をご覧ください。

  4. 2 つのコンポーネント間に接続を作成します。

    gcloud design-center spaces application-templates components connections create CONNECTION \
    --project=PROJECT \
    --location=LOCATION \
    --space=SPACE \
    --application-template=APPLICATION_TEMPLATE \
    --component=COMPONENT \
    --destination-component-uri=COMPONENT_2
    

    次のように置き換えます。

    • CONNECTION: テンプレートに追加する接続の接続 ID。
    • PROJECT: 管理プロジェクト ID。
    • LOCATION: アプリケーション テンプレートのリージョン。
    • SPACE: スペース ID。
    • APPLICATION_TEMPLATE: 接続を追加するアプリケーション テンプレートのテンプレート ID。
    • COMPONENT: ソース コンポーネント ID。
    • COMPONENT_2: 宛先コンポーネント ID。

    詳細については、gcloud design-center spaces application-templates components connections create をご覧ください。

コンポーネントのデフォルト値を構成する

キャンバスに追加するコンポーネントごとに、リソースが作成されるプロジェクトや、デプロイされるロケーションなどの構成の詳細を指定できます。構成の詳細を指定すると、Application Design Center はそれらをアプリケーションのデフォルト値として使用します。

デフォルトの構成が要件を満たしていない場合は、接続の詳細を変更することもできます。たとえば、環境変数キー名を変更したり、接続ポートを変更したり、サービス アカウントに追加のロールを追加したりできます。

デベロッパーは、アプリケーションをデプロイする前に、テンプレートで構成したデフォルト値を表示して変更できます。デベロッパーは、サポートされているリソースごとに必要な詳細情報を構成する必要があります。

コンポーネントと接続を構成する手順は次のとおりです。

デザイン キャンバス

  1. デザイン キャンバスで、コンポーネントをクリックします。

  2. [構成] 領域の [プロジェクト ID] リストで、リソースをデプロイするプロジェクトを選択します。次の条件を満たすプロジェクトを選択します。

  3. リソースの追加設定を構成します。たとえば、Cloud SQL の場合は次のように構成できます。

    • 地域
    • バックアップ構成
    • データベース フラグ
    • IP 構成

    各コンポーネントの構成ドキュメントへのリンクについては、サポートされているリソースをご覧ください。

  4. デザイン キャンバスでコンポーネントを接続すると、デフォルトの構成値を使用して接続が作成されます。接続の詳細を追加または変更する手順は次のとおりです。

    1. デザイン キャンバスで、2 つのコンポーネント間の接続をクリックします。[接続] パネルが開き、接続パラメータが表示されます。

    2. 次のいずれかを行います。

      • 既存の接続パラメータを変更するには、[編集] をクリックします。

      • 新しい接続パラメータを追加するには、[パラメータを追加] をクリックします。

    3. [キー] フィールドと [] フィールドを更新します。たとえば、次の詳細を変更できます。

      • アプリケーションの要件に沿った環境変数キー名。
      • 接続ポートの値。
      • サービス アカウントに追加されたロール。
  5. [保存] をクリックします。

gcloud CLI

  1. アプリケーション テンプレートの各コンポーネントの説明を表示して、コンポーネント パラメータを表示します。

     gcloud design-center spaces application-templates components describe COMPONENT \
     --project=PROJECT \
     --location=LOCATION \
     --space=SPACE \
     --application-template=APPLICATION_TEMPLATE
    

    次のように置き換えます。

    • COMPONENT: 説明を取得するコンポーネントのコンポーネント ID。
    • PROJECT: 管理プロジェクト ID。
    • LOCATION: アプリケーション テンプレートのリージョン。
    • SPACE: スペース ID。
    • APPLICATION_TEMPLATE: アプリケーション テンプレートのテンプレート ID。

    詳細については、gcloud design-center spaces application-templates components describe をご覧ください。

  2. 変更するコンポーネントごとに、ホーム ディレクトリにパラメータ値を含む JSON ファイルを作成します。

    たとえば、Cloud Run コンポーネント用に次のファイルを作成できます。

      [
          {
            "key": "service_name",
            "value": "frontend-service"
          },
          {
            "key": "project_id",
            "value": "DEPLOYMENT_PROJECT"
          }
      ]
    
  3. アプリケーション テンプレートの各コンポーネントを更新して、必要なパラメータを構成します。

     gcloud design-center spaces application-templates components update COMPONENT \
     --project=PROJECT \
     --location=LOCATION \
     --space=SPACE \
     --parameters=PARAMETERS_FILE_PATH_1 \
     --application-template=APPLICATION_TEMPLATE
    

    次のように置き換えます。

    • COMPONENT: 更新するコンポーネントのコンポーネント ID。
    • PROJECT: 管理プロジェクト ID。
    • LOCATION: アプリケーション テンプレートのリージョン。
    • SPACE: スペース ID。
    • PARAMETERS_FILE_PATH_1: コンポーネント パラメータを含む JSON ファイル。
    • APPLICATION_TEMPLATE: アプリケーション テンプレートのテンプレート ID。

    詳細については、gcloud design-center spaces application-templates components update をご覧ください。

  4. コンポーネントの接続を説明します。

     gcloud design-center spaces application-templates components connections describe CONNECTION \
     --component=COMPONENT \
     --application-template=APPLICATION_TEMPLATE \
     --project=PROJECT \
     --location=LOCATION \
     --space=SPACE
    

    次のように置き換えます。

    • CONNECTION: 接続 ID。
    • COMPONENT: コンポーネント ID。
    • APPLICATION_TEMPLATE: テンプレート ID。
    • PROJECT: 管理プロジェクト ID。
    • LOCATION: アプリケーション テンプレートのリージョン。
    • SPACE: スペース ID。

    詳細については、gcloud design-center spaces application-templates components connections describe をご覧ください。

  5. コンポーネント接続パラメータを編集します。

     gcloud design-center spaces application-templates components connections update CONNECTION \
     --component=COMPONENT \
     --application-template=APPLICATION_TEMPLATE \
     --project=PROJECT \
     --location=LOCATION \
     --space=SPACE \
     --source-component-parameters='[{"key": SOURCE_KEY, "value": SOURCE_VALUE}]'
    

    次のように置き換えます。

    • CONNECTION: 接続 ID。
    • COMPONENT: コンポーネント ID。
    • APPLICATION_TEMPLATE: テンプレート ID。
    • PROJECT: 管理プロジェクト ID。
    • LOCATION: アプリケーション テンプレートのリージョン。
    • SPACE: スペース ID。
    • SOURCE_KEY: 新しいパラメータ キー。
    • SOURCE_VALUE: 新しいパラメータ値。

    詳細については、gcloud design-center spaces application-templates components connections update をご覧ください。

Terraform コードを編集する

アプリケーション テンプレートを設計すると、App Design Center は設計と構成の詳細を反映する Terraform コードを生成します。Terraform を編集して、コンポーネント構成の詳細を指定できます。

システムは次の Terraform ファイルを生成します。

  • main.tf: テンプレート内の各コンポーネントのモジュールを含むインフラストラクチャ コード。
  • outputs.tf: デプロイされたインフラストラクチャ コンポーネントに関する情報を公開します。
  • variables.tf: main.tf ファイルで使用される変数の名前、型、説明を宣言します。
  • input.tfvars: main.tf ファイルで使用される変数の値を定義します。
  • providers.tf: Terraform が Google Cloud API とリソースを操作するのに役立つラベルを定義します。

背景情報については、Google Cloudでの Terraform の概要をご覧ください。

Terraform コードを編集する手順は次のとおりです。

  1. デザイン キャンバスで、[コード] をクリックします。生成された Terraform ファイルが表示されます。

  2. [main.tf] をクリックします。システムに、各コンポーネントの Terraform モジュールが表示されます。

  3. 構成の詳細を編集します。詳細については、各サポートされているリソースの構成ドキュメントをご覧ください。

    システムは編集内容を自動的に検証し、無効な編集内容がある場合はエラーを表示します。

  4. 編集内容をハイライト表示して比較する手順は次のとおりです。

    1. [差分を表示] をクリックします。

    2. 変更を元に戻すには、余白で [変更を元に戻すにはここをクリック] をクリックします。

    3. [差分を表示] をクリックして、比較ビューを閉じます。

  5. 編集内容を保存するには、[コードの変更を保存] をクリックします。

  6. 変更を確認する手順は次のとおりです。

    1. [デザイン] をクリックします。
    2. コンポーネントをクリックして、構成の詳細を確認します。

テンプレートを削除する

不要になったテンプレートは削除できます。

デザイン キャンバス

  1. デザイン キャンバスで、 [アクション] をクリックします。
  2. [削除] をクリックします。

gcloud CLI

アプリケーション テンプレートを削除します。

```sh
gcloud design-center spaces application-templates delete APPLICATION_TEMPLATE \
--project=PROJECT \
--location=LOCATION \
--space=SPACE
```

次のように置き換えます。

  • APPLICATION_TEMPLATE: 削除するアプリケーション テンプレートのテンプレート ID。
  • PROJECT: 管理プロジェクト ID。
  • LOCATION: アプリケーション テンプレートのリージョン。
  • SPACE: スペース ID。

詳細については、gcloud design-center spaces application-templates delete をご覧ください。

テンプレートを確認する

テンプレートをデベロッパーと共有する前に、テンプレートが意図したとおりに機能することを確認してください。テンプレートを確認する手順は次のとおりです。

  1. 次の設定でアプリケーションを作成します。
    1. [環境] リストで [TEST] を選択します。
    2. [重要度] リストで [] を選択します。
  2. アプリケーションをデプロイします。デプロイの手順については、コンソールからアプリケーションをデプロイするをご覧ください。
  3. インフラストラクチャをテストして、要件を満たしていることを確認します。
  4. 繰り返し費用が発生しないようにするには、テスト デプロイを削除します。

テンプレートをカタログに共有する

テンプレートを検証したら、テンプレートをカタログに公開できます。このテンプレートは、カタログが共有されているスペースにアクセスできるアプリケーション デベロッパーが使用できます。

  1. デザイン キャンバスで、[カタログに追加] をクリックします。
  2. カタログが共有されているスペースを管理するには、カタログを管理するをご覧ください。

テンプレートを修正して再共有する

アプリケーションの経験を積み、ビジネスニーズが進化するにつれて、アプリケーション テンプレートの更新が必要になることがあります。たとえば、キャッシュ保存用の Memorystore サービスを追加して、バックエンド サービスのパフォーマンスを向上させる場合があります。

テンプレートを変更すると、テンプレート リビジョンが作成されます。既存のアプリケーションに変更を適用するには、デベロッパーがリビジョンを使用してアプリケーションをデプロイする必要があります。

App Design Center では、テンプレート リビジョンがカタログに自動的に公開されることはありません。最新のリビジョンを共有するには、テンプレートをカタログに再度公開します。

新しいリビジョンを作成する手順は次のとおりです。

  1. ナビゲーション メニューで [テンプレート] をクリックします。

    [テンプレート] に移動

  2. 修正するアプリケーション テンプレートを選択します。キャンバスが開きます。

  3. 新しい要件に合わせてテンプレートを変更します。たとえば、新しいコンポーネントを追加して構成します。

  4. 最新のリビジョンを他のスペースと共有するには、関連するカタログにテンプレートを再度追加します。

次のステップ