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

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

このページをフィルタする

このページで説明するプロパティをフィルタするには、[基本]（特に一般的なプロパティ）または [高度]（ほとんどの場合で変更が不要なプロパティ）を選択します。

このページ上の  の構成プロパティを表示します。

最上位プロパティ

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

プロパティ 型 説明
axHashSalt 高度

導入バージョン: 1.3.0

デフォルト値: iloveapis123

省略可

Apigee Analytics に送信される前にユーザーデータを難読化するためのハッシュの計算に使用されるソルト値を含む Kubernetes Secret の名前。ソルト値を指定しない場合、デフォルトで iloveapis123 が使用されます。Secret を作成する際は、このソルト値が入力として使用されます。複数のクラスタ間で同じソルトを使用することで、クラスタ間で一貫したハッシュの結果を得ることができます。

Apigee は SHA512 を使用して元の値をハッシュしてから、データをランタイム プレーンからコントロール プレーンに送信します。

分析用にユーザーデータを難読化するをご覧ください。
contractProvider 高度 導入バージョン: 1.0.0

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

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

ハイブリッド インストールで次の形式のデータ所在地を使用している場合に必須です。

contractProvider: https://CONTROL_PLANE_LOCATION-apigee.googleapis.com

ここで、CONTROL_PLANE_LOCATION は、プロキシ バンドルなどのコントロール プレーン データが保存される場所です。リストについては、使用可能な Apigee API コントロール プレーンのリージョンをご覧ください。

例:

contractProvider: https://us-apigee.googleapis.com
customAutoscaling.enabled 基本 導入バージョン: 1.14.0

デフォルト値: true

true（デフォルト）に設定すると、Apigee の指標ベースの自動スケーリングが有効になります。カスタム自動スケーリングを無効にするには、false に設定します。

apigee-telemetry チャートを更新して、customAutoscaling.enabled に変更を適用します。
enhanceProxyLimits 高度 導入バージョン: 1.14.0

デフォルト値: false

必須

enhanceProxyLimits は、Apigee の環境ごとのプロキシ上限の拡張機能に必要です。ハイブリッド組織が環境ごとのプロキシ上限の拡張機能の利用資格がある場合は、この値を enhanceProxyLimits: true に設定します。

詳しくは、以下を参照してください。

enhanceProxyLimits: true の設定は、プロキシ チェーン、エンドポイント チェーン、ServiceCallout チェーンに必要です。詳細については、以下をご覧ください。

環境グループごとに apigee-org チャートと apigee-virtualhost チャートを更新して、enhanceProxyLimits に変更を適用します。
gcpProjectID 高度 Deprecated: v1.2.0 以降では、代わりに gcp.projectID を使用します。

導入バージョン: 1.0.0

デフォルト値: なし

必須

Google Cloud プロジェクトの ID。k8sClusterName（非推奨）および gcpRegion（非推奨）と連携してプロジェクトを識別し、apigee-logger と apigee-metrics のデータの push 先を決定します。
gcpRegion 高度 Deprecated: v1.2.0 以降では、代わりに gcp.region を使用します。

導入バージョン: 1.0.0

デフォルト値: us-central1

必須

Kubernetes クラスタに最も近い Google Cloud のリージョンまたはゾーン。gcpProjectID（非推奨）および k8sClusterName（非推奨）と連携してプロジェクトを識別し、apigee-logger と apigee-metrics がデータを push する場所を指定します。
hub 高度 導入バージョン: 1.11.0

デフォルト値: なし

非公開リポジトリからすべての Apigee コンポーネントのイメージを pull するために使用される、非公開イメージ コンテナ リポジトリの URL。

hub は、すべての Apigee ハイブリッド コンポーネントのデフォルトパスを提供します。非公開リポジトリを使用している場合は、コンポーネントごとに個別の image.url プロパティを使用するのではなく、hub を使用してすべてのコンポーネントのリポジトリ URL を設定します。特定のコンポーネントに別のリポジトリを使用している場合にのみ、個別の URL を構成します。

個々のコンポーネントのイメージパスは、hub の値にコンポーネントのイメージ名とタグを追加したものです。

たとえば、hub の値が private-docker-host.example.com の場合、個々のコンポーネントのイメージパスは次のように自動的に解決されます。

hub: private-docker-host.example.com

たとえば

containers:
- name: apigee-udca
  image: private-docker-host.example.com/apigee-udca:1.15.0
  imagePullPolicy: IfNotPresent

他のコンポーネントも同様のパターンに従います。

すべてのコンポーネントの現在のリポジトリ URL を表示するには、apigee-pull-push --list を使用します。

Apigee ハイブリッドで限定公開イメージ リポジトリを使用するをご覧ください。

以下のプロパティを使用して、コンポーネントのイメージ URL を個別にオーバーライドできます。
imagePullSecrets.name 高度 導入バージョン: 1.0.0

デフォルト値: なし

Docker レジストリ タイプとして構成された Kubernetes Secret 名。非公開リポジトリからイメージを pull するために使用されます。
instanceID 基本 導入バージョン: 1.3.0

デフォルト値: なし

必須

このインストールの固有識別子。

このインスタンスを識別する一意の文字列。任意の文字と数字の組み合わせで、長さは 63 文字以下にする必要があります。
k8sClusterName 高度 Deprecated: 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 のいずれかを使用してください。

Apigee KMS データの暗号鍵が存在するローカル ファイル システム上のパス。
kmsEncryptionPath 高度 導入バージョン: 1.2.0

デフォルト値: なし

省略可。kmsEncryptionKey、kmsEncryptionPath、kmsEncryptionSecret のいずれかを使用してください。

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

デフォルト値: なし

省略可。kmsEncryptionKey、kmsEncryptionPath、kmsEncryptionSecret のいずれかを使用してください。

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

デフォルト値: なし

省略可。kmsEncryptionKey、kmsEncryptionPath、kmsEncryptionSecret のいずれかを使用してください。

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 の名前。データの暗号化をご覧ください。
multiOrgCluster 高度 導入バージョン: 1.10.0

デフォルト値: false

複数組織クラスタの場合、このプロパティを使用すると、組織の指標を gcp.projectID プロパティにリストされているプロジェクトにエクスポートできます。複数組織のクラスタ内の各組織のオーバーライド ファイルで、この設定を適用します。詳細については、クラスタへの複数のハイブリッド組織の追加をご覧ください。
namespace 基本 導入バージョン: 1.0.0

デフォルト値: apigee

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

導入バージョン: 1.0.0

デフォルト値: なし

必須

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

デフォルト値: true

Universal Data Collection Agent サービス（UDCA）を組織レベルで有効にします。UDCA は、分析、収益化、デバッグ（トレース）を抽出して、コントロール プレーンに存在する統合分析プラットフォーム（UAP）に送信します。

組織をスコープとする UDCA は、すべての Apigee 環境で単一の Google サービス アカウントを使用します。サービス アカウントには Apigee Analytics エージェント（roles/apigee.analyticsAgent）のロールが必要です。

udca.serviceAccountPath プロパティを使用してサービス アカウント キー ファイルのパスを指定するか、または overrides.yaml 構成ファイルで udca.serviceAccountRef プロパティを使用して Kubernetes Secret の鍵を指定します。

環境ごとに個別の UDCA エージェントを使用する場合は、orgScopedUDCA: false に設定して、envs[].serviceAccountPaths.udca と envs[].serviceAccountSecretRefs.udca の値を設定します。

udca もご覧ください。
revision 高度 導入バージョン: 1.0.0

デフォルト値: "1150"（ピリオドなしの Apigee ハイブリッド バージョン。たとえば、バージョン 1.12.0 の場合、デフォルト値は "1120" です）。

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

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

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

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

詳細については、ローリング アップデートをご覧ください。
serviceAccountSecretProviderClass 高度 導入バージョン: 1.12.0

デフォルト値: なし

サービス アカウント キーを Vault に保存するために使用される組織固有のシークレット プロバイダ クラス（SecretProviderClass）の名前。

Hashicorp Vault へのサービス アカウント キーの保存をご覧ください。
validateOrg 高度 導入バージョン: 1.8.0

デフォルト値: true

Apigee 組織と Google Cloud プロジェクトとの間のリンクの厳密な検証を有効にし、環境グループの存在を確認します。

org もご覧ください。
validateServiceAccounts 高度 導入バージョン: 1.0.0

デフォルト値: true

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

gcpProjectID もご覧ください。

ao

Apigee Operators（AO）は、AD のデプロイとメンテナンスに必要な低レベルの Kubernetes リソースと Istio リソースを作成および更新します。たとえば、Message Processor はこのコントローラによってリリースされます。

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

プロパティ 型 説明
ao.args.disableIstioConfigInAPIServer 高度 導入バージョン: 1.8.0

デフォルト値: true

Apigee は、お客様がインストールした Cloud Service Mesh に対して構成を提供できなくなります。

  • Apigee Ingress ゲートウェイを使用するハイブリッド インストールの場合は、true に設定します。
  • Cloud Service Mesh を使用した Apigee ハイブリッド インストール（Apigee ハイブリッド バージョン 1.8 以前）の場合は、false に設定します。
ao.args.disableManagedClusterRoles 高度 導入バージョン: 1.10.0

デフォルト値: true

true（デフォルト）の場合、Apigee ハイブリッドは Kubernetes ClusterRole と ClursterRoleBinding を直接管理しません。これらのリソースの管理を必要とするプロセスがある場合は、適切な権限を持つユーザーがプロセスを実行する必要があります。
ao.image.pullPolicy 高度 導入バージョン: 1.2.0

デフォルト値: IfNotPresent

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

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

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

デフォルト値: 1.15.0

このサービスの Docker イメージのバージョン ラベル。
ao.image.url 高度 導入バージョン: 1.2.0

デフォルト値: なし

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

apigee-pull-push --list を使用して、このコンポーネントの現在のリポジトリ URL を確認できます。
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 コンテナ内のリソースの通常のオペレーションに必要なメモリ（メビバイト単位）。
ao.tolerations.effect 高度 導入バージョン: 1.10.1

デフォルト値: なし

Kubernetes の taint と toleration 機能を使用するために必要です。

effect は、taint と一致する toleration の効果を指定します。effect の値は次のいずれかです。

  • NoExecute
  • NoSchedule
  • PreferNoSchedule

詳細については、taint と toleration: コンセプトをご覧ください。
ao.tolerations.key 高度 導入バージョン: 1.10.1

デフォルト値: なし

Kubernetes の taint と toleration 機能を使用するために必要です。

key は、toleration を適用できる Pod を識別します。

詳細については、taint と toleration: コンセプトをご覧ください。
ao.tolerations.operator 高度 導入バージョン: 1.10.1

デフォルト値: "Equal"

Kubernetes の taint と toleration 機能を使用するために必要です。

operator には、effect をトリガーするオペレーションを指定します。operator の値は次のいずれかです。

  • Equal は、value に設定された値と一致します。
  • Exists は、value に設定された値を無視します。

詳細については、taint と toleration: コンセプトをご覧ください。
ao.tolerations.tolerationSeconds 高度 導入バージョン: 1.10.1

デフォルト値: なし

Kubernetes の taint と toleration 機能で使用します。

tolerationSeconds は、障害が発生しているノードまたは応答していないノードに Pod がバインドされている時間を秒単位で定義します。

詳細については、taint と toleration: コンセプトをご覧ください。
ao.tolerations.value 高度 導入バージョン: 1.10.1

デフォルト値: なし

Kubernetes の taint と toleration 機能で使用します。

value は、operator が Equal に設定されている場合に effect をトリガーする値です。

詳細については、taint と toleration: コンセプトをご覧ください。

apigeeIngressGateway

Apigee ハイブリッドの Apigee Ingress ゲートウェイを構成します。apigeeIngressGateway プロパティを使用して、Apigee Ingress ゲートウェイのすべてのインスタンスに共通の構成を適用します。

個別のインスタンスを一意に構成するには、ingressGateways をご覧ください。

apigee-org チャートを使用して apigeeIngressGateway プロパティに変更を適用します。

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

プロパティ 型 説明
apigeeIngressGateway.image.pullPolicy 高度 導入バージョン: 1.11.0

デフォルト値: IfNotPresent

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

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

詳細については、イメージの更新をご覧ください。
apigeeIngressGateway.image.tag 高度 導入バージョン: 1.11.0

デフォルト値: 1.15.0

このサービスの Docker イメージのバージョン ラベル。
apigeeIngressGateway.image.url 高度 導入バージョン: 1.11.0

デフォルト値: なし

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

apigee-pull-push --list を使用して、このコンポーネントの現在のリポジトリ URL を確認できます。
apigeeIngressGateway.nodeSelector.key 高度 導入バージョン: 1.11.0

デフォルト値: なし

必須

Ingress ゲートウェイ サービス専用の Kubernetes ノードの選択に使用するノードセレクタのラベルキー。

専用ノードプールの構成をご覧ください。
apigeeIngressGateway.nodeSelector.value 高度 導入バージョン: 1.11.0

デフォルト値: なし

Ingress ゲートウェイ サービス専用の Kubernetes ノードを選択し、nodeSelector.apigeeData 設定をオーバーライドするために使用するノードセレクタのラベル値（省略可）。

nodeSelector をご覧ください。
apigeeIngressGateway.replicaCountMax 基本 導入バージョン: 1.11.0

デフォルト値: 4

ハイブリッドが自動スケーリングで使用できる Ingress ゲートウェイに自動的に追加できる Pod の最大数。
apigeeIngressGateway.replicaCountMin 基本 導入バージョン: 1.11.0

デフォルト値: 2

自動スケーリングに使用できる Ingress ゲートウェイの Pod の最小数。
apigeeIngressGateway.targetCPUUtilizationPercentage 高度 導入バージョン: 1.10.5、1.11.2、1.12.1

デフォルト値: 75

ReplicaSet 内の Pod 数をスケーリングするために使用する CPU 使用率のしきい値（使用可能な CPU リソースの合計に対する割合）。

CPU 使用率がこの値を超えると、ReplicaSet 内の Pod 数が徐々に増加します（最大で apigeeIngressGateway.replicaCountMax）。

Kubernetes でのスケーリングの詳細については、Kubernetes ドキュメントの水平 Pod 自動スケーリングをご覧ください。
apigeeIngressGateway.tolerations.effect 高度 導入バージョン: 1.11.0

デフォルト値: なし

Kubernetes の taint と toleration 機能を使用するために必要です。

effect は、taint と一致する toleration の効果を指定します。effect の値は次のいずれかです。

  • NoExecute
  • NoSchedule
  • PreferNoSchedule

詳細については、taint と toleration: コンセプトをご覧ください。
apigeeIngressGateway.tolerations.key 高度 導入バージョン: 1.11.0

デフォルト値: なし

Kubernetes の taint と toleration 機能を使用するために必要です。

key は、toleration を適用できる Pod を識別します。

詳細については、taint と toleration: コンセプトをご覧ください。
apigeeIngressGateway.tolerations.operator 高度 導入バージョン: 1.11.0

デフォルト値: "Equal"

Kubernetes の taint と toleration 機能を使用するために必要です。

operator には、effect をトリガーするオペレーションを指定します。operator の値は次のいずれかです。

  • Equal は、value に設定された値と一致します。
  • Exists は、value に設定された値を無視します。

詳細については、taint と toleration: コンセプトをご覧ください。
apigeeIngressGateway.tolerations.tolerationSeconds 高度 導入バージョン: 1.11.0

デフォルト値: なし

Kubernetes の taint と toleration 機能で使用します。

tolerationSeconds は、障害が発生しているノードまたは応答していないノードに Pod がバインドされている時間を秒単位で定義します。

詳細については、taint と toleration: コンセプトをご覧ください。
apigeeIngressGateway.tolerations.value 高度 導入バージョン: 1.11.0

デフォルト値: なし

Kubernetes の taint と toleration 機能で使用します。

value は、operator が Equal に設定されている場合に effect をトリガーする値です。

詳細については、taint と toleration: コンセプトをご覧ください。

cassandra

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

詳細については、StorageClass の構成をご覧ください。

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

プロパティ 型 説明
cassandra.annotations 高度 導入バージョン: 1.5.0

デフォルト値: なし

（省略可）Pod にアノテーションを付けるために使用する Key-Value マップ。詳しくは、カスタム アノテーションをご覧ください。
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.15.0

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

デフォルト値: なし

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

apigee-pull-push --list を使用して、このコンポーネントの現在のリポジトリ URL を確認できます。
cassandra.auth.jmx.password 基本 導入バージョン: 1.4.0

デフォルト値: iloveapis123

必須

Cassandra JMX オペレーション ユーザーのパスワード。Cassandra JMX インターフェースの認証と通信に使用されます。
cassandra.auth.jmx.username 基本 導入バージョン: 1.4.0

デフォルト値: jmxuser

必須

Cassandra JMX オペレーション ユーザーのユーザー名。Cassandra JMX インターフェースの認証と通信に使用されます。
cassandra.auth.jolokia.password 基本 導入バージョン: 1.4.0

デフォルト値: iloveapis123

必須

Cassandra Jolokia JMX オペレーション ユーザーのパスワード。Cassandra JMX API の認証と通信に使用されます。
cassandra.auth.jolokia.username 基本 導入バージョン: 1.4.0

デフォルト値: apigee

必須

Cassandra Jolokia JMX オペレーション ユーザーのユーザー名。Cassandra JMX API の認証と通信に使用されます。
cassandra.auth.secret 基本 導入バージョン: 1.3.3

デフォルト値: なし

Cassandra のユーザーとパスワードを含む、Kubernetes Secret に格納されているファイルの名前。Secret を作成するには、Secret を作成するの手順を行います。

関連項目:
cassandra.auth.secretProviderClass 高度 導入バージョン: 1.10.3

デフォルト値: なし

Cassandra シークレット ストレージ ポリシー。設定する場合は、Hashicorp Vault などの外部シークレット プロバイダを参照する SecretProviderClass と一致する必要があります。未設定の場合、Apigee ハイブリッドでは以下に保存されているユーザー名とパスワードのいずれかが使用されます。

または、以下に保存されている Kubernetes のシークレット。

ポリシーを作成する手順については、Hashicorp Vault への Cassandra シークレットの保存をご覧ください。
cassandra.backup.cloudProvider 高度 導入バージョン: 1.0.0

デフォルト値: GCP

バックアップ プロバイダの名前。サポートされている値: GCP、HYBRID、CSI。以下の値を設定します。

  • GCP: Google Cloud Storage にバックアップ アーカイブを保存します。
  • HYBRID: バックアップ アーカイブをリモート SSH サーバーに保存します。
  • CSI（推奨）: Kubernetes CSI バックアップにボリューム スナップショットを使用します。Google Cloud、AWS、Azure などのクラウド プラットフォームにおける CSI のバックアップと復元については、CSI のバックアップと復元をご覧ください。
cassandra.backup.dbStorageBucket 高度 導入バージョン: 1.0.0

デフォルト値: なし

バックアップが有効で、cassandra.backup.cloudProvider が GCP に設定されている場合は必須。

バックアップ アーカイブの保存に使用する既存の Google Cloud Storage バケットの名前。バケットを作成する必要がある場合は、バケットの作成をご覧ください。
cassandra.backup.enabled 高度 導入バージョン: 1.0.0

デフォルト値: false

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

Cassandra のバックアップと復元をご覧ください。
cassandra.backup.gsa 高度 導入バージョン: 1.10.0

デフォルト値: なし

Helm のみ: GKE クラスタで Workload Identity を有効にするときに Cassandra バックアップ Kubernetes サービス アカウントに関連付ける、apigee-cassandra Google IAM サービス アカウント（GSA）のメールアドレス。このプロパティは、gcp.workloadIdentity.enabled を true に、cassandra.backup.enabled を true に設定した場合に設定します。

通常、GSA のメールアドレスの形式は次のとおりです。

GSA_NAME@PROJECT_ID.iam.gserviceaccount.com

例:

apigee-cassandra@my-hybrid-project.iam.gserviceaccount.com

GKE で Workload Identity 連携を有効にするをご覧ください。
cassandra.backup.image.pullPolicy 高度 導入バージョン: 1.0.0

デフォルト値: IfNotPresent

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

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

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

デフォルト値: 1.15.0

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

デフォルト値: なし

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

apigee-pull-push --list を使用して、このコンポーネントの現在のリポジトリ URL を確認できます。
cassandra.backup.keyfile 高度 導入バージョン: 1.3.0

デフォルト値: なし

バックアップが有効で、cassandra.backup.cloudProvider が HYBRID に設定されている場合は必須。

ローカル ファイル システム上の SSH 秘密鍵ファイルへのパス。
cassandra.backup.schedule 高度 導入バージョン: 1.0.0

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

バックアップ cron ジョブのスケジュール。

Cassandra のバックアップと復元をご覧ください。
cassandra.backup.server 高度 導入バージョン: 1.3.0

デフォルト値: なし

バックアップが有効で、cassandra.backup.cloudProvider が HYBRID に設定されている場合は必須。

リモート SSH バックアップ サーバーの IP アドレス。
cassandra.backup.serviceAccountPath 高度 導入バージョン: 1.0.0

デフォルト値: なし

Storage オブジェクト管理者（roles/storage.objectAdmin）ロールを持つ Google サービス アカウント キーファイルへのパス。この Google サービス アカウントは、指定された cassandra.backup.dbStorageBucket にバックアップ アーカイブをアップロードするために使用されます。

バックアップが有効で、cassandra.backup.cloudProvider が GCP に設定されている場合、Apigee Hybrid が Google Cloud Storage バケットにアクセスしてバックアップ アーカイブをアップロードできるようにするには、次のいずれかが必要です。
cassandra.backup.serviceAccountRef 高度 導入バージョン: 1.2.0

デフォルト値: なし

Storage オブジェクト管理者（roles/storage.objectAdmin）ロールを持つ Google サービス アカウント キーファイルのコンテンツを格納する既存の Kubernetes Secret の名前。この Google サービス アカウントは、指定された cassandra.backup.dbStorageBucket にバックアップ アーカイブをアップロードするために使用されます。

バックアップが有効で、cassandra.backup.cloudProvider が GCP に設定されている場合、Apigee Hybrid が Google Cloud Storage バケットにアクセスしてバックアップ アーカイブをアップロードできるようにするには、次のいずれかが必要です。
cassandra.backup.storageDirectory 高度 導入バージョン: 1.3.0

デフォルト値: なし

バックアップが有効で、cassandra.backup.cloudProvider が HYBRID に設定されている場合は必須。

apigee ユーザーのホーム ディレクトリへの絶対パスまたは相対パス。

バックアップ SSH サーバー上のバックアップ ディレクトリの名前。
cassandra.clusterName 基本 導入バージョン: 1.0.0

デフォルト値: apigeecluster

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

デフォルト値: dc-1

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

デフォルト値: なし

hostNetwork を true に設定すると、DNS ポリシーは ClusterFirstWithHostNet に設定されます。
cassandra.externalSeedHost 基本 導入バージョン: 1.0.0

デフォルト値: なし

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

デフォルト値: 100M

新しいオブジェクトに割り当てられる JVM システムメモリの量（メガバイト単位）。
cassandra.hostNetwork 基本 導入バージョン: 1.1.1

デフォルト値: false

Kubernetes の hostNetwork 機能を有効にします。Apigee は、Pod ネットワーク Namespace がクラスタ間の接続を持たない場合（クラスタが「島ネットワーク モード」で実行されている場合）に、Pod 間で通信するためにマルチリージョン インストールでこの機能を使用します。これは、VMware またはベアメタル上の Google Distributed Cloud、GKE on AWS、AKS、EKS、OpenShift など、GKE 以外のインストールにおけるデフォルトのケースです。

単一リージョンでのインストールと、異なるクラスタの Pod 間に接続があるマルチリージョン インストール（たとえば、GKE のインストール）では、cassandra.hostNetwork を false に設定します。

異なるクラスタの Pod 間で通信を行わないマルチリージョン インストール（Google Distributed Cloud on VMware またはベアメタル、GKE on AWS、AKS、EKS、OpenShift のインストールなど）では、cassandra.hostNetwork を true に設定します。マルチリージョン デプロイ: 前提条件をご覧ください。

true の場合、DNS ポリシーは自動的に ClusterFirstWithHostNet に設定されます。
cassandra.image.pullPolicy 高度 導入バージョン: 1.0.0

デフォルト値: IfNotPresent

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

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

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

デフォルト値: 1.15.0

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

デフォルト値: なし

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

apigee-pull-push --list を使用して、このコンポーネントの現在のリポジトリ URL を確認できます。
cassandra.maxHeapSize 高度 導入バージョン: 1.0.0

デフォルト値: 512M

Cassandra のオペレーションに使用可能な JVM システムメモリの上限（MB 単位）。
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

コンテナが起動してから readinessProbe が開始されるまでの秒数。
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

デフォルト値: 1

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

デフォルト値: 500m

Kubernetes コンテナ内のリソースの通常オペレーションに必要な CPU（ミリコア単位）。
cassandra.resources.requests.memory 高度 導入バージョン: 1.0.0

デフォルト値: 1Gi

Kubernetes コンテナ内のリソースの通常のオペレーションに必要なメモリ（メビバイト単位）。
cassandra.restore.cloudProvider 高度 導入バージョン: 1.0.0

デフォルト値: GCP

復元プロバイダの名前。サポートされている値: GCP、HYBRID、CSI。以下の値を設定します。

  • GCP: Google Cloud Storage に保存されているバックアップからデータを復元します。
  • HYBRID: リモート SSH サーバーに保存されているバックアップからデータを復元します。
  • CSI（推奨）: Kubernetes CSI ボリューム スナップショットを使用して復元します。Google Cloud、AWS、Azure などのクラウド プラットフォームにおける CSI のバックアップと復元については、CSI のバックアップと復元をご覧ください。
cassandra.restore.dbStorageBucket 高度 導入バージョン: 1.0.0

デフォルト値: なし

復元が有効で、cassandra.restore.cloudProvider が GCP に設定されている場合は必須。

データ復元に使用するバックアップ アーカイブを保存する Google Cloud Storage バケットの名前。
cassandra.restore.enabled 高度 導入バージョン: 1.0.0

デフォルト値: false

デフォルトでは、データの復元は有効になっていません。有効にするには、true に設定します。

Cassandra のバックアップと復元をご覧ください。
cassandra.restore.gsa 高度 導入バージョン: 1.10.0

デフォルト値: なし

Helm のみ: GKE クラスタで Workload Identity を有効にするときに Cassandra 復元 Kubernetes サービス アカウントに関連付ける、apigee-cassandra Google IAM サービス アカウント（GSA）のメールアドレス。このプロパティは、gcp.workloadIdentity.enabled を true に、cassandra.restore.enabled を true に設定した場合に設定します。

通常、GSA のメールアドレスの形式は次のとおりです。

GSA_NAME@PROJECT_ID.iam.gserviceaccount.com

例:

apigee-cassandra@my-hybrid-project.iam.gserviceaccount.com

GKE で Workload Identity 連携を有効にするをご覧ください。
cassandra.restore.image.pullPolicy 高度 導入バージョン: 1.0.0

デフォルト値: IfNotPresent

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

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

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

デフォルト値: 1.15.0

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

デフォルト値: なし

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

apigee-pull-push --list を使用して、このコンポーネントの現在のリポジトリ URL を確認できます。
cassandra.restore.serviceAccountPath 高度 導入バージョン: 1.0.0

デフォルト値: なし

Storage オブジェクト管理者（roles/storage.objectAdmin）ロールを持つ Google サービス アカウント キーファイルへのパス。この Google サービス アカウントは、指定された cassandra.restore.dbStorageBucket からバックアップ アーカイブをダウンロードするために使用されます。

復元が有効で、cassandra.restore.cloudProvider が GCP に設定されている場合、Apigee ハイブリッドが Google Cloud Storage バケットにアクセスして復元用のバックアップ アーカイブをダウンロードできるようにするには、次のいずれかが必要です。
cassandra.restore.serviceAccountRef 高度 導入バージョン: 1.2.0

デフォルト値: なし

Storage オブジェクト管理者（roles/storage.objectAdmin）ロールを持つ Google サービス アカウント キーファイルのコンテンツを格納する既存の Kubernetes Secret の名前。この Google サービス アカウントは、指定された cassandra.restore.dbStorageBucket からバックアップ アーカイブをダウンロードするために使用されます。

復元が有効で、cassandra.restore.cloudProvider が GCP に設定されている場合、Apigee ハイブリッドが Google Cloud Storage バケットにアクセスして復元用のバックアップ アーカイブをダウンロードできるようにするには、次のいずれかが必要です。
cassandra.restore.snapshotTimestamp 高度 導入バージョン: 1.0.0

デフォルト値: なし

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

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

デフォルト値: 10Gi

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

ディスクサイズをメビバイト（MiB）単位またはギビバイト（GiB）単位で指定します。
cassandra.storage.storageclass 基本 導入バージョン: 1.0.0

デフォルト値: なし

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

デフォルト値: 10Gi

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

ディスクサイズをメビバイト（MiB）単位またはギビバイト（GiB）単位で指定します。
cassandra.terminationGracePeriodSeconds 高度 導入バージョン: 1.0.0

デフォルト値: 300

Pod の削除リクエストから実際に Pod が強制終了されるまでの最長時間（秒単位）。この期間中に preStop フックが実行され、動作中のすべてのプロセスが正常に終了します。Pod は、実行中のすべてのプロセスが終了した時点か、猶予期間が終了した時点のどちらか早い方に強制終了されます。実行中のプロセスがない場合、Pod はすぐに強制終了されます。
cassandra.tolerations.effect 高度 導入バージョン: 1.10.1

デフォルト値: なし

Kubernetes の taint と toleration 機能を使用するために必要です。

effect は、taint と一致する toleration の効果を指定します。effect の値は次のいずれかです。

  • NoExecute
  • NoSchedule
  • PreferNoSchedule

詳細については、taint と toleration: コンセプトをご覧ください。
cassandra.tolerations.key 高度 導入バージョン: 1.10.1

デフォルト値: なし

Kubernetes の taint と toleration 機能を使用するために必要です。

key は、toleration を適用できる Pod を識別します。

詳細については、taint と toleration: コンセプトをご覧ください。
cassandra.tolerations.operator 高度 導入バージョン: 1.10.1

デフォルト値: "Equal"

Kubernetes の taint と toleration 機能を使用するために必要です。

operator には、effect をトリガーするオペレーションを指定します。operator の値は次のいずれかです。

  • Equal は、value に設定された値と一致します。
  • Exists は、value に設定された値を無視します。

詳細については、taint と toleration: コンセプトをご覧ください。
cassandra.tolerations.tolerationSeconds 高度 導入バージョン: 1.10.1

デフォルト値: なし

Kubernetes の taint と toleration 機能で使用します。

tolerationSeconds は、障害が発生しているノードまたは応答していないノードに Pod がバインドされている時間を秒単位で定義します。

詳細については、taint と toleration: コンセプトをご覧ください。
cassandra.tolerations.value 高度 導入バージョン: 1.10.1

デフォルト値: なし

Kubernetes の taint と toleration 機能で使用します。

value は、operator が Equal に設定されている場合に effect をトリガーする値です。

詳細については、taint と toleration: コンセプトをご覧ください。

certManager

Apigee は証明書の検証に cert-manager を使用します。

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

プロパティ 型 説明
certManager.namespace 高度 導入バージョン: 1.9.0

デフォルト値: cert-manager

cert-manager の名前空間。

カスタム 名前空間での cert-manager の実行をご覧ください。

connectAgent

Apigee Connect を使用すると、インターネット上で MART エンドポイントを公開しなくても、Apigee Hybrid 管理プレーンをランタイム プレーンの MART サービスに安全に接続できます。

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

プロパティ 型 説明
connectAgent.annotations 高度 導入バージョン: 1.5.0

デフォルト値: なし

（省略可）Pod にアノテーションを付けるために使用する Key-Value マップ。詳しくは、カスタム アノテーションをご覧ください。
connectAgent.gsa 高度 導入バージョン: 1.10.0

デフォルト値: なし

Helm のみ: Helm チャートを使用して GKE クラスタで Workload Identity を有効にするときに、対応する Kubernetes サービス アカウントに関連付ける connectAgent の Google IAM サービス アカウント（GSA）のメールアドレス。このプロパティは、gcp.workloadIdentity.enabled を true に設定した場合に設定します。

通常、GSA のメールアドレスの形式は次のとおりです。

GSA_NAME@PROJECT_ID.iam.gserviceaccount.com

例:

apigee-mart@my-hybrid-project.iam.gserviceaccount.com

GKE で Workload Identity を有効にするまたは AKS と EKS で Workload Identity 連携を有効にするをご覧ください。
connectAgent.logLevel 高度 導入バージョン: 1.2.0

デフォルト値: INFO

ログレポートのレベル。次の値が表示されます。

  • INFO: 警告 / エラー / 致命的メッセージに加え、情報メッセージが含められます。デバッグで最も役立ちます。
  • WARNING: エラー / 致命的メッセージに加え、非致命的な警告が含められます。
  • ERROR: 致命的メッセージに加え、内部エラーと、ユーザーに返されなかったエラーが含められます。
  • FATAL: 回復不可能なエラーと、Apigee Connect のクラッシュの原因となったイベントが含められます。
connectAgent.image.pullPolicy 高度 導入バージョン: 1.2.0

デフォルト値: IfNotPresent

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

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

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

デフォルト値: 1.15.0

このサービスの Docker イメージのバージョン ラベル。
connectAgent.image.url 高度 導入バージョン: 1.2.0

デフォルト値: なし

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

apigee-pull-push --list を使用して、このコンポーネントの現在のリポジトリ URL を確認できます。
connectAgent.replicaCountMax 基本 導入バージョン: 1.2.0

デフォルト値: 5

自動スケーリングに使用できるレプリカの最大数。
connectAgent.replicaCountMin 基本 導入バージョン: 1.2.0

デフォルト値: 1

自動スケーリングに使用できるレプリカの最小数。

本番環境では、replicaCountMin を 1 に増やしてコントロール プレーンへの接続数を増やし、信頼性とスケーラビリティを高めることができます。
connectAgent.resources.limits.cpu 高度 導入バージョン: 1.11.0

デフォルト値: 512m

Kubernetes コンテナ内のリソースの CPU 上限（ミリコア単位）。
connectAgent.resources.limits.memory 高度 導入バージョン: 1.11.0

デフォルト値: 512Mi

Kubernetes コンテナ内のリソースのメモリ上限（MiB 単位）。
connectAgent.resources.requests.cpu 高度 導入バージョン: 1.11.0

デフォルト値: 100m

Kubernetes コンテナ内のリソースの通常オペレーションに必要な CPU（ミリコア単位）。
connectAgent.resources.requests.memory 高度 導入バージョン: 1.2.0

デフォルト値: 30Mi

Kubernetes コンテナ内のリソースの通常のオペレーションに必要なメモリ（メビバイト単位）。
connectAgent.server 高度 導入バージョン: 1.2.0

デフォルト値: apigeeconnect.googleapis.com:443

このサービスのサーバーとポートの場所。
connectAgent.serviceAccountPath 基本 導入バージョン: 1.1.1

デフォルト値: なし

serviceAccountPath または serviceAccountRef のいずれか一方を指定する必要があります。

apigee-mart サービス アカウント用の Google サービス アカウント キーファイルのパスです。

ほとんどのインストールでは、connectAgent.serviceAccountPath の値は mart.serviceAccountPath の値と一致する必要があります。
connectAgent.serviceAccountRef 基本 導入バージョン: 1.2.0

デフォルト値: なし

serviceAccountPath または serviceAccountRef のいずれか一方を指定する必要があります。

ほとんどのインストールでは、connectAgent.serviceAccountRef の値は mart.serviceAccountRef の値と一致する必要があります。
connectAgent.targetCPUUtilizationPercentage 高度 導入バージョン: 1.2.0

デフォルト値: 75

Pod 上の Apigee Connect エージェントの CPU 使用率の目標値。CPU 使用率がこのフィールドの値に達すると、Apigee Connect が（replicaCountMax で指定された上限まで）自動スケーリングします。
connectAgent.terminationGracePeriodSeconds 高度 導入バージョン: 1.2.0

デフォルト値: 600

Pod の削除リクエストから実際に Pod が強制終了されるまでの最長時間（秒単位）。この期間中に preStop フックが実行され、動作中のすべてのプロセスが正常に終了します。Pod は、実行中のすべてのプロセスが終了した時点か、猶予期間が終了した時点のどちらか早い方に強制終了されます。実行中のプロセスがない場合、Pod はすぐに強制終了されます。
connectAgent.tolerations.effect 高度 導入バージョン: 1.10.1

デフォルト値: なし

Kubernetes の taint と toleration 機能を使用するために必要です。

effect は、taint と一致する toleration の効果を指定します。effect の値は次のいずれかです。

  • NoExecute
  • NoSchedule
  • PreferNoSchedule

詳細については、taint と toleration: コンセプトをご覧ください。
connectAgent.tolerations.key 高度 導入バージョン: 1.10.1

デフォルト値: なし

Kubernetes の taint と toleration 機能を使用するために必要です。

key は、toleration を適用できる Pod を識別します。

詳細については、taint と toleration: コンセプトをご覧ください。
connectAgent.tolerations.operator 高度 導入バージョン: 1.10.1

デフォルト値: "Equal"

Kubernetes の taint と toleration 機能を使用するために必要です。

operator には、effect をトリガーするオペレーションを指定します。operator の値は次のいずれかです。

  • Equal は、value に設定された値と一致します。
  • Exists は、value に設定された値を無視します。

詳細については、taint と toleration: コンセプトをご覧ください。
connectAgent.tolerations.tolerationSeconds 高度 導入バージョン: 1.10.1

デフォルト値: なし

Kubernetes の taint と toleration 機能で使用します。

tolerationSeconds は、障害が発生しているノードまたは応答していないノードに Pod がバインドされている時間を秒単位で定義します。

詳細については、taint と toleration: コンセプトをご覧ください。
connectAgent.tolerations.value 高度 導入バージョン: 1.10.1

デフォルト値: なし

Kubernetes の taint と toleration 機能で使用します。

value は、operator が Equal に設定されている場合に effect をトリガーする値です。

詳細については、taint と toleration: コンセプトをご覧ください。

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）のデフォルトのキャッシュ暗号鍵。

diagnostic

診断コレクタツールの設定。

診断コレクタの使用をご覧ください。

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

プロパティ 型 説明
diagnostic.bucket 基本 導入バージョン: 1.6.0

デフォルト値: なし

必須

診断データが付与される Google Cloud Storage バケットの名前。

ストレージ バケットの作成をご覧ください。
diagnostic.container 基本 導入バージョン: 1.6.0

デフォルト値: なし

必須

データをキャプチャする Pod のタイプを指定します。値は次のいずれかです。

  • "apigee-cassandra" の場合は、Cassandra データベースに関するデータがキャプチャされます。istio-cassandra Pod は apigee 名前空間で実行されます。
  • "apigee-mart-server" の場合は、MART に関するデータがキャプチャされます。apigee-mart-server Pod は apigee 名前空間で実行されます。
  • "apigee-runtime" の場合は、Message Processor に関するデータがキャプチャされます。apigee-runtime Pod は apigee 名前空間で実行されます。
  • "apigee-synchronizer" の場合は、Synchronizer に関するデータがキャプチャされます。apigee-synchronizer Pod は apigee 名前空間で実行されます。
  • "apigee-udca" の場合は、UDCA に関するデータがキャプチャされます。apigee-udca Pod は apigee 名前空間で実行されます。
  • "apigee-watcher" の場合は、Watcher に関するデータがキャプチャされます。apigee-watcher Pod は apigee 名前空間で実行されます。
  • "istio-proxy" の場合は、Istio Ingress ゲートウェイに関するデータがキャプチャされます。istio-proxy Pod は istio-system 名前空間で実行されます。
diagnostic.loggingDetails.logDuration 基本 導入バージョン: 1.6.0

デフォルト値: なし

診断コレクション オペレーションが「LOGGING」（operation: "LOGGING" で設定）の場合は必須

収集するログデータの期間（ミリ秒）。一般的な値は 30000 です。

diagnostic.operation を参照してください。
diagnostic.loggingDetails.loggerNames[] 基本 導入バージョン: 1.6.0

デフォルト値: なし

診断コレクション オペレーションが「LOGGING」（operation: "LOGGING" で設定）の場合は必須

データの収集元であるロガーの名前を指定します。Apigee ハイブリッド バージョン 1.6.0 でサポートされている値は ALL（すべてのロガー）のみです。次に例を示します。

diagnostic:
 loggingDetails:
   loggerNames:
   - ALL
diagnostic.loggingDetails.logLevel 基本 導入バージョン: 1.6.0

デフォルト値: なし

診断コレクション オペレーションが「LOGGING」（operation: "LOGGING" で設定）の場合は必須

収集するロギングデータの粒度を指定します。Apigee ハイブリッド 1.6 では、FINE のみがサポートされています。
diagnostic.namespace 基本 導入バージョン: 1.6.0

デフォルト値: なし

必須

データを収集する Pod が存在している Kubernetes Namespace。diagnostic.container で指定したコンテナ用の正しい Namespace を指定する必要があります。

以下の場合は apigee

  • apigee-runtime
  • apigee-synchronizer
  • apigee-udca
  • apigee-watcher
  • apigee-cassandra
  • apigee-mart-server

以下の場合は istio-system

  • istio-proxy
diagnostic.operation 基本 導入バージョン: 1.6.0

デフォルト値: なし

必須

すべての統計情報を収集するか、ログのみを収集するかを指定します。

以下のいずれかの値を設定します。
diagnostic.podNames[] 基本 導入バージョン: 1.6.0

デフォルト値: なし

必須

データを収集する Kubernetes Pod の名前。次に例を示します。

diagnostic:
 podNames:
 - apigee-runtime-eng-hybrid-example-3b2ebf3-150-8vfoj-2wcjn
 - apigee-runtime-eng-hybrid-example-3b2ebf3-150-8vfoj-6xzn2
diagnostic.serviceAccountPath 基本 導入バージョン: 1.6.0

デフォルト値: なし

必須

ストレージ管理者のロール（roles/storage.admin）を持つサービス アカウント（ほとんどの Apigee ハイブリッド インストールでは apigee-cassandra）のキーファイル（.json）へのパス。

サービス アカウントについてをご覧ください。
diagnostic.tcpDumpDetails.maxMsgs 基本 導入バージョン: 1.6.0

デフォルト値: なし

diagnostic.tcpDumpDetails を使用している場合、diagnostic.tcpDumpDetails.maxMsgs または diagnostic.tcpDumpDetails.timeoutInSeconds が必須です。

収集する tcpDump メッセージの最大数を設定します。この最大値は 1000 以下にすることをおすすめします。
diagnostic.tcpDumpDetails.timeoutInSeconds 基本 導入バージョン: 1.6.0

デフォルト値: なし

diagnostic.tcpDumpDetails を使用している場合、diagnostic.tcpDumpDetails.maxMsgs または diagnostic.tcpDumpDetails.timeoutInSeconds が必須です。

tcpDump がメッセージを返すのを待機する時間を秒単位で設定します。
diagnostic.threadDumpDetails.delayInSeconds 基本 導入バージョン: 1.6.0

デフォルト値: なし

diagnostic.threadDumpDetails を使用している場合は、diagnostic.threadDumpDetails.delayInSeconds と diagnostic.threadDumpDetails.iterations の両方が必須です。

各スレッドダンプを収集する間の遅延（秒）。
diagnostic.threadDumpDetails.iterations 基本 導入バージョン: 1.6.0

デフォルト値: なし

diagnostic.threadDumpDetails を使用している場合は、diagnostic.threadDumpDetails.delayInSeconds と diagnostic.threadDumpDetails.iterations の両方が必須です。

収集する jstack スレッドダンプの反復回数。

envs

API プロキシをデプロイできる環境の配列を定義します。各環境は、API プロキシを稼働させるための分離コンテキストまたは「サンドボックス」として使用できます。

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

詳しくは、環境についてをご覧ください。

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

プロパティ 型 説明
envs[].cacheEncryptionKey 基本 導入バージョン: 1.0.0

デフォルト値: なし

cacheEncryptionKey、cacheEncryptionPath、cacheEncryptionSecret は、いずれか 1 つのみが必要です。

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

デフォルト値: なし

cacheEncryptionKey、cacheEncryptionPath、cacheEncryptionSecret は、いずれか 1 つのみが必要です。

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

デフォルト値: なし

cacheEncryptionKey、cacheEncryptionPath、cacheEncryptionSecret は、いずれか 1 つのみが必要です。

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

デフォルト値: なし

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

Base64 でエンコードされた暗号鍵を含む Kubernetes Secret の名前。データの暗号化をご覧ください。
envs[].components.runtime.replicaCountMax 基本 導入バージョン: 1.9.3

デフォルト値: 4

自動スケーリング用のレプリカの最大数。指定されている場合、runtime.replicaCountMax をオーバーライドします。
envs[].components.runtime.replicaCountMin 基本 導入バージョン: 1.9.3

デフォルト値: 1

自動スケーリング用のレプリカの最小数。指定されている場合、runtime.replicaCountMin をオーバーライドします。
envs[].components.runtime.resources.limits.memory 高度 導入バージョン: 1.15.0

デフォルト値: なし

Kubernetes コンテナ内のリソースのメモリ上限（メビバイト（MiB）またはギビバイト（GiB）単位）。
envs[].components.runtime.resources.requests.memory 高度 導入バージョン: 1.15.0

デフォルト値: なし

Kubernetes コンテナ内のリソースの通常オペレーションに必要なメモリ。単位はメビバイト（Mi）またはギビバイト（Gi）です。
envs[].components.synchronizer.replicaCountMax 基本 導入バージョン: 1.9.3

デフォルト値: 4

自動スケーリング用のレプリカの最大数。指定されている場合、synchronizer.replicaCountMax をオーバーライドします。
envs[].components.synchronizer.replicaCountMin 基本 導入バージョン: 1.9.3

デフォルト値: 1

自動スケーリング用のレプリカの最小数。指定されている場合、synchronizer.replicaCountMin をオーバーライドします。
envs[].components.udca.replicaCountMax 基本 導入バージョン: 1.9.3

デフォルト値: 4

自動スケーリング用のレプリカの最大数。指定されている場合、udca.replicaCountMax をオーバーライドします。
envs[].components.udca.replicaCountMin 基本 導入バージョン: 1.9.3

デフォルト値: 1

自動スケーリング用のレプリカの最小数。指定されている場合、udca.replicaCountMin をオーバーライドします。
envs.gsa.runtime 高度 導入バージョン: 1.10.0

デフォルト値: なし

Helm のみ: Helm チャートを使用して GKE クラスタで Workload Identity を有効にするときに、対応する Kubernetes サービス アカウントに関連付けるランタイム Google IAM サービス アカウントのメールアドレス。

GKE で Workload Identity を有効にするまたは AKS と EKS で Workload Identity 連携を有効にするをご覧ください。
envs.gsa.synchronizer 高度 導入バージョン: 1.10.0

デフォルト値: なし

Helm のみ: Helm チャートを使用して GKE クラスタで Workload Identity を有効にするときに、対応する Kubernetes サービス アカウントに関連付ける Synchronizer Google IAM サービス アカウントのメールアドレス。

GKE で Workload Identity を有効にするまたは AKS と EKS で Workload Identity 連携を有効にするをご覧ください。
envs.gsa.udca 高度 導入バージョン: 1.10.0

デフォルト値: なし

Helm のみ: Helm チャートを使用して GKE クラスタで Workload Identity を有効にするときに、対応する Kubernetes サービス アカウントに関連付ける env-scoped udca の udca Google IAM サービス アカウントのメールアドレス。

GKE で Workload Identity を有効にするまたは AKS と EKS で Workload Identity 連携を有効にするをご覧ください。
envs[].hostAliases[] 基本 導入バージョン: 1.2.0

デフォルト値: なし

Deprecated: ハイブリッド バージョン 1.4 以降では、ランタイム プレーンは管理プレーンからこの情報を受け取ります。環境と環境グループについてをご覧ください。
envs[].httpProxy.host 基本 導入バージョン: 1.2.0

デフォルト値: なし

HTTP プロキシが実行されているホスト名または IP アドレスを指定します。

httpProxy プロパティは、scheme、host、port の順に指定します。次に例を示します。

envs:
  - name: test
    httpProxy:
      scheme: HTTP
      host: 10.12.0.47
      port: 3128
      ...

API プロキシのフォワード プロキシを構成するもご覧ください。
envs[].httpProxy.port 基本 導入バージョン: 1.2.0

デフォルト値: なし

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

デフォルト値: HTTPS

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

デフォルト値: なし

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

デフォルト値: なし

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

デフォルト値: なし

必須

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

デフォルト値: なし

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

デフォルト値: なし

HTTPS トラフィックの TCP ポート番号。
envs[].serviceAccountPaths.runtime 基本 導入バージョン: 1.4.0

デフォルト値: なし

ローカル システム上での、Cloud Trace エージェントのロールを持つ Google サービス アカウント（通常は apigee-runtime）のキーファイルへのパス。サービス アカウントのデフォルト名と割り当てられているロールについては、サービス アカウントについてをご覧ください。
envs[].serviceAccountPaths.synchronizer 基本 導入バージョン: 1.0.

デフォルト値: なし

ローカル システム上での、Apigee Synchronizer 管理者のロールを持つ Google サービス アカウントのキーファイルへのパス。
envs[].serviceAccountPaths.udca 基本 導入バージョン: 1.0.

デフォルト値: なし

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

このプロパティは、orgScopedUDCA が false に設定されている場合にのみ設定します。
envs[].serviceAccountSecretProviderClass 高度 導入バージョン: 1.12.0

デフォルト値: なし

サービス アカウント キーを Vault に保存するために使用される環境固有のシークレット プロバイダ クラス（SecretProviderClass）の名前。

Hashicorp Vault へのサービス アカウント キーの保存をご覧ください。
envs[].serviceAccountSecretRefs.runtime 基本 導入バージョン: 1.4.0

デフォルト値: なし

Kubernetes Secret の名前。Cloud Trace エージェント ロールを持つ Google サービス アカウント キーを入力として使用し、Secret を作成する必要があります。
envs[].serviceAccountSecretRefs.synchronizer 基本 導入バージョン: 1.2.0

デフォルト値: なし

Kubernetes Secret の名前。Apigee Synchronizer 管理者ロールを持つ Google サービス アカウント キーを入力として使用し、Secret を作成する必要があります。
envs[].serviceAccountSecretRefs.udca 基本 導入バージョン: 1.2.0

デフォルト値: なし

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

このプロパティは、orgScopedUDCA が false に設定されている場合にのみ設定します。
envs[].sslCertPath 基本 導入バージョン: 1.2.0

デフォルト値: なし

sslCertPath と sslKeyPath を設定するか、sslSecret を設定する必要があります。

システム上の TLS 証明書ファイルへのパス。
envs[].sslKeyPath 基本 導入バージョン: 1.2.0

デフォルト値: なし

sslCertPath と sslKeyPath を設定するか、sslSecret を設定する必要があります。

システム上の TLS 秘密鍵ファイルへのパス。
envs[].sslSecret 基本 導入バージョン: 1.2.0

デフォルト値: なし

sslCertPath/sslKeyPath または sslSecret が必要です。

Cassandra のユーザーとパスワードを含む、Kubernetes Secret に格納されているファイルの名前。Secret を作成するには、Secret を作成するの手順に沿って操作します。

関連項目:

gcp

Google Cloud プロジェクト ID（すべてのハイブリッド インストールに必要）、Workload Identity と連携ワークロード ID の構成、apigee-logger と apigee-metrics がデータを push するリージョンを指定します。

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

プロパティ 型 説明
gcp.federatedWorkloadIdentity.audience 基本 導入バージョン: 1.12.0

デフォルト値: なし

GKE 以外のプラットフォームでの、Workload Identity プロバイダの許可されたオーディエンス。

AKS と EKS で Workload Identity 連携を有効にするをご覧ください。
gcp.federatedWorkloadIdentity.credentialSourceFile 基本 導入バージョン: 1.12.0

デフォルト値: なし

Workload Identity 連携でサービス アカウントの認証情報を取得するために使用される認証情報ソースファイルのファイル名とパス。これは、create-cred-config コマンドで Workload Identity 連携を構成するときに credential-source-file に指定する値です。

AKS と EKS で Workload Identity 連携を有効にするをご覧ください。
gcp.federatedWorkloadIdentity.enabled 基本 導入バージョン: 1.12.0

デフォルト値: false

GKE 以外のプラットフォームで Workload Identity 連携を有効にします。同じクラスタで gcp.workloadIdentity.enabled が true に設定されている場合は、true に設定しないでください。

AKS と EKS で Workload Identity 連携を有効にするをご覧ください。
gcp.federatedWorkloadIdentity.tokenExpiration 基本 導入バージョン: 1.12.0

デフォルト値: 3600

トークンの存続期間（秒単位）。

AKS と EKS で Workload Identity 連携を有効にするをご覧ください。
gcp.projectID 基本 導入バージョン: 1.2.0

デフォルト値: なし

必須

apigee-logger と apigee-metrics がデータを push する Google Cloud プロジェクトを識別します。
gcp.projectIDRuntime 基本 導入バージョン: 1.2.0

デフォルト値: なし

ランタイム Kubernetes クラスタ プロジェクトを特定します。

projectIDRuntime プロパティは省略できます。使用しない場合、Apigee 組織の Google Cloud プロジェクトとランタイム K8s クラスタのプロジェクトの両方で projectID 値が使用されることが想定されます。
gcp.region 基本 導入バージョン: 1.2.0

デフォルト値: us-central1

必須

apigee-logger と apigee-metrics がデータを push する Google Cloud リージョンを識別します。
gcp.workloadIdentity.enabled 基本 導入バージョン: 1.10.0

デフォルト値: false

Helm のみ: GKE で Workload Identity の使用を有効にします。Workload Identity を使用すると、GKE クラスタ内のワークロードが Identity and Access Management（IAM）サービス アカウントの権限を借用して Google Cloud サービスにアクセスできます。

同じクラスタで gcp.federatedWorkloadIdentity.enabled が true に設定されている場合は、true に設定しないでください。

enabled が false（デフォルト）の場合、Apigee は各 Apigee ハイブリッド コンポーネントで IAM サービス アカウントを使用します。サービス アカウントについてをご覧ください。

workloadIdentityEnabled が true の場合、Apigee は Kubernetes サービス アカウントを使用し、コンポーネントごとに適切な IAM サービス アカウントに Kubernetes サービス アカウントをマッピングします。以下のプロパティを使用して、Kubernetes サービス アカウントにマッピングする IAM サービス アカウントを指定します。
gcp.workloadIdentity.gsa 高度 導入バージョン: 1.10.0

デフォルト値: なし

Helm のみ: Helm チャートを使用して GKE クラスタで Workload Identity を有効にするときに、対応する Kubernetes サービス アカウントに関連付けるすべてのコンポーネントの Google IAM サービス アカウント（GSA）のメールアドレス。このプロパティは、gcp.workloadIdentity.enabled を true に設定した場合に設定します。

gcp.workloadIdentity.gsa は、すべてのハイブリッド コンポーネントに適用されます。gcp.workloadIdentity.gsa の値を指定する場合、個々のハイブリッド コンポーネントに GSA を指定する必要はありません。個々のコンポーネントに GSA を指定した場合、そのコンポーネントの GSA は、そのコンポーネントの gcp.workloadIdentity.gsa のみをオーバーライドします。

通常、GSA のメールアドレスの形式は次のとおりです。

GSA_NAME@PROJECT_ID.iam.gserviceaccount.com

例:

apigee-non-prod@my-hybrid-project.iam.gserviceaccount.com

Enabling Workload Identity on GKE をご覧ください。
gcp.workloadIdentityEnabled 基本 導入バージョン: 1.4.0

デフォルト値: false

apigeectl のみ: Workload Identity の使用を有効にします。Workload Identity を使用すると、GKE クラスタ内のワークロードが Identity and Access Management（IAM）サービス アカウントの権限を借用して Google Cloud サービスにアクセスできます。

workloadIdentityEnabled が false（デフォルト）の場合、Apigee は各 Apigee ハイブリッド コンポーネントで IAM サービス アカウントを使用します。サービス アカウントについてをご覧ください。

workloadIdentityEnabled が true の場合、Apigee は IAM サービス アカウントではなく Kubernetes サービス アカウントを使用します。次の構成プロパティは無視されます。

httpProxy

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

をご覧ください。

connectAgent、logger、mart、metrics、