CephClient v1 — ceph.rook.io

apiVersion string

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 string

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

metadata object required

spec object required

Spec represents the specification of a Ceph Client

caps object required

name string

removeSecret boolean

RemoveSecret indicates whether the current secret for this ceph client should be removed or not. If true, the K8s secret will be deleted, but the cephx keyring will remain until the CR is deleted.

secretName string

SecretName is the name of the secret created for this ceph client. If not specified, the default name is "rook-ceph-client-" as a prefix to the CR name.

security object

Security represents security settings

cephx object

CephX configures CephX key settings. More: https://docs.ceph.com/en/latest/dev/cephx/

keyGeneration integer

KeyGeneration specifies the desired CephX key generation. This is used when KeyRotationPolicy is KeyGeneration and ignored for other policies. If this is set to greater than the current key generation, relevant keys will be rotated, and the generation value will be updated to this new value (generation values are not necessarily incremental, though that is the intended use case). If this is set to less than or equal to the current key generation, keys are not rotated.

format: int64

minimum: 0

maximum: 4.294967295e+09

keyRotationPolicy string

KeyRotationPolicy controls if and when CephX keys are rotated after initial creation. One of Disabled, or KeyGeneration. Default Disabled.

enum: , Disabled, KeyGeneration

keyType string

KeyType specifies the desired CephX key cipher type. If unspecified, Ceph's default will be used. If KeyRotationPolicy is Disabled or unspecified (default), modifying this value will never initiate key rotation. If KeyRotationPolicy is set to an enabled value (any other value), modifying this may initiate key rotation.

enum: aes, aes256k

minLength: 3

maxLength: 7

status object

Status represents the status of a Ceph Client

cephx object

keyCephVersion string

KeyCephVersion reports the Ceph version that created the current generation's keys. This is same string format as reported by `CephCluster.status.version.version` to allow them to be compared. E.g., `20.2.0-0`. For all newly-created resources, this field set to the version of Ceph that created the key. The special value "Uninitialized" indicates that keys are being created for the first time. An empty string indicates that the version is unknown, as expected in brownfield deployments.

keyGeneration integer

KeyGeneration represents the CephX key generation for the last successful reconcile. For all newly-created resources, this field is set to `1`. When keys are rotated due to any rotation policy, the generation is incremented or updated to the configured policy generation. Generation `0` indicates that keys existed prior to the implementation of key tracking.

format: int32

keyType string

KeyType identifies the CephX key type for the current generation's keys, if known. If unknown, the value will be empty.

minLength: 3

maxLength: 7

info object

observedGeneration integer

ObservedGeneration is the latest generation observed by the controller.

format: int64

phase string

ConditionType represent a resource's status