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

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

構成プロパティについて

必要に応じて、さまざまな構成プロパティをオーバーライドできます。その場合は、オーバーライドするプロパティを HYBRID_ROOT_DIR/overrides.yaml に追加します。

たとえば、MART サービスのレプリカの最小数と最大数を変更するには、次のスタンザを overrides.yaml に追加します。

mart:
    replicaCountMin: 3
    replicaCountMax: 6

これらの構成プロパティとそのデフォルト設定は HYBRID_ROOT_INSTALL/1.0.0/values.yaml でも確認できます。

詳細については、Manage runtime plane components をご覧ください。

また、 Google Cloud の外部でデプロイを構成する場合は、これらのプロパティの設定について、ステップ 6: オーバーライドを作成するをご覧ください。

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

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

^{filter_list_alt} このページ上の

の構成プロパティを表示します。

最上位プロパティ

次の表に、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` に設定します。注: この機能は、2024 サブスクリプションプランの一部としてご利用いただけます。詳しくは、以下を参照してください。 API プロキシの上限。環境ごとのプロキシ上限の強化。サブスクリプションの利用資格 `enhanceProxyLimits: true` の設定は、プロキシチェーン、エンドポイントチェーン、ServiceCallout チェーンに必要です。詳細については、以下をご覧ください。 API プロキシのチェーン接続 ServiceCallout ポリシーアラート: `true` に設定した後、この値を `false` に設定しないでください。環境グループごとに `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.14.2 imagePullPolicy: IfNotPresent 注: Apigee ハイブリッドバージョン 1.14.2 より前は、サードパーティコンポーネントにはサードパーティベンダーのイメージのバージョンに対して固有な点がありました。次に例を示します。 ## an example of internal component vs 3rd party containers: - name: apigee-udca image: private-docker-host.example.com/apigee-udca:1.14.2 imagePullPolicy: IfNotPresent containers: - name: apigee-ingressgateway image: private-docker-host.example.com/apigee-asm-ingress:1.22.6-asm.2-distroless imagePullPolicy: IfNotPresent 他のコンポーネントも同様のパターンに従います。すべてのコンポーネントの現在のリポジトリ URL を表示するには、`apigee-pull-push --list` を使用します。 Apigee ハイブリッドで限定公開イメージリポジトリを使用するをご覧ください。以下のプロパティを使用して、コンポーネントのイメージ URL を個別にオーバーライドできます。 `ao.image.url` `apigeeIngressGateway.image.url` `cassandra.image.url` `cassandra.auth.image.url` `cassandra.backup.image.url` `cassandra.restore.image.url` `connectAgent.image.url` `ingressGateways[].image.url` `istiod.image.url` `kubeRBACProxy.image.url` `logger.image.url` `mart.image.url` `metrics.adapter.image.url` `metrics.prometheus.image.url` `metrics.sdSidecar.image.url` `mintTaskScheduler.image.url` `redis.image.url` `redis.envoy.image.url` `runtime.image.url` `synchronizer.image.url` `udca.image.url` `udca.fluentd.image.url` `watcher.image.url`
`imagePullSecrets.name`	高度	導入バージョン: 1.0.0 デフォルト値: なし Docker レジストリタイプとして構成された Kubernetes Secret 名。非公開リポジトリからイメージを pull するために使用されます。
`instanceID`	基本	導入バージョン: 1.3.0 デフォルト値: なし必須このインストールの固有識別子。このインスタンスを識別する一意の文字列。任意の文字と数字の組み合わせで、長さは 63 文字以下にする必要があります。同じクラスタ内に複数の組織を作成できますが、`instanceID` は同じ Kubernetes クラスタ内のすべての組織で同じにする必要があります。マルチリージョンインストールの場合、各リージョンに独自のクラスタが必要です（個々のクラスタはリージョンにまたがりません）。
`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 のうち、いずれか 1 つのみを使用してください。 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 デフォルト値: `"1142"`（ピリオドなしの 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` プロパティを変更して適用すると、すべてのコンポーネントに対してローリングアップデートが行われます。次のオブジェクトのプロパティを変更するには、`revision` を更新する必要があります。 nodeSelector envs imagePullSecrets gcpProjectID k8sClusterName contractProvider org 詳細については、ローリングアップデートをご覧ください。
`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.14.2` このサービスの Docker イメージのバージョンラベル。
`ao.image.url`	高度	導入バージョン: 1.2.0 デフォルト値: なしこのサービスの Docker イメージの場所。 `apigee-pull-push --list` を使用して、このコンポーネントの現在のリポジトリ URL を確認できます。ヒント: コンポーネントごとに個別に構成するのではなく、`hub` を使用してすべてのコンポーネントの非公開リポジトリ 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.14.2` このサービスの Docker イメージのバージョンラベル。
`apigeeIngressGateway.image.url`	高度	導入バージョン: 1.11.0 デフォルト値: なしこのサービスの Docker イメージの場所。 `apigee-pull-push --list` を使用して、このコンポーネントの現在のリポジトリ URL を確認できます。ヒント: コンポーネントごとに個別に構成するのではなく、`hub` を使用してすべてのコンポーネントの非公開リポジトリ 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.14.2` このサービスの Docker イメージのバージョンラベル。
`cassandra.auth.image.url`	高度	導入バージョン: 1.0.0 デフォルト値: なしこのサービスの Docker イメージの場所。 `apigee-pull-push --list` を使用して、このコンポーネントの現在のリポジトリ URL を確認できます。ヒント: コンポーネントごとに個別に構成するのではなく、`hub` を使用してすべてのコンポーネントの非公開リポジトリ 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 を作成するの手順を行います。関連項目: Kubernetes Secret へのデータの保存 Kubernetes ドキュメントの Secret Kubernetes ドキュメントの kubectl を使用した Secret の作成
`cassandra.auth.secretProviderClass`	高度	導入バージョン: 1.10.3 デフォルト値: なし Cassandra シークレットストレージポリシー。設定する場合は、Hashicorp Vault などの外部シークレットプロバイダを参照する SecretProviderClass と一致する必要があります。未設定の場合、Apigee ハイブリッドでは以下に保存されているユーザー名とパスワードのいずれかが使用されます。 `cassandra.auth.admin.password` `cassandra.auth.ddl.password` `cassandra.auth.default.password` `cassandra.auth.dml.password` `cassandra.auth.jmx.password` `cassandra.auth.jmx.username` `cassandra.auth.jolokia.password` `cassandra.auth.jolokia.username` または、以下に保存されている Kubernetes のシークレット。 `cassandra.auth.secret` ポリシーを作成する手順については、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 バケットの名前。バケットを作成する必要がある場合は、バケットの作成をご覧ください。注: Hybrid バージョン 1.13 以降では、バケット名に `gs://` を接頭辞として付ける必要はありません。この接頭辞のサポートは非推奨となりました。今後のリリースで削除される予定です。
`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 ヒント: サービスアカウントのメールアドレスは、次のコマンドで確認できます。 gcloud iam service-accounts list --project ${PROJECT_ID} --filter "apigee" 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.14.2` このサービスの Docker イメージのバージョンラベル。
`cassandra.backup.image.url`	高度	導入バージョン: 1.0.0 デフォルト値: なしこのサービスの Docker イメージの場所。 `apigee-pull-push --list` を使用して、このコンポーネントの現在のリポジトリ URL を確認できます。ヒント: コンポーネントごとに個別に構成するのではなく、`hub` を使用してすべてのコンポーネントの非公開リポジトリ 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.serviceAccountPath`。指定済みの `cassandra.backup.serviceAccountRef`。構成済みの GKE で Apigee ハイブリッド用の Workload Identity。構成済みの AKS または EKS で Apigee Hybrid の Workload Identity 連携。
`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.serviceAccountPath`。指定済みの `cassandra.backup.serviceAccountRef`。構成済みの GKE で Apigee ハイブリッド用の Workload Identity。構成済みの AKS または EKS で Apigee Hybrid の Workload Identity 連携。
`cassandra.backup.storageDirectory`	高度	導入バージョン: 1.3.0 デフォルト値: なしバックアップが有効で、`cassandra.backup.cloudProvider` が `HYBRID` に設定されている場合は必須。 `apigee` ユーザーのホームディレクトリへの絶対パスまたは相対パス。バックアップ SSH サーバー上のバックアップディレクトリの名前。
`cassandra.clusterName`	基本	導入バージョン: 1.0.0 デフォルト値: `apigeecluster` Cassandra クラスタの名前を指定します。注: マルチリージョンインストールでは、`clusterName` の値がすべてのリージョンで一致している必要があります。
`cassandra.datacenter`	基本	導入バージョン: 1.0.0 デフォルト値: `dc-1` Cassandra ノードのデータセンターを指定します。
`cassandra.dnsPolicy`	基本	導入バージョン: 1.1.1 デフォルト値: なし注: Apigee ハイブリッド v1.3 では、このプロパティはサポートされなくなりました。 `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.14.2` このサービスの Docker イメージのバージョンラベル。
`cassandra.image.url`	高度	導入バージョン: 1.0.0 デフォルト値: なしこのサービスの Docker イメージの場所。 `apigee-pull-push --list` を使用して、このコンポーネントの現在のリポジトリ URL を確認できます。ヒント: コンポーネントごとに個別に構成するのではなく、`hub` を使用してすべてのコンポーネントの非公開リポジトリ 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 ノードの数を指定します。注: デフォルト値の `1` は、デモまたはテストインストールでのみ使用できます。本番環境のインストールでは、`replicaCount` の値は `3` の倍数にする必要があります。必要な `replicaCount` 値を決定するには、次の点を考慮してください。プロキシのトラフィック需要を見積もります。負荷テストを行い、CPU 使用率を合理的な範囲で予測する。リージョンごとに異なる `replicaCount` 値を指定できる。後でオーバーライドファイルで `replicaCount` を拡張できます。
`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 バケットの名前。注: Hybrid バージョン 1.13 以降では、バケット名に `gs://` を接頭辞として付ける必要はありません。この接頭辞のサポートは非推奨となりました。今後のリリースで削除される予定です。
`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 ヒント: サービスアカウントのメールアドレスは、次のコマンドで確認できます。 gcloud iam service-accounts list --project ${PROJECT_ID} --filter "apigee"