ステップ 3: 環境グループを作成する

このステップでは、環境と環境グループを作成します。

Apigee では、API プロキシは環境にデプロイされます。環境は、プロキシを実行するための分離コンテキストを提供します。環境は環境グループにまとめられます。この環境グループは、グループ内の環境にデプロイされるすべてのプロキシのホスト名を指定します。環境と環境グループはそれぞれ 1 つ以上指定する必要があります。詳しくは、環境と環境グループについてをご覧ください。

環境を作成する

環境グループを作成する前に、まず環境を作成します。環境は Apigee UI または API を使用して作成できます。ここでは UI を使用して、UI に慣れることをおすすめします。

Cloud コンソールの Apigee

Cloud コンソールの Apigee で新しい環境を作成するには:

ブラウザで Cloud コンソールの Apigee UI を開きます。
左側のナビゲーションペインで [管理] > [環境] を選択します。
[環境] ペインで、[+ 環境を作成] を選択します。
[環境の作成] ペインに、次のように入力します。
- 名前: プログラマティック環境の名前。作成後に名前を変更することはできません。
  
  名前は 2～32 文字（小文字、数字、ハイフン）で構成します。名前は文字で始まる必要があります。末尾をハイフンにすることはできません。この名前は、組織内の他の環境名と異なっている必要があります。
- 表示名: UI に表示される環境の名前。
- 説明: 省略可。環境の説明。
- インスタンス: [インスタンス] フィールドは空白のままにします。インスタンスは Apigee ハイブリッドインストールには適用されません。
- Environment group: [Environment group] フィールドは空白のままにします。次の手順で環境グループを作成します。
- デプロイタイプ: ほとんどの Apigee ハイブリッドインストールでは、個々の API プロキシのデプロイオプションを選択します。必要に応じて、API プロキシ構成環境のアーカイブをデプロイできます。詳細については、サポートされているデプロイタイプをご覧ください。
  注: この環境で使用するデプロイタイプは、環境の作成後に変更できません。
[作成] をクリックします。

完了すると、新しい環境が [環境] ペインのテーブルに表示されます。

従来の Apigee UI

UI にアクセスして環境を追加する手順は次のとおりです。

Apigee UI を開きます。初めてログインする場合は、同意ダイアログが表示されます。複数のアカウントから選択するように求められたら、Apigee ハイブリッドのインストールに使用している Google Cloud プロジェクトを所有するアカウントを選択します。[Allow] をクリックします。

ブラウザで UI のメインランディングページが表示されます。

Apigee UI のランディングページ。左側のナビゲーションと大きめの画像（リンク）で構成。

組織のプルダウンリストから組織が選択されていることを確認します。選択されていない場合は、次の例のようにプルダウンリストから選択します。
[Admin] > [Environments] > [Overview] の順にクリックします。

[Environments] ビューが表示されますが、この時点で環境はまだありません。
[+Environment] をクリックします。
[New environment] ダイアログが表示されます。
[New Environment] ダイアログに次の情報を入力します。
1. Display name（必須）: UI で使用される環境のわかりやすい名前。たとえば、「My First Environment」、「test」などです。[Environment name] とは異なり、[Display name] には大文字やその他の特殊文字を使用できます。
2. Environment name（必須）: 環境のプログラム上の名前。環境 ID とも呼ばれます。
  たとえば、「my-environment」、「test」などです。
  
  注意: Environment name に使用できるのは小文字、数字、ハイフンのみです。大文字やその他の特殊文字は使用できません。[Environment name] は 32 文字以下にする必要があります。例: my-test-env、my-test-env-42
  
  [Display name] と [Environment name] は同じでなくてもかまいません。
3. Description（省略可）: 環境に関する追加情報。環境の目的のリマインダーとして追加します。たとえば、「Created during initial installation」などです。
その他の値はすべてデフォルトのままにして、[Create] をクリックします。
Apigee によって新しい環境が作成されます。

次に、環境グループを作成し、そのグループに新しい環境を追加する必要があります。

Apigee API

Create environments API を使用して環境を作成するには、次の手順を行います。

Apigee の管理に使用しているデバイスでターミナルを開きます。
コマンドラインで次のコマンドを使用して、gcloud 認証情報を取得します。
Linux / macOS
```
export TOKEN=$(gcloud auth print-access-token)
```
トークンにデータが入力されていることを確認するには、次の例のように echo を使用します。
```
echo $TOKEN
```
エンコードされた文字列としてトークンが表示されるはずです。
Windows
```
for /f "tokens=*" %a in ('gcloud auth print-access-token') do set TOKEN=%a
```
トークンにデータが入力されていることを確認するには、次の例のように echo を使用します。
```
echo %TOKEN%
```
エンコードされた文字列としてトークンが表示されるはずです。
次の環境変数を作成します。
Linux / macOS
```
export ENV_NAME="YOUR_ENV_NAME"
```
Windows
```
set ENV_NAME="YOUR_ENV_NAME"
```
ここで
- ENV_NAME（必須） 環境名には小文字、ダッシュ、数字を含めることができます。また、先頭は小文字にする必要があります。この名前は ID として使用されるので、環境の作成後には変更できません。

次の Apigee API を呼び出します。

データ所在地を使用しない場合

curl -H "Authorization: Bearer $TOKEN" -X POST -H "content-type:application/json"   -d '{
    "name": "'"$ENV_NAME"'"
  }'   "https://apigee.googleapis.com/v1/organizations/$ORG_NAME/environments"

データ所在地

curl -H "Authorization: Bearer $TOKEN" -X POST -H "content-type:application/json"   -d '{
    "name": "'"$ENV_NAME"'"
  }'   "https://$CONTROL_PLANE_LOCATION-apigee.googleapis.com/v1/organizations/$ORG_NAME/environments"

作成リクエストが成功すると、Environments API から次のようなメッセージが返されます。

{
  "name": "organizations/hybrid-example/operations/c2aee040-7e79-4fd4-b0cf-79ca1b7098a8",
  "metadata": {
    "@type": "type.googleapis.com/google.cloud.apigee.v1.OperationMetadata",
    "operationType": "INSERT",
    "targetResourceName": "organizations/hybrid-example/environments/example-env",
    "state": "IN_PROGRESS"
  }
}

応答の state プロパティが示すように、Apigee は環境の新規作成を開始したので、状態が IN_PROGRESS になっています。

環境が正常に作成されたことを確認します。

データ所在地を使用しない場合

curl -H "Authorization: Bearer $TOKEN" \
          "https://apigee.googleapis.com/v1/organizations/$ORG_NAME/environments"

データ所在地

curl -H "Authorization: Bearer $TOKEN" \
          "https://$CONTROL_PLANE_LOCATION-apigee.googleapis.com/v1/organizations/$ORG_NAME/environments"

作成のリクエストが成功すると、Environments API から次のようなメッセージが返されます。

[
  "your-environment-name"
]

環境グループを作成する

次に環境グループを作成し、先ほど作成した環境をそのグループに割り当てます。

Cloud コンソールの Apigee

Cloud コンソールの Apigee で新しい環境グループを作成するには:

ブラウザで Cloud コンソールの Apigee UI を開きます。
左側のナビゲーションペインで [管理] > [環境] を選択します。
[環境] ペインで、[Environment Groups] を選択します。
[+ 環境グループの作成] をクリックします。
次のように入力します。
- Environment group name: 環境グループの名前。名前の先頭と末尾は英数字にする必要があります。63 文字以下の英数字とハイフンで構成します。この名前は、組織内の既存の環境グループとは別の名前にする必要があります。
- Hostames: プロキシの呼び出しに使用できるホスト名のリスト。ホスト名は、それぞれ別の行に入力する必要があります。
  
  注: 環境グループに割り当てる名前は、そのグループに固有のものでなければなりません。その名前を環境グループで使用することはできません。
  [Configure Google Load Balancer with these domains] をクリックすることもできます。Cloud コンソールの [ロードバランシング] ページが開き、ここでホスト名に対するロードバランシングを構成できます。
- 環境: 環境グループに含める環境のリスト（省略可）。
[作成] をクリックします。

従来の Apigee UI

Apigee UI を使用して環境グループを作成するには、次の操作を行います。

Apigee UI を開きます。

ブラウザで Apigee UI のメインランディングページが表示されます。

組織のプルダウンリストから組織が選択されていることを確認します。選択されていない場合は、プルダウンリストから選択してください。
[Admin] > [Environments] > [Groups] をクリックします。
[Environment Groups Overview] ビューが表示されます。
[+Environment Group] をクリックします。
[Add an Environment Group] ダイアログが表示されます。
トピック名を入力して [Add] をクリックします。
新しく作成した環境グループの上にポインタを置き、[Edit ] をクリックします。

このグループ内の環境にデプロイされるすべてのプロキシで使用するホスト名を追加します。これは、管理アクセス権のあるドメインである必要があります。ホスト名には、ドメイン自体（example.com など）またはサブドメイン（my-proxies.example.com など）を指定できます。

ドメインを登録する必要がある場合は、Google Domains などのドメイン登録事業者をご覧ください。

必要に応じて、ドメインのロードバランサを構成できます。ロードバランサの詳細については、Cloud Load Balancing の概要をご覧ください。
[Environments] ボックスで [Add（+）] をクリックします。
[Add environment] ダイアログが表示されます。
リストから環境を選択して、[Add] をクリックします。
[Save] をクリックします。

Apigee API

Apigee API を使用して環境グループを作成するには:

コマンドラインで次のコマンドを使用して、gcloud 認証情報を取得します。
Linux / macOS
```
TOKEN=$(gcloud auth print-access-token)
```
Windows
```
for /f "tokens=*" %a in ('gcloud auth print-access-token') do set TOKEN=%a
```
次の環境変数を作成します。
Linux / macOS
```
export DOMAIN="YOUR_DOMAIN"
export ENV_GROUP="YOUR_ENVIRONMENT_GROUP"
```
Windows
```
 data-terminal-prefix=">">set ENV_GROUP="YOUR_ENVIRONMENT_GROUP"
 data-terminal-prefix=">">set DOMAIN="YOUR_DOMAIN"
```
ここで
- DOMAIN（必須） これは、このグループ内の環境にデプロイされるすべてのプロキシが使用するホスト名です。これはお客様が管理するドメインであることが必要です。アドレスには、ドメイン自体（example.com など）またはサブドメイン（my-proxies.example.com など）を指定できます。マネージドドメインを保有されていない場合は、この時点ではプレースホルダを入力できます。ドメインアドレスは後で変更できます。
- ENV_GROUP（必須） 環境名には小文字、ダッシュ、数字を含めることができます。また、先頭は小文字にする必要があります。この名前は ID として使用されるため、作成後には変更できません。

環境グループを作成します。

データ所在地を使用しない場合

curl -H "Authorization: Bearer $TOKEN" -X POST -H "content-type:application/json" \
   -d '{
     "name": "'"$ENV_GROUP"'",
     "hostnames":["'"$DOMAIN"'"]
   }' \
   "https://apigee.googleapis.com/v1/organizations/$ORG_NAME/envgroups"

データ所在地

curl -H "Authorization: Bearer $TOKEN" -X POST -H "content-type:application/json" \
   -d '{
     "name": "'"$ENV_GROUP"'",
     "hostnames":["'"$DOMAIN"'"]
   }' \
   "https://$CONTROL_PLANE_LOCATION-apigee.googleapis.com/v1/organizations/$ORG_NAME/envgroups"

環境を新しいグループに割り当てます。

データ所在地を使用しない場合

curl -H "Authorization: Bearer $TOKEN" -X POST -H "content-type:application/json" \
   -d '{
     "environment": "'"$ENV_NAME"'",
   }' \
   "https://apigee.googleapis.com/v1/organizations/$ORG_NAME/envgroups/$ENV_GROUP/attachments"

データ所在地

curl -H "Authorization: Bearer $TOKEN" -X POST -H "content-type:application/json" \
   -d '{
     "environment": "'"$ENV_NAME"'",
   }' \
   "https://$CONTROL_PLANE_LOCATION-apigee.googleapis.com/v1/organizations/$ORG_NAME/envgroups/$ENV_GROUP/attachments"

次の CURL コマンドを使用して、環境グループが正常に作成されたかどうかを確認します。

データ所在地を使用しない場合

curl -H "Authorization: Bearer $TOKEN" \
  "https://apigee.googleapis.com/v1/organizations/$ORG_NAME/envgroups"

データ所在地

curl -H "Authorization: Bearer $TOKEN" \
  "https://$CONTROL_PLANE_LOCATION-apigee.googleapis.com/v1/organizations/$ORG_NAME/envgroups"

作成リクエストが成功すると、Environments Group API から次のようなメッセージが返されます。

      {
        "environmentGroups": [
          {
            "name": "your_envgroup_hybrid",
            "hostnames": [
              "apigee.hybrid.com"
            ],
            "createdAt": "1677826235324",
            "lastModifiedAt": "1677826235324",
            "state": "ACTIVE"
          }
        ]
      }

次の CURL コマンドを使用して、新規作成された環境グループの最新のアタッチメントを取得します。

データ所在地を使用しない場合

curl -H "Authorization: Bearer $TOKEN" \
  "https://apigee.googleapis.com/v1/organizations/$ORG_NAME/envgroups/$ENV_GROUP/attachments"

データ所在地

curl -H "Authorization: Bearer $TOKEN" \
  "https://$CONTROL_PLANE_LOCATION-apigee.googleapis.com/v1/organizations/$ORG_NAME/envgroups/$ENV_GROUP/attachments"

次の応答出力例に示すように、結果に一意のハッシュ値が示されていれば、環境グループの作成と接続は成功しています。


        {
          "environmentGroupAttachments": [
            {
              "name": "c27046d1-b83e-4cba-xxxx-caaa660b2bd6",
              "environment": "your_envtest_hybrid",
              "createdAt": "1677826263567",
              "environmentGroupId": "your_envgroup_hybrid"
            }
          ]
        }

次のステップ

インストールを続行するには、パート 2: ハイブリッドランタイムを設定するに進んでください。

ステップ 3: 環境グループを作成する

環境を作成する

Cloud コンソールの Apigee

従来の Apigee UI

Apigee API

Linux / macOS

Windows

Linux / macOS

Windows

データ所在地を使用しない場合

データ所在地

データ所在地を使用しない場合

データ所在地

環境グループを作成する

Cloud コンソールの Apigee

従来の Apigee UI

Apigee API

Linux / macOS

Windows

Linux / macOS

Windows

データ所在地を使用しない場合

データ所在地

データ所在地を使用しない場合

データ所在地

データ所在地を使用しない場合

データ所在地

データ所在地を使用しない場合

データ所在地

次のステップ