リファレンス: セルフホステッド ゲートウェイの Azure Arc 構成設定
適用対象: Developer | Premium
この記事では、Azure Arc 拡張機能を、API Management セルフホステッド ゲートウェイ コンテナーに対して構成するために使われる必要な設定と省略可能な設定のリファレンスを提供します。
重要
Azure Arc での API Management セルフホステッド ゲートウェイは、現在プレビュー段階です。 プレビュー期間中、API Management ゲートウェイ拡張機能は次のリージョンで使用できます。
- アジア (東、南東)
- オーストラリア (中部、中部 2、東部、南東)
- ブラジル (南と南東)
- カナダ (中部、東部)
- ヨーロッパ (北、西)
- フランス (中部と南部)
- ドイツ (北部と中西部)
- インド (中央、南、西、九尾中央&九尾西)
- 日本 (東西)
- 韓国 (中部と南部)
- ノルウェー (東部と西部)
- 南アフリカ (北と西)
- スウェーデン (中部)
- スイス (北と西)
- アラブ首長国連邦 (アラブ首長国連邦 - 中部&北)
- イギリス (UK -南部)
- 米国 (US - 中部、中部 EUAP、東部、東部 2、東部 2 EUAP、北中部、南中部、西中部、西部、西部 2、西部 3)
構成 API の統合
構成 API は、Azure API Management に接続して最新の構成を取得し、有効にした場合にメトリックを送信するためにセルフホステッド ゲートウェイによって使用されます。
すべての構成オプションの概要を次に示します。
| Name | 説明 | 必要 | Default |
|---|---|---|---|
gateway.configuration.uri |
セルフホステッド ゲートウェイの Azure API Management の構成エンドポイント。 この値は、Azure portal の [ゲートウェイ]>[デプロイ] の下にあります。 | はい | 該当なし |
gateway.auth.token |
Azure API Management サービスに対して認証するための認証キー。 通常、GatewayKey で始まります。 |
はい | 該当なし |
gateway.configuration.backup.enabled |
有効にすると、ダウンロードした最新の構成のバックアップ コピーをストレージ ボリュームに保存します | false |
|
gateway.configuration.backup.persistentVolumeClaim.accessMode |
永続ボリューム要求 (PVC) ポッドのアクセス モード | ReadWriteMany |
|
gateway.configuration.backup.persistentVolumeClaim.size |
作成する永続ボリューム要求 (PVC) のサイズ | 50Mi |
|
gateway.configuration.backup.persistentVolumeClaim.storageClassName |
永続ボリューム要求 (PVC) に使用するストレージ クラス名。 値が割り当てられていない場合 (null)、プラットフォームの既定値が使用されます。 指定されたストレージ クラスは ReadWriteMany アクセス モードをサポートしている必要があります。サポートされているボリューム プロバイダーとそれらでサポートされているアクセス モードの詳細を確認してください。 |
null |
クロスインスタンス検出と同期
| 名前 | 説明 | 必要 | Default |
|---|---|---|---|
service.instance.heartbeat.port |
他のインスタンスにハートビートを送信するために、セルフホステッド ゲートウェイデプロイのインスタンスに使用される UDP ポート。 | いいえ | 4291 |
service.instance.synchronization.port |
複数のインスタンス間でレート制限を同期するために、セルフホステッド ゲートウェイ インスタンスに使用される UDP ポート。 | いいえ | 4290 |
メトリック
| 名前 | 説明 | 必要 | Default |
|---|---|---|---|
telemetry.metrics.cloud |
Azure Monitor に対するメトリックの生成を有効にするかどうかを示します。 | いいえ | true |
telemetry.metrics.local |
StatsD を使ってローカル メトリックの収集を有効にします。 値は、以下のオプションの いずれかです。none、statsd。 |
いいえ | 該当なし |
telemetry.metrics.localStatsd.endpoint |
StatsD エンドポイント。 | telemetry.metrics.local を statsd に設定した場合は "はい"。それ以外の場合は "いいえ"。 |
該当なし |
telemetry.metrics.localStatsd.sampling |
StatsD メトリックのサンプリング レート。 値は 0 から 1 にする必要があります (たとえば 0.5)。 | いいえ | 該当なし |
telemetry.metrics.localStatsd.tagFormat |
StatsD エクスポーターのタグ付け形式。 値は、以下のオプションの いずれかです。ibrato、dogStatsD、influxDB。 |
いいえ | 該当なし |
telemetry.metrics.opentelemetry.enabled |
Kubernetes 上で OpenTelemetry コレクターに対するメトリックの生成を有効にするかどうかを示します。 | いいえ | false |
telemetry.metrics.opentelemetry.collector.uri |
メトリックの送信先 OpenTelemetry コレクターの URI。 | observability.opentelemetry.enabled を true に設定した場合は "はい"。それ以外の場合は "いいえ"。 |
該当なし |
ログ
| 名前 | 説明 | 必要 | Default |
|---|---|---|---|
telemetry.logs.std |
標準ストリームへのログ記録を有効にします。 値は、以下のオプションの いずれかです。none、text、json。 |
いいえ | text |
telemetry.logs.local |
ローカルのログ記録を有効にします。 値は、以下のオプションの いずれかです。none、auto、localsyslog、 rfc5424、 journal、 json |
いいえ | auto |
telemetry.logs.localConfig.localsyslog.endpoint |
ローカル Syslog のエンドポイント | telemetry.logs.local を localsyslog に設定した場合は "はい"。それ以外の場合は "いいえ"。 |
該当なし |
telemetry.logs.localConfig.localsyslog.facility |
ローカル Syslog のファシリティ コードを指定します。たとえば、7 です。 |
いいえ | 該当なし |
telemetry.logs.localConfig.rfc5424.endpoint |
rfc5424 エンドポイント。 | telemetry.logs.local を rfc5424 に設定した場合は "はい"。それ以外の場合は "いいえ"。 |
該当なし |
telemetry.logs.localConfig.rfc5424.facility |
rfc5424 によるファシリティ コード (たとえば 7) |
いいえ | 該当なし |
telemetry.logs.localConfig.journal.endpoint |
ジャーナル エンドポイント。 | telemetry.logs.local を journal に設定した場合は "はい"。それ以外の場合は "いいえ"。 |
該当なし |
トラフィックのルーティング
| Name | 説明 | 必要 | Default |
|---|---|---|---|
service.type |
ゲートウェイの公開に使用する Kubernetes サービスの種類。 (ドキュメント) | いいえ | ClusterIP |
service.http.port |
HTTP トラフィックを公開するために使用するポート。 | いいえ | 8080 |
service.http.nodePort |
HTTP トラフィックを公開するために使用するノード上のポート。 これには、サービスの種類として NodePort が必要です。 |
いいえ | 該当なし |
service.https.port |
HTTPS トラフィックを公開するために使用するポート。 | いいえ | 8081 |
service.https.nodePort |
HTTPS トラフィックを公開するために使用するノード上のポート。 これには、サービスの種類として NodePort が必要です。 |
いいえ | 該当なし |
service.annotations |
ゲートウェイのために Kubernetes サービスに追加する注釈。 | いいえ | 該当なし |
ingress.annotations |
ゲートウェイのために Kubernetes イングレスに追加する注釈。 (試験段階) | いいえ | 該当なし |
ingress.enabled |
Kubernetes イングレスを使用する必要があるかどうかを示します。 (試験段階) | いいえ | false |
ingress.tls |
Kubernetes イングレスの TLS 構成。 (試験段階) | いいえ | 該当なし |
ingress.hosts |
Kubernetes イングレスに使用するホストの構成。 (試験段階) | いいえ | 該当なし |
統合
セルフホステッド ゲートウェイは、他のさまざまなテクノロジと統合されます。 このセクションでは、使用できる構成オプションの概要について説明します。
Dapr
| Name | 説明 | 必要 | Default |
|---|---|---|---|
dapr.enabled |
Dapr 統合を使用する必要があるかどうかを示します。 | いいえ | false |
dapr.app.id |
Dapr 統合に使用するアプリケーション ID | なし | |
dapr.config |
CRD Dapr がどの構成を使用すべきかを定義します | tracing |
|
dapr.logging.level |
Dapr サイドカーのログ詳細度のレベル | info |
|
dapr.logging.useJsonOutput |
ログが JSON 形式である必要があるかどうかを示します | true |
Azure Monitor
| 名前 | 説明 | 必要 | Default |
|---|---|---|---|
monitoring.customResourceId |
ログを送信する Azure Log Analytics ワークスペースのリソース ID。 | いいえ | 該当なし |
monitoring.ingestionKey |
ログを送信する Azure Log Analytics ワークスペースで認証するためのインジェスト キー。 | いいえ | 該当なし |
monitoring.workspaceId |
ログを送信する Azure Log Analytics ワークスペースのワークスペース ID。 | いいえ | N/A |
イメージとワークロードのスケジュール設定
Kubernetes は強力なオーケストレーション プラットフォームであり、デプロイする必要があるものとそれのスケジュール方法を柔軟に設定できます。
このセクションでは、使用されるイメージに影響を与えるために使用できる構成オプションの概要、それが自己修復するようにスケジュール設定および構成される方法について説明します。
| Name | 説明 | 必要 | Default |
|---|---|---|---|
replicaCount |
実行するセルフホステッド ゲートウェイのインスタンスの数。 | いいえ | 3 |
image.repository |
実行するイメージ。 | いいえ | mcr.microsoft.com/azure-api-management/gateway |
image.pullPolicy |
コンテナー イメージのプルに使用するポリシー。 | いいえ | IfNotPresent |
image.tag |
使用するコンテナー イメージ タグ。 | いいえ | 拡張機能のアプリ バージョンが使用されています |
imagePullSecrets |
コンテナー イメージをプルするときにコンテナー レジストリでの認証に使用する Kubernetes シークレット。 | いいえ | 該当なし |
probes.readiness.httpGet.path |
コンテナーの readiness probe に使用する URI パス | いいえ | /status-0123456789abcdef |
probes.readiness.httpGet.port |
コンテナーの liveness probe に使用するポート | いいえ | http |
probes.liveness.httpGet.path |
コンテナーの liveness probe に使用する URI パス | いいえ | /status-0123456789abcdef |
probes.liveness.httpGet.port |
コンテナーの liveness probe に使用するポート | いいえ | http |
highAvailability.enabled |
ゲートウェイをクラスター内で頻繫に使用できるようスケジュール設定する必要があるかどうかを示します。 | いいえ | false |
highAvailability.disruption.maximumUnavailable |
自発的な中断のために使用できないことを許容するポッドの量。 | いいえ | 25% |
highAvailability.podTopologySpread.whenUnsatisfiable |
要件を満たすことができない場合に備えて、ポッドをノード間で分散する方法を示します。 「Kubernetes のドキュメント」で詳細を確認してください | いいえ | ScheduleAnyway |
resources |
ゲートウェイに割り当てる CPU/メモリ リソースを定義する機能 | いいえ | 該当なし |
nodeSelector |
セレクターを使用して、ゲートウェイを実行するノードを識別する機能。 | いいえ | 該当なし |
affinity |
ポッドのスケジュール設定のためのアフィニティ (ドキュメント) | いいえ | 該当なし |
tolerations |
ポッドのスケジュール設定の容認 (ドキュメント) | いいえ | 該当なし |