The CouchbaseEncryptionKey resource is used to manage encryption keys for a Couchbase cluster. CouchbaseEncryptionKey is the Schema for the couchbaseencryptionkeys API.
4 top-level fields · unchanged since Couchbase Operator 2.9.0
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
CouchbaseEncryptionKeySpec defines the desired state of CouchbaseEncryptionKey.
AutoGenerated defines settings for auto-generated keys. This field is only valid when KeyType is "AutoGenerated".
CanBeCached defines whether the key can be cached.
EncryptWithKey is the name of another encryption key to use to encrypt the auto-generated key. If not provided, the key will be encrypted with the master password.
Rotation defines the rotation settings for the auto-generated key. If not provided, the key will not be rotated.
IntervalDays defines the rotation interval in days.
StartTime defines when rotation should start (timestamp).
AwsKey defines settings for AWS KMS keys. This field is only valid when KeyType is "AWS".
CredentialSecret is the name of the secret containing AWS credentials. The secret must contain a key with the name "credentials" with the data value of the AWS credentials file.
KeyArn is the ARN of the AWS KMS key.
KeyRegion is the AWS region where the key is located.
ProfileName is the name of the profile to use from the credentials secret.
UseImds defines whether to use IMDS for authentication.
KeyType defines the type of encryption key. This field is immutable after creation.
KmipKey defines settings for KMIP keys. This field is only valid when KeyType is "KMIP".
ClientSecret is the name of the secret containing the client private key, cert and passphrase. The secret must contain the keys "tls.crt", "tls.key", and "passphrase" with the data value of the client cert, key in encrypted pkcs8 format, and the passphrase for the key respectively.
EncryptionApproach defines the encryption approach to use.
Host is the KMIP server host.
KeyID is the KMIP key identifier.
Port is the KMIP server port.
TimeoutInMs is the timeout in milliseconds.
VerifyWithCouchbaseCA defines whether to verify with Couchbase CA.
VerifyWithSystemCA defines whether to verify with system CA.
Usage defines what the encryption key should be used for.
AllBuckets defines whether the key should be used for all buckets.
Audit defines whether the key should be used for audit.
Configuration defines whether the key should be used for configurations.
Key defines whether the key should be used for keys.
Log defines whether the key should be used for logs.
Source: couchbase.crds.yaml
Changes to CouchbaseEncryptionKey (couchbase.com/v2) in each Couchbase Operator version, compared to the version before it.
CouchbaseEncryptionKey was first seen on this version of Couchbase Operator
Released · View CouchbaseEncryptionKey in 2.9.0
No examples of CouchbaseEncryptionKey yet. Contribute one on GitHub.
kubespec.dev