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

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

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

必要な権限

環境と環境グループの作成者には少なくとも Apigee 組織管理者のロールが必要です。ただし、プロジェクト オーナーの場合は、環境または環境グループを作成する権限が自動的に付与されます。また、このタスクをプロジェクト オーナー以外のユーザーに委任する場合は、そのユーザーにプロジェクトの Apigee 組織管理者のロールを付与する必要があります。ロールの付与については、リソースへのアクセス権の付与、変更、取り消しをご覧ください。

環境の作成

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

Apigee ハイブリッド UI

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

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

    左側のナビゲーションと、リンクになっている大きな画像で構成される、Apigee ハイブリッド UI のランディング ページ。

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

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

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

    [Admin] > [Environments] > [Overview] の順に展開した様子を示した Apigee ハイブリッド UI メニュー

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

    空白の [Environments] ビュー(環境なし)

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

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

    [New environment] ダイアログ

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

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

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

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

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

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

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

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

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

gcloud CLI

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

  1. Apigee の管理に使用しているデバイス上でターミナルを開きます。
  2. 次の例のように、コマンドラインで gcloud 認証情報を取得します。

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

    トークンにデータが入力されていることを確認するには、次の例のように echo を使用します。

    echo $TOKEN

    エンコードされた文字列としてトークンが表示されるはずです。

    詳細については、gcloud コマンドライン ツールの概要をご覧ください。

  3. 環境の要素用に環境変数を作成します。環境変数を作成するには、次のコマンドを使用します。
    • 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 に送信します。

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

    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 を開きます。
  2. ブラウザで、ハイブリッド UI のメイン ランディング ページに移動します。

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

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

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

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

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

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

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

    このグループ内の環境にデプロイされるすべてのプロキシで使用するホスト名を追加します。これは、ステップ 5: DNS を構成するで使用したドメインです。

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

  9. [Add (+)] をクリックします。
  10. [Add environment] ダイアログが表示されます。
  11. 使用可能な環境が一覧表示される [Add environment] ダイアログ

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

gcloud CLI

コマンドラインを使用して環境グループを作成するには、次の手順を行います。

  1. 次の例のように、コマンドラインで gcloud 認証情報を取得します。

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

    トークンにデータが入力されていることを確認するには、次の例のように echo を使用します。

    echo $TOKEN

    エンコードされた文字列としてトークンが表示されるはずです。

    詳細については、gcloud コマンドライン ツールの概要をご覧ください。

  2. 次の例のように DOMAIN 環境変数が設定されていることを確認します。
    echo $DOMAIN

    これは、このグループ内の環境にデプロイされるすべてのプロキシが使用するホスト名です。ステップ 5: DNS を構成するで使用したものと同じドメインを使用します。

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

    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"
        

次のステップ

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