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

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

最上位プロパティ

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

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

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

インストール内のすべての API の API パスを定義します。

gcpProjectID バージョン: 1.0.0

デフォルト値: なし

必須

Google Cloud プロジェクトの ID。apigee-loggerapigee-metrics の組み合わせにより、プロジェクトが特定され、k8sClusterNamegcpRegion のデータの push 先が決定します。

gcpRegion バージョン: 1.0.0

デフォルト値: us-central1

必須

Kubernetes クラスタに最も近い GCP のリージョンまたはゾーン。gcpProjectIDk8sClusterName の組み合わせにより、プロジェクトが特定され、apigee-loggerapigee-metrics のデータの push 先が決定します。

imagePullSecrets.name バージョン: 1.0.0

デフォルト値: なし

Docker レジストリ タイプとして構成された Kubernetes Secret 名。非公開リポジトリからイメージを pull するために使用されます。

k8sClusterName

タイプ:

バージョン: 1.0.0

デフォルト値: なし

ハイブリッド プロジェクトが実行されている Kubernetes(K8S)プロクラスタの名前。gcpProjectIDgcpRegion の組み合わせにより、プロジェクトが特定され、apigee-loggerapigee-metrics のデータの push 先が決定します。

namespace バージョン: 1.0.0

デフォルト値: apigee

Apigee コンポーネントがインストールされる Kubernetes クラスタの名前空間。

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 の場合、プロジェクトのチェックは gcpProjectID の overrides.yaml に基づきます。

gcpProjectID もご覧ください。

adah

Apigee Deployment Admissionhook(ADAH)は、ユーザーが apigee-deployment-controller に提供した構成を検証します。Kubernetes クラスタで実行され、Apigee デプロイ コントローラから受信したリクエスト(作成、更新、削除)を検証します。関連情報:

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

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

デフォルト値: IfNotPresent

kubelet が Pod の Docker イメージを pull するタイミングを決定します。有効な値は次のとおりです。

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

詳細については、イメージの更新をご覧ください。

adah.image.tag バージョン: 1.0.0

デフォルト値: 1.0.0

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

adah.image.url バージョン: 1.0.0

デフォルト値: "us.gcr.io/google.com/edge-ci/release/eda/apigee-deployment-admissionhook/master/admissionhook"

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

adc

Apigee Deployment Controller(ADC)は、Kubernetes クラスタ内の Apigee のデプロイを管理するプロセスです。このコントローラは Kubernetes カスタム コントローラで、ApigeeDeployment(AD)のデプロイとメンテナンスに必要な低レベルの Kubernetes リソースと Istio リソースの作成と更新を行います。

adah(Apigee Deployment Admissionhook)もご覧ください。

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

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

デフォルト値: IfNotPresent

kubelet が Pod の Docker イメージを pull するタイミングを決定します。有効な値は次のとおりです。

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

詳細については、イメージの更新をご覧ください。

adc.image.tag バージョン: 1.0.0

デフォルト値: 1.0.0

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

adc.image.url バージョン: 1.0.0

デフォルト値: "us.gcr.io/google.com/edge-ci/release/eda/apigee-deployment-controller/master/controller"

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

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

デフォルト値: 250m

Kubernetes コンテナ内のリソースの CPU 上限(ミリコア単位)。

adc.resources.limits.memory バージョン: 1.0.0

デフォルト値: 256Mi

Kubernetes コンテナ内のリソースのメモリ上限(MiB 単位)。

adc.resources.requests.cpu バージョン: 1.0.0

デフォルト値: 250m

Kubernetes コンテナ内のリソースの通常のオペレーションに必要な CPU(ミリコア単位)。

adc.resources.requests.memory バージョン: 1.0.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.0.0

このサービスの Docker イメージのバージョン ラベル。

authz.image.url バージョン: 1.0.0

デフォルト値: "us.gcr.io/google.com/edge-ci/integration/featureplatform/apigee-authn-authz/master"

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

authz.livenessProbe.failureThreshold バージョン: 1.0.0

デフォルト値: 2

Kubernetes が検出する livenessProbe の失敗回数。この数に達すると、コンテナが再起動されます。最小値は 1 です。

authz.livenessProbe.initialDelaySeconds バージョン: 1.0.0

デフォルト値: 0

コンテナが起動してから Liveness Probe が開始されるまでの秒数。

authz.livenessProbe.periodSeconds バージョン: 1.0.0

デフォルト値: 5

livenessProbe を実行する頻度を秒単位で指定します。最小値は 1 です。

authz.livenessProbe.timeoutSeconds バージョン: 1.0.0

デフォルト値: 1

livenessProbe がタイムアウトするまでの秒数。最小値は 1 です。

authz.readinessProbe.failureThreshold バージョン: Beta2

デフォルト値: 2

Kubernetes が検出する readinessProbe の失敗回数。この数に達すると、Pod が「準備未完了」とマークされます。最小値は 1 です。

authz.readinessProbe.initialDelaySeconds バージョン: 1.0.0

デフォルト値: 0

コンテナが起動してから Readiness Probe が開始されるまでの秒数。

authz.readinessProbe.periodSeconds バージョン: 1.0.0

デフォルト値: 5

readinessProbe の実行頻度を秒単位で指定します。最小値は 1 です。

authz.readinessProbe.successThreshold バージョン: 1.0.0

デフォルト値: 1

失敗した readinessProbe が成功とみなされるために必要な最小の連続成功回数。最小値は 1 です。

authz.readinessProbe.timeoutSeconds バージョン: 1.0.0

デフォルト値: 1

livenessProbe がタイムアウトするまでの秒数。最小値は 1 です。

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

デフォルト値: 50m

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

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

デフォルト値: 128Mi

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

authz.serviceAccountPath バージョン: 1.0.0

デフォルト値: なし

必須

「Apigee 読み取り専用管理者」ロールを持つ Google サービス アカウントの鍵ファイルのパス。

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.0.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.0.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

デフォルト値: なし

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

「Apigee 読み取り専用管理者」ロールを持つ Google サービス アカウントの鍵ファイルのパス。

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.0.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 が検出する readinessProbe の失敗回数。この数に達すると、Pod が「準備未完了」とマークされます。最小値は 1 です。

cassandra.readinessProbe.initialDelaySeconds バージョン: 1.0.0

デフォルト値: 0

コンテナが起動してから Readiness Probe が開始されるまでの秒数。

cassandra.readinessProbe.periodSeconds バージョン: 1.0.0

デフォルト値: 10

readinessProbe の実行頻度を秒単位で指定します。最小値は 1 です。

cassandra.readinessProbe.successThreshold バージョン: 1.0.0

デフォルト値: 1

失敗した readinessProbe が成功とみなされるために必要な最小の連続成功回数。最小値は 1 です。

cassandra.readinessProbe.timeoutSeconds バージョン: 1.0.0

デフォルト値: 5

livenessProbe がタイムアウトするまでの秒数。最小値は 1 です。

cassandra.replicaCount バージョン: 1.0.0

デフォルト値: 3

Cassandra は複製されたデータベースです。各リージョンまたはデータセンターに 3 つ以上のデータコピーが存在するように構成されています。このプロパティは、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.0.0

このサービスの Docker イメージのバージョン ラベル。

cassandra.restore.image.url バージョン: 1.0.0

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

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

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

デフォルト値: なし

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

「Apigee 読み取り専用管理者」ロールを持つ Google サービス アカウントの鍵ファイルのパス。

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 が強制終了されるまでの時間(秒単位)。この期間中に preStop フックが実行され、動作中のすべてのプロセスが正常に終了します。

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[] を使用してベースパス ルーティングを構成すると、Apigee ハイブリッドが API プロキシコールを正しい環境にルーティングする方法を構成し、管理できます。

詳細情報:

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

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

デフォルト値: なし

必須

Apigee キャッシュ データの暗号鍵のローカル ファイル システムのパス。

envs[].hostAlias バージョン: 1.0.0

デフォルト値: なし

必須

サーバーの DNS 名。例: foo-test.mydomain.comDNS 名がない場合は、ワイルドカード('*')を使用できます。ワイルドカードを使用する場合は、istio-ingressgateway の外部 IP を使用できます。これは、インストール完了後に kubectl get services -n namespace を呼び出すことで取得できます。

複数の環境がある場合は、それぞれに固有のホスト エイリアス名を使用する必要があります。たとえば、foo-test.mydomain.comfoo-prod.mydomain.com です。

envs[].kmsEncryptionKey バージョン: 1.0.0

デフォルト値: なし

必須

Apigee KMS データの暗号鍵のローカル ファイル システムのパス。

envs[].name バージョン: 1.0.0

デフォルト値: なし

必須

同期する Apigee 環境名。

envs[].pollInterval バージョン: 1.0.0

デフォルト値: なし

組織と環境の同期を取るために変更をポーリングする間隔(秒単位)。

envs[].paths.uri.prefixes バージョン: 1.0.0

デフォルト値: なし

接頭辞のベースパス ルーティングに対応するプロパティ。これらのパスはパターンとして指定します。

      org: hybrid
      envs:
      - name: test
        paths:
          uri:
            prefixes:
            - /foo
            - /bar
envs[].port バージョン: 1.0.0

デフォルト値: なし

HTTPS トラフィックの TCP ポート番号。

envs[].serviceAccountPaths.synchronizer バージョン: 一般提供

デフォルト値: なし

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

envs[].serviceAccountPaths.udca バージョン: 一般提供

デフォルト値: なし

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

envs[].sslCertPath バージョン: 1.0.0

デフォルト値: なし

必須

TLS 証明書ファイルへのシステム上のパス。

envs[].sslKeyPath バージョン: 1.0.0

デフォルト値: なし

必須

TLS 秘密鍵ファイルへのシステム上のパス。

httpProxy

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

MARTSynchronizerUDCA もご覧ください。

次の表に、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 Gateway のインスタンス化です。Kubernetes Ingress リソースは、クラスタの外部に公開するサービスを指定するために使用されます。ランタイム プレーン外からランタイム プレーン内のサービスにトラフィックをルーティングするコンテナ化アプリを定義します。Apigee をインストールすると、次の用途の 2 つの Istio Ingress オブジェクトが作成されます。

  1. ランタイム
  2. 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.runtime.loadBalancerIP バージョン: 1.1.1

デフォルト値: 10.0.10.251

Apigee ランタイム オブジェクトのロードバランサの 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 オブジェクト
  • Istio ドキュメントの Ingress ゲートウェイ
  • 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

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

    以下をご覧ください。

    logger

    運用ログを管理するサービスを定義します。この情報は、Kubernetes クラスタで実行されるすべての Apigee Hybrid サービスから出力されます。

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

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

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

    デフォルト値: true

    クラスタでのロギングを有効または無効にします。GKE 以外の場合は true に設定し、Anthos または GKE の場合は false に設定します。

    logger.fluentd.buffer_chunk_limit バージョン: 1.0.0

    デフォルト値: 512k

    バッファ チャンクの許容される最大サイズ(KB 単位)。この上限を超えるチャンクは出力キューに自動的にフラッシュされます。

    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 が検出する livenessProbe の失敗回数。この数に達すると、コンテナが再起動されます。最小値は 1 です。

    logger.livenessProbe.initialDelaySeconds バージョン: 1.0.0

    デフォルト値: 0

    コンテナが起動してから Liveness Probe が開始されるまでの秒数。

    logger.livenessProbe.periodSeconds バージョン: 1.0.0

    デフォルト値: 60

    livenessProbe を実行する頻度を秒単位で指定します。最小値は 1 です。

    logger.livenessProbe.successThreshold バージョン: 1.0.0

    デフォルト値: 1

    失敗した livenessProbe が成功とみなされるために必要な最小の連続成功回数。最小値は 1 です。

    logger.livenessProbe.timeoutSeconds バージョン: 1.0.0

    デフォルト値: 1

    livenessProbe がタイムアウトするまでの秒数。最小値は 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

    デフォルト値: なし

    必須

    「Apigee 読み取り専用管理者」ロールを持つ Google サービス アカウントの鍵ファイルのパス。

    logger.terminationGracePeriodSeconds バージョン: 1.0.0

    デフォルト値: 30

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

    mart

    MART(Management API for RunTime data)サービスを定義します。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.0.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 が検出する livenessProbe の失敗回数。この数に達すると、コンテナが再起動されます。最小値は 1 です。

    mart.livenessProbe.initialDelaySeconds バージョン: 1.0.0

    デフォルト値: 15

    コンテナが起動してから Liveness Probe が開始されるまでの秒数。

    mart.livenessProbe.periodSeconds バージョン: 1.0.0

    デフォルト値: 5

    livenessProbe を実行する頻度を秒単位で指定します。最小値は 1 です。

    mart.livenessProbe.timeoutSeconds バージョン: 1.0.0

    デフォルト値: 1

    livenessProbe がタイムアウトするまでの秒数。最小値は 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 が検出する readinessProbe の失敗回数。この数に達すると、Pod が「準備未完了」とマークされます。最小値は 1 です。

    mart.readinessProbe.initialDelaySeconds バージョン: 1.0.0

    デフォルト値: 15

    コンテナが起動してから Readiness Probe が開始されるまでの秒数。

    mart.readinessProbe.periodSeconds バージョン: 1.0.0

    デフォルト値: 5

    readinessProbe の実行頻度を秒単位で指定します。最小値は 1 です。

    mart.readinessProbe.successThreshold バージョン: 1.0.0

    デフォルト値: 1

    失敗した readinessProbe が成功とみなされるために必要な最小の連続成功回数。最小値は 1 です。

    mart.readinessProbe.timeoutSeconds バージョン: 1.0.0

    デフォルト値: 1

    livenessProbe がタイムアウトするまでの秒数。最小値は 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

    デフォルト値: なし

    必須

    「Apigee 読み取り専用管理者」ロールを持つ Google サービス アカウントの鍵ファイルのパス。

    mart.sslCertPath バージョン: 1.0.0

    デフォルト値: なし

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

    mart.sslKeyPath バージョン: 1.0.0

    デフォルト値: なし

    SSL 鍵を Secret に読み込んでエンコードするためのローカル ファイル システムのパス。

    mart.targetCPUUtilizationPercentage バージョン: 1.0.0

    デフォルト値: 75

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

    mart.terminationGracePeriodSeconds バージョン: 1.0.0

    デフォルト値: 30

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

    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 が検出する livenessProbe の失敗回数。この数に達すると、コンテナが再起動されます。最小値は 1 です。

    metrics.prometheus.livenessProbe.periodSeconds バージョン: 1.0.0

    デフォルト値: 5

    livenessProbe を実行する頻度を秒単位で指定します。最小値は 1 です。

    metrics.prometheus.livenessProbe.timeoutSeconds バージョン: 1.0.0

    デフォルト値: 3

    livenessProbe がタイムアウトするまでの秒数。最小値は 1 です。

    metrics.prometheus.readinessProbe.failureThreshold バージョン: 1.0.0

    デフォルト値: 120

    Kubernetes が検出する readinessProbe の失敗回数。この数に達すると、Pod が「準備未完了」とマークされます。最小値は 1 です。

    metrics.prometheus.readinessProbe.periodSeconds バージョン: 1.0.0

    デフォルト値: 5

    readinessProbe の実行頻度を秒単位で指定します。最小値は 1 です。

    metrics.prometheus.readinessProbe.timeoutSeconds バージョン: 1.0.0

    デフォルト値: 3

    livenessProbe がタイムアウトするまでの秒数。最小値は 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

    デフォルト値: なし

    必須

    「Apigee 読み取り専用管理者」ロールを持つ Google サービス アカウントの鍵ファイルのパス。

    metrics.terminationGracePeriodSeconds バージョン: 1.0.0

    デフォルト値: 300

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

    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 ランタイムはプロジェクトのランタイム環境用のノードです。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.0.0

    このサービスの Docker イメージのバージョン ラベル。

    runtime.image.url バージョン: 1.0.0

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

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

    runtime.livenessProbe.failureThreshold バージョン: 1.0.0

    デフォルト値: 2

    Kubernetes が検出する livenessProbe の失敗回数。この数に達すると、コンテナが再起動されます。最小値は 1 です。

    runtime.livenessProbe.initialDelaySeconds バージョン: 1.0.0

    デフォルト値: 60

    コンテナが起動してから Liveness Probe が開始されるまでの秒数。

    runtime.livenessProbe.periodSeconds バージョン: 1.0.0

    デフォルト値: 5

    livenessProbe を実行する頻度を秒単位で指定します。最小値は 1 です。

    runtime.livenessProbe.timeoutSeconds バージョン: 1.0.0

    デフォルト値: 1

    livenessProbe がタイムアウトするまでの秒数。最小値は 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 が検出する readinessProbe の失敗回数。この数に達すると、Pod が「準備未完了」とマークされます。最小値は 1 です。

    runtime.readinessProbe.initialDelaySeconds バージョン: 1.0.0

    デフォルト値: 60

    コンテナが起動してから Readiness Probe が開始されるまでの秒数。

    runtime.readinessProbe.periodSeconds バージョン: 1.0.0

    デフォルト値: 5

    readinessProbe の実行頻度を秒単位で指定します。最小値は 1 です。

    runtime.readinessProbe.successThreshold バージョン: 1.0.0

    デフォルト値: 1

    失敗した readinessProbe が成功とみなされるために必要な最小の連続成功回数。最小値は 1 です。

    runtime.readinessProbe.timeoutSeconds バージョン: 1.0.0

    デフォルト値: 1

    livenessProbe がタイムアウトするまでの秒数。最小値は 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 が強制終了されるまでの時間(秒単位)。この期間中に preStop フックが実行され、動作中のすべてのプロセスが正常に終了します。

    synchronizer

    デプロイされた最新の API プロキシ バンドルに同期して Message Processor を最新の状態に維持します。これを行うには、Synchronizer が管理プレーンに対してポーリングを行います。新しい契約が検出されると、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.0.0

    このサービスの Docker イメージのバージョン ラベル。

    synchronizer.image.url バージョン: 1.0.0

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

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

    synchronizer.livenessProbe.failureThreshold バージョン: 1.0.0

    デフォルト値: 2

    Kubernetes が検出する livenessProbe の失敗回数。この数に達すると、コンテナが再起動されます。最小値は 1 です。

    synchronizer.livenessProbe.initialDelaySeconds バージョン: 1.0.0

    デフォルト値: 0

    コンテナが起動してから Liveness Probe が開始されるまでの秒数。

    synchronizer.livenessProbe.periodSeconds バージョン: 1.0.0

    デフォルト値: 5

    livenessProbe を実行する頻度を秒単位で指定します。最小値は 1 です。

    synchronizer.livenessProbe.timeoutSeconds バージョン: 1.0.0

    デフォルト値: 1

    livenessProbe がタイムアウトするまでの秒数。最小値は 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 が検出する readinessProbe の失敗回数。この数に達すると、Pod が「準備未完了」とマークされます。最小値は 1 です。

    synchronizer.readinessProbe.initialDelaySeconds バージョン: 1.0.0

    デフォルト値: 0

    コンテナが起動してから Readiness Probe が開始されるまでの秒数。

    synchronizer.readinessProbe.periodSeconds バージョン: 1.0.0

    デフォルト値: 5

    readinessProbe の実行頻度を秒単位で指定します。最小値は 1 です。

    synchronizer.readinessProbe.successThreshold バージョン: 1.0.0

    デフォルト値: 1

    失敗した readinessProbe が成功とみなされるために必要な最小の連続成功回数。最小値は 1 です。

    synchronizer.readinessProbe.timeoutSeconds バージョン: 1.0.0

    デフォルト値: 1

    livenessProbe がタイムアウトするまでの秒数。最小値は 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

    デフォルト値: なし

    必須

    「Apigee 読み取り専用管理者」ロールを持つ Google サービス アカウントの鍵ファイルのパス。

    synchronizer.targetCPUUtilizationPercentage バージョン: 1.0.0

    デフォルト値: 75

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

    synchronizer.terminationGracePeriodSeconds バージョン: 1.0.0

    デフォルト値: 30

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

    udca

    (Universal Data Collection Agent)ランタイム プレーンのデータ収集 Pod で実行されるサービスを定義します。このサービスは、アナリティクスとデプロイのステータスデータを抽出し、統合アナリティクス プラットフォーム(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.0.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.0.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 が検出する livenessProbe の失敗回数。この数に達すると、コンテナが再起動されます。最小値は 1 です。

    udca.livenessProbe.initialDelaySeconds バージョン: 1.0.0

    デフォルト値: 0

    コンテナが起動してから Liveness Probe が開始されるまでの秒数。

    udca.livenessProbe.periodSeconds バージョン: 1.0.0

    デフォルト値: 5

    livenessProbe を実行する頻度を秒単位で指定します。最小値は 1 です。

    udca.livenessProbe.timeoutSeconds バージョン: 1.0.0

    デフォルト値: 1

    livenessProbe がタイムアウトするまでの秒数。最小値は 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 デプロイ用の Pod の最大数。UDCA は ReplicaSet として実装されているため、これらの Pod はレプリカです。

    udca.replicaCountMin バージョン: 1.0.0

    デフォルト値: 1

    UDCA デプロイ用の 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.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 が強制終了されるまでの時間(秒単位)。この期間中に停止前フックが実行され、動作中のすべてのプロセスが正常に終了します。