IaC設定

# IaC設定

### はじめに

Infrastructure as Code（IaC）設定では、Catalystコンソールからプロジェクトのエクスポートとインポートを簡単に実行できます。{{%link href="/ja/getting-started/catalyst-projects" %}}Catalystプロジェクト{{%/link%}}のスキーマ（コンポーネントの構成やコードを含む）を外部ZIPファイルとしてエクスポートできます。このZIPファイルを新しいプロジェクトとして任意のCatalystアカウントにインポートできます。ZIPファイルはプロジェクトのエクスポート時に特定の形式で作成され、この形式でのみインポートできます。

プロジェクトのエクスポートとインポート機能により、データセンター間またはCatalystアカウント間でプロジェクトを簡単に転送できます。また、GitHubリポジトリなどの外部環境からプロジェクトに簡単にアクセスしてテストすることもできます。Catalystプロジェクトのコンポーネントを含むGitリポジトリをクローンし、ZIPファイルを生成してインポートし、プロジェクトをテストするだけです。CIシステムなどのリモートシステムからこれらのアクションを実行したり、スクリプトを作成してこれらのタスクを自動化したりすることもできます。この機能を使用すると、既存のプロジェクトを簡単に複製し、さまざまなユースケース用にブランチすることもできます。

IaCプロジェクトのエクスポートとインポート機能は、Catalystコンソールの_{{%bold%}}General settings{{%/bold%}}_からアクセスできます。

{{%note%}}{{%bold%}}注:{{%/bold%}} これらのIaC操作はCLIからも実行できます。CLIでは、プロジェクトをローカルディレクトリにエクスポートしたり、リモートコンソールやローカル環境に新しいプロジェクトをインポートしたり、任意のプロジェクトのインポート可能なZIPファイルを生成したりできます。詳細は{{%link href="/ja/cli/v1/export-and-import-projects/introduction/" %}}CLIエクスポートとインポートヘルプドキュメント{{%/link%}}を参照してください。{{%/note%}}

### エクスポート/インポートZIPファイル形式とは？

IaC操作では、データなしでプロジェクトの構成をエクスポートおよびインポートできます。Data Storeテーブルのレコード、アプリケーションのユーザーリスト、File StoreのファイルなどのデータはZIPファイルに含まれません。ただし、Data Storeの各テーブルのメタデータやFile Storeのフォルダ構造は含まれます。これはすべての機能で同様です。

ZIPファイルには、すべての{{%link href="/ja/serverless/help/functions/introduction/" %}}関数{{%/link%}}とクライアントコンポーネントのコードが{{%link href="/ja/cli/v1/project-directory-structure/introduction/" %}}それぞれのディレクトリ{{%/link%}}に含まれます。

プロジェクトのエクスポート時に生成されるZIPファイルの構造を以下に示します:

* {{%bold%}}関数ディレクトリのZIPファイル:{{%/bold%}} 標準構造のプロジェクトの{{%badge%}}{{%link href="/ja/cli/v1/project-directory-structure/functions-directory/" %}}functionsディレクトリ{{%/link%}}{{%/badge%}}。プロジェクトで作成されたすべての関数が、構成ファイルとSDKコンポーネントとともに個別のZIPファイルとしてこのディレクトリに存在します。
* {{%bold%}}クライアントディレクトリのZIPファイル:{{%/bold%}} 標準構造のプロジェクトの{{%badge%}}{{%link href="/ja/cli/v1/project-directory-structure/client-directory/" %}}webclientディレクトリ{{%/link%}}{{%/badge%}}。プロジェクトで初期化されたWebクライアントが、すべてのクライアントファイルとともにZIPファイルとしてこのフォルダに存在します。
* {{%bold%}}Project-Template JSONファイル:{{%/bold%}} プロジェクトのコンポーネント構成が1つのJSONファイルに含まれます。JSONファイルには、プロジェクト設定とコンポーネント定義が含まれます。これには、Data StoreとFile Storeのメタデータ、Cacheセグメント、Cronジョブ、Circuit構成、セキュリティルール、メールドメインとアドレス、Event Listenersとルール、API GatewayのAPI、メールテンプレート、ユーザープロファイルなどが含まれます。

サンプルproject-template JSONの抜粋を以下に示します:

{{%code class="language-json line-numbers"%}}{
  "name" : "project-template",
  "version" : "1.0.0",
  "parameters" : { },
  "components" : {
    "Circuits" : [ {
      "type" : "circuit",
      "name" : "InvoiceGen",
      "properties" : {
        "name" : "InvoiceGen",
        "states" : {
          "State1" : {
            "next" : "End",
            "start" : true,
            "type" : "pass"
          }
        }
      },
      "dependsOn" : [ ]
    } ],
    "Functions" : [ {
      "type" : "function",
      "name" : "warehouseportal",
      "properties" : {
        "stack" : "node14",
        "code" : {
          "path" : "functions/warehouseportal.zip"
        },
        "configuration" : {
          "memory" : 256
        },
        "type" : "basicio",
        "name" : "warehouseportal"
      },
      "dependsOn" : [ ]
    }
 ],
    "WebClient" : [ {
      "type" : "client",
      "name" : "warehousePortal",
      "properties" : {
        "app_name" : "warehousePortal",
        "code" : {
          "path" : "webclient/warehousePortal.zip"
        }
      },
      "dependsOn" : [ ]
    } ],
    "Cron" : [ {
      "type" : "cron",
      "name" : "dailyBackup",
      "properties" : {
        "cron_url_details" : {
          "headers" : { },
          "request_body" : "",
          "request_method" : "POST",
          "params" : { },
          "url" : "https://catalyst.zoho.com/help/index.html"
        },
        "end_time" : -1,
        "description" : "",
        "cron_name" : "dailyBackup",
        "job_detail" : {
          "hour" : 1,
          "timezone" : "America/Los_Angeles",
          "minute" : 0,
          "second" : 0,
          "repetition_type" : "Daily"
        },
        "cron_type" : "Calendar",
        "status" : true
      },
      "dependsOn" : [ ]
    } ],
    "Datastore" : [ {
      "type" : "table",
      "name" : "InventoryDB",
      "properties" : {
        "table_name" : "InventoryDB"
      },
      "dependsOn" : [ ]
    }, {
      "type" : "column",
      "name" : "InventoryDB-ProductID",
      "properties" : {
        "decimal_digits" : 2,
        "column_name" : "ProductID",
        "data_type" : "int",
        "is_unique" : false,
        "is_mandatory" : false,
        "search_index_enabled" : false,
        "table_id" : "InventoryDB",
        "table_name" : "InventoryDB",
        "max_length" : 10
      },
      "dependsOn" : [ "Datastore.table.InventoryDB" ]
    },
{
      "type" : "tableScope",
      "name" : "InventoryDB-App Administrator",
      "properties" : {
        "role_name" : "App Administrator",
        "table_scope" : "GLOBAL",
        "type" : "App Administrator",
        "table_name" : "InventoryDB"
      },
      "dependsOn" : [ "Datastore.table.InventoryDB" ]
    }, {
      "type" : "tableScope",
      "name" : "InventoryDB-App User",
      "properties" : {
        "role_name" : "App User",
        "table_scope" : "GLOBAL",
        "type" : "App User",
        "table_name" : "InventoryDB"
      },
      "dependsOn" : [ "Datastore.table.InventoryDB" ]
    }, {
      "type" : "tablePermission",
      "name" : "InventoryDB-App Administrator",
      "properties" : {
        "role_name" : "App Administrator",
        "type" : "App Administrator",
        "table_permissions" : [ "SELECT", "UPDATE", "INSERT", "DELETE" ],
        "table_name" : "InventoryDB"
      },
      "dependsOn" : [ "Datastore.table.InventoryDB" ]
    }, {
      "type" : "tablePermission",
      "name" : "InventoryDB-App User",
      "properties" : {
        "role_name" : "App User",
        "type" : "App User",
        "table_permissions" : [ "SELECT" ],
        "table_name" : "InventoryDB"
      },
      "dependsOn" : [ "Datastore.table.InventoryDB" ]
    }]
}
}{{%/code%}}

{{%note%}}{{%bold%}}注:{{%/bold%}} ZIPファイルにproject-template JSONファイルが含まれていない場合、Catalystはプロジェクトをインポートできません。これはプロジェクトの設定を定義する必須ファイルです。{{%/note%}}

### プロジェクトをエクスポートするには？

_General Settings_セクションから任意のプロジェクトをエクスポートできます。これらはCatalystアカウント全体に適用される共通設定です。

Catalystは、すべてのコンポーネント定義とプロジェクト設定をproject-template JSONファイルに書き込みます。コンポーネントが構成されていない場合は、デフォルトの構成がJSONファイルに書き込まれます。

{{%note%}}{{%bold%}}注:{{%/bold%}} ローカル環境でプロジェクトを操作した場合は、コンソールからプロジェクトをエクスポートする前に、CLIを使用して更新されたコードやセットアップをリモートコンソールにデプロイしてください。{{%/note%}}

プロジェクトの{{%link href="/ja/deployment-and-billing/environments/introduction/"%}}開発環境または本番環境{{%/link%}}からプロジェクトをエクスポートできます（本番環境が有効になっている場合）。エクスポートが完了すると、生成されたZIPファイルをダウンロードできます。このZIPファイルをそのまま、別のアカウント、データセンター、またはプロジェクトの複製が必要な場合は同じアカウントの新しいプロジェクトとしてインポートできます。

{{%note%}}{{%bold%}}注:{{%/bold%}} ZIPファイルが生成された後、Catalystはダウンロード用にファイルを{{%bold%}}15日間{{%/bold%}}保存します。15日後にダウンロードリンクは無効になります。有効期限切れ後にダウンロード用の新しいZIPファイルを生成するには、プロジェクトを再エクスポートする必要があります。{{%/note%}}

プロジェクトをエクスポートするには:

1. _General Settings_の{{%bold%}}Infrastructure as Code{{%/bold%}}に移動し、{{%bold%}}IaC Exports{{%/bold%}}タブをクリックします。 
2. {{%bold%}}Export a Project{{%/bold%}}をクリックします。
3. ドロップダウンのプロジェクトリストからエクスポートするプロジェクトを選択します。Catalystアカウントのすべてのプロジェクトがここに表示されます。エクスポートするプロジェクトの環境を選択します。 
4. {{%bold%}}Export{{%/bold%}}をクリックします。

Catalystがプロジェクトのエクスポートプロセスを開始します。コンソールにエクスポートのステータスが表示されます。

エクスポートが初期化されると、{{%bold%}}Export ID{{%/bold%}}が自動的に生成されます。Export IDを使用して、{{%link href="/ja/cli/v1/export-and-import-projects/export-import-job-status/" %}}CLIからエクスポートジョブのステータスを確認{{%/link%}}できます。コンソールにはエクスポートの他の詳細も表示されます。エクスポートが完了すると、プロジェクトのZIPファイルをダウンロードできる{{%bold%}}Download ZIP{{%/bold%}}リンクが表示されます。

エクスポートプロセスに問題があり、Catalystがプロジェクトをエクスポートできなかった場合、コンソールに{{%bold%}}View Error Log{{%/bold%}}リンクが表示されます。

このリンクをクリックしてエラーの詳細を表示できます。エラーを解決し、プロジェクトを再度エクスポートできます。

#### プロジェクトを再エクスポートするには？

ZIPダウンロードリンクの有効期限が切れた場合やプロジェクトのコンポーネントやコードが更新された場合、以前エクスポートしたプロジェクトを再度エクスポートできます。

{{%note%}}{{%bold%}}注:{{%/bold%}}

* Catalystは常にプロジェクトの最新の定義とコードをエクスポートします。

* 以前エクスポートしたプロジェクトを再エクスポートすると、そのプロジェクトの最新のエクスポートの_Download ZIP_リンクのみが利用可能になります。これは、Catalystがプロジェクトの最新のエクスポートのみを保存し、以前のエクスポートは保存しないためです。
{{%/note%}}

以前エクスポートしたプロジェクトを再度エクスポートするには、エクスポートされたプロジェクトの省略記号アイコンをクリックし、{{%bold%}}Export Again{{%/bold%}}をクリックします。

前のセクションで説明したのと同じ方法でプロジェクトがエクスポートされます。{{%bold%}}Download ZIP{{%/bold%}}リンクから最新のエクスポートをダウンロードできます。

### プロジェクトをインポートするには？

IaCインポートオプションを使用すると、既存のプロジェクトZIPファイルから新しいCatalystプロジェクトをインポートできます。Catalystは、project-template JSONで指定された定義に基づいて各コンポーネントを構成します。関数とクライアントコードも、存在する場合はプロジェクトに入力されます。インポートジョブが完了すると、構成とコードが入力された新しいプロジェクトが利用可能になります。

{{%note%}}{{%bold%}}注:{{%/bold%}}

* プロジェクト定義、関数およびクライアントコードを含むソースZIPファイルは、インポートするために{{%link href="/ja/cli/v1/export-and-import-projects/export-import-zip-file/" %}}標準形式{{%/link%}}である必要があります。

* project-template JSONファイルはZIPファイルのルートに必ず存在する必要があります。このファイルなしではプロジェクトをインポートできません。{{%badge%}}functions{{%/badge%}}または{{%badge%}}webclient{{%/badge%}}ディレクトリは必須ではありません。

* {{%link href="/ja/deployment-and-billing/environments/development-environment" %}}本番環境{{%/link%}}に直接プロジェクトをインポートすることはできません。
{{%/note%}}

以下の方法で新しいプロジェクトをインポートできます:

1. _General Settings_の{{%bold%}}Infrastructure as Code{{%/bold%}}に移動します。 
2. _IaC Imports_セクションから{{%bold%}}Import New Project{{%/bold%}}をクリックします。
3. ポップアップウィンドウに新しいプロジェクトの名前を入力します。インポートするプロジェクトのソースZIPファイルを選択します。 
4. {{%bold%}}Import{{%/bold%}}をクリックします。

Catalystがプロジェクトのインポートプロセスを開始します。コンソールにプロセスのステータスが表示されます。

インポートが初期化されると、{{%bold%}}Import ID{{%/bold%}}が自動的に生成されます。Import IDを使用して、{{%link href="/ja/cli/v1/export-and-import-projects/export-import-job-status/" %}}CLIからインポートジョブのステータスを確認{{%/link%}}できます。コンソールにはインポートジョブの他の詳細も表示されます。

インポートが成功すると、ZIPファイルに基づいてコンポーネントが構成された新しいプロジェクトがコンソールに作成されます。コンソールにはインポートジョブの{{%bold%}}Access Project{{%/bold%}}リンクが表示されます。このリンクをクリックして新しいプロジェクトを開くことができます。

インポートプロセスに問題があり、Catalystがプロジェクトをインポートできなかった場合、コンソールに{{%bold%}}View Error Log{{%/bold%}}リンクが表示されます。

クリックしてエラーの詳細を表示できます。エラーを解決し、プロジェクトを再度インポートできます。

はじめに

Infrastructure as Code（IaC）設定では、Catalystコンソールからプロジェクトのエクスポートとインポートを簡単に実行できます。Catalystプロジェクトのスキーマ（コンポーネントの構成やコードを含む）を外部ZIPファイルとしてエクスポートできます。このZIPファイルを新しいプロジェクトとして任意のCatalystアカウントにインポートできます。ZIPファイルはプロジェクトのエクスポート時に特定の形式で作成され、この形式でのみインポートできます。

IaCプロジェクトのエクスポートとインポート機能は、Catalystコンソールの_General settings_からアクセスできます。

注: これらのIaC操作はCLIからも実行できます。CLIでは、プロジェクトをローカルディレクトリにエクスポートしたり、リモートコンソールやローカル環境に新しいプロジェクトをインポートしたり、任意のプロジェクトのインポート可能なZIPファイルを生成したりできます。詳細はCLIエクスポートとインポートヘルプドキュメントを参照してください。

エクスポート/インポートZIPファイル形式とは？

ZIPファイルには、すべての関数とクライアントコンポーネントのコードがそれぞれのディレクトリに含まれます。

プロジェクトのエクスポート時に生成されるZIPファイルの構造を以下に示します:

関数ディレクトリのZIPファイル: 標準構造のプロジェクトのfunctionsディレクトリ。プロジェクトで作成されたすべての関数が、構成ファイルとSDKコンポーネントとともに個別のZIPファイルとしてこのディレクトリに存在します。
クライアントディレクトリのZIPファイル: 標準構造のプロジェクトのwebclientディレクトリ。プロジェクトで初期化されたWebクライアントが、すべてのクライアントファイルとともにZIPファイルとしてこのフォルダに存在します。
Project-Template JSONファイル: プロジェクトのコンポーネント構成が1つのJSONファイルに含まれます。JSONファイルには、プロジェクト設定とコンポーネント定義が含まれます。これには、Data StoreとFile Storeのメタデータ、Cacheセグメント、Cronジョブ、Circuit構成、セキュリティルール、メールドメインとアドレス、Event Listenersとルール、API GatewayのAPI、メールテンプレート、ユーザープロファイルなどが含まれます。

サンプルproject-template JSONの抜粋を以下に示します:

copy

         {
  "name" : "project-template",
  "version" : "1.0.0",
  "parameters" : { },
  "components" : {
    "Circuits" : [ {
      "type" : "circuit",
      "name" : "InvoiceGen",
      "properties" : {
        "name" : "InvoiceGen",
        "states" : {
          "State1" : {
            "next" : "End",
            "start" : true,
            "type" : "pass"
          }
        }
      },
      "dependsOn" : [ ]
    } ],
    "Functions" : [ {
      "type" : "function",
      "name" : "warehouseportal",
      "properties" : {
        "stack" : "node14",
        "code" : {
          "path" : "functions/warehouseportal.zip"
        },
        "configuration" : {
          "memory" : 256
        },
        "type" : "basicio",
        "name" : "warehouseportal"
      },
      "dependsOn" : [ ]
    }
 ],
    "WebClient" : [ {
      "type" : "client",
      "name" : "warehousePortal",
      "properties" : {
        "app_name" : "warehousePortal",
        "code" : {
          "path" : "webclient/warehousePortal.zip"
        }
      },
      "dependsOn" : [ ]
    } ],
    "Cron" : [ {
      "type" : "cron",
      "name" : "dailyBackup",
      "properties" : {
        "cron_url_details" : {
          "headers" : { },
          "request_body" : "",
          "request_method" : "POST",
          "params" : { },
          "url" : "https://catalyst.zoho.com/help/index.html"
        },
        "end_time" : -1,
        "description" : "",
        "cron_name" : "dailyBackup",
        "job_detail" : {
          "hour" : 1,
          "timezone" : "America/Los_Angeles",
          "minute" : 0,
          "second" : 0,
          "repetition_type" : "Daily"
        },
        "cron_type" : "Calendar",
        "status" : true
      },
      "dependsOn" : [ ]
    } ],
    "Datastore" : [ {
      "type" : "table",
      "name" : "InventoryDB",
      "properties" : {
        "table_name" : "InventoryDB"
      },
      "dependsOn" : [ ]
    }, {
      "type" : "column",
      "name" : "InventoryDB-ProductID",
      "properties" : {
        "decimal_digits" : 2,
        "column_name" : "ProductID",
        "data_type" : "int",
        "is_unique" : false,
        "is_mandatory" : false,
        "search_index_enabled" : false,
        "table_id" : "InventoryDB",
        "table_name" : "InventoryDB",
        "max_length" : 10
      },
      "dependsOn" : [ "Datastore.table.InventoryDB" ]
    },
{
      "type" : "tableScope",
      "name" : "InventoryDB-App Administrator",
      "properties" : {
        "role_name" : "App Administrator",
        "table_scope" : "GLOBAL",
        "type" : "App Administrator",
        "table_name" : "InventoryDB"
      },
      "dependsOn" : [ "Datastore.table.InventoryDB" ]
    }, {
      "type" : "tableScope",
      "name" : "InventoryDB-App User",
      "properties" : {
        "role_name" : "App User",
        "table_scope" : "GLOBAL",
        "type" : "App User",
        "table_name" : "InventoryDB"
      },
      "dependsOn" : [ "Datastore.table.InventoryDB" ]
    }, {
      "type" : "tablePermission",
      "name" : "InventoryDB-App Administrator",
      "properties" : {
        "role_name" : "App Administrator",
        "type" : "App Administrator",
        "table_permissions" : [ "SELECT", "UPDATE", "INSERT", "DELETE" ],
        "table_name" : "InventoryDB"
      },
      "dependsOn" : [ "Datastore.table.InventoryDB" ]
    }, {
      "type" : "tablePermission",
      "name" : "InventoryDB-App User",
      "properties" : {
        "role_name" : "App User",
        "type" : "App User",
        "table_permissions" : [ "SELECT" ],
        "table_name" : "InventoryDB"
      },
      "dependsOn" : [ "Datastore.table.InventoryDB" ]
    }]
}
}
    

注: ZIPファイルにproject-template JSONファイルが含まれていない場合、Catalystはプロジェクトをインポートできません。これはプロジェクトの設定を定義する必須ファイルです。

プロジェクトをエクスポートするには？

_General Settings_セクションから任意のプロジェクトをエクスポートできます。これらはCatalystアカウント全体に適用される共通設定です。

注: ローカル環境でプロジェクトを操作した場合は、コンソールからプロジェクトをエクスポートする前に、CLIを使用して更新されたコードやセットアップをリモートコンソールにデプロイしてください。

プロジェクトの開発環境または本番環境からプロジェクトをエクスポートできます（本番環境が有効になっている場合）。エクスポートが完了すると、生成されたZIPファイルをダウンロードできます。このZIPファイルをそのまま、別のアカウント、データセンター、またはプロジェクトの複製が必要な場合は同じアカウントの新しいプロジェクトとしてインポートできます。

注: ZIPファイルが生成された後、Catalystはダウンロード用にファイルを15日間保存します。15日後にダウンロードリンクは無効になります。有効期限切れ後にダウンロード用の新しいZIPファイルを生成するには、プロジェクトを再エクスポートする必要があります。

プロジェクトをエクスポートするには:

_General Settings_のInfrastructure as Codeに移動し、IaC Exportsタブをクリックします。
Export a Projectをクリックします。
ドロップダウンのプロジェクトリストからエクスポートするプロジェクトを選択します。Catalystアカウントのすべてのプロジェクトがここに表示されます。エクスポートするプロジェクトの環境を選択します。
Exportをクリックします。

Catalystがプロジェクトのエクスポートプロセスを開始します。コンソールにエクスポートのステータスが表示されます。

エクスポートが初期化されると、Export IDが自動的に生成されます。Export IDを使用して、CLIからエクスポートジョブのステータスを確認できます。コンソールにはエクスポートの他の詳細も表示されます。エクスポートが完了すると、プロジェクトのZIPファイルをダウンロードできるDownload ZIPリンクが表示されます。

エクスポートプロセスに問題があり、Catalystがプロジェクトをエクスポートできなかった場合、コンソールにView Error Logリンクが表示されます。

このリンクをクリックしてエラーの詳細を表示できます。エラーを解決し、プロジェクトを再度エクスポートできます。

プロジェクトを再エクスポートするには？

注:

Catalystは常にプロジェクトの最新の定義とコードをエクスポートします。
以前エクスポートしたプロジェクトを再エクスポートすると、そのプロジェクトの最新のエクスポートの_Download ZIP_リンクのみが利用可能になります。これは、Catalystがプロジェクトの最新のエクスポートのみを保存し、以前のエクスポートは保存しないためです。

以前エクスポートしたプロジェクトを再度エクスポートするには、エクスポートされたプロジェクトの省略記号アイコンをクリックし、Export Againをクリックします。

前のセクションで説明したのと同じ方法でプロジェクトがエクスポートされます。Download ZIPリンクから最新のエクスポートをダウンロードできます。

プロジェクトをインポートするには？

注:

プロジェクト定義、関数およびクライアントコードを含むソースZIPファイルは、インポートするために標準形式である必要があります。
project-template JSONファイルはZIPファイルのルートに必ず存在する必要があります。このファイルなしではプロジェクトをインポートできません。functionsまたはwebclientディレクトリは必須ではありません。
本番環境に直接プロジェクトをインポートすることはできません。

以下の方法で新しいプロジェクトをインポートできます: