ステップ 1: 環境変数を定義する

このページは Apigee と Apigee ハイブリッドに適用されます。

Apigee Edge ドキュメントを表示する

このステップで行う操作

このセクションでは、ドキュメント全体（特に、この構成チュートリアル）で使用される複数の環境変数を設定する方法について説明します。以降で紹介するコマンドをそのまま入力して動作する前提となっているため、環境変数の使用を強くおすすめします。

これは、Apigee プロビジョニング ウィザードを開始する前にコマンドラインで実行する 2 つのステップの最初のステップです。

ステップを実行する

コマンドラインで環境変数を定義するには:

  1. 現在のプロジェクトに対して次の環境変数を定義します。
    PROJECT_ID="YOUR_PROJECT_ID"
PROJECT_NUMBER=$(gcloud projects describe $PROJECT_ID --format="value(projectNumber)")
RUNTIME_LOCATION="YOUR_RUNTIME_LOCATION"
ANALYTICS_REGION="YOUR_ANALYTICS_REGION"
RUNTIMEDBKEY_LOCATION="RUNTIMEDB_LOCATION"
APPKEY_KEY_RING_NAME="RUNTIMEDB_KEY_RING_NAME"
APPKEY_KEY_NAME="RUNTIMEDB_KEY_NAME"
DISK_KEY_RING_NAME="DISK_KEY_RING_NAME"
DISK_KEY_NAME="DISK_KEY_NAME"

    ここで

    • PROJECT_ID は、前提条件で作成した Cloud プロジェクト ID です。プロジェクト ID がわからない場合は、Cloud コンソールまたは gcloud projects list コマンドで確認します。
    • PROJECT_NUMBER は、前提条件で作成した Cloud プロジェクト番号です。この例では、プロジェクト番号を取得するために gcloud コマンドを発行します。別の方法としては、Google Cloud コンソール プロジェクト ダッシュボードで確認することも、gcloud projects list コマンドで検索することもできます。

    • RUNTIME_LOCATION は、インスタンスが配置されている物理的なロケーションです。有効な値は、Compute Engine リージョン（有料組織の場合）または Compute Engine ゾーン（評価組織の場合）です。詳細については、Compute Engine のロケーションをご覧ください。

    • ANALYTICS_REGION は、分析データを格納する物理的なロケーションです。

      有効な値は、Compute Engine リージョンのサブセットです。指定できる値は次のとおりです。

      • asia-northeast1
      • asia-south1
      • europe-west1
      • us-central1
      • us-east1
      • us-west1
      • australia-southeast1
      • europe-west2

      評価アカウントと有料アカウントの両方で分析ロケーションのリージョンを使用します。そのため、有料組織の場合は、RUNTIME_LOCATION（リージョン）と同じ値を使用できます。ANALYTICS_REGION の値は、RUNTIME_LOCATION と同じである必要はありません。ただし、同じであれば、パフォーマンス上のメリットが得られることがあります。

      評価アカウントの場合、分析ロケーションはリージョンになりますが、ランタイム ロケーションはゾーンであるため、同じではありません。

    • RUNTIMEDBKEY_LOCATION は、アプリケーションのキーリングと鍵が保存される物理的なロケーションです。Apigee は、アプリケーション キーを使用して KVM、キャッシュ、クライアント シークレットなどのアプリケーション データを暗号化します。これらのデータはデータベースに保存されます。

      分析リージョンと同様に、有効な値は Compute Engine リージョンのサブセットです。値は $RUNTIME_LOCATION（またはリージョン）と同じにすることができますが、必ずしも同じである必要はありません。同じであれば、パフォーマンス上のメリットが得られることがあります。

    • APPKEY_KEY_RING_NAME は、アプリケーション キーが保存されるキーリングの名前です。キーリングの名前は組織に固有のものである必要があります。追加のリージョンを作成する場合、そのリージョンのキーリング名を既存のキーリング名と同じにすることはできません。
    • APPKEY_KEY_NAME はアプリケーション キーの名前です。アプリケーション キー名は、特定のキーリング内で一意である必要があります。
    • DISK_KEY_RING_NAME は、ディスクのキーリングの名前です。ディスクのキーリング名は、アプリケーション キー名とは別の名前にする必要があります。ディスクのキーリングは、$RUNTIME_LOCATION と同じロケーションに作成します。
    • DISK_KEY_NAME はディスク暗号鍵の名前です。Apigee は、この鍵を使用して、ディスクに書き込まれる前にランタイム インスタンス データを暗号化します。

    次の例では、有料組織の環境変数を定義します。

    PROJECT_ID="my-cloud-project"
PROJECT_NUMBER=$(gcloud projects describe $PROJECT_ID --format="value(projectNumber)")
RUNTIME_LOCATION="us-west1"
ANALYTICS_REGION="us-west1"
RUNTIMEDBKEY_LOCATION="us-west1"
APPKEY_KEY_RING_NAME="us-west1"
APPKEY_KEY_NAME="us-west1"
DISK_KEY_RING_NAME="us-west1"
DISK_KEY_NAME="us-west1"

    評価組織の場合は、RUNTIME_LOCATION はリージョンではなくゾーンに設定されます。

    コマンドでは、$PROJECT_ID などの変数名を文字列リテラルとして使用します。

    プロビジョニングや構成時にこれらの環境変数すべてを使用できない場合があります。

  2. （省略可）設定した値をエコーして作業内容を確認します。コマンドで変数を使用する場合は、変数名の前にドル記号（$）を付けます。
    echo $PROJECT_ID
echo $PROJECT_NUMBER
echo $ANALYTICS_REGION
echo $RUNTIMEDBKEY_LOCATION
echo $APPKEY_KEY_RING_NAME
echo $APPKEY_KEY_NAME
echo $DISK_KEY_RING_NAME
echo $DISK_KEY_NAME

    echo コマンドに対するレスポンスは次のようになります。

    Authorization: Bearer ya29.a123456678940B63hPSAMPLEsampleKKYVsample0f3pWDWZDuH2-hENkNa
TvgZ1PD977TMvv6edBQPJezdHw040880Ol_LoD5ZDkt-i-knizia_KhA9L20sSvztL81-SAMPLE42ELPMASk2_
1CxN
my-cloud-project
1234567890
us-west1
us-west1
us-west1
$RUNTIMEDB_KEY_RING_NAME
$RUNTIMEDB_KEY_NAME
$DISK_KEY_RING_NAME
$DISK_KEY_NAME

このプロセスの過程でエラーが発生した場合は、トラブルシューティングをご覧ください。

1 次: API を有効にする 3 4 5 6 7 8