構成プロパティのリファレンス

このセクションでは、Apigee ハイブリッドのデプロイのランタイム プレーンをカスタマイズする際に使用できるすべての構成プロパティを示します。

最上位プロパティ

次の表に、overrides.yaml ファイルの最上位プロパティを示します。このようなプロパティは他のオブジェクトに属しておらず、組織レベルまたは環境レベルで適用されます。

プロパティ 説明
contractProvider バージョン: 1.0.0

デフォルト値: https://apigee.googleapis.com

インストール環境にデプロイされているすべての API の API パスを定義します。
gcpProjectID 非推奨: v1.2.0 以降では、代わりに gcp.projectID を使用します。

バージョン: 1.0.0

デフォルト値: なし

必須

GCP プロジェクトの ID。このプロパティと k8sClusterName（非推奨）および gcpRegion（非推奨）との組み合わせによってプロジェクトが識別され、apigee-logger と apigee-metrics のデータの push 先が決まります。
gcpRegion 非推奨: v1.2.0 以降では、代わりに gcp.region を使用します。

バージョン: 1.0.0

デフォルト値: us-central1

必須

Kubernetes クラスタの最も近い GCP リージョンまたはゾーン。このプロパティと gcpProjectID（非推奨）および k8sClusterName（非推奨）との組み合わせによってプロジェクトが識別され、apigee-logger と apigee-metrics のデータの push 先が決まります。
imagePullSecrets.name バージョン: 1.0.0

デフォルト値: なし

docker-registry タイプとして構成された Kubernetes Secret 名。プライベート リポジトリからイメージを pull するために使用されます。
k8sClusterName 非推奨: v1.2.0 以降では、代わりに k8sCluster.name と k8sCluster.region を使用します。

バージョン: 1.0.0

デフォルト値: なし

ハイブリッド プロジェクトが実行されている Kubernetes（K8s）プロクラスタの名前。このプロパティと gcpProjectID（非推奨）および gcpRegion（非推奨）との組み合わせによってプロジェクトが識別され、apigee-logger と apigee-metrics のデータの push 先が決まります。
kmsEncryptionKey バージョン: 1.0.0

デフォルト値: defaults.org.kmsEncryptionKey

省略可。kmsEncryptionKey、kmsEncryptionPath、kmsEncryptionSecret のいずれか 1 つのみを使用します。

Apigee KMS データの暗号鍵のローカル ファイル システム上のパス。
kmsEncryptionPath バージョン: 1.2.0

デフォルト値: なし

省略可。kmsEncryptionKey、kmsEncryptionPath、kmsEncryptionSecret のいずれか 1 つのみを使用します。

Base64 でエンコードされた暗号鍵を含むファイルのパス。データ暗号化をご覧ください。
kmsEncryptionSecret.key バージョン: 1.2.0

デフォルト値: なし

省略可。kmsEncryptionKey、kmsEncryptionPath、kmsEncryptionSecret のいずれか 1 つのみを使用します。

Base64 でエンコードされた暗号鍵を含む Kubernetes Secret の鍵。データ暗号化をご覧ください。
kmsEncryptionSecret.name バージョン: 1.2.0

デフォルト値: なし

省略可。kmsEncryptionKey、kmsEncryptionPath、kmsEncryptionSecret のいずれか 1 つのみを使用します。

Base64 でエンコードされた暗号鍵を含む Kubernetes Secret の名前。データ暗号化をご覧ください。
kvmEncryptionKey バージョン: 1.0.0

デフォルト値: defaults.org.kmsEncryptionKey

省略可。kvmEncryptionKey、kvmEncryptionPath、kvmEncryptionSecret のいずれか 1 つのみを使用します。

Apigee KVM データの暗号鍵のローカル ファイル システム上のパス。
kvmEncryptionPath バージョン: 1.2.0

デフォルト値: なし

省略可。kvmEncryptionKey、kvmEncryptionPath、kvmEncryptionSecret のいずれか 1 つのみを使用します。

Base64 でエンコードされた暗号鍵を含むファイルのパス。データ暗号化をご覧ください。
kvmEncryptionSecret.key バージョン: 1.2.0

デフォルト値: なし

省略可。kvmEncryptionKey、kvmEncryptionPath、kvmEncryptionSecret のいずれか 1 つのみを使用します。

Base64 でエンコードされた暗号鍵を含む Kubernetes Secret の鍵。データ暗号化をご覧ください。
kvmEncryptionSecret.name バージョン: 1.2.0

デフォルト値: なし

省略可。kvmEncryptionKey、kvmEncryptionPath、kvmEncryptionSecret のいずれか 1 つのみを使用します。

Base64 でエンコードされた暗号鍵を含む Kubernetes Secret の名前。データ暗号化をご覧ください。
namespace バージョン: 1.0.0

デフォルト値: apigee

Apigee コンポーネントがインストールされる Kubernetes クラスタの Namespace。
org

バージョン: 1.0.0

デフォルト値: なし

必須

ハイブリッドのインストール中に Apigee によってプロビジョニングされたハイブリッド対応組織。組織とは、Apigee Edge での最上位レベルのコンテナです。組織にはすべての API プロキシと関連リソースが含まれています。この値が空の場合は、組織を作成してその名前をこのプロパティに設定する必要があります。
revision バージョン: 1.0.0

デフォルト値: 1.0.0

Apigee ハイブリッドは Kubernetes のローリング アップデートをサポートしています。Pod インスタンスを段階的に新しいインスタンスに更新できるので、Deployment の更新をダウンタイムなしで行うことができます。

ある特定の YAML オーバーライドを更新した結果、基になる Kubernetes PodTemplateSpec が変更される場合は、ユーザー独自の override.yaml で revision オーバーライド プロパティも変更する必要があります。これは、基盤となる Kubernetes ApigeeDeployment（AD）コントローラが旧バージョンから新しいバージョンへのローリング アップデートを安全に行うために必須です。「blue」、「a」、「1.0.0」などの任意のテキスト値を使用できます。

revision プロパティを変更して適用すると、すべてのコンポーネントに対してローリング アップデートが行われます。

次のオブジェクトのプロパティを変更する場合は、revision を更新する必要があります。

詳細については、ローリング アップデートをご覧ください。
validateServiceAccounts バージョン: 1.0.0

デフォルト値: true

サービス アカウント権限の厳密な検証を有効にします。これを有効にすると、Cloud Resource Manager API メソッドの testIamPermissions を使用して、指定されたサービス アカウントに必要な権限があるかどうかが検証されます。Apigee 組織のサービス アカウントの場合は、プロジェクト ID がその組織にマッピングされたものかどうかがチェックされます。Metrics と Logger の場合、プロジェクトのチェックは overrides.yaml の gcpProjectID プロパティの構成に基づきます。

gcpProjectID もご覧ください。

ao

Apigee 演算子（AO）。AD のデプロイとメンテナンスに必要な低レベルの Kubernetes リソースと Istio リソースを作成および更新します。たとえば、このコントローラは Message Processor をリリースします。また、ApigeeDeployment 構成を Kubernetes クラスタに永続化する前に検証します。

次の表に、apigee-operator ao オブジェクトのプロパティを示します。

プロパティ 説明
ao.image.pullPolicy バージョン: 1.2.0

デフォルト値: IfNotPresent

kubelet が Pod の Docker イメージをいつ pull するかを指定します。有効な値は次のとおりです。

  • IfNotPresent: イメージがすでに存在する場合、新しいイメージは pull しません。
  • Always: イメージがすでに存在するかどうかにかかわらず、常にイメージを pull します。

詳細については、イメージの更新をご覧ください。
ao.image.tag バージョン: 1.2.0

デフォルト値: 1.2.0

このサービスの Docker イメージの場所。
ao.image.url バージョン: 1.2.0

デフォルト値: "google/apigee-deployment-controller"

このサービスの Docker イメージの場所。
ao.resources.limits.cpu バージョン: 1.2.0

デフォルト値: 250m

Kubernetes コンテナ内のリソースの CPU 上限（ミリコア単位）。
ao.resources.limits.memory バージョン: 1.2.0

デフォルト値: 256Mi

Kubernetes コンテナ内のリソースのメモリ上限（MiB 単位）。
ao.resources.requests.cpu バージョン: 1.2.0

デフォルト値: 250m

Kubernetes コンテナ内のリソースの通常の操作に必要な CPU（ミリコア単位）。
ao.resources.requests.memory バージョン: 1.2.0

デフォルト値: 256Mi

Kubernetes コンテナ内のリソースの通常の操作に必要なメモリ（MiB 単位）。

authz

次の表に、authz オブジェクトのプロパティを示します。

プロパティ 説明
authz.image.pullPolicy バージョン: 1.0.0

デフォルト値: IfNotPresent

kubelet が Pod の Docker イメージをいつ pull するかを指定します。有効な値は次のとおりです。

  • IfNotPresent: イメージがすでに存在する場合、新しいイメージは pull しません。
  • Always: イメージがすでに存在するかどうかにかかわらず、常にイメージを pull します。

詳細については、イメージの更新をご覧ください。
authz.image.tag バージョン: 1.0.0

デフォルト値: 1.2.0

このサービスの Docker イメージのバージョン ラベル。
authz.image.url バージョン: 1.0.0

デフォルト値: "google/apigee-authn-authz"

このサービスの Docker イメージの場所。
authz.livenessProbe.failureThreshold バージョン: 1.0.0

デフォルト値: 2

Kubernetes がコンテナを再起動するための条件となる、Liveness Probe の失敗が確認された回数。最小値は 1 です。
authz.livenessProbe.initialDelaySeconds バージョン: 1.0.0

デフォルト値: 0

コンテナが起動してから Liveness Probe が開始されるまでの秒数。
authz.livenessProbe.periodSeconds バージョン: 1.0.0

デフォルト値: 5

Liveness Probe を実行する頻度を秒単位で指定します。最小値は 1 です。
authz.livenessProbe.timeoutSeconds バージョン: 1.0.0

デフォルト値: 1

Liveness Probe がタイムアウトするまでの秒数。最小値は 1 です。
authz.readinessProbe.failureThreshold バージョン: Beta2

デフォルト値: 2

Kubernetes が Pod を「準備未完了」とマークするための条件となる、Readiness Probe の失敗が確認された回数。最小値は 1 です。
authz.readinessProbe.initialDelaySeconds バージョン: 1.0.0

デフォルト値: 0

コンテナが起動してから Readiness Probe が開始されるまでの秒数。
authz.readinessProbe.periodSeconds バージョン: 1.0.0

デフォルト値: 5

Readiness Probe を実行する頻度を秒単位で指定します。最小値は 1 です。
authz.readinessProbe.successThreshold バージョン: 1.0.0

デフォルト値: 1

失敗した Readiness Probe が成功とみなされるために必要な最小の連続成功回数。最小値は 1 です。
authz.readinessProbe.timeoutSeconds バージョン: 1.0.0

デフォルト値: 1

Liveness Probe がタイムアウトするまでの秒数。最小値は 1 です。
authz.resources.requests.cpu バージョン: 1.0.0

デフォルト値: 50m

認証リクエストに割り当てる CPU リソースの量。

authz.resources.requests.memory バージョン: 1.0.0

デフォルト値: 128Mi

認証リクエストに割り当てるメモリリソースの量。

busyBoxInit（非推奨）

次の表に、busyBoxInit オブジェクトのプロパティを示します。

プロパティ 説明
busyBoxInit.image.pullPolicy 非推奨。

バージョン: 1.0.0

デフォルト値: IfNotPresent

kubelet が Pod の Docker イメージをいつ pull するかを指定します。有効な値は次のとおりです。

  • IfNotPresent: イメージがすでに存在する場合、新しいイメージは pull しません。
  • Always: イメージがすでに存在するかどうかにかかわらず、常にイメージを pull します。

詳細については、イメージの更新をご覧ください。
busyBoxInit.image.tag 非推奨。

バージョン: 1.0.0

デフォルト値: "1.0.0"

このサービスの Docker イメージのバージョン ラベル。
busyBoxInit.image.url 非推奨。

バージョン: 1.0.0

デフォルト値: "busybox"

このサービスの Docker イメージの場所。

cassandra

ランタイム データ リポジトリを管理するハイブリッド サービスを定義します。このリポジトリには、アプリケーションの構成、分散割り当てカウンタ、API キー、ゲートウェイで実行されているアプリケーションの OAuth トークンが格納されます。

詳細については、Cassandra を構成するをご覧ください。

次の表に、cassandra オブジェクトのプロパティを示します。

プロパティ 説明
cassandra.auth.admin.password バージョン: 1.0.0

デフォルト値: "iloveapis123"

必須

Cassandra 管理者のパスワード。管理ユーザーは、Cassandra クラスタで行われる管理アクティビティに使用されます。
cassandra.auth.ddl.password バージョン: 1.0.0

デフォルト値: "iloveapis123"

必須

Cassandra データ定義言語（DDL）ユーザーのパスワード。キースペースの作成、更新、削除などのデータ定義タスクのために MART によって使用されます。
cassandra.auth.default.password バージョン: 1.0.0

デフォルト値: "iloveapis123"

必須

認証が有効な場合に作成されるデフォルト Cassandra ユーザーのパスワード。このパスワードは、Cassandra 認証を構成するときに再設定する必要があります。詳細については、Cassandra 用の TLS の構成をご覧ください。
cassandra.auth.dml.password バージョン: 1.0.0

デフォルト値: "iloveapis123"

必須

Cassandra データ操作言語（DML）ユーザーのパスワード。DML ユーザーは、クライアントによる Cassandra からのデータの読み取りと Cassandra へのデータの書き込みに使用されます。
cassandra.auth.image.pullPolicy バージョン: 1.0.0

デフォルト値: IfNotPresent

kubelet が Pod の Docker イメージをいつ pull するかを指定します。有効な値は次のとおりです。

  • IfNotPresent: イメージがすでに存在する場合、新しいイメージは pull しません。
  • Always: イメージがすでに存在するかどうかにかかわらず、常にイメージを pull します。

詳細については、イメージの更新をご覧ください。
cassandra.auth.image.tag バージョン: 1.0.0

デフォルト値: 1.2.0

このサービスの Docker イメージのバージョン ラベル。
cassandra.auth.image.url バージョン: 1.0.0

デフォルト値: "google/apigee-cassandra-client"

このサービスの Docker イメージの場所。
cassandra.backup.cloudProvider バージョン: 1.0.0

デフォルト値: "GCP"

バックアップが有効な場合は必須。

バックアップ ストレージのクラウド プロバイダ。
cassandra.backup.dbStorageBucket バージョン: 1.0.0

デフォルト値: なし

バックアップが有効な場合は必須。

バックアップ データ用の Cloud Storage バケット。
cassandra.backup.enabled バージョン: 1.0.0

デフォルト値: false

データ バックアップはデフォルトでは有効になっていません。有効にするには、このプロパティを true に設定します。

Cassandra のバックアップと復元をご覧ください。
cassandra.backup.image.pullPolicy バージョン: 1.0.0

デフォルト値: IfNotPresent

kubelet が Pod の Docker イメージをいつ pull するかを指定します。有効な値は次のとおりです。

  • IfNotPresent: イメージがすでに存在する場合、新しいイメージは pull しません。
  • Always: イメージがすでに存在するかどうかにかかわらず、常にイメージを pull します。

詳細については、イメージの更新をご覧ください。
cassandra.backup.image.tag バージョン: 1.0.0

デフォルト値: 1.2.0

このサービスの Docker イメージのバージョン ラベル。
cassandra.backup.image.url バージョン: 1.0.0

デフォルト値: "google/apigee-cassandra-backup-utility"

このサービスの Docker イメージの場所。
cassandra.backup.schedule バージョン: 1.0.0

デフォルト値: "0 2 * * *"

cron ジョブのスケジュール。

Cassandra のバックアップと復元をご覧ください。
cassandra.backup.serviceAccountPath バージョン: 1.0.0

デフォルト値: なし

バックアップが有効になっている場合は、backup.serviceAccountPath か backup.serviceAccountSecretRef のいずれかが必要です。

ストレージ オブジェクト管理者のロールを持つ Google サービス アカウント キーファイルのパス。

cassandra.backup.serviceAccountSecretRef バージョン: 1.2.0

デフォルト値: なし

バックアップが有効になっている場合は、backup.serviceAccountPath か backup.serviceAccountSecretRef のいずれかが必要です。

Kubernetes Secret の名前。ストレージ オブジェクト管理者のロールを持つ Google サービス アカウント キーを入力として Secret を作成する必要があります。

cassandra.clusterName バージョン: 1.0.0

デフォルト値: "apigeecluster"

Cassandra クラスタの名前を指定します。
cassandra.datacenter バージョン: 1.0.0

デフォルト値: "dc-1"

Cassandra ノードのデータセンターを指定します。
cassandra.dnsPolicy バージョン: 1.1.1

デフォルト値: ClusterFirstWithHostNet

cassandra.hostNetwork を true に設定すると、Cassandra が使用する DNS ポリシーが決まります。Anthos ベースのデプロイでは、ClusterFirstWithHostNet に設定する必要があります。
cassandra.externalSeedHost バージョン: 1.0.0

デフォルト値: なし

Cassandra クラスタノードのホスト名または IP。設定されていない場合は、Kubernetes ローカル サービスが使用されます。
cassandra.heapNewSize バージョン: 1.0.0

デフォルト値: 100M

新しいオブジェクトに割り当てられる JVM システムメモリの量（メガバイト単位）。

cassandra.hostNetwork バージョン: 1.1.1

デフォルト値: true

Anthos ベースのデプロイの場合は true に設定します。

cassandra.image.pullPolicy バージョン: 1.0.0

デフォルト値: IfNotPresent

kubelet が Pod の Docker イメージをいつ pull するかを指定します。有効な値は次のとおりです。

  • IfNotPresent: イメージがすでに存在する場合、新しいイメージは pull しません。
  • Always: イメージがすでに存在するかどうかにかかわらず、常にイメージを pull します。

詳細については、イメージの更新をご覧ください。
cassandra.image.tag バージョン: 1.0.0

デフォルト値: 1.2.0

このサービスの Docker イメージのバージョン ラベル。
cassandra.image.url バージョン: 1.0.0

デフォルト値: "google/apigee-cassandra"

このサービスの Docker イメージの場所。
cassandra.maxHeapSize バージョン: 1.0.0

デフォルト値: 512M

Cassandra のオペレーションに使用可能な JVM システムメモリの上限（メガバイト単位）。

cassandra.multiRegionSeedHost バージョン: 1.0.0

デフォルト値: なし

既存のクラスタを新しいリージョンに拡張するために使用される既存の Cassandra クラスタの IP アドレス。マルチリージョン シードホストを構成するをご覧ください。

cassandra.nodeSelector.key バージョン: 1.0.0

デフォルト値: なし

必須

cassandra データサービス専用の Kubernetes ノードを選択するために使用されるノードセレクタ ラベルのキー。

ノードセレクタを追加するをご覧ください。
cassandra.nodeSelector.value バージョン: 1.0.0

デフォルト値: なし

cassandra データサービス専用の Kubernetes ノードを選択するために使用される省略可能なノードセレクタ ラベルの値。この値により、nodeSelector.apigeeData の設定がオーバーライドされます。

nodeSelector をご覧ください。
cassandra.port バージョン: 1.0.0

デフォルト値: 9042

Cassandra への接続に使用するポート番号。
cassandra.rack バージョン: 1.0.0

デフォルト値: "ra-1"

Cassandra ノードのラックを指定します。
cassandra.readinessProbe.failureThreshold バージョン: 1.0.0

デフォルト値: 2

Kubernetes が Pod を「準備未完了」とマークするための条件となる、Readiness Probe の失敗が確認された回数。最小値は 1 です。
cassandra.readinessProbe.initialDelaySeconds バージョン: 1.0.0

デフォルト値: 0

コンテナが起動してから Readiness Probe が開始されるまでの秒数。
cassandra.readinessProbe.periodSeconds バージョン: 1.0.0

デフォルト値: 10

Readiness Probe を実行する頻度を秒単位で指定します。最小値は 1 です。
cassandra.readinessProbe.successThreshold バージョン: 1.0.0

デフォルト値: 1

失敗した Readiness Probe が成功とみなされるために必要な最小の連続成功回数。最小値は 1 です。
cassandra.readinessProbe.timeoutSeconds バージョン: 1.0.0

デフォルト値: 5

Liveness Probe がタイムアウトするまでの秒数。最小値は 1 です。
cassandra.replicaCount バージョン: 1.0.0

デフォルト値: 1

Cassandra はレプリケートされるデータベースです。このプロパティは、StatefulSet として使用される Cassandra ノードの数を指定します。
cassandra.resources.requests.cpu バージョン: 1.0.0

デフォルト値: 500m

Kubernetes コンテナ内のリソースの通常の操作に必要な CPU（ミリコア単位）。
cassandra.resources.requests.memory バージョン: 1.0.0

デフォルト値: 1Gi

Kubernetes コンテナ内のリソースの通常の操作に必要なメモリ（MiB 単位）。
cassandra.restore.cloudProvider バージョン: 1.0.0

デフォルト値: "GCP"

復元が有効な場合は必須。

バックアップ ストレージのクラウド プロバイダ。
cassandra.restore.dbStorageBucket バージョン: 1.0.0

デフォルト値: なし

復元が有効な場合は必須。

復元するバックアップ データの Cloud Storage バケット。
cassandra.restore.enabled バージョン: 1.0.0

デフォルト値: false
cassandra.restore.image.pullPolicy バージョン: 1.0.0

デフォルト値: IfNotPresent

kubelet が Pod の Docker イメージをいつ pull するかを指定します。有効な値は次のとおりです。

  • IfNotPresent: イメージがすでに存在する場合、新しいイメージは pull しません。
  • Always: イメージがすでに存在するかどうかにかかわらず、常にイメージを pull します。

詳細については、イメージの更新をご覧ください。
cassandra.restore.image.tag バージョン: 1.0.0

デフォルト値: 1.2.0

このサービスの Docker イメージのバージョン ラベル。
cassandra.restore.image.url バージョン: 1.0.0

デフォルト値: "google/apigee-cassandra-backup-utility"

このサービスの Docker イメージの場所。
cassandra.restore.serviceAccountPath バージョン: 1.0.0

デフォルト値: なし

復元が有効になっている場合は、restore.serviceAccountPath か restore.serviceAccountSecretRef のいずれかが必要です。

ストレージ オブジェクト管理者のロールを持つ Google サービス アカウント キーファイルのパス。

cassandra.restore.serviceAccountSecretRef バージョン: 1.2.0

デフォルト値: なし

復元が有効になっている場合は、restore.serviceAccountPath か restore.serviceAccountSecretRef のいずれかが必要です。

Kubernetes Secret の名前。ストレージ オブジェクト管理者のロールを持つ Google サービス アカウント キーを入力として Secret を作成する必要があります。

cassandra.restore.snapshotTimestamp バージョン: 1.0.0

デフォルト値: なし

復元が有効な場合は必須。

復元するバックアップのタイムスタンプ。
cassandra.storage.capacity バージョン: 1.0.0

デフォルト値: 50Gi

storage.storageClass が指定されている場合は必須

ディスクサイズを MiB 単位で指定します。
cassandra.storage.storageClass バージョン: 1.0.0

デフォルト値: なし

使用するオンプレミス ストレージのクラスを指定します。
cassandra.terminationGracePeriodSeconds バージョン: 1.0.0

デフォルト値: 300

Pod の削除リクエストから実際に Pod が強制終了されるまでの時間（秒単位）。この期間中に停止前フックが実行され、動作中のすべてのプロセスが正常に終了します。

defaults

Apigee ハイブリッド インストール環境のデフォルトの暗号鍵。

次の表に、defaults オブジェクトのプロパティを示します。

プロパティ 説明
defaults.org.kmsEncryptionKey バージョン: 1.0.0

デフォルト値: "aWxvdmVhcGlzMTIzNDU2Nw=="

組織のデフォルトの KMS 暗号鍵。

defaults.org.kvmEncryptionKey バージョン: 1.0.0

デフォルト値: "aWxvdmVhcGlzMTIzNDU2Nw=="

組織のデフォルトの KVM 暗号鍵。

defaults.env.kmsEncryptionKey バージョン: 1.0.0

デフォルト値: "aWxvdmVhcGlzMTIzNDU2Nw=="

環境（env）のデフォルトの KMS 暗号鍵。

defaults.env.kvmEncryptionKey バージョン: 1.0.0

デフォルト値: "aWxvdmVhcGlzMTIzNDU2Nw=="

環境（env）のデフォルトの KVM 暗号鍵。

defaults.env.cacheEncryptionKey バージョン: 1.0.0

デフォルト値: "aWxvdmVhcGlzMTIzNDU2Nw=="

環境（env）のデフォルトのキャッシュ暗号鍵。

envs

API プロキシをデプロイできる環境の配列を定義します。各環境は、API プロキシを実行するための分離されたコンテキスト、すなわち「サンドボックス」を提供します。

ハイブリッド対応組織には少なくとも 1 つの環境が必要です。

詳細については、環境を構成するをご覧ください。

次の表に、envs オブジェクトのプロパティを示します。

プロパティ 説明
envs[].cacheEncryptionKey バージョン: 1.0.0

デフォルト値: なし

cacheEncryptionKey、cacheEncryptionPath、cacheEncryptionSecret のいずれかが必要です。

Base64 でエンコードされた暗号鍵。データ暗号化をご覧ください。
envs[].cacheEncryptionPath バージョン: 1.2.0

デフォルト値: なし

cacheEncryptionKey、cacheEncryptionPath、cacheEncryptionSecret のいずれかが必要です。

Base64 でエンコードされた暗号鍵を含むファイルのパス。データ暗号化をご覧ください。
envs[].cacheEncryptionSecret.key バージョン: 1.2.0

デフォルト値: なし

cacheEncryptionKey、cacheEncryptionPath、cacheEncryptionSecret のいずれかが必要です。

Base64 でエンコードされた暗号鍵を含む Kubernetes Secret の鍵。データ暗号化をご覧ください。
envs[].cacheEncryptionSecret.name バージョン: 1.2.0

デフォルト値: なし

cacheEncryptionKey、cacheEncryptionPath、cacheEncryptionSecret のいずれかが必要です。

Base64 でエンコードされた暗号鍵を含む Kubernetes Secret の名前。データ暗号化をご覧ください。
envs[].httpProxy.scheme バージョン: 1.2.0

デフォルト値: なし

HTTP プロキシのタイプを HTTP または HTTPS として指定します。デフォルトでは、「HTTP」が使用されます。
envs[].httpProxy.host バージョン: 1.2.0

デフォルト値: なし

HTTP プロキシが動作しているホストの名前または IP アドレスを指定します。
envs[].httpProxy.port バージョン: 1.2.0

デフォルト値: なし

HTTP プロキシが動作しているポートを指定します。このプロパティを省略すると、HTTP の場合はポート 80、HTTPS の場合はポート 443 がデフォルトで使用されます。
envs[].httpProxy.username バージョン: 1.2.0

デフォルト値: なし

HTTP プロキシで Basic 認証が必要な場合、このプロパティを使用してユーザー名を指定します。
envs[].httpProxy.password バージョン: 1.2.0

デフォルト値: なし

HTTP プロキシで Basic 認証が必要な場合、このプロパティを使用してパスワードを指定します。
envs[].kmsEncryptionKey バージョン: 1.0.0

デフォルト値: なし

kmsEncryptionKey、kmsEncryptionPath、kmsEncryptionSecret のいずれかが必要です。

Apigee KMS データの暗号鍵のローカル ファイル システム上のパス。
envs[].kmsEncryptionPath バージョン: 1.2.0

デフォルト値: なし

kmsEncryptionKey、kmsEncryptionPath、kmsEncryptionSecret のいずれかが必要です。

Base64 でエンコードされた暗号鍵を含むファイルのパス。データ暗号化をご覧ください。
envs[].kmsEncryptionSecret.key バージョン: 1.2.0

デフォルト値: なし

kmsEncryptionKey、kmsEncryptionPath、kmsEncryptionSecret のいずれかが必要です。

Base64 でエンコードされた暗号鍵を含む Kubernetes Secret の鍵。データ暗号化をご覧ください。
envs[].kmsEncryptionSecret.name バージョン: 1.2.0

デフォルト値: なし

kmsEncryptionKey、kmsEncryptionPath、kmsEncryptionSecret のいずれかが必要です。

Base64 でエンコードされた暗号鍵を含む Kubernetes Secret の名前。データ暗号化をご覧ください。
envs[].name バージョン: 1.0.0

デフォルト値: なし

必須

同期する Apigee 環境名。
envs[].pollInterval バージョン: 1.0.0

デフォルト値: なし

組織および環境との同期をとるために変更をポーリングする間隔（秒単位）。
envs[].port バージョン: 1.0.0

デフォルト値: なし

HTTPS トラフィックの TCP ポート番号。
envs[].serviceAccountPaths.synchronizer バージョン: 一般提供

デフォルト値: なし

Apigee Synchronizer 管理者のロールを持つ Google サービス アカウント キーを含むファイルのローカル システム上のパス。
envs[].serviceAccountPaths.udca バージョン: 一般提供

デフォルト値: なし

Apigee Analytic エージェントのロールを持つ Google サービス アカウント キーを含むファイルのローカル システム上のパス。
envs[].serviceAccountSecretRefs.synchronizer バージョン: 1.2.0

デフォルト値: なし

Kubernetes Secret の名前。Apigee Synchronizer 管理者のロールを持つ Google サービス アカウント キーを入力として Secret を作成する必要があります。

envs[].serviceAccountSecretRefs.udca バージョン: 1.2.0

デフォルト値: なし

Kubernetes Secret の名前。Apigee Analytic エージェントのロールを持つ Google サービス アカウント キーを入力として Secret を作成する必要があります。

gcp

apigee-logger と apigee-metrics がデータを push する GCP のプロジェクト ID とリージョンを識別します。

次の表に、gcp オブジェクトのプロパティを示します。

プロパティ 説明
gcp.region バージョン: 1.2.0

デフォルト値: なし

apigee-logger と apigee-metrics がデータを push する GCP リージョンを識別します。
gcp.projectID バージョン: 1.2.0

デフォルト値: なし

apigee-logger と apigee-metrics がデータを push する GCP プロジェクトを識別します。

httpProxy

httpProxy は、HTTP 転送プロキシ サーバーの構成パラメータを提供します。overrides.yaml で構成されている場合、MART、Synchronizer、UDCA コンポーネントのインターネット通信はすべて、プロキシ サーバーを通過します。

MART、Synchronizer、UDCA もご覧ください。

次の表に、httpProxy オブジェクトのプロパティを示します。

プロパティ 説明
httpProxy.host バージョン: 1.1.1

デフォルト値: なし

HTTP プロキシのホスト名。
httpProxy.port バージョン: 1.1.1

デフォルト値: なし

HTTP プロキシのポート。
httpProxy.scheme バージョン: 1.1.1

デフォルト値: HTTPS

プロキシで使用されるスキーム。値は HTTP または HTTPS です。値に使用できるのは大文字のみです。

ingress

Ingress は Istio Ingress ゲートウェイをインスタンス化したものです。クラスタ外に公開するサービスを指定するために使用されます。ハイブリッド ランタイムのインストールでは、次の 2 つのランタイム コンポーネント用に Ingress オブジェクトが作成されます。

  • runtime
  • MART

関連情報:

次の表に、ingress オブジェクトのプロパティを示します。

プロパティ 説明
ingress.enableAccesslog バージョン: 1.0.0

デフォルト値: false

Ingress アクセスログを有効または無効にします。デフォルトでは無効になっています。
ingress.envoyHeaders.headers バージョン: 1.0.0

デフォルト値: なし

Envoy ヘッダーのリスト。
ingress.envoyHeaders.preserved バージョン: 1.0.0

デフォルト値: false

Envoy のヘッダーを保持するかどうかを決定します。デフォルトでは保持されません。
ingress.httpsRedirect バージョン: 1.0.0

デフォルト値: true

すべての受信トラフィックに対する HTTPS 自動リダイレクトを有効または無効にします。
ingress.mart.loadBalancerIP バージョン: 1.1.1

デフォルト値: 10.0.10.252

MART ロードバランサの IP アドレス。
ingress.minTLSProtocolVersion バージョン: 1.2.0

デフォルト値: minTLSProtocolVersion も maxTLSProtocolVersion も指定されていない場合、Ingress はデフォルトの TLS_AUTO を使用します。Envoy プロキシのドキュメントの一般的な TLS 構成をご覧ください。

Ingress の最小 TLS バージョンを設定できます。有効な値は 1.0、1.1、1.2、1.3 です。
ingress.maxTLSProtocolVersion バージョン: 1.2.0

デフォルト値: minTLSProtocolVersion も maxTLSProtocolVersion も指定されていない場合、Ingress はデフォルトの TLS_AUTO を使用します。Envoy プロキシのドキュメントの一般的な TLS 構成をご覧ください。

Ingress の最大 TLS バージョンを設定できます。有効な値は 1.0、1.1、1.2、1.3 です。
ingress.runtime.loadBalancerIP バージョン: 1.1.1

デフォルト値: 10.0.10.251

apigee-runtime オブジェクトのロードバランサの IP アドレス。
ingress.serviceType バージョン: 1.0.0

デフォルト値: LoadBalancer

外部トラフィックの内部サービスへのルーティングに使用されるサービスのタイプ。

有効な値は次のとおりです。

  • ClusterIP（サポートされていません）
  • LoadBalancer
  • NodePort

istio

Google Cloud Platform（GCP）における Istio の実装は既存の Apigee インスタンスの上層に存在するサービス メッシュであり、Apigee インスタンスとロギング プラットフォーム、テレメトリー、ポリシー システムとの統合に寄与します。

GCP の Istio に関するドキュメントと Istio とはもご覧ください。

次の表に、istio オブジェクトのプロパティを示します。

プロパティ 説明
istio.ingressgateway.replicaCountMax バージョン: 1.0.0

デフォルト値: 5

必須

Istio Ingress ゲートウェイのレプリカの許容される最大数。

詳細については、以下をご覧ください。
istio.ingressgateway.replicaCountMin バージョン: 1.0.0

デフォルト値: 1

必須

Istio Ingress ゲートウェイのレプリカの最低限必要な数。

詳細については、以下をご覧ください。
istio.ingressgateway.resources.requests.cpu バージョン: 1.0.0

デフォルト値: 100m

必須

Ingress コントローラに割り当てられる、ゲートウェイが最適に動作するために必要な CPU リソース。

詳細については、以下をご覧ください。
istio.ingressgateway.resources.requests.memory バージョン: 1.0.0

デフォルト値: 128Mi

Ingress コントローラに割り当てられる、ゲートウェイが最適に動作するために必要なメモリリソース。

  • ingress オブジェクト
  • Ingress ゲートウェイ（Istio ドキュメント）
  • Ingress コントローラ（Kubernetes ドキュメント）
    		•
    istio.nodeSelector.key バージョン: 1.0.0

    デフォルト値: なし

    istio サービス用の Kubernetes ノードを選択するために使用される省略可能なノードセレクタ ラベルのキー。mart.nodeselector のキーが指定されていない場合、istio サービスは nodeSelector オブジェクトで指定されたノードを使用します。
    istio.nodeSelector.value バージョン: 1.0.0

    デフォルト値: なし

    istio サービス用の Kubernetes ノードを選択するために使用される省略可能なノードセレクタ ラベルの値。nodeSelector オブジェクトもご覧ください。
    istio.pilot.replicaCountMax バージョン: 1.0.0

    デフォルト値: 5

    必須

    envoy サイドカー プロキシとやり取りする、クラスタ内の pilot コア トラフィック管理。replicaCountMax は Istio パイロット レプリカの許容される最大数です。

    Istio ドキュメントのパイロット: コア トラフィック管理をご覧ください。
    istio.pilot.replicaCountMin バージョン: 1.0.0

    デフォルト値: 1

    必須

    envoy サイドカー プロキシとやり取りする、クラスタ内の pilot コア トラフィック管理。replicaCountMax は Istio パイロット レプリカの最低限必要な数です。

    Istio ドキュメントのパイロット: コア トラフィック管理をご覧ください。
    istio.pilot.resources.requests.cpu バージョン: 1.0.0

    デフォルト値: 500m

    必須

    パイロット プロセスに割り当てられる、ゲートウェイが最適に動作するために必要な CPU リソース。

    詳細については、以下をご覧ください。
    istio.pilot.resources.requests.memory バージョン: 1.0.0

    デフォルト値: 2048Mi

    パイロット プロセスに割り当てられる、ゲートウェイが最適に動作するために必要なメモリリソース。

    詳細については、以下をご覧ください。

    k8sCluster

    ハイブリッド ランタイムがインストールされている Kubernetes クラスタを識別します。

    次の表に、k8sCluster オブジェクトのプロパティを示します。

    プロパティ 説明
    k8sCluster.name バージョン: 1.2.0

    デフォルト値: なし

    ハイブリッド ランタイムがインストールされている Kubernetes クラスタの名前。
    k8sCluster.region バージョン: 1.2.0

    デフォルト値: なし

    Kubernetes クラスタが作成された GCP リージョンを識別します。

    logger

    オペレーション ログを管理するサービスを定義します。この情報は、Kubernetes クラスタで実行されるすべての Apigee ハイブリッド サービスから出力されます。

    詳細については、ロギングをご覧ください。

    次の表に、logger オブジェクトのプロパティを示します。

    プロパティ 説明
    logger.enabled バージョン: 1.0.0

    デフォルト値: true

    クラスタでのロギングを有効または無効にします。GKE 以外の場合は true に設定し、Anthos または GKE の場合は false に設定します。
    logger.fluentd.buffer_chunk_limit バージョン: 1.0.0

    デフォルト値: 512k

    バッファ チャンクの許容される最大サイズ（キロバイト単位）。この上限を超えるチャンクは出力キューに自動的にフラッシュされます。
    logger.fluentd.buffer_queue_limit バージョン: 1.0.0

    デフォルト値: 6

    出力キューの最大長。デフォルトの上限は 256 チャンクです。
    logger.fluentd.flush_interval バージョン: 1.0.0

    デフォルト値: 5s

    次のバッファ フラッシュを呼び出すまでの待機時間（秒単位）。
    logger.fluentd.max_retry_wait バージョン: 1.0.0

    デフォルト値: 30

    書き込み再試行の最大間隔（秒単位）。
    logger.fluentd.num_threads バージョン: 1.0.0

    デフォルト値: 2

    バッファのフラッシュに使用されるスレッドの数。デフォルトは 1 です。
    logger.image.pullPolicy バージョン: 1.0.0

    デフォルト値: IfNotPresent

    kubelet が Pod の Docker イメージをいつ pull するかを指定します。有効な値は次のとおりです。

    • IfNotPresent: イメージがすでに存在する場合、新しいイメージは pull しません。
    • Always: イメージがすでに存在するかどうかにかかわらず、常にイメージを pull します。

    詳細については、イメージの更新をご覧ください。
    logger.image.tag バージョン: 1.0.0

    デフォルト値: "1.6.8"

    このサービスの Docker イメージのバージョン ラベル。
    logger.image.url バージョン: 1.0.0

    デフォルト値: "google/apigee-stackdriver-logging-agent"

    このサービスの Docker イメージの場所。
    logger.livenessProbe.failureThreshold バージョン: 1.0.0

    デフォルト値: 3

    Kubernetes がコンテナを再起動するための条件となる、Liveness Probe の失敗が確認された回数。最小値は 1 です。
    logger.livenessProbe.initialDelaySeconds バージョン: 1.0.0

    デフォルト値: 0

    コンテナが起動してから Liveness Probe が開始されるまでの秒数。
    logger.livenessProbe.periodSeconds バージョン: 1.0.0

    デフォルト値: 60

    Liveness Probe を実行する頻度を秒単位で指定します。最小値は 1 です。
    logger.livenessProbe.successThreshold バージョン: 1.0.0

    デフォルト値: 1

    失敗した Liveness Probe が成功とみなされるために必要な最小の連続成功回数。最小値は 1 です。
    logger.livenessProbe.timeoutSeconds バージョン: 1.0.0

    デフォルト値: 1

    Liveness Probe がタイムアウトするまでの秒数。最小値は 1 です。
    logger.nodeSelector.key バージョン: 1.0.0

    デフォルト値: "apigee.com/apigee-logger-enabled"

    必須

    logger ランタイム サービス専用の Kubernetes ノードを選択するために使用されるノードセレクタ ラベルのキー。

    ノードセレクタを追加するをご覧ください。
    logger.nodeSelector.value バージョン: 1.0.0

    デフォルト値: "true"

    必須

    logger ランタイム サービス専用の Kubernetes ノードを選択するために使用されるノードセレクタ ラベルの値。

    ノードセレクタを追加するをご覧ください。
    logger.proxyURL バージョン: 1.0.0

    デフォルト値: なし

    ユーザーのプロキシ サーバーの URL。
    logger.resource.limits.memory バージョン: 1.0.0

    デフォルト値: 500Mi

    Kubernetes コンテナ内のリソースのメモリ上限（MiB 単位）。
    logger.resource.limits.cpu バージョン: 1.0.0

    デフォルト値: 200m

    Kubernetes コンテナ内のリソースの CPU 上限（ミリコア単位）。
    logger.resource.requests.cpu バージョン: 1.0.0

    デフォルト値: 100m

    Kubernetes コンテナ内のリソースの通常の操作に必要な CPU（ミリコア単位）。
    logger.resource.requests.memory バージョン: 1.0.0

    デフォルト値: 250Mi

    Kubernetes コンテナ内のリソースの通常の操作に必要なメモリ（MiB 単位）。
    logger.serviceAccountPath バージョン: 1.0.0

    デフォルト値: なし

    serviceAccountPath か serviceAccountSecretRef のいずれかが必要です。

    ログ書き込みのロールを持つ Google サービス アカウント キーファイルのパス。

    logger.serviceAccountSecretRef バージョン: 1.2.0

    デフォルト値: なし

    serviceAccountPath か serviceAccountSecretRef のいずれかが必要です。

    Kubernetes Secret の名前。ログ書き込みのロールを持つ Google サービス アカウント キーを入力として Secret を作成する必要があります。

    logger.terminationGracePeriodSeconds バージョン: 1.0.0

    デフォルト値: 30

    Pod の削除リクエストから実際に Pod が強制終了されるまでの時間（秒単位）。この期間中に停止前フックが実行され、動作中のすべてのプロセスが正常に終了します。

    mart

    MART（Management API for RunTime データ）サービスを定義します。MART はパブリック Apigee API の API プロバイダとして機能します。ユーザーはこのサービスを介して KMS（API キーと OAuth トークン）、KVM、割り当て、API プロダクトなどのランタイム データ エンティティにアクセスし、これらを管理できます。

    次の表に、mart オブジェクトのプロパティを示します。

    プロパティ 説明
    mart.hostAlias バージョン: 1.0.0

    デフォルト値: なし

    この MART オブジェクトを指すホスト エイリアス。このプロパティは * または完全修飾ドメイン名に設定できます。
    mart.image.pullPolicy バージョン: 1.0.0

    デフォルト値: IfNotPresent

    kubelet が Pod の Docker イメージをいつ pull するかを指定します。有効な値は次のとおりです。

    • IfNotPresent: イメージがすでに存在する場合、新しいイメージは pull しません。
    • Always: イメージがすでに存在するかどうかにかかわらず、常にイメージを pull します。

    詳細については、イメージの更新をご覧ください。
    mart.image.tag バージョン: 1.0.0

    デフォルト値: 1.2.0

    このサービスの Docker イメージのバージョン ラベル。
    mart.image.url バージョン: 1.0.0

    デフォルト値: "google/apigee-mart-server"

    このサービスの Docker イメージの場所。具体的な URL については、values.yaml ファイルで確認してください。その値をオーバーライドできます。
    mart.initCheckCF.resources.requests.cpu バージョン: 1.0.0

    デフォルト値: 10m

    Cloud Foundry プロセスの初期化チェックに割り当てられる CPU リソースの量。
    mart.livenessProbe.failureThreshold バージョン: 1.0.0

    デフォルト値: 12

    Kubernetes がコンテナを再起動するための条件となる、Liveness Probe の失敗が確認された回数。最小値は 1 です。
    mart.livenessProbe.initialDelaySeconds バージョン: 1.0.0

    デフォルト値: 15

    コンテナが起動してから Liveness Probe が開始されるまでの秒数。
    mart.livenessProbe.periodSeconds バージョン: 1.0.0

    デフォルト値: 5

    Liveness Probe を実行する頻度を秒単位で指定します。最小値は 1 です。
    mart.livenessProbe.timeoutSeconds バージョン: 1.0.0

    デフォルト値: 1

    Liveness Probe がタイムアウトするまでの秒数。最小値は 1 です。
    mart.metricsURL バージョン: 1.0.0

    デフォルト値: "/v1/server/metrics"

    mart.nodeSelector.key バージョン: 1.0.0

    デフォルト値: なし

    mart ランタイム サービス用の Kubernetes ノードを選択するために使用される省略可能なノードセレクタ ラベルのキー。mart.nodeselector のキーが指定されていない場合、ランタイムは nodeSelector オブジェクトで指定されたノードを使用します。

    ノードセレクタを追加するをご覧ください。
    mart.nodeSelector.value バージョン: 1.0.0

    デフォルト値: なし

    mart ランタイム サービス用の Kubernetes ノードを選択するために使用される省略可能なノードセレクタ ラベルの値。nodeSelector オブジェクトもご覧ください。

    ノードセレクタを追加するをご覧ください。
    mart.readinessProbe.failureThreshold バージョン: 1.0.0

    デフォルト値: 2

    Kubernetes が Pod を「準備未完了」とマークするための条件となる、Readiness Probe の失敗が確認された回数。最小値は 1 です。
    mart.readinessProbe.initialDelaySeconds バージョン: 1.0.0

    デフォルト値: 15

    コンテナが起動してから Readiness Probe が開始されるまでの秒数。
    mart.readinessProbe.periodSeconds バージョン: 1.0.0

    デフォルト値: 5

    Readiness Probe を実行する頻度を秒単位で指定します。最小値は 1 です。
    mart.readinessProbe.successThreshold バージョン: 1.0.0

    デフォルト値: 1

    失敗した Readiness Probe が成功とみなされるために必要な最小の連続成功回数。最小値は 1 です。
    mart.readinessProbe.timeoutSeconds バージョン: 1.0.0

    デフォルト値: 1

    Liveness Probe がタイムアウトするまでの秒数。最小値は 1 です。
    mart.replicaCountMax バージョン: 1.0.0

    デフォルト値: 5

    自動スケーリングに使用できるレプリカの最大数。
    mart.replicaCountMin バージョン: 1.0.0

    デフォルト値: 1

    自動スケーリングに使用できるレプリカの最小数。
    mart.resources.requests.cpu バージョン: 1.0.0

    デフォルト値: 500m

    Kubernetes コンテナ内のリソースの通常の操作に必要な CPU（ミリコア単位）。
    mart.resources.requests.memory バージョン: 1.0.0

    デフォルト値: 512Mi

    Kubernetes コンテナ内のリソースの通常の操作に必要なメモリ（MiB 単位）。
    mart.serviceAccountPath バージョン: 1.1.1

    デフォルト値: なし

    serviceAccountPath か serviceAccountSecretRef のいずれかが必要です。

    ロールなしの Google サービス アカウント キーファイルのパス。

    mart.serviceAccountSecretRef バージョン: 1.2.0

    デフォルト値: なし

    serviceAccountPath か serviceAccountSecretRef のいずれかが必要です。

    Kubernetes Secret の名前。ロールなしの Google サービス アカウント キーを入力として Secret を作成する必要があります。

    mart.sslCertPath バージョン: 1.0.0

    デフォルト値: なし

    SSL 証明書を Secret に読み込んでエンコードするためのローカル ファイル システム上のパス。
    mart.sslKeyPath バージョン: 1.0.0

    デフォルト値: なし

    SSL 鍵を Secret に読み込んでエンコードするためのローカル ファイル システム上のパス。
    mart.sslSecret バージョン: 1.2.0

    デフォルト値: なし

    必須

    Kubernetes Secret の名前。TLS 証明書と鍵データを入力として Secret を作成する必要があります。

    mart.targetCPUUtilizationPercentage バージョン: 1.0.0

    デフォルト値: 75

    Pod 上の MART プロセスのターゲット CPU 使用率。CPU 使用率がこのフィールドの値に達すると、MART が（replicaCountMax で指定された上限まで）自動的にスケーリングします。
    mart.terminationGracePeriodSeconds バージョン: 1.0.0

    デフォルト値: 30

    Pod の削除リクエストから実際に Pod が強制終了されるまでの時間（秒単位）。この期間中に停止前フックが実行され、動作中のすべてのプロセスが正常に終了します。

    metrics

    オペレーション指標を収集するサービスを定義します。この指標データは、ハイブリッド サービスの状態のモニタリングやアラートの設定に使用できます。

    詳細については、指標の収集の概要をご覧ください。

    次の表に、metrics オブジェクトのプロパティを示します。

    プロパティ 説明
    metrics.enabled バージョン: 1.0.0

    デフォルト値: false

    Apigee の指標を有効にします。true に設定すると、指標が有効になります。false に設定すると、指標が無効になります。

    metrics.nodeSelector.key バージョン: 1.0.0

    デフォルト値: なし

    必須

    metrics ランタイム サービス専用の Kubernetes ノードを選択するために使用されるノードセレクタ ラベルのキー。

    ノードセレクタを追加するをご覧ください。
    metrics.nodeSelector.value バージョン: 1.0.0

    デフォルト値: なし

    必須

    metrics ランタイム サービス専用の Kubernetes ノードを選択するために使用されるノードセレクタ ラベルの値。

    ノードセレクタを追加するをご覧ください。
    metrics.prometheus.args.storage_tsdb_retention バージョン: 1.0.0

    デフォルト値: 48h

    Prometheus がローカル ストレージにデータを保持する時間（時間単位）。
    metrics.prometheus.containerPort バージョン: 1.0.0

    デフォルト値: 9090

    Prometheus 指標サービスに接続するためのポート。
    metrics.prometheus.image.pullPolicy バージョン: 1.0.0

    デフォルト値: IfNotPresent

    kubelet が Pod の Docker イメージをいつ pull するかを指定します。有効な値は次のとおりです。

    • IfNotPresent: イメージがすでに存在する場合、新しいイメージは pull しません。
    • Always: イメージがすでに存在するかどうかにかかわらず、常にイメージを pull します。

    詳細については、イメージの更新をご覧ください。
    metrics.prometheus.image.tag バージョン: 1.0.0

    デフォルト値: "v2.9.2"

    このサービスの Docker イメージのバージョン ラベル。
    metrics.prometheus.image.url バージョン: 1.0.0

    デフォルト値: "google/apigee-prom-prometheus"

    このサービスの Docker イメージの場所。
    metrics.prometheus.livenessProbe.failureThreshold バージョン: 1.0.0

    デフォルト値: 6

    Kubernetes がコンテナを再起動するための条件となる、Liveness Probe の失敗が確認された回数。最小値は 1 です。
    metrics.prometheus.livenessProbe.periodSeconds バージョン: 1.0.0

    デフォルト値: 5

    Liveness Probe を実行する頻度を秒単位で指定します。最小値は 1 です。
    metrics.prometheus.livenessProbe.timeoutSeconds バージョン: 1.0.0

    デフォルト値: 3

    Liveness Probe がタイムアウトするまでの秒数。最小値は 1 です。
    metrics.prometheus.readinessProbe.failureThreshold バージョン: 1.0.0

    デフォルト値: 120

    Kubernetes が Pod を「準備未完了」とマークするための条件となる、Readiness Probe の失敗が確認された回数。最小値は 1 です。
    metrics.prometheus.readinessProbe.periodSeconds バージョン: 1.0.0

    デフォルト値: 5

    Readiness Probe を実行する頻度を秒単位で指定します。最小値は 1 です。
    metrics.prometheus.readinessProbe.timeoutSeconds バージョン: 1.0.0

    デフォルト値: 3

    Liveness Probe がタイムアウトするまでの秒数。最小値は 1 です。
    metrics.proxyURL バージョン: 1.0.0

    デフォルト値: なし

    Kubernetes クラスタ内の指標プロセス サイドカー プロキシの URL。

    metrics.resources.limits.cpu バージョン: 1.0.0

    デフォルト値: 250m

    Kubernetes コンテナ内のリソースの CPU 上限（ミリコア単位）。
    metrics.resources.limits.memory バージョン: 1.0.0

    デフォルト値: 256Mi

    Kubernetes コンテナ内のリソースのメモリ上限（MiB 単位）。
    metrics.resources.requests.cpu バージョン: 1.0.0

    デフォルト値: 250m

    Kubernetes コンテナ内のリソースの通常の操作に必要な CPU（ミリコア単位）。
    metrics.resources.requests.memory バージョン: 1.0.0

    デフォルト値: 256Mi

    Kubernetes コンテナ内のリソースの通常の操作に必要なメモリ（MiB 単位）。
    metrics.sdSidecar.containerPort バージョン: 1.0.0

    デフォルト値: 9091

    Stackdriver 指標サービスに接続するためのポート。
    metrics.sdSidecar.image.pullPolicy バージョン: 1.0.0

    デフォルト値: IfNotPresent

    kubelet がこのサービスの Docker イメージをいつ pull するかを指定します。有効な値は次のとおりです。

    • IfNotPresent: イメージがすでに存在する場合、新しいイメージは pull しません。
    • Always: ポリシーがすでに存在する場合でも、常にポリシーを pull します。

      詳細については、イメージの更新をご覧ください。
    metrics.sdSidecar.image.tag バージョン: 1.0.0

    デフォルト値: "release-0.4.0"

    このサービスの Docker イメージのバージョン ラベル。
    metrics.sdSidecar.image.url バージョン: 1.0.0

    デフォルト値: "google/apigee-stackdriver-prometheus-sidecar"

    このサービスの Docker イメージの場所。
    metrics.serviceAccountPath バージョン: 1.0.0

    デフォルト値: なし

    serviceAccountPath か serviceAccountSecretRef のいずれかが必要です。

    モニタリング指標の書き込みのロールを持つ Google サービス アカウント キーファイルのパス。

    metrics.serviceAccountSecretRef バージョン: 1.2.0

    デフォルト値: なし

    serviceAccountPath か serviceAccountSecretRef のいずれかが必要です。

    Kubernetes Secret の名前。モニタリング指標の書き込みのロールを持つ Google サービス アカウント キーを入力として Secret を作成する必要があります。

    metrics.terminationGracePeriodSeconds バージョン: 1.0.0

    デフォルト値: 300

    Pod の削除リクエストから実際に Pod が強制終了されるまでの時間（秒単位）。この期間中に停止前フックが実行され、動作中のすべてのプロセスが正常に終了します。

    nodeSelector

    nodeSelector オブジェクトは Apigee インスタンスのノードを定義します。apigeectl が実行されると、内部で apigeeRuntime および apigeeData のラベルの Key-Value が個々の Istio コンポーネントおよび MART コンポーネントにマッピングされます。個々のオブジェクトに関するこの設定は、istio:nodeSelector プロパティと mart:nodeSelector プロパティでオーバーライドできます。

    次の表に、nodeSelector オブジェクトのプロパティを示します。

    プロパティ 説明
    nodeSelector.apigeeData.key バージョン: 1.0.0

    デフォルト値: "cloud.google.com/gke-nodepool"

    ApigeeData は Cassandra データベース用のノードです。これは、Apigee サービスのデータを処理する Kubernetes ノードを選択するためのノードセレクタ ラベルのキーです。

    ノードセレクタを追加するをご覧ください。
    nodeSelector.apigeeData.value バージョン: 1.0.0

    デフォルト値: "apigee-data"

    apigee-data は Cassandra データベース用のノードです。これは、Apigee サービスのデータを処理する Kubernetes ノードを選択するためのノードセレクタ ラベルの値です。

    ノードセレクタを追加するをご覧ください。
    nodeSelector.apigeeRuntime.key バージョン: 1.0.0

    デフォルト値: "cloud.google.com/gke-nodepool"

    Apigee Runtime はプロジェクトのランタイム環境用のノードです。これは、Apigee ランタイム サービス用の Kubernetes ノードを選択するためのノードセレクタ ラベルのキーです。

    ノードセレクタを追加するをご覧ください。
    nodeSelector.apigeeRuntime.value バージョン: 1.0.0

    デフォルト値: "apigee-runtime"

    apigee-runtime はプロジェクトのランタイム環境用のノードです。これは、Apigee ランタイム サービス用の Kubernetes ノードを選択するためのノードセレクタ ラベルの値です。

    ノードセレクタを追加するをご覧ください。
    nodeSelector.requiredForScheduling バージョン: 1.0.0

    デフォルト値: false

    requiredForScheduling プロパティはデフォルトで false に設定されます。この値を true に変更すると、構成されたラベルの Key-Value を持つノードが見つからない場合、基になる Pod は VM ワーカーノードでスケジュールされません。

    本番環境では、nodeSelector.requiredForScheduling を true に設定してください。

    ノードセレクタを追加するをご覧ください。

    runtime

    次の表に、runtime オブジェクトのプロパティを示します。

    プロパティ 説明
    runtime.image.pullPolicy バージョン: 1.0.0

    デフォルト値: IfNotPresent

    kubelet が Pod の Docker イメージをいつ pull するかを指定します。有効な値は次のとおりです。

    • IfNotPresent: イメージがすでに存在する場合、新しいイメージは pull しません。
    • Always: イメージがすでに存在するかどうかにかかわらず、常にイメージを pull します。

    詳細については、イメージの更新をご覧ください。
    runtime.image.tag バージョン: 1.0.0

    デフォルト値: 1.2.0

    このサービスの Docker イメージのバージョン ラベル。
    runtime.image.url バージョン: 1.0.0

    デフォルト値: インストール環境のイメージ リソースの URL（例: "google/apigee-runtime"）

    このサービスの Docker イメージの場所。
    runtime.livenessProbe.failureThreshold バージョン: 1.0.0

    デフォルト値: 2

    Kubernetes がコンテナを再起動するための条件となる、Liveness Probe の失敗が確認された回数。最小値は 1 です。
    runtime.livenessProbe.initialDelaySeconds バージョン: 1.0.0

    デフォルト値: 60

    コンテナが起動してから Liveness Probe が開始されるまでの秒数。
    runtime.livenessProbe.periodSeconds バージョン: 1.0.0

    デフォルト値: 5

    Liveness Probe を実行する頻度を秒単位で指定します。最小値は 1 です。
    runtime.livenessProbe.timeoutSeconds バージョン: 1.0.0

    デフォルト値: 1

    Liveness Probe がタイムアウトするまでの秒数。最小値は 1 です。
    runtime.nodeSelector.key バージョン: 1.0.0

    デフォルト値: なし

    runtime サービス用の Kubernetes ノードを選択するために使用される任意指定のノードセレクタ ラベルのキー。

    nodeSelector プロパティをご覧ください。
    runtime.nodeSelector.value バージョン: 1.0.0

    デフォルト値: なし

    runtime サービス用の Kubernetes ノードを選択するために使用されるノードセレクタ ラベルの値。

    ノードセレクタを追加するをご覧ください。
    runtime.readinessProbe.failureThreshold バージョン: 1.0.0

    デフォルト値: 2

    Kubernetes が Pod を「準備未完了」とマークするための条件となる、Readiness Probe の失敗が確認された回数。最小値は 1 です。
    runtime.readinessProbe.initialDelaySeconds バージョン: 1.0.0

    デフォルト値: 60

    コンテナが起動してから Readiness Probe が開始されるまでの秒数。
    runtime.readinessProbe.periodSeconds バージョン: 1.0.0

    デフォルト値: 5

    Readiness Probe を実行する頻度を秒単位で指定します。最小値は 1 です。
    runtime.readinessProbe.successThreshold バージョン: 1.0.0

    デフォルト値: 1

    失敗した Readiness Probe が成功とみなされるために必要な最小の連続成功回数。最小値は 1 です。
    runtime.readinessProbe.timeoutSeconds バージョン: 1.0.0

    デフォルト値: 1

    Liveness Probe がタイムアウトするまでの秒数。最小値は 1 です。
    runtime.replicaCountMax バージョン: 1.0.0

    デフォルト値: 4

    自動スケーリングに使用できるレプリカの最大数。
    runtime.replicaCountMin バージョン: 1.0.0

    デフォルト値: 1

    自動スケーリングに使用できるレプリカの最小数。
    runtime.resources.requests.cpu バージョン: 1.0.0

    デフォルト値: 500m

    Kubernetes コンテナ内のリソースの通常の操作に必要な CPU（ミリコア単位）。
    runtime.resources.requests.memory バージョン: 1.0.0

    デフォルト値: 1Gi

    Kubernetes コンテナ内のリソースの通常の操作に必要なメモリ（MiB 単位）。
    runtime.service.type バージョン: 1.0.0

    デフォルト値: ClusterIP

    サービスのタイプ。これは ClusterIP 以外のサービスに設定できます（例: LoadBalancer）。
    runtime.targetCPUUtilizationPercentage バージョン: 1.0.0

    デフォルト値: 75

    Pod 上のランタイム プロセスのターゲット CPU 使用率。CPU 使用率がこのフィールドの値に達すると、ランタイムが（replicaCountMax で指定された上限まで）自動的にスケーリングします。
    runtime.terminationGracePeriodSeconds バージョン: 1.0.0

    デフォルト値: 180

    Pod の削除リクエストから実際に Pod が強制終了されるまでの時間（秒単位）。この期間中に停止前フックが実行され、動作中のすべてのプロセスが正常に終了します。

    synchronizer

    デプロイされた最新の API プロキシ バンドルに同期して Message Processor を最新の状態に維持します。そのために、Synchronizer は管理プレーンに対してポーリングを行い、新しい契約が検出されるとそれをランタイム プレーンに送信します。

    詳細については、Synchronizer をご覧ください。

    次の表に、synchronizer オブジェクトのプロパティを示します。

    プロパティ 説明
    synchronizer.image.pullPolicy バージョン: 1.0.0

    デフォルト値: IfNotPresent

    kubelet が Pod の Docker イメージをいつ pull するかを指定します。有効な値は次のとおりです。

    • IfNotPresent: イメージがすでに存在する場合、新しいイメージは pull しません。
    • Always: イメージがすでに存在するかどうかにかかわらず、常にイメージを pull します。

    詳細については、イメージの更新をご覧ください。
    synchronizer.image.tag バージョン: 1.0.0

    デフォルト値: 1.2.0

    このサービスの Docker イメージのバージョン ラベル。
    synchronizer.image.url バージョン: 1.0.0

    デフォルト値: "google/apigee-synchronizer"

    このサービスの Docker イメージの場所。
    synchronizer.livenessProbe.failureThreshold バージョン: 1.0.0

    デフォルト値: 2

    Kubernetes がコンテナを再起動するための条件となる、Liveness Probe の失敗が確認された回数。最小値は 1 です。
    synchronizer.livenessProbe.initialDelaySeconds バージョン: 1.0.0

    デフォルト値: 0

    コンテナが起動してから Liveness Probe が開始されるまでの秒数。
    synchronizer.livenessProbe.periodSeconds バージョン: 1.0.0

    デフォルト値: 5

    Liveness Probe を実行する頻度を秒単位で指定します。最小値は 1 です。
    synchronizer.livenessProbe.timeoutSeconds バージョン: 1.0.0

    デフォルト値: 1

    Liveness Probe がタイムアウトするまでの秒数。最小値は 1 です。
    synchronizer.nodeSelector.key バージョン: 1.0.0

    デフォルト値: なし

    必須

    synchronizer ランタイム サービス用の Kubernetes ノードを選択するために使用される省略可能なノードセレクタ ラベルのキー。

    nodeSelector をご覧ください。
    synchronizer.nodeSelector.value バージョン: 1.0.0

    デフォルト値: なし

    synchronizer ランタイム サービス用の Kubernetes ノードを選択するために使用される省略可能なノードセレクタ ラベルの値。

    nodeSelector をご覧ください。
    synchronizer.pollInterval バージョン: 1.0.0

    デフォルト値: 60

    Synchronizer がポーリングを行う間隔。Synchronizer は Apigee コントロール プレーン サービスに対してポーリングを行い、新しいランタイム契約が検出されるとそれを pull します。
    synchronizer.readinessProbe.failureThreshold バージョン: 1.0.0

    デフォルト値: 2

    Kubernetes が Pod を「準備未完了」とマークするための条件となる、Readiness Probe の失敗が確認された回数。最小値は 1 です。
    synchronizer.readinessProbe.initialDelaySeconds バージョン: 1.0.0

    デフォルト値: 0

    コンテナが起動してから Readiness Probe が開始されるまでの秒数。
    synchronizer.readinessProbe.periodSeconds バージョン: 1.0.0

    デフォルト値: 5

    Readiness Probe を実行する頻度を秒単位で指定します。最小値は 1 です。
    synchronizer.readinessProbe.successThreshold バージョン: 1.0.0

    デフォルト値: 1

    失敗した Readiness Probe が成功とみなされるために必要な最小の連続成功回数。最小値は 1 です。
    synchronizer.readinessProbe.timeoutSeconds バージョン: 1.0.0

    デフォルト値: 1

    Liveness Probe がタイムアウトするまでの秒数。最小値は 1 です。
    synchronizer.replicaCount バージョン: 1.0.0

    デフォルト値: 2

    自動スケーリングに使用されるレプリカの数。
    synchronizer.resources.requests.cpu バージョン: 1.0.0

    デフォルト値: 100m

    Kubernetes コンテナ内のリソースの通常の操作に必要な CPU（ミリコア単位）。
    synchronizer.resources.requests.memory バージョン: 1.0.0

    デフォルト値: 1Gi

    Kubernetes コンテナ内のリソースの通常の操作に必要なメモリ（ギガバイト単位）。
    synchronizer.serviceAccountPath バージョン: 1.0.0

    デフォルト値: なし

    serviceAccountPath か serviceAccountSecretRef のいずれかが必要です。

    Apigee Synchronizer 管理者のロールを持つ Google サービス アカウント キーファイルのパス。

    synchronizer.serviceAccountSecretRef バージョン: 1.2.0

    デフォルト値: なし

    serviceAccountPath か serviceAccountSecretRef のいずれかが必要です。

    Kubernetes Secret の名前。Apigee Synchronizer 管理者のロールを持つ Google サービス アカウント キーを入力として Secret を作成する必要があります。

    synchronizer.targetCPUUtilizationPercentage バージョン: 1.0.0

    デフォルト値: 75

    Pod 上の Synchronizer プロセスのターゲット CPU 使用率。CPU 使用率がこのフィールドの値に達すると、Synchronizer が（replicaCountMax で指定された上限まで）自動的にスケーリングします。
    synchronizer.terminationGracePeriodSeconds バージョン: 1.0.0

    デフォルト値: 30

    Pod の削除リクエストから実際に Pod が強制終了されるまでの時間（秒単位）。この期間中に停止前フックが実行され、動作中のすべてのプロセスが正常に終了します。

    udca

    （Universal Data Collection Agent）ランタイム プレーンのデータ収集 Pod で実行されるサービスを定義します。このサービスは、アナリティクスとデプロイのステータス データを抽出して Unified Analytics Platform（UAP）に送信します。

    詳細については、アナリティクスとデプロイのステータス データの収集をご覧ください。

    次の表に、udca オブジェクトのプロパティを示します。

    プロパティ 説明
    udca.fluentd.image.pullPolicy バージョン: 1.0.0

    デフォルト値: IfNotPresent

    kubelet が Pod の Docker イメージをいつ pull するかを指定します。有効な値は次のとおりです。

    • IfNotPresent: イメージがすでに存在する場合、新しいイメージは pull しません。
    • Always: イメージがすでに存在するかどうかにかかわらず、常にイメージを pull します。

    詳細については、イメージの更新をご覧ください。
    udca.fluentd.image.tag バージョン: 1.0.0

    デフォルト値: 1.2.0

    このサービスの Docker イメージのバージョン ラベル。
    udca.fluentd.image.url バージョン: 1.0.0

    デフォルト値: "google/apigee-stackdriver-logging-agent"

    このサービスの Docker イメージの場所。
    udca.fluentd.resource.limits.memory バージョン: 1.0.0

    デフォルト値: 500Mi

    Kubernetes コンテナ内のリソースのメモリ上限（MiB 単位）。
    udca.fluentd.resource.requests.cpu バージョン: 1.0.0

    デフォルト値: 500m

    Kubernetes コンテナ内のリソースの通常の操作に必要な CPU（ミリコア単位）。
    udca.fluentd.resource.requests.memory バージョン: 1.0.0

    デフォルト値: 250Mi

    Kubernetes コンテナ内のリソースの通常の操作に必要なメモリ（MiB 単位）。
    udca.image.pullPolicy バージョン: 1.0.0

    デフォルト値: IfNotPresent

    kubelet が Pod の Docker イメージをいつ pull するかを指定します。有効な値は次のとおりです。

    • IfNotPresent: イメージがすでに存在する場合、新しいイメージは pull しません。
    • Always: イメージがすでに存在するかどうかにかかわらず、常にイメージを pull します。

    詳細については、イメージの更新をご覧ください。
    udca.image.tag バージョン: 1.0.0

    デフォルト値: "1.2.0"

    このサービスの Docker イメージのバージョン ラベル。
    udca.image.url バージョン: 1.0.0

    デフォルト値: "google/apigee-udca"

    このサービスの Docker イメージの場所。
    udca.jvmXms バージョン: 1.0.0

    デフォルト値: 256m

    データ収集 Pod の JVM の初期メモリ量。
    udca.jvmXmx バージョン: 1.0.0

    デフォルト値: 256m

    データ収集 Pod の JVM の最大メモリ割り当て量。
    udca.livenessProbe.failureThreshold バージョン: 1.0.0

    デフォルト値: 2

    Kubernetes がコンテナを再起動するための条件となる、Liveness Probe の失敗が確認された回数。最小値は 1 です。
    udca.livenessProbe.initialDelaySeconds バージョン: 1.0.0

    デフォルト値: 0

    コンテナが起動してから Liveness Probe が開始されるまでの秒数。
    udca.livenessProbe.periodSeconds バージョン: 1.0.0

    デフォルト値: 5

    Liveness Probe を実行する頻度を秒単位で指定します。最小値は 1 です。
    udca.livenessProbe.timeoutSeconds バージョン: 1.0.0

    デフォルト値: 1

    Liveness Probe がタイムアウトするまでの秒数。最小値は 1 です。
    udca.nodeSelector.key バージョン: 1.0.0

    デフォルト値: なし

    必須

    udca ランタイム サービス専用の Kubernetes ノードを選択するために使用されるノードセレクタ ラベルのキー。

    ノードセレクタを追加するをご覧ください。
    udca.nodeSelector.value バージョン: 1.0.0

    デフォルト値: なし

    必須

    udca ランタイム サービス専用の Kubernetes ノードを選択するために使用されるノードセレクタ ラベルの値。

    ノードセレクタを追加するをご覧ください。
    udca.pollingIntervalInSec バージョン: 1.0.0

    デフォルト値: 1

    UDCA がポーリングを行う間隔（秒単位）。UDCA は、データ収集 Pod のファイル システム上のデータ ディレクトリをポーリングして、アップロードする新しいファイルを検出します。
    prometheus.sslCertPath バージョン: 1.0.0

    デフォルト値: なし

    必須

    Prometheus 指標収集プロセス用の SSL 証明書のパス。Prometheus は、Apigee の指標の収集と処理に使用できるツールです。

    詳細については、以下をご覧ください。

    prometheus.sslKeyPath バージョン: 1.0.0

    デフォルト値: なし

    必須

    Prometheus 指標収集プロセス用の SSL 鍵のパス。Prometheus は、Apigee の指標の収集と処理に使用できるツールです。

    詳細については、以下をご覧ください。

    udca.replicaCountMax バージョン: 1.0.0

    デフォルト値: 4

    自動的に追加できる UDCA Deployment 用の Pod の最大数。UDCA は ReplicaSet として実装されているため、これらの Pod はレプリカです。
    udca.replicaCountMin バージョン: 1.0.0

    デフォルト値: 1

    UDCA Deployment 用の Pod の最小数。UDCA は ReplicaSet として実装されているため、これらの Pod はレプリカです。

    CPU 使用率が udca.targetCPUUtilizationPercentage を超えると、Pod の数が徐々に（udca.replicaCountMax で指定された上限まで）増えます。
    udca.resource.requests.cpu バージョン: 1.0.0

    デフォルト値: 250m

    Kubernetes コンテナ内のリソースの通常の操作に必要な CPU（ミリコア単位）。
    udca.revision バージョン: 1

    デフォルト値: "v1"

    カナリア デプロイを有効にするためにラベルに挿入される静的な値。
    udca.serviceAccountPath バージョン: 1.0.0

    デフォルト値: なし

    serviceAccountPath か serviceAccountSecretRef のいずれかが必要です。

    Apigee Analytics エージェントのロールを持つ Google サービス アカウント キーファイルのパス。

    udca.serviceAccountSecretRef バージョン: 1.2.0

    デフォルト値: なし

    serviceAccountPath か serviceAccountSecretRef のいずれかが必要です。

    Kubernetes Secret の名前。Apigee Analytics エージェントのロールを持つ Google サービス アカウント キーを入力として Secret を作成する必要があります。

    udca.targetCPUUtilizationPercentage バージョン: 1.0.0

    デフォルト値: 75

    ReplicaSet 内の Pod の数のスケーリングに使用する CPU 使用率のしきい値。使用可能な CPU リソースの総量に対する割合で指定します。現在の CPU 使用率は、データ収集 Pod（fluentd と UDCA の両方）内のすべてのコンテナの CPU 使用率を集約して計算されます。

    CPU 使用率がこの値を超えると、ReplicaSet 内の Pod の数が徐々に（udca.replicaCountMax で指定された上限まで）増えます。
    udca.terminationGracePeriodSeconds バージョン: 1.0.0

    デフォルト値: 600

    Pod の削除リクエストから実際に Pod が強制終了されるまでの時間（秒単位）。この期間中に停止前フックが実行され、動作中のすべてのプロセスが正常に終了します。

    virtualhosts

    virtualhosts プロパティは必須の構成プロパティです。仮想ホストを使用すると、Apigee ハイブリッドで複数のドメイン名への API リクエストを処理し、プロキシのベースパスを特定の環境にルーティングすることができます。

    詳細については、仮想ホストの構成をご覧ください。

    次の表に、virtualhosts オブジェクトのプロパティを示します。

    プロパティ 説明
    virtualhosts[].name バージョン: 1.2.0

    デフォルト値: なし

    必須

    仮想ホストの名前。
    virtualhosts[].hostAliases[] バージョン: 1.2.0

    デフォルト値: なし

    必須

    サーバーの 1 つ以上の DNS 名。たとえば、foo-test.mydomain.com です。

    仮想ホストで複数のホスト エイリアスを使用する場合、各ホスト エイリアスは一意にする必要があります。たとえば、foo-test.mydomain.com、foo-prod.mydomain.com とします。

    複数の仮想ホスト定義を作成する場合は、それぞれに一意のホスト エイリアスが必要です。つまり、2 つの仮想ホスト定義に同じホスト エイリアス ドメイン名を含めることはできません。

    virtualhosts[].sslCertPath バージョン: 1.2.0

    デフォルト値: なし

    sslCertPath/sslKeyPath または sslSecret のいずれかが必要です。

    TLS 証明書ファイルのシステム上のパス。
    virtualhosts[].sslKeyPath バージョン: 1.2.0

    デフォルト値: なし

    sslCertPath/sslKeyPath または sslSecret のいずれかが必要です。

    TLS 秘密鍵ファイルのシステム上のパス。
    virtualhosts[].routingRules[] バージョン: 1.2.0

    デフォルト値: なし

    組織および環境との同期をとるために変更をポーリングする間隔（秒単位）。
    virtualhosts[].routingRules[] バージョン: 1.2.0

    デフォルト値: デフォルトのパスは / です。

    接頭辞ベースパス ルーティングをサポートするためのプロパティ。ルーティング ルールの構成は、次のパターンに従います。

    
org: hybrid
virtualhosts:
- name: default
  routingRules:
    - paths:
      - /v1/stats
      env: test
    - paths:
      - /v1/customers
      env: prod