このセクションでは、Apigee ハイブリッド デプロイのランタイム プレーンをカスタマイズする際に使用できるすべての構成プロパティを示します。
最上位プロパティ
次の表に、overrides.yaml
ファイルの最上位プロパティを示します。このようなプロパティは他のオブジェクトに属しておらず、組織レベルまたは環境レベルで適用されます。
プロパティ | 説明 |
---|---|
axHashSalt |
導入バージョン: 1.3.0 デフォルト値: 組織名 省略可 Apigee Analytics に送信される難読化されたユーザーデータの暗号化に使用するハッシュ化ソルト値が含まれる Kubernetes Secret の名前。ソルト値を指定しない場合、組織名がデフォルトで使用されます。ソルト値を入力として使用して Secret を作成します。複数のクラスタ間で同じソルトを使用すると、クラスタ間で一貫したハッシュ結果を得ることができます。 |
contractProvider |
導入バージョン: 1.0.0
デフォルト値: インストール内のすべての API の API パスを定義します。 |
gcpProjectID |
Deprecated: v1.2.0 以降では、代わりに gcp.projectID を使用します。導入バージョン: 1.0.0 デフォルト値: なし 必須 Google Cloud プロジェクトの ID。 |
gcpRegion |
Deprecated: v1.2.0 以降では、代わりに gcp.region を使用します。導入バージョン: 1.0.0 デフォルト値: 必須 Kubernetes クラスタに最も近い Google Cloud のリージョンまたはゾーン。 |
imagePullSecrets.name |
導入バージョン: 1.0.0
デフォルト値: なし Docker レジストリ タイプとして構成された Kubernetes Secret の名前。非公開リポジトリからイメージを pull するために使用されます。 |
k8sClusterName |
Deprecated: v1.2.0 以降では、代わりに k8sCluster.name と k8sCluster.region を使用します。導入バージョン: 1.0.0 デフォルト値: なし ハイブリッド プロジェクトが実行されている Kubernetes(K8s)プロクラスタの名前。 |
kmsEncryptionKey |
導入バージョン: 1.0.0
デフォルト値: 省略可。kmsEncryptionKey、kmsEncryptionPath、kmsEncryptionSecret のうち、いずれか 1 つのみを使用してください。 Apigee KMS データの暗号鍵のローカル ファイル システムのパス。 |
kmsEncryptionPath |
導入バージョン: 1.2.0 デフォルト値: なし 省略可。kmsEncryptionKey、kmsEncryptionPath、kmsEncryptionSecret のうち、いずれか 1 つのみを使用してください。 base64 でエンコードされた暗号鍵を含むファイルへのパス。データの暗号化をご覧ください。 |
kmsEncryptionSecret.key |
導入バージョン: 1.2.0 デフォルト値: なし 省略可。kmsEncryptionKey、kmsEncryptionPath、kmsEncryptionSecret のうち、いずれか 1 つのみを使用してください。 Base64 でエンコードされた暗号鍵を含む Kubernetes Secret の鍵。データの暗号化をご覧ください。 |
kmsEncryptionSecret.name |
導入バージョン: 1.2.0 デフォルト値: なし 省略可。kmsEncryptionKey、kmsEncryptionPath、kmsEncryptionSecret のうち、いずれか 1 つのみを使用してください。 Base64 でエンコードされた暗号鍵を含む Kubernetes Secret の名前。データの暗号化をご覧ください。 |
kvmEncryptionKey |
導入バージョン: 1.0.0
デフォルト値: 省略可。kvmEncryptionKey、kvmEncryptionPath、kvmEncryptionSecret のうち、いずれか 1 つのみを使用してください。 Apigee KVM データの暗号鍵に対するローカル ファイル システムのパス。 |
kvmEncryptionPath |
導入バージョン: 1.2.0 デフォルト値: なし 省略可。kvmEncryptionKey、kvmEncryptionPath、kvmEncryptionSecret のうち、いずれか 1 つのみを使用してください。 base64 でエンコードされた暗号鍵を含むファイルへのパス。データの暗号化をご覧ください。 |
kvmEncryptionSecret.key |
導入バージョン: 1.2.0 デフォルト値: なし 省略可。kvmEncryptionKey、kvmEncryptionPath、kvmEncryptionSecret のうち、いずれか 1 つのみを使用してください。 Base64 でエンコードされた暗号鍵を含む Kubernetes Secret の鍵。データの暗号化をご覧ください。 |
kvmEncryptionSecret.name |
導入バージョン: 1.2.0 デフォルト値: なし 省略可。kvmEncryptionKey、kvmEncryptionPath、kvmEncryptionSecret のうち、いずれか 1 つのみを使用してください。 Base64 でエンコードされた暗号鍵を含む Kubernetes Secret の名前。データの暗号化をご覧ください。 |
namespace |
導入バージョン: 1.0.0
デフォルト値: Apigee コンポーネントがインストールされる Kubernetes クラスタの Namespace。 |
org |
導入バージョン: 1.0.0 デフォルト値: なし 必須 ハイブリッドのインストール中に Apigee によってプロビジョニングされたハイブリッド対応の組織。組織は、Apigee Edge の最上位コンテナです。この中にはすべての API プロキシと関連リソースが含まれています。この値が空の場合は組織を作成して、組織名をこのプロパティに設定する必要があります。 |
revision |
導入バージョン: 1.0.0
デフォルト値: Apigee ハイブリッドは Kubernetes のローリング アップデートをサポートしています。Pod インスタンスを段階的に新しいインスタンスに更新できるので、Deployment の更新をダウンタイムなしで行うことができます。 特定の YAML オーバーライドの更新の結果として、基盤となる Kubernetes
次のオブジェクトのプロパティを変更するには、 詳細については、ローリング アップデートをご覧ください。 |
validateServiceAccounts |
導入バージョン: 1.0.0
デフォルト値: サービス アカウント権限の厳密な検証を有効にします。Cloud Resource Manager API の
|
ao
Apigee Operators(AO)は、ApigeeDeployment(AD)のデプロイと維持に必要な低レベルの Kubernetes リソースと Istio リソースを作成し、更新します。たとえば、コントローラは Message Processor をリリースします。また、ApigeeDeployment 構成を Kubernetes クラスタに永続化する前に検証します。
次の表に、Apigee Operators の ao
オブジェクトのプロパティを示します。
プロパティ | 説明 |
---|---|
ao.image.pullPolicy |
導入バージョン: 1.2.0 デフォルト値: kubelet が Pod の Docker イメージを pull するタイミングを決定します。有効な値は次のとおりです。
詳細については、イメージの更新をご覧ください。 |
ao.image.tag |
導入バージョン: 1.2.0 デフォルト値: このサービスの Docker イメージのバージョン ラベル。 |
ao.image.url |
導入バージョン: 1.2.0 デフォルト値: このサービスの Docker イメージの場所。 |
ao.resources.limits.cpu |
導入バージョン: 1.2.0 デフォルト値: Kubernetes コンテナ内のリソースの CPU 上限(ミリコア単位)。
|
ao.resources.limits.memory |
導入バージョン: 1.2.0 デフォルト値: Kubernetes コンテナ内のリソースのメモリ上限(MiB 単位)。
|
ao.resources.requests.cpu |
導入バージョン: 1.2.0 デフォルト値: Kubernetes コンテナ内のリソースの通常のオペレーションに必要な CPU(ミリコア単位)。 |
ao.resources.requests.memory |
導入バージョン: 1.2.0 デフォルト値: Kubernetes コンテナ内のリソースの通常オペレーションに必要なメモリ(MiB 単位)。 |
authz
次の表に、authz
オブジェクトのプロパティを示します。
プロパティ | 説明 |
---|---|
authz.image.pullPolicy |
導入バージョン: 1.0.0
デフォルト値: kubelet が Pod の Docker イメージを pull するタイミングを決定します。有効な値は次のとおりです。
詳細については、イメージの更新をご覧ください。 |
authz.image.tag |
導入バージョン: 1.0.0
デフォルト値: このサービスの Docker イメージのバージョン ラベル。 |
authz.image.url |
導入バージョン: 1.0.0
デフォルト値: このサービスの Docker イメージの場所。 |
authz.livenessProbe.failureThreshold |
導入バージョン: 1.0.0 デフォルト値: Kubernetes が検出する livenessProbe の失敗回数。この数に達すると、コンテナが再起動されます。最小値は 1 です。 |
authz.livenessProbe.initialDelaySeconds |
導入バージョン: 1.0.0 デフォルト値: コンテナが起動してから livenessProbe が開始されるまでの秒数。 |
authz.livenessProbe.periodSeconds |
導入バージョン: 1.0.0 デフォルト値: livenessProbe を実行する頻度を秒単位で指定します。最小値は 1 です。 |
authz.livenessProbe.timeoutSeconds |
導入バージョン: 1.0.0 デフォルト値: livenessProbe がタイムアウトするまでの秒数。最小値は 1 です。 |
authz.readinessProbe.failureThreshold |
バージョン導入: Beta2 デフォルト値: Kubernetes が検出する readinessProbe の失敗回数。この数に達すると、Pod が「準備未完了」とマークされます。最小値は 1 です。 |
authz.readinessProbe.initialDelaySeconds |
導入バージョン: 1.0.0 デフォルト値: コンテナが起動してから readinessProbe が開始されるまでの秒数。 |
authz.readinessProbe.periodSeconds |
導入バージョン: 1.0.0 デフォルト値: readinessProbe の実行頻度を秒単位で指定します。最小値は 1 です。 |
authz.readinessProbe.successThreshold |
導入バージョン: 1.0.0 デフォルト値: 失敗した readinessProbe が成功とみなされるために必要な最小の連続成功回数。最小値は 1 です。 |
authz.readinessProbe.timeoutSeconds |
導入バージョン: 1.0.0 デフォルト値: livenessProbe がタイムアウトするまでの秒数。最小値は 1 です。 |
authz.resources.requests.cpu |
導入バージョン: 1.0.0
デフォルト値: 認証リクエストに割り当てる CPU リソースの量。 |
authz.resources.requests.memory |
導入バージョン: 1.0.0
デフォルト値: 認証リクエストに割り当てるメモリリソースの量。 |
busyBoxInit
(非推奨)
次の表に、busyBoxInit
オブジェクトのプロパティを示します。
プロパティ | 説明 |
---|---|
busyBoxInit.image.pullPolicy |
Deprecated.
導入バージョン: 1.0.0 デフォルト値: kubelet が Pod の Docker イメージを pull するタイミングを決定します。有効な値は次のとおりです。
詳細については、イメージの更新をご覧ください。 |
busyBoxInit.image.tag |
Deprecated.
バージョン導入: 1.0.0 デフォルト値: このサービスの Docker イメージのバージョン ラベル。 |
busyBoxInit.image.url |
Deprecated.
バージョン導入: 1.0.0 デフォルト値: このサービスの Docker イメージの場所。 |
cassandra
ランタイム データ リポジトリを管理するハイブリッド サービスを定義します。このリポジトリには、ゲートウェイで実行されているアプリケーションの構成、分散割り当てカウンタ、API キー、OAuth トークンが格納されます。
詳細については、StorageClass の構成をご覧ください。
次の表に、cassandra
オブジェクトのプロパティを示します。
プロパティ | 説明 |
---|---|
cassandra.auth.admin.password |
導入バージョン: 1.0.0
デフォルト値: 必須 Cassandra 管理者のパスワード。管理者ユーザーは、Cassandra クラスタで行われる管理アクティビティに使用されます。 |
cassandra.auth.ddl.password |
導入バージョン: 1.0.0
デフォルト値: 必須 Cassandra データ定義言語(DDL)ユーザーのパスワード。キースペースの作成、更新、削除などのデータ定義タスクのために MART によって使用されます。 |
cassandra.auth.default.password |
導入バージョン: 1.0.0
デフォルト値: 必須 認証が有効になっている場合に作成されるデフォルト Cassandra ユーザーのパスワード。このパスワードは、Cassandra 認証を構成するときに再設定する必要があります。Cassandra の TLS の構成をご覧ください。 |
cassandra.auth.dml.password |
導入バージョン: 1.0.0
デフォルト値: 必須 Cassandra データ操作言語(DML)ユーザーのパスワード。DML ユーザーは、クライアントによる Cassandra からのデータの読み取りと Cassandra へのデータの書き込みに使用されます。 |
cassandra.auth.image.pullPolicy |
導入バージョン: 1.0.0 デフォルト値: kubelet が Pod の Docker イメージを pull するタイミングを決定します。有効な値は次のとおりです。
詳細については、イメージの更新をご覧ください。 |
cassandra.auth.image.tag |
導入バージョン: 1.0.0
デフォルト値: このサービスの Docker イメージのバージョン ラベル。 |
cassandra.auth.image.url |
導入バージョン: 1.0.0
デフォルト値: このサービスの Docker イメージの場所。 |
cassandra.auth.jmx.password |
導入バージョン: 1.4.0 デフォルト値: 必須 Cassandra JMX オペレーション ユーザーのパスワード。Cassandra JMX インターフェースの認証と通信に使用されます。 |
cassandra.auth.jolokia.password |
導入バージョン: 1.4.0 デフォルト値: 必須 Cassandra Jolokia JMX オペレーション ユーザーのパスワード。Cassandra JMX API の認証と通信に使用されます。 |
cassandra.auth.secret |
導入バージョン: 1.3.3 デフォルト値: なし
TLS 証明書と秘密鍵を含む、Kubernetes Secret に格納されているファイルの名前。TLS 証明書と鍵データを入力として使用し、この Secret を作成する必要があります。 関連項目:
|
cassandra.backup.cloudProvider |
導入バージョン: 1.0.0 デフォルト値: バックアップが有効な場合は必須。 バックアップ ストレージのクラウド プロバイダ。 |
cassandra.backup.dbStorageBucket |
導入バージョン: 1.0.0
デフォルト値: なし バックアップが有効な場合は必須。 バックアップ データ用の Cloud Storage バケット。 |
cassandra.backup.enabled |
導入バージョン: 1.0.0
デフォルト値: デフォルトでは、データ バックアップは有効になっていません。有効にするには、 Cassandra のバックアップと復元をご覧ください。 |
cassandra.backup.image.pullPolicy |
導入バージョン: 1.0.0 デフォルト値: kubelet が Pod の Docker イメージを pull するタイミングを決定します。有効な値は次のとおりです。
詳細については、イメージの更新をご覧ください。 |
cassandra.backup.image.tag |
導入バージョン: 1.0.0
デフォルト値: このサービスの Docker イメージのバージョン ラベル。 |
cassandra.backup.image.url |
導入バージョン: 1.0.0
デフォルト値: このサービスの Docker イメージの場所。 |
cassandra.backup.schedule |
導入バージョン: 1.0.0
デフォルト値: cron ジョブのスケジュール。 Cassandra のバックアップと復元をご覧ください。 |
cassandra.backup.serviceAccountPath |
導入バージョン: 1.0.0
デフォルト値: なし バックアップが有効な場合は、 Storage オブジェクト管理者ロールを持つ Google サービス アカウント キーファイルへのパス。 |
cassandra.backup.serviceAccountSecretRef |
導入バージョン: 1.2.0 デフォルト値: なし バックアップが有効な場合は、 Kubernetes Secret の名前。ストレージ オブジェクト管理者ロールを持つ Google サービス アカウント キーを入力として使用し、Secret を作成する必要があります。 |
cassandra.clusterName |
バージョン導入: 1.0.0 デフォルト値: Cassandra クラスタの名前を指定します。 |
cassandra.datacenter |
導入バージョン: 1.0.0
デフォルト値: Cassandra ノードのデータセンターを指定します。 |
cassandra.dnsPolicy |
導入バージョン: 1.1.1 デフォルト値: なし
|
cassandra.externalSeedHost |
導入バージョン: 1.0.0
デフォルト値: なし Cassandra クラスタノードのホスト名または IP。設定されていない場合は、Kubernetes ローカル サービスが使用されます。 |
cassandra.heapNewSize |
導入バージョン: 1.0.0
デフォルト値: 新しいオブジェクトに割り当てられる JVM システムメモリの量(MB 単位)。 |
cassandra.hostNetwork |
バージョン導入: 1.1.1 デフォルト値: Anthos をインストールする場合、このプロパティを |
cassandra.image.pullPolicy |
導入バージョン: 1.0.0 デフォルト値: kubelet が Pod の Docker イメージを pull するタイミングを決定します。有効な値は次のとおりです。
詳細については、イメージの更新をご覧ください。 |
cassandra.image.tag |
導入バージョン: 1.0.0
デフォルト値: このサービスの Docker イメージのバージョン ラベル。 |
cassandra.image.url |
導入バージョン: 1.0.0
デフォルト値: このサービスの Docker イメージの場所。 |
cassandra.maxHeapSize |
導入バージョン: 1.0.0
デフォルト値: Cassandra のオペレーションに使用可能な JVM システムメモリの上限(MB 単位)。 |
cassandra.multiRegionSeedHost |
導入バージョン: 1.0.0
デフォルト値: なし 既存のクラスタを新しいリージョンに拡張するために使用される既存の Cassandra クラスタの IP アドレス。マルチリージョン シードホストを構成するをご覧ください。 |
cassandra.nodeSelector.key |
導入バージョン: 1.0.0
デフォルト値: なし 必須
専用ノードプールの構成をご覧ください。 |
cassandra.nodeSelector.value |
導入バージョン: 1.0.0
デフォルト値: なし (省略可) nodeSelector をご覧ください。 |
cassandra.port |
導入バージョン: 1.0.0
デフォルト値: Cassandra への接続に使用するポート番号。 |
cassandra.rack |
導入バージョン: 1.0.0
デフォルト値: Cassandra ノードのラックを指定します。 |
cassandra.readinessProbe.failureThreshold |
導入バージョン: 1.0.0 デフォルト値: Kubernetes が検出する readinessProbe の失敗回数。この数に達すると、Pod が「準備未完了」とマークされます。最小値は 1 です。 |
cassandra.readinessProbe.initialDelaySeconds |
導入バージョン: 1.0.0 デフォルト値: コンテナが起動してから readinessProbe が開始されるまでの秒数。 |
cassandra.readinessProbe.periodSeconds |
導入バージョン: 1.0.0 デフォルト値: readinessProbe の実行頻度を秒単位で指定します。最小値は 1 です。 |
cassandra.readinessProbe.successThreshold |
導入バージョン: 1.0.0 デフォルト値: 失敗した readinessProbe が成功とみなされるために必要な最小の連続成功回数。最小値は 1 です。 |
cassandra.readinessProbe.timeoutSeconds |
導入バージョン: 1.0.0 デフォルト値: livenessProbe がタイムアウトするまでの秒数。最小値は 1 です。 |
cassandra.replicaCount |
導入バージョン: 1.0.0
デフォルト値: Cassandra は複製されたデータベースです。このプロパティは、StatefulSet として使用される Cassandra ノードの数を指定します。 |
cassandra.resources.requests.cpu |
導入バージョン: 1.0.0
デフォルト値: Kubernetes コンテナ内のリソースの通常のオペレーションに必要な CPU(ミリコア単位)。 |
cassandra.resources.requests.memory |
導入バージョン: 1.0.0
デフォルト値: Kubernetes コンテナ内のリソースの通常のオペレーションに必要なメモリ(MiB 単位)。 |
cassandra.restore.cloudProvider |
導入バージョン: 1.0.0 デフォルト値: 復元が有効な場合は必須。 バックアップ ストレージのクラウド プロバイダ。 |
cassandra.restore.dbStorageBucket |
導入バージョン: 1.0.0
デフォルト値: なし 復元が有効な場合は必須。 復元するバックアップ データの Cloud Storage バケット。 |
cassandra.restore.enabled |
導入バージョン: 1.0.0
デフォルト値: |
cassandra.restore.image.pullPolicy |
導入バージョン: 1.0.0 デフォルト値: kubelet が Pod の Docker イメージを pull するタイミングを決定します。有効な値は次のとおりです。
詳細については、イメージの更新をご覧ください。 |
cassandra.restore.image.tag |
導入バージョン: 1.0.0
デフォルト値: このサービスの Docker イメージのバージョン ラベル。 |
cassandra.restore.image.url |
導入バージョン: 1.0.0
デフォルト値: このサービスの Docker イメージの場所。 |
cassandra.restore.serviceAccountPath |
導入バージョン: 1.0.0
デフォルト値: なし 復元が有効になっている場合は、 Storage オブジェクト管理者ロールを持つ Google サービス アカウント キーファイルへのパス。 |
cassandra.restore.serviceAccountSecretRef |
導入バージョン: 1.2.0 デフォルト値: なし 復元が有効になっている場合は、 Kubernetes Secret の名前。ストレージ オブジェクト管理者ロールを持つ Google サービス アカウント キーを入力として使用し、Secret を作成する必要があります。 |
cassandra.restore.snapshotTimestamp |
バージョン導入: 1.0.0 デフォルト値: なし 復元が有効な場合は必須。 復元するバックアップのタイムスタンプ。 |
cassandra.restore.user |
導入バージョン: 1.0.0
デフォルト値: 管理者アカウント スキーマのバックアップの復元に使用される Cassandra ユーザー名。指定しない場合、管理者ユーザーが使用されます。 |
cassandra.sslCertPath |
導入バージョン: 1.2.0 デフォルト値: なし
システム上の TLS 証明書ファイルへのパス。 |
cassandra.sslKeyPath |
導入バージョン: 1.2.0 デフォルト値: なし
TLS 秘密鍵ファイルへのシステム上のパス。 |
cassandra.sslRootCAPath |
導入バージョン: 1.2.0 デフォルト値: なし ルート CA(認証局)への証明書チェーン。 |
cassandra.storage.capacity |
導入バージョン: 1.0.0
デフォルト値: storage.storageClass が指定されている場合は必須 ディスクサイズを MiB 単位で指定します。 |
cassandra.storage.storageClass |
導入バージョン: 1.0.0
デフォルト値: なし 使用するオンプレミス ストレージのクラスを指定します。 |
cassandra.terminationGracePeriodSeconds |
導入バージョン: 1.0.0
デフォルト値: Pod の削除リクエストから実際に Pod が強制終了されるまでの時間(秒単位)。この期間中に preStop フックが実行され、動作中のすべてのプロセスが正常に終了します。 |
certmanager
cert-manager は、Apigee で使用される Kubernetes 実装の証明書マネージャーです。cert-manager へようこそをご覧ください。
次の表に、certmanager
オブジェクトのプロパティを示します。
プロパティ | 説明 |
---|---|
certmanager.image.tag |
導入バージョン: 1.2.0 デフォルト値: このサービスの Docker イメージのバージョン ラベル。 |
certmanager.image.url |
導入バージョン: 1.2.0 デフォルト値: このサービスの Docker イメージの場所。 |
certmanagercainjector
cert-manager CA インジェクタは、CA バンドルを cert-manager Webhook プロセスに挿入する cert-manager プロセスです。cert-manager ドキュメントの CA インジェクタをご覧ください。
次の表に、certmanagercainjector
オブジェクトのプロパティを示します。
プロパティ | 説明 |
---|---|
certmanagercainjector.image.tag |
導入バージョン: 1.2.0 デフォルト値: このサービスの Docker イメージのバージョン ラベル。 |
certmanagercainjector.image.url |
導入バージョン: 1.2.0 デフォルト値: このサービスの Docker イメージの場所。 |
certmanagerwebhook
cert-manager Webhook は、cert-manager リソースに動的なアドミッション コントロールを提供するプロセスです。cert-manager ドキュメントの Webhook をご覧ください。
次の表に、certmanagerwebhook
オブジェクトのプロパティを示します。
プロパティ | 説明 |
---|---|
certmanagerwebhook.image.tag |
導入バージョン: 1.2.0 デフォルト値: このサービスの Docker イメージのバージョン ラベル。 |
certmanagerwebhook.image.url |
導入バージョン: 1.2.0 デフォルト値: このサービスの Docker イメージの場所。 |
connectAgent
Apigee Connect を使用すると、インターネット上で MART エンドポイントを公開しなくても、Apigee Hybrid 管理プレーンをランタイム プレーンの MART サービスに安全に接続できます。
Apigee Connect をご覧ください。
次の表に、connectAgent
オブジェクトのプロパティを示します。
プロパティ | 説明 |
---|---|
connectAgent.enabled |
導入バージョン: 1.2.0 デフォルト値: このインストールでは、Mart 用に Istio Ingress の代わりに Apigee Connect を使用しているかどうか True または False で指定します。 Apigee Connect をご覧ください。 |
connectAgent.server |
導入バージョン: 1.2.0 デフォルト値: このサービスのサーバーとポートの場所。 |
connectAgent.logLevel |
導入バージョン: 1.2.0 デフォルト値: ログレポートのレベル。次の値が表示されます。
|
connectAgent.image.pullPolicy |
導入バージョン: 1.2.0 デフォルト値: kubelet が Pod の Docker イメージを pull するタイミングを決定します。有効な値は次のとおりです。
詳細については、イメージの更新をご覧ください。 |
connectAgent.image.tag |
導入バージョン: 1.2.0 デフォルト値: このサービスの Docker イメージのバージョン ラベル。 |
connectAgent.image.url |
導入バージョン: 1.2.0 デフォルト値: このサービスの Docker イメージの場所。特定の URL については、 |
connectAgent.replicaCountMax |
導入バージョン: 1.2.0 デフォルト値: 自動スケーリングに使用できるレプリカの最大数。 |
connectAgent.replicaCountMin |
導入バージョン: 1.2.0 デフォルト値: 自動スケーリングに使用できるレプリカの最小数。 本番環境では、 |
connectAgent.resources.requests.cpu |
導入バージョン: 1.0.0
デフォルト値: Kubernetes コンテナ内のリソースの通常のオペレーションに必要な CPU(ミリコア単位)。 |
connectAgent.resources.requests.memory |
導入バージョン: 1.0.0
デフォルト値: Kubernetes コンテナ内のリソースの通常のオペレーションに必要なメモリ(MiB 単位)。 |
connectAgent.targetCPUUtilizationPercentage |
導入バージョン: 1.2.0 デフォルト値: Pod 上の Apigee Connect エージェントの CPU 使用率の目標値。CPU 使用率がこのフィールドの値に達すると、Apigee Connect が( |
connectAgent.terminationGracePeriodSeconds |
導入バージョン: 1.2.0 デフォルト値: Pod の削除リクエストから実際に Pod が強制終了されるまでの時間(秒単位)。この期間中に preStop フックが実行され、動作中のすべてのプロセスが正常に終了します。 |
defaults
Apigee ハイブリッド インストールのデフォルトの暗号鍵。
次の表に、defaults
オブジェクトのプロパティを示します。
プロパティ | 説明 |
---|---|
defaults.org.kmsEncryptionKey |
導入バージョン: 1.0.0
デフォルト値: 組織のデフォルトの KMS 暗号鍵。 |
defaults.org.kvmEncryptionKey |
導入バージョン: 1.0.0
デフォルト値: 組織のデフォルトの KVM 暗号鍵。 |
defaults.env.kmsEncryptionKey |
導入バージョン: 1.0.0
デフォルト値: 環境(env)のデフォルトの KMS 暗号鍵。 |
defaults.env.kvmEncryptionKey |
導入バージョン: 1.0.0
デフォルト値: 環境(env)のデフォルトの KVM 暗号鍵。 |
defaults.env.cacheEncryptionKey |
導入バージョン: 1.0.0
デフォルト値: 環境(env)のデフォルトのキャッシュ暗号鍵。 |
envs
API プロキシをデプロイできる環境の配列を定義します。各環境は、API プロキシを稼働させるための分離コンテキストまたは「サンドボックス」として使用できます。
ハイブリッド対応組織には少なくとも 1 つの環境が必要です。
詳しくは、環境についてをご覧ください。
次の表に、envs
オブジェクトのプロパティを示します。
プロパティ | 説明 |
---|---|
envs[].cacheEncryptionKey |
導入バージョン: 1.0.0
デフォルト値: なし
Base64 でエンコードされた暗号鍵。データの暗号化をご覧ください。 |
envs[].cacheEncryptionPath |
導入バージョン: 1.2.0 デフォルト値: なし
Base64 でエンコードされた暗号鍵を含むファイルへのパス。データの暗号化をご覧ください。 |
envs[].cacheEncryptionSecret.key |
導入バージョン: 1.2.0 デフォルト値: なし
Base64 でエンコードされた暗号鍵を含む Kubernetes Secret の鍵。データの暗号化をご覧ください。 |
envs[].cacheEncryptionSecret.name |
導入バージョン: 1.2.0 デフォルト値: なし
Base64 でエンコードされた暗号鍵を含む Kubernetes Secret の名前。データの暗号化をご覧ください。 |
envs[].hostAliases[] |
導入バージョン: 1.2.0 デフォルト値: なし Deprecated: ハイブリッド バージョン 1.4 以降では、ランタイム プレーンは管理プレーンからこの情報を受け取ります。環境と環境グループについてをご覧ください。 |
envs[].httpProxy.host |
導入バージョン: 1.2.0 デフォルト値: なし HTTP プロキシが実行されているホスト名または IP アドレスを指定します。
envs: - name: test httpProxy: scheme: HTTP host: 10.12.0.47 port: 3128 ... API プロキシの転送プロキシを構成するもご覧ください。 |
envs[].httpProxy.port |
導入バージョン: 1.2.0 デフォルト値: なし HTTP プロキシが実行されているポートを指定します。このプロパティを省略すると、HTTP の場合はポート |
envs[].httpProxy.scheme |
導入バージョン: 1.2.0 デフォルト値: なし HTTP プロキシのタイプを HTTP または HTTPS として指定します。デフォルトでは「HTTP」が使用されます。 |
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 サービス アカウント(通常は |
envs[].serviceAccountPaths.synchronizer |
導入バージョン: 1.0. デフォルト値: なし Apigee Synchronizer 管理者ロールを持つ Google サービス アカウント キーへのローカル システム上のファイルパス。 |
envs[].serviceAccountPaths.udca |
導入バージョン: 1.0. デフォルト値: なし Apigee Analytics エージェント ロールを持つ Google サービス アカウント キーへのローカル システム上のファイルパス。 |
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 を作成する必要があります。 |
envs[].sslCertPath |
導入バージョン: 1.2.0 デフォルト値: なし
システム上の TLS 証明書ファイルへのパス。 |
envs[].sslKeyPath |
導入バージョン: 1.2.0 デフォルト値: なし
TLS 秘密鍵ファイルへのシステム上のパス。 |
envs[].sslSecret |
導入バージョン: 1.2.0 デフォルト値: なし
TLS 証明書と秘密鍵を含む、Kubernetes Secret に格納されているファイルの名前。TLS 証明書と鍵データを入力として使用し、この Secret を作成する必要があります。 関連項目:
|
gcp
apigee-logger
と apigee-metrics
がデータを push する Google Cloud プロジェクト ID とリージョンを識別します。
次の表に、gcp
オブジェクトのプロパティを示します。
プロパティ | 説明 |
---|---|
gcp.region |
導入バージョン: 1.2.0 デフォルト値: なし 必須
|
gcp.projectID |
導入バージョン: 1.2.0 デフォルト値: なし 必須
|
gcp.projectIDRuntime |
導入バージョン: 1.2.0 デフォルト値: なし ランタイム Kubernetes クラスタ プロジェクトを特定します。
|
httpProxy
httpProxy
は HTTP 転送プロキシ サーバー用の構成パラメータを提供します。overrides.yaml
でプロキシ サーバーが構成されている場合、MART、Synchronizer、UDCA コンポーネントのインターネット通信はすべてプロキシ サーバーを通過します。
logger、mart、metrics、synchronizer、udca もご覧ください。
次の表に、httpProxy
オブジェクトのプロパティを示します。
プロパティ | 説明 |
---|---|
httpProxy.host |
導入バージョン: 1.1.1 デフォルト値: なし HTTP プロキシのホスト名。 |
httpProxy.port |
導入バージョン: 1.1.1 デフォルト値: なし HTTP プロキシのポート。 |
httpProxy.scheme |
導入バージョン: 1.1.1 デフォルト値: プロキシで使用されるスキーム。値は |
k8sCluster
ハイブリッド ランタイムがインストールされる Kubernetes クラスタを特定します。
次の表に、k8sCluster
オブジェクトのプロパティを示します。
プロパティ | 説明 |
---|---|
k8sCluster.name |
導入バージョン: 1.2.0 デフォルト値: なし ハイブリッド ランタイムがインストールされる Kubernetes クラスタの名前。 |
k8sCluster.region |
導入バージョン: 1.2.0 デフォルト値: なし Kubernetes クラスタが作成された Google Cloud リージョンを識別します。 |
kubeRBACProxy
Apigee が Kubernetes のロールベースのアクセス制御を探す場所を識別します。
次の表に、kubeRBACProxy
オブジェクトのプロパティを示します。
プロパティ | 説明 |
---|---|
kubeRBACProxy.image.pullPolicy |
導入バージョン: 1.2.0 デフォルト値: kubelet が Pod の Docker イメージを pull するタイミングを決定します。有効な値は次のとおりです。
詳細については、イメージの更新をご覧ください。 |
kubeRBACProxy.image.tag |
導入バージョン: v0.4.1 デフォルト値: このサービスの Docker イメージのバージョン ラベル。 |
kubeRBACProxy.image.url |
導入バージョン: 1.2.0 デフォルト値: このサービスの Docker イメージの場所。 Google Docker Hub を使用しない場合はイメージをダウンロードし、その Docker イメージが内部でホストされているアドレスに設定します。 |
logger
運用ログを管理するサービスを定義します。この情報は、Kubernetes クラスタで実行されるすべての Apigee Hybrid サービスから出力されます。
詳しくは、ロギングの概要をご覧ください。
次の表に、logger
オブジェクトのプロパティを示します。
プロパティ | 説明 |
---|---|
logger.enabled |
導入バージョン: 1.0.0
デフォルト値: クラスタでのロギングを有効または無効にします。GKE 以外の場合は |
logger.fluentd.buffer_chunk_limit |
導入バージョン: 1.0.0
デフォルト値: バッファ チャンクの許容される最大サイズ(KB 単位)。この上限を超えるチャンクは出力キューに自動的にフラッシュされます。 |
logger.fluentd.buffer_queue_limit |
導入バージョン: 1.0.0
デフォルト値: 出力キューの最大長。デフォルトの上限は 256 チャンクです。 |
logger.fluentd.flush_interval |
導入バージョン: 1.0.0
デフォルト値: 次のバッファ フラッシュを呼び出すまでの待機時間(秒単位)。 |
logger.fluentd.max_retry_wait |
導入バージョン: 1.0.0
デフォルト値: 書き込み再試行の最大間隔(秒単位)。 |
logger.fluentd.num_threads |
導入バージョン: 1.0.0
デフォルト値: バッファのフラッシュに使用されるスレッドの数。デフォルトは 1 です。 |
logger.image.pullPolicy |
導入バージョン: 1.0.0 デフォルト値: kubelet が Pod の Docker イメージを pull するタイミングを決定します。有効な値は次のとおりです。
詳細については、イメージの更新をご覧ください。 |
logger.image.tag |
導入バージョン: 1.0.0
デフォルト値: このサービスの Docker イメージのバージョン ラベル。 |
logger.image.url |
導入バージョン: 1.0.0
デフォルト値: このサービスの Docker イメージの場所。 |
logger.livenessProbe.failureThreshold |
導入バージョン: 1.0.0 デフォルト値: Kubernetes が検出する livenessProbe の失敗回数。この数に達すると、コンテナが再起動されます。最小値は 1 です。 |
logger.livenessProbe.initialDelaySeconds |
導入バージョン: 1.0.0 デフォルト値: コンテナが起動してから livenessProbe が開始されるまでの秒数。 |
logger.livenessProbe.periodSeconds |
導入バージョン: 1.0.0 デフォルト値: livenessProbe を実行する頻度を秒単位で指定します。最小値は 1 です。 |
logger.livenessProbe.successThreshold |
導入バージョン: 1.0.0
デフォルト値: 失敗した livenessProbe が成功とみなされるために必要な最小の連続成功回数。最小値は 1 です。 |
logger.livenessProbe.timeoutSeconds |
導入バージョン: 1.0.0 デフォルト値: livenessProbe がタイムアウトするまでの秒数。最小値は 1 です。 |
logger.nodeSelector.key |
導入バージョン: 1.0.0
デフォルト値: 必須
専用ノードプールの構成をご覧ください。 |
logger.nodeSelector.value |
導入バージョン: 1.0.0
デフォルト値: 必須
専用ノードプールの構成をご覧ください。 |
logger.proxyURL |
導入バージョン: 1.0.0
デフォルト値: なし ユーザーのプロキシ サーバーの URL。 |
logger.resources.limits.memory |
導入バージョン: 1.0.0
デフォルト値: Kubernetes コンテナ内のリソースのメモリ上限(MiB 単位)。
|
logger.resources.limits.cpu |
導入バージョン: 1.0.0
デフォルト値: Kubernetes コンテナ内のリソースの CPU 上限(ミリコア単位)。
|
logger.resources.requests.cpu |
導入バージョン: 1.0.0
デフォルト値: Kubernetes コンテナ内のリソースの通常のオペレーションに必要な CPU(ミリコア単位)。 |
logger.resources.requests.memory |
導入バージョン: 1.0.0
デフォルト値: Kubernetes コンテナ内のリソースの通常のオペレーションに必要なメモリ(MiB 単位)。 |
logger.serviceAccountPath |
導入バージョン: 1.0.0
デフォルト値: なし
ログ書き込みロールを持つ Google サービス アカウント キーファイルへのパス。 |
logger.serviceAccountSecretRef |
導入バージョン: 1.2.0 デフォルト値: なし
Kubernetes Secret の名前。ログ書き込みロールを持つ Google サービス アカウント キーを入力として使用し、Secret を作成する必要があります。 |
logger.terminationGracePeriodSeconds |
バージョン導入: 1.0.0 デフォルト値: 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
デフォルト値: kubelet が Pod の Docker イメージを pull するタイミングを決定します。有効な値は次のとおりです。
詳細については、イメージの更新をご覧ください。 |
mart.image.tag |
導入バージョン: 1.0.0
デフォルト値: このサービスの Docker イメージのバージョン ラベル。 |
mart.image.url |
導入バージョン: 1.0.0
デフォルト値: このサービスの Docker イメージの場所。特定の URL の |
mart.initCheckCF.resources.requests.cpu |
導入バージョン: 1.0.0
デフォルト値: Cloud Foundry プロセスの初期化チェックに割り当てられる CPU リソースの量。 |
mart.livenessProbe.failureThreshold |
導入バージョン: 1.0.0 デフォルト値: Kubernetes が検出する livenessProbe の失敗回数。この数に達すると、コンテナが再起動されます。最小値は 1 です。 |
mart.livenessProbe.initialDelaySeconds |
導入バージョン: 1.0.0 デフォルト値: コンテナが起動してから livenessProbe が開始されるまでの秒数。 |
mart.livenessProbe.periodSeconds |
導入バージョン: 1.0.0 デフォルト値: livenessProbe を実行する頻度を秒単位で指定します。最小値は 1 です。 |
mart.livenessProbe.timeoutSeconds |
導入バージョン: 1.0.0 デフォルト値: livenessProbe がタイムアウトするまでの秒数。最小値は 1 です。 |
mart.metricsURL |
導入バージョン: 1.0.0
デフォルト値: |
mart.nodeSelector.key |
導入バージョン: 1.0.0
デフォルト値: なし
専用ノードプールの構成をご覧ください。 |
mart.nodeSelector.value |
導入バージョン: 1.0.0
デフォルト値: なし (省略可) 専用ノードプールの構成をご覧ください。 |
mart.readinessProbe.failureThreshold |
導入バージョン: 1.0.0 デフォルト値: Kubernetes が検出する readinessProbe の失敗回数。この数に達すると、Pod が「準備未完了」とマークされます。最小値は 1 です。 |
mart.readinessProbe.initialDelaySeconds |
導入バージョン: 1.0.0 デフォルト値: コンテナが起動してから readinessProbe が開始されるまでの秒数。 |
mart.readinessProbe.periodSeconds |
導入バージョン: 1.0.0 デフォルト値: readinessProbe の実行頻度を秒単位で指定します。最小値は 1 です。 |
mart.readinessProbe.successThreshold |
導入バージョン: 1.0.0 デフォルト値: 失敗した readinessProbe が成功とみなされるために必要な最小の連続成功回数。最小値は 1 です。 |
mart.readinessProbe.timeoutSeconds |
導入バージョン: 1.0.0 デフォルト値: livenessProbe がタイムアウトするまでの秒数。最小値は 1 です。 |
mart.replicaCountMax |
導入バージョン: 1.0.0
デフォルト値: 自動スケーリングに使用できるレプリカの最大数。 |
mart.replicaCountMin |
導入バージョン: 1.0.0
デフォルト値: 自動スケーリングに使用できるレプリカの最小数。 |
mart.resources.requests.cpu |
導入バージョン: 1.0.0
デフォルト値: Kubernetes コンテナ内のリソースの通常のオペレーションに必要な CPU(ミリコア単位)。 |
mart.resources.requests.memory |
導入バージョン: 1.0.0
デフォルト値: Kubernetes コンテナ内のリソースの通常のオペレーションに必要なメモリ(MiB 単位)。 |
mart.serviceAccountPath |
導入バージョン: 1.1.1 デフォルト値: なし
ロールを持たない Google サービス アカウント キーファイルへのパス。 |
mart.serviceAccountSecretRef |
導入バージョン: 1.2.0 デフォルト値: なし
Kubernetes Secret の名前。ロールを持たない Google サービス アカウント キーを入力として使用し、Secret を作成する必要があります。 |
mart.sslCertPath |
バージョン導入: 1.0.0 デフォルト値: なし
SSL 証明書を Secret に読み込んでエンコードするためのローカル ファイル システム上のパス。 |
mart.sslKeyPath |
導入バージョン: 1.0.0
デフォルト値: なし
SSL 鍵を Secret に読み込んでエンコードするためのローカル ファイル システムのパス。 |
mart.sslSecret |
導入バージョン: 1.2.0 デフォルト値: なし
TLS 証明書と秘密鍵を含む、Kubernetes Secret に格納されているファイルの名前。TLS 証明書と鍵データを入力として使用し、この Secret を作成する必要があります。 関連項目:
|
mart.targetCPUUtilizationPercentage |
導入バージョン: 1.0.0
デフォルト値: Pod 上の MART プロセスのターゲット CPU 使用率。CPU 使用率がこのフィールドの値に達すると、MART が( |
mart.terminationGracePeriodSeconds |
導入バージョン: 1.0.0 デフォルト値: Pod の削除リクエストから実際に Pod が強制終了されるまでの時間(秒単位)。この期間中に preStop フックが実行され、動作中のすべてのプロセスが正常に終了します。 |
metrics
オペレーション指標を収集するサービスを定義します。この指標データは、ハイブリッド サービスの状態のモニタリングやアラートの設定などの用途に使用できます。
詳細については、指標の収集の概要をご覧ください。
次の表に、metrics
オブジェクトのプロパティを示します。
プロパティ | 説明 |
---|---|
metrics.aggregator.requests.cpu |
導入バージョン: 1.4.0 デフォルト値: Kubernetes コンテナ内のアグリゲータの通常オペレーションに必要な CPU(ミリコア単位)。 |
metrics.aggregator.requests.memory |
導入バージョン: 1.4.0 デフォルト値: Kubernetes コンテナ内のアグリゲータの通常オペレーションに必要なメモリ(MiB 単位)。 |
metrics.aggregator.resources.limits.cpu |
導入バージョン: 1.4.0 デフォルト値: Kubernetes コンテナ内のアグリゲータ リソースの CPU 上限(ミリコア単位)。 |
metrics.aggregator.resources.limits.memory |
導入バージョン: 1.4.0 デフォルト値: Kubernetes コンテナ内のアグリゲータ リソースのメモリ上限(ギビバイト単位)。 |
metrics.app.requests.cpu |
バージョン導入: 1.4.0 デフォルト値: Kubernetes コンテナ内のアプリの通常のオペレーションに必要な CPU(ミリコア単位)。 |
metrics.app.requests.memory |
導入バージョン: 1.4.0 デフォルト値: Kubernetes コンテナ内のアプリの通常オペレーションに必要なメモリ(MiB 単位)。 |
metrics.app.resources.limits.cpu |
導入バージョン: 1.4.0 デフォルト値: Kubernetes コンテナ内のアプリリソースの CPU 上限(ミリコア単位)。 |
metrics.app.resources.limits.memory |
導入バージョン: 1.4.0 デフォルト値: Kubernetes コンテナ内のアプリリソースのメモリ上限(GiB 単位)。 |
metrics.enabled |
導入バージョン: 1.0.0
デフォルト値: Apigee の指標を有効にします。 |
metrics.nodeSelector.key |
導入バージョン: 1.0.0
デフォルト値: なし 必須
専用ノードプールの構成をご覧ください。 |
metrics.nodeSelector.value |
導入バージョン: 1.0.0
デフォルト値: なし 必須
専用ノードプールの構成をご覧ください。 |
metrics.prometheus.args.storage_tsdb_retention |
導入バージョン: 1.0.0
デフォルト値: Prometheus がローカル ストレージにデータを保持する時間(時間単位)。 |
metrics.prometheus.containerPort |
導入バージョン: 1.0.0
デフォルト値: Prometheus 指標サービスに接続するためのポート。 |
metrics.prometheus.image.pullPolicy |
導入バージョン: 1.0.0 デフォルト値: kubelet が Pod の Docker イメージを pull するタイミングを決定します。有効な値は次のとおりです。
詳細については、イメージの更新をご覧ください。 |
metrics.prometheus.image.tag |
導入バージョン: 1.0.0
デフォルト値: このサービスの Docker イメージのバージョン ラベル。 |
metrics.prometheus.image.url |
導入バージョン: 1.0.0
デフォルト値: このサービスの Docker イメージの場所。 |
metrics.prometheus.livenessProbe.failureThreshold |
導入バージョン: 1.0.0 デフォルト値: Kubernetes が検出する livenessProbe の失敗回数。この数に達すると、コンテナが再起動されます。最小値は 1 です。 |
metrics.prometheus.livenessProbe.periodSeconds |
導入バージョン: 1.0.0 デフォルト値: livenessProbe を実行する頻度を秒単位で指定します。最小値は 1 です。 |
metrics.prometheus.livenessProbe.timeoutSeconds |
導入バージョン: 1.0.0 デフォルト値: livenessProbe がタイムアウトするまでの秒数。最小値は 1 です。 |
metrics.prometheus.readinessProbe.failureThreshold |
導入バージョン: 1.0.0 デフォルト値: Kubernetes が検出する readinessProbe の失敗回数。この数に達すると、Pod が「準備未完了」とマークされます。最小値は 1 です。 |
metrics.prometheus.readinessProbe.periodSeconds |
導入バージョン: 1.0.0 デフォルト値: readinessProbe の実行頻度を秒単位で指定します。最小値は 1 です。 |
metrics.prometheus.readinessProbe.timeoutSeconds |
導入バージョン: 1.0.0 デフォルト値: livenessProbe がタイムアウトするまでの秒数。最小値は 1 です。 |
metrics.prometheus.sslCertPath |
導入バージョン: 1.0.0
デフォルト値: なし 必須 Prometheus 指標収集プロセス用の SSL 証明書のパス。Prometheus は、Apigee の指標の収集と処理に使用できるツールです。 詳しくは、以下をご覧ください。
|
metrics.prometheus.sslKeyPath |
導入バージョン: 1.0.0
デフォルト値: なし 必須 Prometheus 指標収集プロセス用の SSL 鍵のパス。Prometheus は、Apigee の指標の収集と処理に使用できるツールです。 詳しくは、以下をご覧ください。
|
metrics.proxy.requests.cpu |
導入バージョン: 1.4.0 デフォルト値: Kubernetes コンテナ内のプロキシの通常オペレーションに必要な CPU(ミリコア単位)。 |
metrics.proxy.requests.memory |
導入バージョン: 1.4.0 デフォルト値: Kubernetes コンテナ内のプロキシの通常オペレーションに必要なメモリ(MiB 単位)。 |
metrics.proxy.resources.limits.cpu |
導入バージョン: 1.4.0 デフォルト値: Kubernetes コンテナ内のプロキシ リソースの CPU 上限(ミリコア単位)。 |
metrics.proxy.resources.limits.memory |
導入バージョン: 1.4.0 デフォルト値: Kubernetes コンテナ内のプロキシ リソースのメモリ上限(GiB 単位)。 |
metrics.proxyURL |
導入バージョン: 1.0.0
デフォルト値: なし Kubernetes クラスタ内の指標プロセス サイドカー プロキシの URL。 |
metrics.sdSidecar.containerPort |
導入バージョン: 1.0.0
デフォルト値: Cloud Operations 指標サービスに接続するためのポート。 |
metrics.sdSidecar.image.pullPolicy |
導入バージョン: 1.0.0
デフォルト値: kubelet がこのサービスの Docker イメージをいつ pull するかを指定します。有効な値は次のとおりです。
|
metrics.sdSidecar.image.tag |
導入バージョン: 1.0.0
デフォルト値: このサービスの Docker イメージのバージョン ラベル。 |
metrics.sdSidecar.image.url |
導入バージョン: 1.0.0 デフォルト値: このサービスの Docker イメージの場所。 |
metrics.serviceAccountPath |
導入バージョン: 1.0.0
デフォルト値: なし
モニタリング指標の書き込みロールを持つ Google サービス アカウント キーファイルへのパス。 |
metrics.serviceAccountSecretRef |
導入バージョン: 1.2.0 デフォルト値: なし
Kubernetes Secret の名前。モニタリング指標の書き込みロールを持つ Google サービス アカウント キーを入力として使用し、Secret を作成する必要があります。 |
metrics.stackdriverExporter.requests.cpu |
バージョン導入: 1.4.0 デフォルト値: Kubernetes コンテナ内の stackdriverExporter の通常オペレーションに必要な CPU(ミリコア単位)。 |
metrics.stackdriverExporter.requests.memory |
バージョン導入: 1.4.0 デフォルト値: Kubernetes コンテナ内の stackdriverExporter の通常オペレーションに必要なメモリ(MiB 単位)。 |
metrics.stackdriverExporter.resources.limits.cpu |
バージョン導入: 1.4.0 デフォルト値: Kubernetes コンテナ内の stackdriverExporter リソースの CPU 上限(ミリコア単位)。 |
metrics.stackdriverExporter.resources.limits.memory |
バージョン導入: 1.4.0 デフォルト値: Kubernetes コンテナ内の stackdriverExporter リソースのメモリ上限(GiB 単位)。 |
metrics.terminationGracePeriodSeconds |
導入バージョン: 1.0.0 デフォルト値: Pod の削除リクエストから実際に Pod が強制終了されるまでの時間(秒単位)。この期間中に preStop フックが実行され、動作中のすべてのプロセスが正常に終了します。 |
nodeSelector
nodeSelector
オブジェクトは Apigee インスタンスのノードを定義します。apigeectl
が実行されると、内部で apigeeRuntime
と apigeeData
のラベルの Key-Value が個々の Istio コンポーネントと MART コンポーネントにマッピングされます。この設定は、mart:nodeSelector プロパティに含まれる個々のオブジェクトでオーバーライドできます。
次の表に、nodeSelector
オブジェクトのプロパティを示します。
プロパティ | 説明 |
---|---|
nodeSelector.apigeeData.key |
導入バージョン: 1.0.0
デフォルト値: ApigeeData は Cassandra データベース用のノードです。これは、Apigee サービスデータを操作するための Kubernetes ノードの選択に使用するノードセレクタのラベルキーです。 専用ノードプールの構成をご覧ください。 |
nodeSelector.apigeeData.value |
導入バージョン: 1.0.0
デフォルト値: apigee-data は Cassandra データベース用のノードです。これは、Apigee サービスデータを操作するための Kubernetes ノードの選択に使用するノードセレクタのラベル値です。 専用ノードプールの構成をご覧ください。 |
nodeSelector.apigeeRuntime.key |
導入バージョン: 1.0.0
デフォルト値: Apigee Runtime はプロジェクトのランタイム環境用のノードです。これは、Apigee ランタイム サービス用の Kubernetes ノードの選択に使用するノードセレクタのラベルキーです。 専用ノードプールの構成をご覧ください。 |
nodeSelector.apigeeRuntime.value |
導入バージョン: 1.0.0
デフォルト値:
専用ノードプールの構成をご覧ください。 |
nodeSelector.requiredForScheduling |
導入バージョン: 1.0.0
デフォルト値: false
本番環境では、 専用ノードプールの構成をご覧ください。 |
runtime
次の表に、runtime
オブジェクトのプロパティを示します。
プロパティ | 説明 |
---|---|
runtime.image.pullPolicy |
導入バージョン: 1.0.0
デフォルト値: kubelet が Pod の Docker イメージを pull するタイミングを決定します。有効な値は次のとおりです。
詳細については、イメージの更新をご覧ください。 |
runtime.image.tag |
導入バージョン: 1.0.0
デフォルト値: このサービスの Docker イメージのバージョン ラベル。 |
runtime.image.url |
導入バージョン: 1.0.0
デフォルト値: インストールのイメージ リソースの URL( このサービスの Docker イメージの場所。 |
runtime.livenessProbe.failureThreshold |
導入バージョン: 1.0.0 デフォルト値: Kubernetes が検出する livenessProbe の失敗回数。この数に達すると、コンテナが再起動されます。最小値は 1 です。 |
runtime.livenessProbe.initialDelaySeconds |
導入バージョン: 1.0.0 デフォルト値: コンテナが起動してから livenessProbe が開始されるまでの秒数。 |
runtime.livenessProbe.periodSeconds |
導入バージョン: 1.0.0 デフォルト値: livenessProbe を実行する頻度を秒単位で指定します。最小値は 1 です。 |
runtime.livenessProbe.timeoutSeconds |
導入バージョン: 1.0.0 デフォルト値: livenessProbe がタイムアウトするまでの秒数。最小値は 1 です。 |
runtime.nodeSelector.key |
導入バージョン: 1.0.0
デフォルト値: なし (省略可) nodeSelector のプロパティをご覧ください。 |
runtime.nodeSelector.value |
導入バージョン: 1.0.0
デフォルト値: なし
専用ノードプールの構成をご覧ください。 |
runtime.readinessProbe.failureThreshold |
導入バージョン: 1.0.0 デフォルト値: Kubernetes が検出する readinessProbe の失敗回数。この数に達すると、Pod が「準備未完了」とマークされます。最小値は 1 です。 |
runtime.readinessProbe.initialDelaySeconds |
導入バージョン: 1.0.0 デフォルト値: コンテナが起動してから readinessProbe が開始されるまでの秒数。 |
runtime.readinessProbe.periodSeconds |
導入バージョン: 1.0.0 デフォルト値: readinessProbe の実行頻度を秒単位で指定します。最小値は 1 です。 |
runtime.readinessProbe.successThreshold |
導入バージョン: 1.0.0 デフォルト値: 失敗した readinessProbe が成功とみなされるために必要な最小の連続成功回数。最小値は 1 です。 |
runtime.readinessProbe.timeoutSeconds |
導入バージョン: 1.0.0 デフォルト値: livenessProbe がタイムアウトするまでの秒数。最小値は 1 です。 |
runtime.replicaCountMax |
導入バージョン: 1.0.0
デフォルト値: 自動スケーリングに使用できるレプリカの最大数。 |
runtime.replicaCountMin |
導入バージョン: 1.0.0
デフォルト値: 自動スケーリングに使用できるレプリカの最小数。 |
runtime.resources.requests.cpu |
導入バージョン: 1.0.0
デフォルト値: Kubernetes コンテナ内のリソースの通常オペレーションに必要な CPU(ミリコア単位)。 |
runtime.resources.requests.memory |
導入バージョン: 1.0.0
デフォルト値: Kubernetes コンテナ内のリソースの通常オペレーションに必要なメモリ。単位はメビバイト( |
runtime.service.type |
導入バージョン: 1.0.0
デフォルト値: サービスのタイプ。これは ClusterIP 以外のサービスに設定できます(例: |
runtime.targetCPUUtilizationPercentage |
導入バージョン: 1.0.0
デフォルト値: Pod 上のランタイム プロセスのターゲット CPU 使用率。CPU 使用率がこのフィールドの値に達すると、ランタイムが( |
runtime.terminationGracePeriodSeconds |
導入バージョン: 1.0.0 デフォルト値: Pod の削除リクエストから実際に Pod が強制終了されるまでの時間(秒単位)。この期間中に preStop フックが実行され、動作中のすべてのプロセスが正常に終了します。 |
synchronizer
Synchronizer は、デプロイされた最新の API プロキシ バンドルによって Message Processor を最新の状態に維持します。このために、Synchronizer は管理プレーンに対してポーリングを行い、新しい契約が検出されるとそれをランタイム プレーンに送信します。Synchronizer は、デフォルトで環境構成データを Cassandra に保存します。
詳細については、Synchronizer をご覧ください。
次の表に、synchronizer
オブジェクトのプロパティを示します。
プロパティ | 説明 |
---|---|
synchronizer.image.pullPolicy |
導入バージョン: 1.0.0
デフォルト値: kubelet が Pod の Docker イメージを pull するタイミングを決定します。有効な値は次のとおりです。
詳細については、イメージの更新をご覧ください。 |
synchronizer.image.tag |
導入バージョン: 1.0.0
デフォルト値: このサービスの Docker イメージのバージョン ラベル。 |
synchronizer.image.url |
導入バージョン: 1.0.0
デフォルト値: このサービスの Docker イメージの場所。 |
synchronizer.livenessProbe.failureThreshold |
導入バージョン: 1.0.0 デフォルト値: Kubernetes が検出する livenessProbe の失敗回数。この数に達すると、コンテナが再起動されます。最小値は 1 です。 |
synchronizer.livenessProbe.initialDelaySeconds |
導入バージョン: 1.0.0 デフォルト値: コンテナが起動してから livenessProbe が開始されるまでの秒数。 |
synchronizer.livenessProbe.periodSeconds |
導入バージョン: 1.0.0 デフォルト値: livenessProbe を実行する頻度を秒単位で指定します。最小値は 1 です。 |
synchronizer.livenessProbe.timeoutSeconds |
導入バージョン: 1.0.0 デフォルト値: livenessProbe がタイムアウトするまでの秒数。最小値は 1 です。 |
synchronizer.nodeSelector.key |
導入バージョン: 1.0.0
デフォルト値: なし 必須
nodeSelector をご覧ください。 |
synchronizer.nodeSelector.value |
導入バージョン: 1.0.0
デフォルト値: なし (省略可) nodeSelector をご覧ください。 |
synchronizer.pollInterval |
導入バージョン: 1.0.0
デフォルト値: Synchronizer がポーリングを行う間隔。Synchronizer は Apigee コントロール プレーン サービスに対してポーリングを行います。新しいランタイム契約が検出されると、それを pull します。 |
synchronizer.readinessProbe.failureThreshold |
導入バージョン: 1.0.0 デフォルト値: Kubernetes が検出する readinessProbe の失敗回数。この数に達すると、Pod が「準備未完了」とマークされます。最小値は 1 です。 |
synchronizer.readinessProbe.initialDelaySeconds |
導入バージョン: 1.0.0 デフォルト値: コンテナが起動してから readinessProbe が開始されるまでの秒数。 |
synchronizer.readinessProbe.periodSeconds |
導入バージョン: 1.0.0 デフォルト値: readinessProbe の実行頻度を秒単位で指定します。最小値は 1 です。 |
synchronizer.readinessProbe.successThreshold |
導入バージョン: 1.0.0 デフォルト値: 失敗した readinessProbe が成功とみなされるために必要な最小の連続成功回数。最小値は 1 です。 |
synchronizer.readinessProbe.timeoutSeconds |
導入バージョン: 1.0.0 デフォルト値: livenessProbe がタイムアウトするまでの秒数。最小値は 1 です。 |
synchronizer.replicaCount |
導入バージョン: 1.0.0
デフォルト値: 自動スケーリングのレプリカの数。 |
synchronizer.replicaCountMax |
導入バージョン: 1.2.0 デフォルト値: 自動スケーリングのレプリカの最大数。 |
synchronizer.replicaCountMin |
導入バージョン: 1.2.0 デフォルト値: 自動スケーリングのレプリカの最小数。 |
synchronizer.resources.requests.cpu |
導入バージョン: 1.0.0
デフォルト値: Kubernetes コンテナ内のリソースの通常のオペレーションに必要な CPU(ミリコア単位)。 |
synchronizer.resources.requests.memory |
導入バージョン: 1.0.0
デフォルト値: Kubernetes コンテナ内のリソースの通常のオペレーションに必要なメモリ(GB 単位)。 |
synchronizer.serviceAccountPath |
導入バージョン: 1.0.0
デフォルト値: なし
Apigee Synchronizer 管理者ロールを持つ Google サービス アカウント キーファイルへのパス。 |
synchronizer.serviceAccountSecretRef |
導入バージョン: 1.2.0 デフォルト値: なし
Kubernetes Secret の名前。Apigee Synchronizer 管理者ロールを持つ Google サービス アカウント キーを入力として使用し、Secret を作成する必要があります。 |
synchronizer.targetCPUUtilizationPercentage |
バージョン導入: 1.0.0 デフォルト値:
Pod 上の Synchronizer プロセスのターゲット CPU 使用率。CPU 使用率がこのフィールドの値に達すると、Synchronizer が( |
synchronizer.terminationGracePeriodSeconds |
導入バージョン: 1.0.0 デフォルト値: Pod の削除リクエストから実際に Pod が強制終了されるまでの時間(秒単位)。この期間中に preStop フックが実行され、動作中のすべてのプロセスが正常に終了します。 |
udca
(Universal Data Collection Agent)ランタイム プレーンのデータ収集 Pod で実行されるサービスを定義します。このサービスは、アナリティクスとデプロイのステータスデータを抽出し、統合アナリティクス プラットフォーム(UAP)に送信します。
詳細については、分析とデプロイのステータス データの収集をご覧ください。
次の表に、udca
オブジェクトのプロパティを示します。
プロパティ | 説明 |
---|---|
udca.fluentd.image.pullPolicy |
導入バージョン: 1.0.0
デフォルト値: kubelet が Pod の Docker イメージを pull するタイミングを決定します。有効な値は次のとおりです。
詳細については、イメージの更新をご覧ください。 |
udca.fluentd.image.tag |
導入バージョン: 1.0.0
デフォルト値: このサービスの Docker イメージのバージョン ラベル。 |
udca.fluentd.image.url |
導入バージョン: 1.0.0
デフォルト値: このサービスの Docker イメージの場所。 |
udca.fluentd.resource.limits.memory |
導入バージョン: 1.0.0
デフォルト値: Kubernetes コンテナ内のリソースのメモリ上限(MiB 単位)。
|
udca.fluentd.resource.requests.cpu |
導入バージョン: 1.0.0
デフォルト値: Kubernetes コンテナ内のリソースの通常のオペレーションに必要な CPU(ミリコア単位)。 |
udca.fluentd.resource.requests.memory |
導入バージョン: 1.0.0
デフォルト値: Kubernetes コンテナ内のリソースの通常のオペレーションに必要なメモリ(MiB 単位)。 |
udca.image.pullPolicy |
導入バージョン: 1.0.0 デフォルト値: IfNotPresent kubelet が Pod の Docker イメージを pull するタイミングを決定します。有効な値は次のとおりです。
詳細については、イメージの更新をご覧ください。 |
udca.image.tag |
導入バージョン: 1.0.0
デフォルト値: このサービスの Docker イメージのバージョン ラベル。 |
udca.image.url |
導入バージョン: 1.0.0
デフォルト値: このサービスの Docker イメージの場所。 |
udca.jvmXms |
導入バージョン: 1.0.0
デフォルト値: データ収集 Pod の JVM の初期メモリ量。 |
udca.jvmXmx |
導入バージョン: 1.0.0
デフォルト値: データ収集 Pod の JVM の最大メモリ割り当て量。 |
udca.livenessProbe.failureThreshold |
導入バージョン: 1.0.0 デフォルト値: Kubernetes が検出する livenessProbe の失敗回数。この数に達すると、コンテナが再起動されます。最小値は 1 です。 |
udca.livenessProbe.initialDelaySeconds |
導入バージョン: 1.0.0 デフォルト値: コンテナが起動してから livenessProbe が開始されるまでの秒数。 |
udca.livenessProbe.periodSeconds |
導入バージョン: 1.0.0 デフォルト値: livenessProbe を実行する頻度を秒単位で指定します。最小値は 1 です。 |
udca.livenessProbe.timeoutSeconds |
導入バージョン: 1.0.0 デフォルト値: livenessProbe がタイムアウトするまでの秒数。最小値は 1 です。 |
udca.nodeSelector.key |
導入バージョン: 1.0.0
デフォルト値: なし 必須
専用ノードプールの構成をご覧ください。 |
udca.nodeSelector.value |
導入バージョン: 1.0.0
デフォルト値: なし 必須
専用ノードプールの構成をご覧ください。 |
udca.pollingIntervalInSec |
導入バージョン: 1.0.0
デフォルト値: UDCA がポーリングを行う間隔(秒単位)。UDCA は、データ収集 Pod のファイル システム上にあるデータ ディレクトリをポーリングして、アップロードする新しいファイルを検出します。 |
udca.replicaCountMax |
導入バージョン: 1.0.0
デフォルト値: 自動的に追加できる UDCA デプロイ用の Pod の最大数。UDCA は ReplicaSet として実装されているため、Pod はレプリカです。 |
udca.replicaCountMin |
導入バージョン: 1.0.0
デフォルト値: UDCA デプロイ用の Pod の最小数。UDCA は ReplicaSet として実装されているため、これらの Pod はレプリカです。 CPU 使用率が |
udca.resources.requests.cpu |
導入バージョン: 1.0.0
デフォルト値: Kubernetes コンテナ内のリソースの通常のオペレーションに必要な CPU(ミリコア単位)。 |
udca.revision |
導入バージョン: 1 デフォルト値: カナリア デプロイを有効にするためにラベルに挿入される静的な値。 |
udca.serviceAccountPath |
導入バージョン: 1.0.0
デフォルト値: なし
Apigee Analytics エージェント ロールを持つ Google サービス アカウント キーファイルへのパス。 |
udca.serviceAccountSecretRef |
導入バージョン: 1.2.0 デフォルト値: なし serviceAccountPath または serviceAccountSecretRef のいずれかが必要です。 Kubernetes Secret の名前。Apigee Analytics エージェント ロールを持つ Google サービス アカウント キーを入力として使用し、Secret を作成する必要があります。 |
udca.targetCPUUtilizationPercentage |
バージョン導入: 1.0.0 デフォルト値: ReplicaSet 内の Pod 数のスケーリングに使用する CPU 使用率のしきい値。使用可能な CPU リソースの総量に対する割合で指定します。現在の CPU 使用率は、データ収集 Pod(fluentd と UDCA の両方)内のすべてのコンテナの CPU 使用率を集計して計算されます。 CPU 使用率がこの値を超えると、ReplicaSet 内の Pod の数が徐々に( |
udca.terminationGracePeriodSeconds |
導入バージョン: 1.0.0 デフォルト値: Pod の削除リクエストから実際に Pod が強制終了されるまでの時間(秒単位)。この期間中に preStop フックが実行され、動作中のすべてのプロセスが正常に終了します。 |
virtualhosts
virtualhosts
プロパティは必須の構成プロパティです。仮想ホストにより、Apigee ハイブリッドは指定された環境グループに対する API リクエストを処理できます。
詳細については、仮想ホストを構成するをご覧ください。
次の表に、virtualhosts
オブジェクトのプロパティを示します。
プロパティ | 説明 |
---|---|
virtualhosts[].additionalGateways |
導入バージョン: 1.2.0 デフォルト値: なし トラフィックのルーティング先となる Istio ゲートウェイのリスト。 |
virtualhosts[].name |
導入バージョン: 1.2.0 デフォルト値: なし 必須 仮想ホストの名前。 |
virtualhosts[].hostAliases[] |
導入バージョン: 1.2.0 デフォルト値: なし 必須 Deprecated: ハイブリッド バージョン 1.4 以降では、ランタイム プレーンは管理プレーンからこの情報を受け取ります。環境と環境グループについてをご覧ください。 |
virtualhosts[].maxTLSProtocolVersion |
導入バージョン: 1.3.0 デフォルト値: なし Envoy で選択できる TLS プロトコルの最大バージョン。Envoy では、 値は数値の形式にする必要があります。次に例を示します。 virtualhosts: - name: default maxTLSProtocolVersion: "1.3"
この数値は、 Istio ドキュメントの |
virtualhosts[].minTLSProtocolVersion |
導入バージョン: 1.3.0 デフォルト値: なし Envoy で選択できる TLS プロトコルの最小バージョン。Envoy では、 値は数値の形式にする必要があります。次に例を示します。 virtualhosts: - name: default minTLSProtocolVersion: "1.2"
この数値は、 Istio ドキュメントの |
virtualhosts[].selector |
導入バージョン: 1.2.0 デフォルト値: 必須 異なる Ingress セレクタを参照する Key-Value セレクタ値のペア。 |
virtualhosts[].sslCertPath |
導入バージョン: 1.2.0 デフォルト値: なし
システム上の TLS 証明書ファイルへのパス。 |
virtualhosts[].sslKeyPath |
導入バージョン: 1.2.0 デフォルト値: なし
TLS 秘密鍵ファイルへのシステム上のパス。 |
virtualhosts[].sslSecret |
導入バージョン: 1.2.0 デフォルト値: なし
TLS 証明書と秘密鍵を含む、Kubernetes Secret に格納されているファイルの名前。TLS 証明書と鍵データを入力として使用し、この Secret を作成する必要があります。 関連項目:
|
watcher
watcher
プロパティは必須の構成プロパティです。ウォッチャーは、構成の変更を監視し、アプリケーションをランタイム プレーンにトリガーするプロセスです。
次の表に、watcher
オブジェクトのプロパティを示します。
プロパティ | 説明 |
---|---|
watcher.replicaCountMax |
バージョン導入: 1.3.0 デフォルト値: ウォッチャー レプリカの最大数。競合を避けるため、 |
watcher.replicaCountMin |
導入バージョン: 1.3.0 デフォルト値: watcher レプリカの最小数。 |
watcher.serviceAccountPath |
導入バージョン: 1.3.0 デフォルト値: なし 必須 Apigee ランタイム エージェント ロールを持つ Google サービス アカウント キーファイルへのパス。 |
watcher.serviceAccountSecretRef |
導入バージョン: 1.3.0 デフォルト値: なし serviceAccountPath または serviceAccountSecretRef のいずれかが必要です。 Kubernetes Secret の名前。Apigee ランタイム エージェント ロールを持つ Google サービス アカウント キーを入力として使用し、Secret を作成する必要があります。 |