第10章 カスタムドメインの設定

https://developer.mydomain.com または https://api.mydomain.com のように、ご自分の企業ドメイン名に属するデベロッパーポータルのブランディングを設定することができます。3scale のお客様の中で最も人気のあるオプションは developer.mydomain.com です。

カスタムデベロッパーポータルドメイン用に、SaaS 版 3scale プラットフォームは Let's Encrypt 認証局が発行する SSL 証明書を管理します。

以下の手順に従って、デベロッパーポータルの URL をご自分の企業ドメイン名に属するものに変更します。

10.1. 前提条件

  • 有料の 3scale プランにサブスクライブする必要があります。
  • 有効な 3scale エンタイトルメントが設定された Red Hat アカウントが必要です。

Red Hat アカウントに関してサポートが必要であれば、Red Hat カスタマーサービス にお問い合わせください。

10.2. 手順

10.2.1. DNS 設定への CNAME エントリーの追加

DNS において、ドメイン名を autossl.3scale.net にポイントする CNAME レコードを追加します。たとえば、autossl.3scale.net にポイントするドメイン developer.mydomain.com は、以下のようになります。

developer.mydomain.com.  CNAME  autossl.3scale.net.

通常、デベロッパーポータルへのパブリックアクセスを許可する前に、カスタムドメインに変更を加えます。パブリックユーザーがすでにいる場合は、mydomain.3scale.net からカスタムドメインへのリダイレクトを定義することができないことに注意してください。そのため、ドメインの変更についてユーザーに通知する必要があります。

事前に CNAME を実装することが推奨されます。上記が不可能なまれなケースでは (そのドメインで一般に公開されている既存サイトがある場合など)、Red Hat サポート に問い合わせてスイッチオーバーを同期させるのに最適な方法を判断してください。

DNS の変更が反映されるまでに、多少時間がかかる場合があります。CNAME レコードが正しく設定されていることを確認します。以下のコマンドを使用して、CNAME 設定を確認することができます。

dig cname developer.mydomain.com

または

nslookup developer.mydomain.com

10.2.2. DNS 設定への CAA レコードの追加 (オプション)

認証局の承認 (CAA) を使用している場合は、ルートドメインの letsencrypt.org アドレスの CAA レコードを追加して、Let's Encrypt 認証局がドメインの証明書を発行できるようにする必要があります。たとえば、letsencrypt.org にポイントするドメイン mydomain.com は、以下のようになります。

mydomain.com.  CAA 0 issue "letsencrypt.org"

DNS プロバイダーによっては、 0 issue "letsencrypt.org" フラグ、タグ、および値をルートドメインの CAA レコードの認証局リストに追加しなければならない場合があります。CAA レコードの設定方法は、お使いの DNS プロバイダーにお問い合せください。

10.2.3. Red Hat サポートへの問い合わせ

CNAME エントリーを追加し、オプションで CAA レコードを DNS 設定に追加したら、デベロッパーポータルのドメイン変更を要求するために Red Hat サポートケース を作成して以下の情報を指定する必要があります。

  • 「Red Hat 3scale API Management Platform」製品を選択します
  • ケースの説明には、以下を追加します。

    • 3scale アカウントの管理ポータルドメイン (例: mydomain-admin.3scale.net)。
    • デベロッパーポータルで使用するカスタムドメイン (例: developer.mydomain.com)。

チケットを送信すると、Red Hat サポートは DNS 設定を検証し、変更が適用されたら確認したことを通知するか、あるいは必要に応じて応答します。

10.2.4. デベロッパーポータルの確認

ドメインの変更に関する Red Hat サポートからの確認を受け取ったら、デベロッパーポータルを確認し、テストします。カスタムドメインへの非相対リンクが更新されていることを確認します。