メインコンテンツまでスキップ

Gateway URL Configuration

概要

Gatewayインスタンスを作成した後、外部に公開するために1つ以上のGateway URLを登録する必要があります。これには、ベースドメイン、TLS証明書、Ingress設定、およびオプションのメタデータ(ラベル、アノテーション)を定義することが含まれます。このチュートリアルでは、モックデータを使用して、シンプルおよび高度なアノテーション方法の両方で完全なGateway URLを構成する方法を示します。

前提条件

  • Gateway がすでに作成されています(例:gateway-test-01)
  • TLS証明書および秘密鍵ファイルにアクセスできます
  • ベースドメインがDNSにマッピングされています(例:api.sksample.co.kr
  • 管理者としてログインしています

ステップバイステップチュートリアル

ステップ1. Gateway URL構成を開く

  • Gateway管理画面に移動します
  • 対象のGateway(例:gateway-test-01)を選択してGateway編集画面にアクセスします
  • Gateway URLセクションまでスクロールし、Addボタンをクリックして新しいGateway URLを追加します

ステップ2. Gateway URLとベースパスを入力

Field Example
Gateway URLapi.sksample.co.kr
Global BasePath/gateway-test-01

完全なAPI URLはhttps://api.sksample.co.kr/gateway-test-01になります。

ステップ3. HTTPSを有効にし、証明書をアップロード

  • HTTPS OnlyをONに切り替えます
  • TLS Certificate (tls.crt)を貼り付けます。例:
----BEGIN CERTIFICATE-----
MIIFzjCCBbegAwIBAgISBKKPTR3WPWUG2AcFUD4Dn45iMA0GCSqGSIb3DQEBCwUA
...
-----END CERTIFICATE-----
  • TLS Private Key (tls.key)を貼り付けます。例:
----BEGIN PRIVATE KEY-----
MIIEv...
...
-----END PRIVATE KEY-----

証明書は有効であり、指定されたドメイン名と一致する必要があります。

ステップ4. Ingressクラスを設定

Gatewayで使用するIngressクラスを選択します:

Field Value
Ingress Classnginx

ステップ5. ラベルを定義(オプション)

識別や自動化のためにメタデータラベルを追加できます:

KeyValue
envproduction
regionkr-central

さらに追加するには、プラスアイコンをクリックします。追加したラベルを削除するには、バツアイコンをクリックします。

ステップ6. アノテーションを追加

アノテーションを入力する方法は2つあります:

方法1:キー-バリュー入力(JSONトグルOFF)

KeyValue
nginx.ingress.kubernetes.io/ssl-redirecttrue
nginx.ingress.kubernetes.io/backend-protocolHTTPS

このモードは明確さと個別編集のために使用します。

方法2:JSONモード(JSONトグルON)

JSONトグルをクリックし、次の構造を入力します:

{
"nginx.ingress.kubernetes.io/ssl-redirect": "true",
"nginx.ingress.kubernetes.io/backend-protocol": "HTTPS"
}

このモードは、大量のアノテーションセットを一度にインポートする際に便利です。

ステップ7. 構成を保存

GATEWAY URL保存ボタンをクリックします。 確認を待ち、URLがリストに表示されることを確認します。

ヒントとベストプラクティス

  • HTTPSのみを使用して安全なトラフィックを強制します
  • 証明書のドメインをGateway URLと正確に一致させます
  • アノテーションは重要なIngressの動作を制御します - Kubernetes Ingressコントローラーのドキュメントを確認して、すべてのオプションを確認してください
  • ラベルを使用して将来の自動化を可能にします(例:CI/CDルーティング、監視フィルター)