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

現在、Apigee ハイブリッド バージョン 1.7 のドキュメントを表示しています。このバージョンのサポートは終了しています。新しいバージョンにアップグレードする必要があります。詳細については、サポートされているバージョンをご覧ください。

Version 1.7 (unsupported)

   Supported versions:

• v1.12 (latest)                        
• v1.11                         
• v1.10                                        
• List of supported versions

   Unsupported versions:

• v1.9                                         
• v1.8                                         
• v1.7                                         
• v1.6                                         
• v1.5                                         
• v1.4                                         
• v1.3                                         
• v1.2                                         
• v1.1                                         

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

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

環境を作成する

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

Apigee ハイブリッド UI

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

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

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



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

   

   注: プルダウン リストからハイブリッド対応組織を選択すると、ハイブリッド UI のヘッダーに、Apigee 組織名と Google Cloud プロジェクト名が表示されます。Apigee 組織名と Google Cloud プロジェクト名は同じです。
3. [Admin] > [Environments] > [Overview] の順にクリックします。

   [Environments] > [Overview] の順に開いた状態の Apigee ハイブリッド UI メニュー" class="l10n-absolute-url-src screenshot" l10n-attrs-original-order="src,width,class,alt,title" src="https://cloud.google.com/static/apigee/docs/hybrid/v1.7/images/hybrid-ui-menu-admin-environments-overview.png" title="[Admin]、[Environments]、[Overview] オプション" width="25%" />

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

   

4. [+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」などです。

      注意: Environment name に使用できるのは小文字、数字、ハイフンのみです。大文字やその他の特殊文字は使用できません。[Environment name] は 32 文字以下にする必要があります。例: my-test-env、my-test-env-42

      [Display name] と [Environment name] は同じでなくてもかまいません。

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

   新しい環境が作成され、「Pending Provisioning」と表示されます。

   

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

   

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

gcloud CLI

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. 次のコマンドを使用して、必要な環境変数が定義されていることを確認します。

   echo ${PROJECT_ID}
   echo ${ENV_NAME}
   echo ${ENV_DISPLAY_NAME}
   echo ${ORG_NAME}
   echo ${ENV_DESCRIPTION}

   必要に応じて、環境の要素用に次の環境変数を作成または再定義します。環境変数を作成するには、次のコマンドを使用します。

   • ENV_NAME（必須）は、環境のプログラム上の ID です。環境名には小文字、ダッシュ、数字を含めることができます。また、先頭は小文字にする必要があります。この名前は ID として使用されますので、作成後には変更できません。

     export ENV_NAME=environment_name

   • ENV_DISPLAY_NAME（必須）は、ユーザーにわかりやすい環境の名前です。この値は一意である必要はありません。また、スペースや特殊文字も使用できます。たとえば、「My Example Environment」などです。

     ENV_DISPLAY_NAME=friendly_name

   • ORG_NAME（必須）は、組織 ID です。ステップ 4: 組織を作成するで、ORG_NAME 環境変数を設定しています。

     echo $ORG_NAME

   • ENV_DESCRIPTION（省略可）は環境に関する情報です。目的のリマインダーとして使用します。たとえば、「Apigee ハイブリッドの説明用のサンプル環境」などです。

     ENV_DESCRIPTION=description_text

4. 認証済みの POST リクエストを Create environments API に送信します。
   注: ハイブリッド対応組織を作成した後は、組織の削除、組織 ID の変更、組織にバインドされた Google Cloud プロジェクトの変更はできません。これらを変更する場合は、Apigee サポートにご連絡ください。

   次の例は、以下のコマンドを使用して環境を作成するリクエスト構造を示したものです。

   curl -H "Authorization: Bearer $TOKEN" -X POST -H "content-type:application/json"   -d '{
       "name": "'"$ENV_NAME"'",
       "displayName": "'"$ENV_DISPLAY_NAME"'",
       "description": "'"$ENV_DESCRIPTION"'"
     }'   "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 になっています。この処理には、数分かかることがあります。

環境グループを作成する

次に環境グループを作成し、先ほど作成した環境をそのグループに割り当てます。環境グループを使用すると、環境をグループ化して、グループ内の環境にデプロイされているプロキシのルーティングに使用するホスト名を指定できます。少なくとも 1 つの環境グループを作成し、そのグループに 1 つ以上のホスト名を割り当てる必要があります。環境グループの概要については、環境と環境グループについてをご覧ください。

注: 環境を追加した環境グループは、その環境が使用されるすべてのオーバーライド ファイルに含まれている必要があります。

Apigee ハイブリッド UI

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

1. Apigee UI を開きます。

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

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

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

   

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

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

   

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

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

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

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



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



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

gcloud CLI

コマンドラインを使用して環境グループを作成する手順は、次のとおりです。

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. 次の例のように DOMAIN 環境変数が設定されていることを確認します。

   echo $DOMAIN

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

   設定されていない場合は、Apigee ハイブリッドをインストールするドメインで環境変数を作成します。次に例を示します。

   export DOMAIN=domain-name.com

3. 前のステップで作成した環境に ENV_NAME 環境変数が設定されていることを確認します。次に例を示します。

   echo $ENV_NAME

4. 目的の環境グループ名の環境変数を作成します。次に例を示します。

   export ENV_GROUP=environment-group-name

5. 次のコマンドを使用して、環境グループを作成します。

   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"
       

6. 次のコマンドを使用して、環境を新しいグループに割り当てます。

   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"
       

これで完了です。

Google Cloud アカウントとプロジェクトを作成し、組織をプロビジョニングしました。さらに、必要な API を有効にして、新しい環境と環境グループを作成しました。これで、Apigee ハイブリッド ランタイムをインストールして設定する準備ができました。

次のステップ

インストールに進む前に、ランタイムのインストールを始める前にをご覧ください。