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

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

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

環境の作成

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

Apigee UI

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

  1. Apigee UI を開きます。初めてログインする場合は、同意を求めるダイアログが表示されます。複数のアカウントから選択するように求められたら、ステップ 2: Google Cloud プロジェクトを作成するで作成したプロジェクトを所有するアカウントを選択します。[Allow] をクリックします。

    2. ブラウザで、UI のメイン ランディング ページに移動します。

    Apigee UI のランディング ページ。左側のナビゲーションとリンク付きの大きな画像から構成されている。

  2. 組織のプルダウン リストから組織が選択されていることを確認します。選択されていない場合は、次の例のようにプルダウン リストから選択します。

    ハイブリッド対応の組織のリスト

  3. [Admin] > [Environments] > [Overview] の順にクリックします。

    [Admin] > [Environments] > [Overview] の順に開いた状態の Apigee UI メニュー

    [Environments] ビューが表示されますが、この時点で環境はまだありません。

    空白の [Environments] ビュー（環境なし）

  4. [+Environment] をクリックします。

    [New environment] ダイアログが表示されます。

    [New environment] ダイアログ

  5. [New Environment] ダイアログに次の情報を入力します。
    1. Display name（必須）: UI で使用される環境のわかりやすい名前。たとえば、「My First Environment」、「test」などです。Environment name とは異なり、Display name には大文字やその他の特殊文字を含めることができます。
    2. Environment name（必須）: 環境のプログラム上の名前。「環境 ID」とも呼ばれます。

      たとえば、「my-environment」、「test」などです。

      Display name と Environment name は異なる場合があります。

    3. Description（省略可）: 環境の目的のリマインダーとして追加する、環境に関する追加情報。たとえば、「Created during initial installation」などです。
  6. [作成] をクリックします。

    Apigee によって新しい環境が作成され、[Pending Provisioning] と表示されます。

    プロビジョニング保留中のステータス メッセージ

    しばらくすると、「provisioned」 に変わります。

    新しい環境がプロビジョニングされた場合のメッセージ

    ただし、まだ完了ではありません。新しい環境をランタイムの overrides.yaml ファイルに追加する必要がありますが、その前にランタイムをインストールしておく必要があります。先走らないようにしましょう。

Apigee API

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

  1. Apigee の管理に使用しているデバイスでターミナルを開きます。

  2. コマンドラインで次のコマンドを使用して 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%

    エンコードされた文字列としてトークンが表示されるはずです。
  3. 次の環境変数を作成します。

    Linux / MacOS 

    export ENV_NAME="YOUR_ENV_NAME"

    Windows 

    set ENV_NAME="YOUR_ENV_NAME"

    ここで

    • ENV_NAME (必須) 環境名には小文字、ダッシュ、数字を含めることができます。また、先頭は小文字にする必要があります。この名前は ID として使用されますが、環境の作成後には変更できません。
  4. 次の 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"

    作成リクエストが成功すると、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 になっています。

  5. 環境が正常に作成されたことを検証するために確認します。
    curl -H "Authorization: Bearer $TOKEN" \
          "https://apigee.googleapis.com/v1/organizations/$ORG_NAME/environments"

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

    [
  "your-environment-name"
]

環境グループを作成する

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

Apigee UI

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

  1. Apigee UI を開きます。

    2. ブラウザで、Apigee UI のメイン ランディング ページに移動します。

  2. 組織のプルダウン リストから組織が選択されていることを確認します。選択されていない場合は、プルダウン リストから選択してください。
  3. [Admin] > [Environments] > [Groups] をクリックします。

    [Environment Groups Overview] ビューに、作成した環境グループが表示されます。

    作成したグループが表示される [Environment Groups] ビュー

  4. [+Environment Group] をクリックします。

    [Add an Environment Group] ダイアログが表示されます。

    [Name] フィールドが空白の [Add Environment Group] ダイアログ

  5. 名前を入力し、[Add] をクリックします。

  6. 新しく作成した環境グループの上にポインタを置き、[Edit]（）をクリックします。

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

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

    7. 環境が割り当てられていない [Edit Environment Group] ウィンドウ

  7. [Add] をクリックします。
  8. [Add environment] ダイアログが表示されます。

    9. 使用可能な環境が一覧表示される [Add environment] ダイアログ

  9. リストから環境を選択して、[Add] をクリックします。

Apigee API

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

  1. コマンドラインで次のコマンドを使用して gcloud 認証情報を取得します。

    Linux / MacOS 

    TOKEN=$(gcloud auth print-access-token)

    Windows 

    for /f "tokens=*" %a in ('gcloud auth print-access-token') do set TOKEN=%a
  2. 次の環境変数を作成します。

    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 として使用されますので、作成後には変更できません。
  3. 環境グループを作成します。
    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"
  4. 環境を新しいグループに割り当てます。
    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"
  5. 次の CURL コマンドを使用して、環境グループが正常に作成されたかどうかを確認します。
    curl -H "Authorization: Bearer $TOKEN" \ 
      "https://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"
          }
        ]
      }
  6. 次の CURL コマンドを使用して、新しく作成された環境グループの最新のアタッチメントを取得します。 
    curl -H "Authorization: Bearer $TOKEN" \ 
      "https://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: ハイブリッド ランタイムの設定に移動してください。