ドメインのカスタマイズ

このページの内容は Apigee と Apigee ハイブリッドに該当します。

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

デベロッパー ポータルを作成するとき、デフォルトでは、ライブポータルへのアクセス用に次の形式の Apigee サンプル ドメイン名が提供されます。

https://orgname-portalname.apigee.io

ここで、orgname は組織名、portalname はポータル名をすべて小文字に変換してスペースとダッシュを削除したものです。

デベロッパー ポータルをリリースする前に、独自のカスタム ドメイン名を用意することをおすすめします。たとえば、次のような方法が一般的です。

https://developers.example.com

SAML ID プロバイダでカスタム ドメインを使用する場合の考慮事項については、SAML ID プロバイダでのカスタム ドメインの使用をご覧ください。

ドメインをカスタマイズするステップ

ドメイン名をカスタマイズするには、次の手順を行います。

  1. ドメイン名を登録します。
  2. カスタム ドメインの TLS 証明書を作成します。ロードバランサを作成するときに、この証明書が必要になります。
  3. ポータルのデフォルトのホスト名を確認する。
  4. インターネット ネットワーク エンドポイント グループ（NEG）を作成して、ロードバランサの統合ポータルに対するバックエンドのエンドポイントを定義します。
  5. インターネット NEG を参照し、受信クライアント リクエスト用の IP を予約するロードバランサを作成します。
  6. ポータルでカスタム ドメインを構成する
  7. DNS を更新して、カスタム ドメインホストの新しいレコードを作成します。

ステップ 1: ドメイン名を登録する

新しいドメインの登録が必要な場合は、Google Domains など、数多くの有名なドメイン登録サイトがあります。どのドメイン登録サイトを選んでもかまいません。

ドメイン名を決定する際は、ユーザー フレンドリーで意味のわかる URL を使用することが、検索エンジン最適化を向上させるうえで重要であることを考慮してください。詳細については、検索エンジン最適化（SEO）を実施するをご覧ください。

ステップ 2: カスタム ドメインの TLS 証明書を作成する

Let's Encrypt などのツールを使用して、カスタム ドメインの TLS 証明書を作成します。詳しくは以下をご覧ください。

ステップ 3: ポータルのデフォルトのホスト名を確認する

ポータルのデフォルトのホスト名を確認するには:

  1. Apigee UI で、サイド ナビゲーション バーから [公開] > [ポータル] を選択します。ポータルのリストが表示されます。

  2. カスタム ドメインを作成するポータルの [Location] フィールドの内容をコピーします。 ロケーション フィールドがハイライト表示されたポータル アイテム

    この値は次のステップで必要になります。

ステップ 4: インターネット NEG を作成する

このステップでは、インターネット ネットワーク エンドポイント グループ（NEG）を作成して、ロードバランサの統合ポータルへのバックエンドのエンドポイントを定義します。詳細については、インターネット ネットワーク エンドポイント グループの概要をご覧ください。

  1. Google Cloud コンソールで [ダッシュボード] ページに移動し、Google Cloud プロジェクトを選択または作成します。

    [ダッシュボード] ページに移動する

  2. ナビゲータで [Compute Engine] > [ネットワーク エンドポイント グループ] を選択します。

  3. [ネットワーク エンドポイント グループを作成] をクリックします。

  4. 次のフィールドを構成します。

    フィールド 値
    名前 インターネット NEG の名前を入力します。
    ネットワーク エンドポイント グループの種類 [ネットワーク エンドポイント グループ（インターネット）] を選択します。
    新しいネットワーク エンドポイント

  5. その他のフィールドはデフォルトのままにしてかまいません。

  6. [作成] をクリックします。

インターネット NEG が作成されます。

ステップ 5: ロードバランサを作成する

インターネット NEG を参照し、受信クライアント リクエスト用の IP を予約するロードバランサを作成します。

構成を開始する

  1. Google Cloud コンソールで、[ロード バランシング] ページに移動します。

    [ロード バランシング] に移動

  2. [ロードバランサを作成] をクリックします。
  3. [ロードバランサの種類] で [アプリケーション ロードバランサ（HTTP / HTTPS）] を選択し、[次へ] をクリックします。
  4. [インターネット接続または内部] で [インターネット接続（外部）] を選択し、[次へ] をクリックします。
  5. [グローバルまたはシングル リージョンのデプロイ] で [グローバル ワークロードに最適] を選択し、[次へ] をクリックします。
  6. [ロードバランサの世代] で [グローバル外部アプリケーション ロードバランサ] を選択し、[次へ] をクリックします。
  7. [構成] をクリックします。

ロードバランサを構成する

  1. 各カテゴリをクリックして、次の表の説明に沿ってロードバランサを構成します。

    カテゴリ ステップ
    フロントエンドの構成

    受信クライアント リクエスト用に IP アドレスを予約し、ステップ 2: TLS 証明書を作成するで作成した TLS 証明書をアップロードします。

    1. [グローバル外部アプリケーション ロードバランサを作成する] セクションで、[フロントエンドの構成] にカーソルを合わせ、矢印をクリックします。
    2. [名前] フィールドにフロントエンドの名前を入力します。
    3. [プロトコル] プルダウン メニューから [HTTPS] を選択します。
    4. [IP アドレス] プルダウン メニューで、[IP アドレスの作成] を選択します。
      [新しい静的 IP アドレスの予約] ダイアログが表示されます。
    5. [名前] フィールドに静的 IP アドレスの名前を入力します。
    6. 必要に応じて、説明を入力します。
    7. [予約] をクリックします。
    8. DNS レコードの設定時に、予約されている IP アドレスを保存します。
    9. [証明書] プルダウンから [新しい証明書を作成] を選択します。
      [新しい証明書の作成] ウィンドウがスライドで開きます。
    10. 新しい証明書の名前を [名前] フィールドに入力します。
    11. [作成モード] で [証明書をアップロードする] を選択します。
    12. TLS 証明書の詳細（公開鍵、証明書チェーン、秘密鍵など）をアップロードします。
    13. [作成] をクリックします。
    14. [完了] をクリックして、新しいフロントエンドの IP とポートを作成します。
    バックエンドの構成

    ステップ 4: インターネット ネットワーク エンドポイント グループ（NEG）を作成するで作成したインターネット NEG に受信トラフィックを振り向けるようにバックエンド構成を構成します。

    1. [グローバル外部アプリケーション ロードバランサを作成する] セクションで、[バックエンドの構成] にカーソルを合わせ、矢印をクリックします。
    2. [バックエンド サービスとバックエンド バケット] セクションで、プルダウンから [バックエンド サービス] > [バックエンド サービスを作成] の順に選択します。
      [バックエンド サービスを作成] ウィンドウのスライドが開きます。
    3. 必要に応じて、[名前] フィールドに名前を入力します。
    4. [バックエンド タイプ] プルダウンで [インターネット ネットワーク エンドポイント グループ] を選択します。
    5. プロトコルとして [HTTPS] を選択します。
    6. [新しいバックエンド] セクションの [インターネット ネットワーク エンドポイント グループ] プルダウン メニューで、ステップ 4: インターネット ネットワーク エンドポイント グループ（NEG）を作成するで作成したインターネット NEG を選択し、[完了] をクリックします。
    7. [Cloud CDN を有効にする] チェックボックスをオフにします。
    8. その他の値はすべてデフォルトのままでかまいません。
    9. [作成] をクリックします。
    ホストとパスのルール

    ホストとパスのルールを構成して、トラフィックを指示する方法を決定します。

    1. [グローバル外部アプリケーション ロードバランサを作成する] セクションで、[ホストとパスのルール] にカーソルを合わせ、矢印をクリックします。
    2. [モード] の [詳細なホストとパスのルール（URL リダイレクト、URL の書き換え）] をクリックします。
    3. [新しいホストとパスのルール] セクションで、次の操作を行います。
      1. [アクション] プルダウンで [トラフィックを 1 つのバックエンドにルーティング] を選択します。
      2. [アドオン アクション（URL の書き換え）] を開きます。
      3. ステップ 3: ポータルのデフォルトのホスト名を確認するでコピーしたデフォルトのドメイン名を、[ホストの書き換え] フィールドに入力します。
      4. [バックエンド] プルダウンで、構成したバックエンド サービスを選択します。
      5. [完了] をクリックします。

  2. [グローバル外部アプリケーション ロードバランサを作成する] ページで、[作成] をクリックします。

ステップ 6: ポータルでカスタム ドメインを構成する

ポータルでカスタム ドメインを構成するには:

  1. Apigee UI で、サイド ナビゲーション バーから [公開] > [ポータル] を選択します。
    ポータルのリストが表示されます。
  2. リストからポータルを選択します。
  3. ランディング ページまたは上部のナビゲーション バーにあるプルダウンから [設定] を選択します。
  4. [ドメイン] タブをクリックします。
  5. [ドメイン] フィールドにカスタム ドメイン名を入力します。
  6. [有効にする] をクリックします。

ブラウザでカスタム ドメインにアクセスすると、統合ポータルにリダイレクトされることをテストします。

カスタム ドメインの編集とカスタム ドメインの無効化もご覧ください。

ステップ 7: DNS を更新する

DNS システムで、カスタム ドメインホストの新しいレコードを作成します。

Cloud DNS ゾーンを作成するには、ゾーンの管理で説明されている手順を行います。以下の説明に従ってフィールドを構成してください。

フィールド 説明
ゾーンのタイプ [公開] を選択します。
ゾーン名 ゾーンの名前としてわかりやすいものを入力します。例: mycompany-zone
DNS 名 所有しているドメイン名を使用してゾーンのサフィックスを入力します。例: mycompany.com

ゾーンを作成した後、ゾーンの詳細ページで [Add record set] をクリックし、レコードの管理の手順を行います。以下の説明に従ってフィールドを構成してください。

フィールド 説明
DNS 名 DNS 名の接頭辞を指定します。Cloud DNS ゾーンに定義した接頭辞も表示されますが、編集することはできません。例: developers.mycompany.com
リソース レコードのタイプ [A]（デフォルト）を選択します。
TTL 目的の値に設定するか、[5]（デフォルト）のままにします。
TTL 単位 目的の値に設定するか、[分]（デフォルト）のままにします。
IPv4 アドレス ロードバランサの作成時に予約した外部 IP アドレスを入力します。

ポータルでのカスタム ドメインの編集

ポータルでカスタム ドメインを編集する場合:

  1. Apigee UI で、サイド ナビゲーション バーから [公開] > [ポータル] を選択します。
    ポータルのリストが表示されます。
  2. リストからポータルを選択します。
  3. 上部のナビゲーション バーにあるプルダウン メニューまたはランディング ページで [設定] を選択します。
  4. [ドメイン] タブをクリックします。
  5. カスタム ドメインの情報を編集します。
  6. [保存] をクリックします。

ポータルでのカスタム ドメインの無効化

ポータルでカスタム ドメイン名を無効にする場合:

  1. Apigee UI で、サイド ナビゲーション バーから [公開] > [ポータル] を選択します。ポータルのリストが表示されます。
  2. リストからポータルを選択します。
  3. 上部のナビゲーション バーにあるプルダウン メニューまたはランディング ページで [設定] を選択します。
  4. [ドメイン] タブをクリックします。
  5. [無効にする] をクリックします。
  6. 操作の確認を求めるメッセージで [無効にする] をクリックします。

カスタム ドメインが無効になり、フィールドがクリアされます。