11.9. External Secrets Operator for Red Hat OpenShift の API

apiVersion

string

apiVersion は、使用中のスキーマのバージョン (operator.openshift.io/v1alpha1) を示します。

kind

string

kind は、オブジェクトの種類を示します。この API の場合は externalSecretsManagerList です。

metadata

ListMeta

metadata フィールドの詳細は、Kubernetes API ドキュメントを参照してください。

items

array

apiVersion

string

apiVersion は、使用中のスキーマのバージョン (operator.openshift.io/v1alpha1) を示します。

kind

string

kind は、オブジェクトの種類を示します。このオブジェクトの場合は externalSecretsManager です。

metadata

ObjectMeta

metadata フィールドの詳細は、Kubernetes API ドキュメントを参照してください。

spec

object

spec には、望ましい動作の仕様を含めます。

status

object

status は、External Secrets Operator 内のコントローラーの直近に観測された状態を示します。

apiVersion

string

apiVersion は、使用中のスキーマのバージョン (operator.openshift.io/v1alpha1) を示します。

kind

string

kind は、オブジェクトの種類を示します。この API の場合は externalSecretsList です。

metadata

ListMeta

metadata フィールドの詳細は、Kubernetes API ドキュメントを参照してください。

items

array

items には、externalSecrets オブジェクトのリストが格納されます。

apiVersion

string

apiVersion は、使用中のスキーマのバージョン (operator.openshift.io/v1alpha1) を示します。

kind

string

kind は、オブジェクトの種類を示します。このオブジェクトの場合は externalSecrets です。

metadata

ObjectMeta

metadata フィールドの詳細は、Kubernetes API ドキュメントを参照してください。

spec

object

spec には、externalSecrets オブジェクトの望ましい動作の仕様を含めます。

status

object

status は、externalSecrets オブジェクトの直近に観測されたステータスを示します。

globalConfig

object

globalConfig は、External Secrets Operator が管理するデプロイメントの動作を設定します。

任意

controllerStatuses

array

controllerStatuses には、Operator が使用するコントローラーの観測された状態が格納されます。

lastTransitionTime

Time

lastTransitionTime には、状態のステータスが変更された最新の時刻が記録されます。

形式: date-time

型: string

appConfig

object

appConfig は、external-secrets オペランドの動作を設定します。

任意

plugins

object

plugins は、オプションのプロバイダープラグインを設定します。

任意

controllerConfig

object

controllerConfig は、external-secrets オペランドを有効にするデフォルト値を設定するようにコントローラーを設定します。

任意

conditions

Condition の 配列

conditions には、デプロイメントの現在の状態に関する情報が格納されます。

externalSecretsImage

string

externalSecretsImage は、デプロイメントの external-secrets オペランドに使用するイメージの名前とタグを指定します。

bitwardenSDKServerImage

string

bitwardenSDKServerImage は、bitwarden-sdk-server をデプロイするために使用するイメージとタグの名前を指定します。

labels

integer

labels は、Operator によって作成されるすべてのリソースに適用されます。このフィールドには最大 20 個のエントリーを設定できます。

1

プロパティーの最大数は 20 です。

プロパティーの最小数は 0 です。

任意

logLevel

integer

logLevel は、Kubernetes のロギングガイドライン で定義されている値の範囲をサポートしています。

1

範囲の最大値は 5 です。

範囲の最小値は 1 です。

任意

resources

ResourceRequirements

resources ではリソースの要件を定義します。このフィールドの値は、最初に設定した後は変更できません。詳細は、https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ を参照してください。

任意

affinity

Affinity

affinity は、スケジューリングのアフィニティールールを設定します。詳細は、https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/ を参照してください。

任意

tolerations

Toleration の 配列

tolerations は Pod の toleration を設定します。詳細は、https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/ を参照してください。

項目の最大数は 50 です。

項目の最小数は 0 です。

任意

nodeSelector

object (keys:string, values:string)

nodeSelector では、ノードラベルを使用してスケジューリングの基準を定義します。詳細は、https://kubernetes.io/docs/concepts/configuration/assign-pod-node/ を参照してください。

プロパティーの最大数は 50 です。

プロパティーの最小数は 0 です。

任意

proxy

object

proxy は、Operator によって管理されるオペランドコンテナーで使用可能なプロキシー設定を、環境変数として設定します。

任意

certProvider

string

certProvider は、Webhook およびプラグインの TLS 証明書を管理するために使用する証明書プロバイダーの設定を定義します。

任意

labels

object (keys:string, values:string)

labels フィールドは、external-secrets オペランドのデプロイメント用に作成されたすべてのリソースにラベルを適用します。

プロパティーの最大数は 20 です。

プロパティーの最小数は 0 です。

任意

name

string

name は、観測された状態が記録されるコントローラーの名前を示します。

必須

conditions

array

conditions には、External Secrets Operator コントローラーの現在の状態に関する情報が格納されます。

observedGeneration

integer

observedGeneration は、観測対象リソースの .metadata.generation を表します。

観測対象リソースの最小数は 0 です。

logLevel

integer

logLevel は、Kubernetes のロギングガイドライン で定義されている値の範囲をサポートしています。

1

範囲の最大値は 5 です。

範囲の最小値は 1 です。

任意

operatingNamespace

string

operatingNamespace は、external-secrets オペランドの操作を、指定した namespace に制限します。このフィールドを有効にすると、ClusterSecretStore と ClusterExternalSecret が無効になります。

最大長は 63 です。

最小長は 1 です。

任意

webhookConfig

object

webhookConfig は、external-secrets オペランドの Webhook の詳細を設定します。

resources

ResourceRequirements

resources ではリソースの要件を定義します。このフィールドの値は、最初に設定した後は変更できません。詳細は、https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ を参照してください。

任意

affinity

Affinity

affinity は、スケジューリングのアフィニティールールを設定します。詳細は、https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/ を参照してください。

任意

tolerations

Toleration の 配列

tolerations は Pod の toleration を設定します。詳細は、https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/ を参照してください。

項目の最大数は 50 です。

項目の最小数は 0 です。

任意

nodeSelector

object (keys:string, values:string)

nodeSelector では、ノードラベルを使用してスケジューリングの基準を定義します。詳細は、https://kubernetes.io/docs/concepts/configuration/assign-pod-node/ を参照してください。

プロパティーの最大数は 50 です。

プロパティーの最小数は 0 です。

任意

proxy

object (keys:string, values:string)

proxy は、Operator によって管理されるオペランドコンテナーで使用可能なプロキシー設定を、環境変数として設定します。

任意

mode

string

mode フィールドは、bitwardenSecretManagerProvider プロバイダーの状態を有効にします。これは、Enabled または Disabled に設定できます。Enabled に設定すると、Operator により、プラグインがデプロイおよび同期されていることが確認されます。Disabled に設定すると、Bitwarden プロバイダープラグインのリコンシリエーションが無効になります。プラグインとリソースは現在の状態のままとなり、Operator によって管理されません。

Disabled

enum: [Enabled Disabled]

任意

secretRef

SecretReference

SecretRef は、Bitwarden サーバーの TLS 鍵ペアを含む Kubernetes シークレットを指定します。この参照が提供されず、certManagerConfig フィールドが設定されている場合、certManagerConfig で定義された発行者が必要な証明書を生成します。シークレットでは、証明書には tls.crt、秘密鍵には tls.key、CA 証明書には ca.crt を使用する必要があります。

任意

certificateCheckInterval

Duration

certificateCheckInterval は、証明書の有効性をチェックするためのポーリングの間隔を設定します。

5m

任意

mode

string

mode は、組み込みの cert-controller の代わりに cert-manager を使用して証明書を管理するかどうかを指定します。これは、Enabled または Disabled を設定することで指定されます。Enabled に設定すると、Webhook サーバーおよびその他のコンポーネントの証明書を取得するために cert-manager が使用されます。Disabled に設定すると、Webhook サーバーの証明書を取得するために cert-controller が使用されます。Disabled がデフォルトの動作です。

false

enum: [true false]

必須

injectAnnotations

string

injectAnnotations は、cert-manager Operator の認証局 (CA) を使用して Webhook を自動的に設定するために、cert-manager.io/inject-ca-from アノテーションを Webhook とカスタムリソース定義 (CRD) に追加します。これを行うには、cert-manager Operator で CA インジェクターを有効にする必要があります。このフィールドは true または false に設定します。設定すると、このフィールドは変更できなくなります。

false

enum: [true false]

任意

issuerRef

ObjectReference

issuerRef には、証明書を取得するために使用する参照オブジェクトの詳細が格納されます。クラスタースコープの cert-manager Operator 発行者が使用されていない限り、オブジェクトは external-secrets namespace に存在する必要があります。

必須

certificateDuration

Duration

certificateDuration は、Webhook 証明書の有効期間を設定します。

8760h

任意

certificateRenewBefore

Duration

certificateRenewBefore は、有効期限が切れるどれくらい前に Webhook 証明書を更新するかを設定します。

30m

任意

certManager

object

certManager は、cert-manager プロバイダー固有の設定を定義します。

任意

name

string

name は、参照されるリソースの名前を指定します。

最大長は 253 文字です。

最小長は 1 文字です。

必須

kind

string

kind は、参照されるリソースの種類を指定します。

最大長は 253 文字です。

最小長は 1 文字です。

任意

group

string

group は、参照されるリソースのグループを指定します。

最大長は 253 文字です。

最小長は 1 文字です。

任意

name

string

name は、参照されるシークレットリソースの名前を指定します。

最大長は 253 です。

最小長は 1 です。

必須

type

string

type には、デプロイメントの状態が格納されます。

必須

status

ConditionStatus

status には、デプロイメントの状態のステータスが格納されます。

message

string

message は、デプロイメントの状態の詳細を提供します。

conditions

array

conditions には、デプロイメントの現在の状態に関する情報が格納されます。

Enabled

Enabled は、オプションの設定が有効であることを示します。

Disabled

Disabled は、オプションの設定が無効であることを示します。

bitwardenSecretManagerProvider

object

bitwardenSecretManagerProvider は、'bitwarden-secrets-manager' に接続するために、bitwarden-secrets-manager プロバイダープラグインを有効にします。

任意

httpProxy

string

httpProxy フィールドには、HTTP リクエスト用のプロキシーの URL が格納されます。このフィールドには最大 2048 文字まで入力できます。

最大長は 2048 文字です。

最小長は 0 文字です。

任意

httpsProxy

string

httpsProxy フィールドには、HTTPS リクエスト用のプロキシーの URL が格納されます。このフィールドには最大 2048 文字まで入力できます。

最大長は 2048 文字です。

最小長は 0 文字です。

任意

noProxy

string

noProxy フィールドは、プロキシーを使用してはならないホスト名、Classless Inter-Domain Routing (CIDR)、IP アドレス、またはこれら 3 つを組み合わせたもののコンマ区切りリストです。このフィールドには最大 4096 文字まで入力できます。

最大長は 4096 文字です。

最小長は 0 文字です。

任意