ceph.rook.io / v1 / CephObjectStore

• string

  .apiVersion

  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

• string

  .kind

  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

• object required

  .metadata

• object required

  .spec

  ObjectStoreSpec represent the spec of a pool

• array

  .spec .allowUsersInNamespaces

  The list of allowed namespaces in addition to the object store namespace where ceph object store users may be created. Specify “*” to allow all namespaces, otherwise list individual namespaces that are to be allowed. This is useful for applications that need object store credentials to be created in their own namespace, where neither OBCs nor COSI is being used to create buckets. The default is empty.

• object

  .spec .auth

  The authentication configuration

• object | null

  .spec .auth .keystone

  The spec for Keystone

• array required

  .spec .auth .keystone .acceptedRoles

  The roles requires to serve requests.

• string

  .spec .auth .keystone .implicitTenants

  Create new users in their own tenants of the same name. Possible values are true, false, swift and s3. The latter have the effect of splitting the identity space such that only the indicated protocol will use implicit tenants.

• integer | null

  .spec .auth .keystone .revocationInterval

  The number of seconds between token revocation checks.

• string required

  .spec .auth .keystone .serviceUserSecretName

  The name of the secret containing the credentials for the service user account used by RGW. It has to be in the same namespace as the object store resource.

• integer | null

  .spec .auth .keystone .tokenCacheSize

  The maximum number of entries in each Keystone token cache.

• string required

  .spec .auth .keystone .url

  The URL for the Keystone server.

• object | null

  .spec .dataPool

  The data pool settings

• string

  .spec .dataPool .application

  The application name to set on the pool. Only expected to be set for rgw pools.

• string | null

  .spec .dataPool .compressionMode

  DEPRECATED: use Parameters instead, e.g., Parameters[“compression_mode”] = “force” The inline compression mode in Bluestore OSD to set to (options are: none, passive, aggressive, force) Do NOT set a default value for kubebuilder as this will override the Parameters

• string | null

  .spec .dataPool .crushRoot

  The root of the crush hierarchy utilized by the pool

• string | null

  .spec .dataPool .deviceClass

  The device class the OSD should set to for use in the pool

• boolean

  .spec .dataPool .enableCrushUpdates

  Allow rook operator to change the pool CRUSH tunables once the pool is created

• boolean

  .spec .dataPool .enableRBDStats

  EnableRBDStats is used to enable gathering of statistics for all RBD images in the pool

• object

  .spec .dataPool .erasureCoded

  The erasure code settings

• string

  .spec .dataPool .erasureCoded .algorithm

  The algorithm for erasure coding

• integer required

  .spec .dataPool .erasureCoded .codingChunks

  Number of coding chunks per object in an erasure coded storage pool (required for erasure-coded pool type). This is the number of OSDs that can be lost simultaneously before data cannot be recovered.

• integer required

  .spec .dataPool .erasureCoded .dataChunks

  Number of data chunks per object in an erasure coded storage pool (required for erasure-coded pool type). The number of chunks required to recover an object when any single OSD is lost is the same as dataChunks so be aware that the larger the number of data chunks, the higher the cost of recovery.

• string

  .spec .dataPool .failureDomain

  The failure domain: osd/host/(region or zone if available) - technically also any type in the crush map

• object

  .spec .dataPool .mirroring

  The mirroring settings

• boolean

  .spec .dataPool .mirroring .enabled

  Enabled whether this pool is mirrored or not

• string

  .spec .dataPool .mirroring .mode

  Mode is the mirroring mode: pool, image or init-only.

• object | null

  .spec .dataPool .mirroring .peers

  Peers represents the peers spec

• array

  .spec .dataPool .mirroring .peers .secretNames

  SecretNames represents the Kubernetes Secret names to add rbd-mirror or cephfs-mirror peers

• array

  .spec .dataPool .mirroring .snapshotSchedules

  SnapshotSchedules is the scheduling of snapshot for mirrored images/pools

• string

  .spec .dataPool .mirroring .snapshotSchedules[] .interval

  Interval represent the periodicity of the snapshot.

• string

  .spec .dataPool .mirroring .snapshotSchedules[] .path

  Path is the path to snapshot, only valid for CephFS

• string

  .spec .dataPool .mirroring .snapshotSchedules[] .startTime

  StartTime indicates when to start the snapshot

• object | null

  .spec .dataPool .parameters

  Parameters is a list of properties to enable on a given pool

• object | null

  .spec .dataPool .quotas

  The quota settings

• integer

  .spec .dataPool .quotas .maxBytes

  MaxBytes represents the quota in bytes Deprecated in favor of MaxSize

• integer

  .spec .dataPool .quotas .maxObjects

  MaxObjects represents the quota in objects

• string

  .spec .dataPool .quotas .maxSize

  MaxSize represents the quota in bytes as a string

• object

  .spec .dataPool .replicated

  The replication settings

• object | null

  .spec .dataPool .replicated .hybridStorage

  HybridStorage represents hybrid storage tier settings

• string required

  .spec .dataPool .replicated .hybridStorage .primaryDeviceClass

  PrimaryDeviceClass represents high performance tier (for example SSD or NVME) for Primary OSD

• string required

  .spec .dataPool .replicated .hybridStorage .secondaryDeviceClass

  SecondaryDeviceClass represents low performance tier (for example HDDs) for remaining OSDs

• integer

  .spec .dataPool .replicated .replicasPerFailureDomain

  ReplicasPerFailureDomain the number of replica in the specified failure domain

• boolean

  .spec .dataPool .replicated .requireSafeReplicaSize

  RequireSafeReplicaSize if false allows you to set replica 1

• integer required

  .spec .dataPool .replicated .size

  Size - Number of copies per object in a replicated storage pool, including the object itself (required for replicated pool type)

• string

  .spec .dataPool .replicated .subFailureDomain

  SubFailureDomain the name of the sub-failure domain

• number

  .spec .dataPool .replicated .targetSizeRatio

  TargetSizeRatio gives a hint (%) to Ceph in terms of expected consumption of the total cluster capacity

• object

  .spec .dataPool .statusCheck

  The mirroring statusCheck

• object | null

  .spec .dataPool .statusCheck .mirror

  HealthCheckSpec represents the health check of an object store bucket

• boolean

  .spec .dataPool .statusCheck .mirror .disabled

• string

  .spec .dataPool .statusCheck .mirror .interval

  Interval is the internal in second or minute for the health check to run like 60s for 60 seconds

• string

  .spec .dataPool .statusCheck .mirror .timeout

• object | null

  .spec .gateway

  The rgw pod info

• array

  .spec .gateway .additionalVolumeMounts

  AdditionalVolumeMounts allows additional volumes to be mounted to the RGW pod. The root directory for each additional volume mount is /var/rgw. Example: for an additional mount at subPath ldap, mounted from a secret that has key bindpass.secret, the file would reside at /var/rgw/ldap/bindpass.secret.

• string required

  .spec .gateway .additionalVolumeMounts[] .subPath

  SubPath defines the sub-path (subdirectory) of the directory root where the volumeSource will be mounted. All files/keys in the volume source’s volume will be mounted to the subdirectory. This is not the same as the Kubernetes subPath volume mount option. Each subPath definition must be unique and must not contain ‘:’.

• object required

  .spec .gateway .additionalVolumeMounts[] .volumeSource

• object

  .spec .gateway .additionalVolumeMounts[] .volumeSource .configMap

• integer

  .spec .gateway .additionalVolumeMounts[] .volumeSource .configMap .defaultMode

• array

  .spec .gateway .additionalVolumeMounts[] .volumeSource .configMap .items

• string required

  .spec .gateway .additionalVolumeMounts[] .volumeSource .configMap .items[] .key

• integer

  .spec .gateway .additionalVolumeMounts[] .volumeSource .configMap .items[] .mode

• string required

  .spec .gateway .additionalVolumeMounts[] .volumeSource .configMap .items[] .path

• string

  .spec .gateway .additionalVolumeMounts[] .volumeSource .configMap .name

• boolean

  .spec .gateway .additionalVolumeMounts[] .volumeSource .configMap .optional

• object

  .spec .gateway .additionalVolumeMounts[] .volumeSource .emptyDir

• string

  .spec .gateway .additionalVolumeMounts[] .volumeSource .emptyDir .medium

• integer | string

  .spec .gateway .additionalVolumeMounts[] .volumeSource .emptyDir .sizeLimit

• object

  .spec .gateway .additionalVolumeMounts[] .volumeSource .hostPath

• string required

  .spec .gateway .additionalVolumeMounts[] .volumeSource .hostPath .path

• string

  .spec .gateway .additionalVolumeMounts[] .volumeSource .hostPath .type

• object

  .spec .gateway .additionalVolumeMounts[] .volumeSource .persistentVolumeClaim

• string required

  .spec .gateway .additionalVolumeMounts[] .volumeSource .persistentVolumeClaim .claimName

• boolean

  .spec .gateway .additionalVolumeMounts[] .volumeSource .persistentVolumeClaim .readOnly

• object

  .spec .gateway .additionalVolumeMounts[] .volumeSource .projected

• integer

  .spec .gateway .additionalVolumeMounts[] .volumeSource .projected .defaultMode

• array

  .spec .gateway .additionalVolumeMounts[] .volumeSource .projected .sources

• object

  .spec .gateway .additionalVolumeMounts[] .volumeSource .projected .sources[] .clusterTrustBundle

• object

  .spec .gateway .additionalVolumeMounts[] .volumeSource .projected .sources[] .clusterTrustBundle .labelSelector

• array

  .spec .gateway .additionalVolumeMounts[] .volumeSource .projected .sources[] .clusterTrustBundle .labelSelector .matchExpressions

• string required

  .spec .gateway .additionalVolumeMounts[] .volumeSource .projected .sources[] .clusterTrustBundle .labelSelector .matchExpressions[] .key

• string required

  .spec .gateway .additionalVolumeMounts[] .volumeSource .projected .sources[] .clusterTrustBundle .labelSelector .matchExpressions[] .operator

• array

  .spec .gateway .additionalVolumeMounts[] .volumeSource .projected .sources[] .clusterTrustBundle .labelSelector .matchExpressions[] .values

• object

  .spec .gateway .additionalVolumeMounts[] .volumeSource .projected .sources[] .clusterTrustBundle .labelSelector .matchLabels

• string

  .spec .gateway .additionalVolumeMounts[] .volumeSource .projected .sources[] .clusterTrustBundle .name

• boolean

  .spec .gateway .additionalVolumeMounts[] .volumeSource .projected .sources[] .clusterTrustBundle .optional

• string required

  .spec .gateway .additionalVolumeMounts[] .volumeSource .projected .sources[] .clusterTrustBundle .path

• string

  .spec .gateway .additionalVolumeMounts[] .volumeSource .projected .sources[] .clusterTrustBundle .signerName

• object

  .spec .gateway .additionalVolumeMounts[] .volumeSource .projected .sources[] .configMap

• array

  .spec .gateway .additionalVolumeMounts[] .volumeSource .projected .sources[] .configMap .items

• string required

  .spec .gateway .additionalVolumeMounts[] .volumeSource .projected .sources[] .configMap .items[] .key

• integer

  .spec .gateway .additionalVolumeMounts[] .volumeSource .projected .sources[] .configMap .items[] .mode

• string required

  .spec .gateway .additionalVolumeMounts[] .volumeSource .projected .sources[] .configMap .items[] .path

• string

  .spec .gateway .additionalVolumeMounts[] .volumeSource .projected .sources[] .configMap .name

• boolean

  .spec .gateway .additionalVolumeMounts[] .volumeSource .projected .sources[] .configMap .optional

• object

  .spec .gateway .additionalVolumeMounts[] .volumeSource .projected .sources[] .downwardAPI

• array

  .spec .gateway .additionalVolumeMounts[] .volumeSource .projected .sources[] .downwardAPI .items

• object

  .spec .gateway .additionalVolumeMounts[] .volumeSource .projected .sources[] .downwardAPI .items[] .fieldRef

• string

  .spec .gateway .additionalVolumeMounts[] .volumeSource .projected .sources[] .downwardAPI .items[] .fieldRef .apiVersion

• string required

  .spec .gateway .additionalVolumeMounts[] .volumeSource .projected .sources[] .downwardAPI .items[] .fieldRef .fieldPath

• integer

  .spec .gateway .additionalVolumeMounts[] .volumeSource .projected .sources[] .downwardAPI .items[] .mode

• string required

  .spec .gateway .additionalVolumeMounts[] .volumeSource .projected .sources[] .downwardAPI .items[] .path

• object

  .spec .gateway .additionalVolumeMounts[] .volumeSource .projected .sources[] .downwardAPI .items[] .resourceFieldRef

• string

  .spec .gateway .additionalVolumeMounts[] .volumeSource .projected .sources[] .downwardAPI .items[] .resourceFieldRef .containerName

• integer | string

  .spec .gateway .additionalVolumeMounts[] .volumeSource .projected .sources[] .downwardAPI .items[] .resourceFieldRef .divisor

• string required

  .spec .gateway .additionalVolumeMounts[] .volumeSource .projected .sources[] .downwardAPI .items[] .resourceFieldRef .resource

• object

  .spec .gateway .additionalVolumeMounts[] .volumeSource .projected .sources[] .secret

• array

  .spec .gateway .additionalVolumeMounts[] .volumeSource .projected .sources[] .secret .items

• string required

  .spec .gateway .additionalVolumeMounts[] .volumeSource .projected .sources[] .secret .items[] .key

• integer

  .spec .gateway .additionalVolumeMounts[] .volumeSource .projected .sources[] .secret .items[] .mode

• string required

  .spec .gateway .additionalVolumeMounts[] .volumeSource .projected .sources[] .secret .items[] .path

• string

  .spec .gateway .additionalVolumeMounts[] .volumeSource .projected .sources[] .secret .name

• boolean

  .spec .gateway .additionalVolumeMounts[] .volumeSource .projected .sources[] .secret .optional

• object

  .spec .gateway .additionalVolumeMounts[] .volumeSource .projected .sources[] .serviceAccountToken

• string

  .spec .gateway .additionalVolumeMounts[] .volumeSource .projected .sources[] .serviceAccountToken .audience

• integer

  .spec .gateway .additionalVolumeMounts[] .volumeSource .projected .sources[] .serviceAccountToken .expirationSeconds

• string required

  .spec .gateway .additionalVolumeMounts[] .volumeSource .projected .sources[] .serviceAccountToken .path

• object

  .spec .gateway .additionalVolumeMounts[] .volumeSource .secret

• integer

  .spec .gateway .additionalVolumeMounts[] .volumeSource .secret .defaultMode

• array

  .spec .gateway .additionalVolumeMounts[] .volumeSource .secret .items

• string required

  .spec .gateway .additionalVolumeMounts[] .volumeSource .secret .items[] .key

• integer

  .spec .gateway .additionalVolumeMounts[] .volumeSource .secret .items[] .mode

• string required

  .spec .gateway .additionalVolumeMounts[] .volumeSource .secret .items[] .path

• boolean

  .spec .gateway .additionalVolumeMounts[] .volumeSource .secret .optional

• string

  .spec .gateway .additionalVolumeMounts[] .volumeSource .secret .secretName

• object | null

  .spec .gateway .annotations

  The annotations-related configuration to add/set on each Pod related object.

• string | null

  .spec .gateway .caBundleRef

  The name of the secret that stores custom ca-bundle with root and intermediate certificates.

• boolean | null

  .spec .gateway .dashboardEnabled

  Whether rgw dashboard is enabled for the rgw daemon. If not set, the rgw dashboard will be enabled.

• boolean

  .spec .gateway .disableMultisiteSyncTraffic

  DisableMultisiteSyncTraffic, when true, prevents this object store’s gateways from transmitting multisite replication data. Note that this value does not affect whether gateways receive multisite replication traffic: see ObjectZone.spec.customEndpoints for that. If false or unset, this object store’s gateways will be able to transmit multisite replication data.

• array | null

  .spec .gateway .externalRgwEndpoints

  ExternalRgwEndpoints points to external RGW endpoint(s). Multiple endpoints can be given, but for stability of ObjectBucketClaims, we highly recommend that users give only a single external RGW endpoint that is a load balancer that sends requests to the multiple RGWs.

• boolean | null

  .spec .gateway .hostNetwork

  Whether host networking is enabled for the rgw daemon. If not set, the network settings from the cluster CR will be applied.

• integer | null

  .spec .gateway .instances

  The number of pods in the rgw replicaset.

• object | null

  .spec .gateway .labels

  The labels-related configuration to add/set on each Pod related object.

• object | null

  .spec .gateway .opsLogSidecar

  Enable enhanced operation Logs for S3 in a sidecar named ops-log

• object

  .spec .gateway .opsLogSidecar .resources

  Resources represents the way to specify resource requirements for the ops-log sidecar

• array

  .spec .gateway .opsLogSidecar .resources .claims

  Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container.

  This is an alpha field and requires enabling the DynamicResourceAllocation feature gate.

  This field is immutable. It can only be set for containers.

• string required

  .spec .gateway .opsLogSidecar .resources .claims[] .name

  Name must match the name of one entry in pod.spec.resourceClaims of the Pod where this field is used. It makes that resource available inside a container.

• string

  .spec .gateway .opsLogSidecar .resources .claims[] .request

  Request is the name chosen for a request in the referenced claim. If empty, everything from the claim is made available, otherwise only the result of this request.

• object

  .spec .gateway .opsLogSidecar .resources .limits

  Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

• object

  .spec .gateway .opsLogSidecar .resources .requests

  Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

• object | null

  .spec .gateway .placement

• object

  .spec .gateway .placement .nodeAffinity

• array

  .spec .gateway .placement .nodeAffinity .preferredDuringSchedulingIgnoredDuringExecution

• object required

  .spec .gateway .placement .nodeAffinity .preferredDuringSchedulingIgnoredDuringExecution[] .preference

• array

  .spec .gateway .placement .nodeAffinity .preferredDuringSchedulingIgnoredDuringExecution[] .preference .matchExpressions

• string required

  .spec .gateway .placement .nodeAffinity .preferredDuringSchedulingIgnoredDuringExecution[] .preference .matchExpressions[] .key

• string required

  .spec .gateway .placement .nodeAffinity .preferredDuringSchedulingIgnoredDuringExecution[] .preference .matchExpressions[] .operator

• array

  .spec .gateway .placement .nodeAffinity .preferredDuringSchedulingIgnoredDuringExecution[] .preference .matchExpressions[] .values

• array

  .spec .gateway .placement .nodeAffinity .preferredDuringSchedulingIgnoredDuringExecution[] .preference .matchFields

• string required

  .spec .gateway .placement .nodeAffinity .preferredDuringSchedulingIgnoredDuringExecution[] .preference .matchFields[] .key

• string required

  .spec .gateway .placement .nodeAffinity .preferredDuringSchedulingIgnoredDuringExecution[] .preference .matchFields[] .operator

• array

  .spec .gateway .placement .nodeAffinity .preferredDuringSchedulingIgnoredDuringExecution[] .preference .matchFields[] .values

• integer required

  .spec .gateway .placement .nodeAffinity .preferredDuringSchedulingIgnoredDuringExecution[] .weight

• object

  .spec .gateway .placement .nodeAffinity .requiredDuringSchedulingIgnoredDuringExecution

• array required

  .spec .gateway .placement .nodeAffinity .requiredDuringSchedulingIgnoredDuringExecution .nodeSelectorTerms

• array

  .spec .gateway .placement .nodeAffinity .requiredDuringSchedulingIgnoredDuringExecution .nodeSelectorTerms[] .matchExpressions

• string required

  .spec .gateway .placement .nodeAffinity .requiredDuringSchedulingIgnoredDuringExecution .nodeSelectorTerms[] .matchExpressions[] .key

• string required

  .spec .gateway .placement .nodeAffinity .requiredDuringSchedulingIgnoredDuringExecution .nodeSelectorTerms[] .matchExpressions[] .operator

• array

  .spec .gateway .placement .nodeAffinity .requiredDuringSchedulingIgnoredDuringExecution .nodeSelectorTerms[] .matchExpressions[] .values

• array

  .spec .gateway .placement .nodeAffinity .requiredDuringSchedulingIgnoredDuringExecution .nodeSelectorTerms[] .matchFields

• string required

  .spec .gateway .placement .nodeAffinity .requiredDuringSchedulingIgnoredDuringExecution .nodeSelectorTerms[] .matchFields[] .key

• string required

  .spec .gateway .placement .nodeAffinity .requiredDuringSchedulingIgnoredDuringExecution .nodeSelectorTerms[] .matchFields[] .operator

• array

  .spec .gateway .placement .nodeAffinity .requiredDuringSchedulingIgnoredDuringExecution .nodeSelectorTerms[] .matchFields[] .values

• object

  .spec .gateway .placement .podAffinity

• array

  .spec .gateway .placement .podAffinity .preferredDuringSchedulingIgnoredDuringExecution

• object required

  .spec .gateway .placement .podAffinity .preferredDuringSchedulingIgnoredDuringExecution[] .podAffinityTerm

• object

  .spec .gateway .placement .podAffinity .preferredDuringSchedulingIgnoredDuringExecution[] .podAffinityTerm .labelSelector

• array

  .spec .gateway .placement .podAffinity .preferredDuringSchedulingIgnoredDuringExecution[] .podAffinityTerm .labelSelector .matchExpressions

• string required

  .spec .gateway .placement .podAffinity .preferredDuringSchedulingIgnoredDuringExecution[] .podAffinityTerm .labelSelector .matchExpressions[] .key

• string required

  .spec .gateway .placement .podAffinity .preferredDuringSchedulingIgnoredDuringExecution[] .podAffinityTerm .labelSelector .matchExpressions[] .operator

• array

  .spec .gateway .placement .podAffinity .preferredDuringSchedulingIgnoredDuringExecution[] .podAffinityTerm .labelSelector .matchExpressions[] .values

• object

  .spec .gateway .placement .podAffinity .preferredDuringSchedulingIgnoredDuringExecution[] .podAffinityTerm .labelSelector .matchLabels

• array

  .spec .gateway .placement .podAffinity .preferredDuringSchedulingIgnoredDuringExecution[] .podAffinityTerm .matchLabelKeys

• array

  .spec .gateway .placement .podAffinity .preferredDuringSchedulingIgnoredDuringExecution[] .podAffinityTerm .mismatchLabelKeys

• object

  .spec .gateway .placement .podAffinity .preferredDuringSchedulingIgnoredDuringExecution[] .podAffinityTerm .namespaceSelector

• array

  .spec .gateway .placement .podAffinity .preferredDuringSchedulingIgnoredDuringExecution[] .podAffinityTerm .namespaceSelector .matchExpressions

• string required

  .spec .gateway .placement .podAffinity .preferredDuringSchedulingIgnoredDuringExecution[] .podAffinityTerm .namespaceSelector .matchExpressions[] .key

• string required

  .spec .gateway .placement .podAffinity .preferredDuringSchedulingIgnoredDuringExecution[] .podAffinityTerm .namespaceSelector .matchExpressions[] .operator

• array

  .spec .gateway .placement .podAffinity .preferredDuringSchedulingIgnoredDuringExecution[] .podAffinityTerm .namespaceSelector .matchExpressions[] .values

• object

  .spec .gateway .placement .podAffinity .preferredDuringSchedulingIgnoredDuringExecution[] .podAffinityTerm .namespaceSelector .matchLabels

• array

  .spec .gateway .placement .podAffinity .preferredDuringSchedulingIgnoredDuringExecution[] .podAffinityTerm .namespaces

• string required

  .spec .gateway .placement .podAffinity .preferredDuringSchedulingIgnoredDuringExecution[] .podAffinityTerm .topologyKey

• integer required

  .spec .gateway .placement .podAffinity .preferredDuringSchedulingIgnoredDuringExecution[] .weight

• array

  .spec .gateway .placement .podAffinity .requiredDuringSchedulingIgnoredDuringExecution

• object

  .spec .gateway .placement .podAffinity .requiredDuringSchedulingIgnoredDuringExecution[] .labelSelector

• array

  .spec .gateway .placement .podAffinity .requiredDuringSchedulingIgnoredDuringExecution[] .labelSelector .matchExpressions

• string required

  .spec .gateway .placement .podAffinity .requiredDuringSchedulingIgnoredDuringExecution[] .labelSelector .matchExpressions[] .key

• string required

  .spec .gateway .placement .podAffinity .requiredDuringSchedulingIgnoredDuringExecution[] .labelSelector .matchExpressions[] .operator

• array

  .spec .gateway .placement .podAffinity .requiredDuringSchedulingIgnoredDuringExecution[] .labelSelector .matchExpressions[] .values

• object

  .spec .gateway .placement .podAffinity .requiredDuringSchedulingIgnoredDuringExecution[] .labelSelector .matchLabels

• array

  .spec .gateway .placement .podAffinity .requiredDuringSchedulingIgnoredDuringExecution[] .matchLabelKeys

• array

  .spec .gateway .placement .podAffinity .requiredDuringSchedulingIgnoredDuringExecution[] .mismatchLabelKeys

• object

  .spec .gateway .placement .podAffinity .requiredDuringSchedulingIgnoredDuringExecution[] .namespaceSelector

• array

  .spec .gateway .placement .podAffinity .requiredDuringSchedulingIgnoredDuringExecution[] .namespaceSelector .matchExpressions

• string required

  .spec .gateway .placement .podAffinity .requiredDuringSchedulingIgnoredDuringExecution[] .namespaceSelector .matchExpressions[] .key

• string required

  .spec .gateway .placement .podAffinity .requiredDuringSchedulingIgnoredDuringExecution[] .namespaceSelector .matchExpressions[] .operator

• array

  .spec .gateway .placement .podAffinity .requiredDuringSchedulingIgnoredDuringExecution[] .namespaceSelector .matchExpressions[] .values

• object

  .spec .gateway .placement .podAffinity .requiredDuringSchedulingIgnoredDuringExecution[] .namespaceSelector .matchLabels

• array

  .spec .gateway .placement .podAffinity .requiredDuringSchedulingIgnoredDuringExecution[] .namespaces

• string required

  .spec .gateway .placement .podAffinity .requiredDuringSchedulingIgnoredDuringExecution[] .topologyKey

• object

  .spec .gateway .placement .podAntiAffinity

• array

  .spec .gateway .placement .podAntiAffinity .preferredDuringSchedulingIgnoredDuringExecution

• object required

  .spec .gateway .placement .podAntiAffinity .preferredDuringSchedulingIgnoredDuringExecution[] .podAffinityTerm

• object

  .spec .gateway .placement .podAntiAffinity .preferredDuringSchedulingIgnoredDuringExecution[] .podAffinityTerm .labelSelector

• array

  .spec .gateway .placement .podAntiAffinity .preferredDuringSchedulingIgnoredDuringExecution[] .podAffinityTerm .labelSelector .matchExpressions

• string required

  .spec .gateway .placement .podAntiAffinity .preferredDuringSchedulingIgnoredDuringExecution[] .podAffinityTerm .labelSelector .matchExpressions[] .key

• string required

  .spec .gateway .placement .podAntiAffinity .preferredDuringSchedulingIgnoredDuringExecution[] .podAffinityTerm .labelSelector .matchExpressions[] .operator

• array

  .spec .gateway .placement .podAntiAffinity .preferredDuringSchedulingIgnoredDuringExecution[] .podAffinityTerm .labelSelector .matchExpressions[] .values

• object

  .spec .gateway .placement .podAntiAffinity .preferredDuringSchedulingIgnoredDuringExecution[] .podAffinityTerm .labelSelector .matchLabels

• array

  .spec .gateway .placement .podAntiAffinity .preferredDuringSchedulingIgnoredDuringExecution[] .podAffinityTerm .matchLabelKeys

• array

  .spec .gateway .placement .podAntiAffinity .preferredDuringSchedulingIgnoredDuringExecution[] .podAffinityTerm .mismatchLabelKeys

• object

  .spec .gateway .placement .podAntiAffinity .preferredDuringSchedulingIgnoredDuringExecution[] .podAffinityTerm .namespaceSelector

• array

  .spec .gateway .placement .podAntiAffinity .preferredDuringSchedulingIgnoredDuringExecution[] .podAffinityTerm .namespaceSelector .matchExpressions

• string required

  .spec .gateway .placement .podAntiAffinity .preferredDuringSchedulingIgnoredDuringExecution[] .podAffinityTerm .namespaceSelector .matchExpressions[] .key

• string required

  .spec .gateway .placement .podAntiAffinity .preferredDuringSchedulingIgnoredDuringExecution[] .podAffinityTerm .namespaceSelector .matchExpressions[] .operator

• array

  .spec .gateway .placement .podAntiAffinity .preferredDuringSchedulingIgnoredDuringExecution[] .podAffinityTerm .namespaceSelector .matchExpressions[] .values

• object

  .spec .gateway .placement .podAntiAffinity .preferredDuringSchedulingIgnoredDuringExecution[] .podAffinityTerm .namespaceSelector .matchLabels

• array

  .spec .gateway .placement .podAntiAffinity .preferredDuringSchedulingIgnoredDuringExecution[] .podAffinityTerm .namespaces

• string required

  .spec .gateway .placement .podAntiAffinity .preferredDuringSchedulingIgnoredDuringExecution[] .podAffinityTerm .topologyKey

• integer required

  .spec .gateway .placement .podAntiAffinity .preferredDuringSchedulingIgnoredDuringExecution[] .weight

• array

  .spec .gateway .placement .podAntiAffinity .requiredDuringSchedulingIgnoredDuringExecution

• object

  .spec .gateway .placement .podAntiAffinity .requiredDuringSchedulingIgnoredDuringExecution[] .labelSelector

• array

  .spec .gateway .placement .podAntiAffinity .requiredDuringSchedulingIgnoredDuringExecution[] .labelSelector .matchExpressions

• string required

  .spec .gateway .placement .podAntiAffinity .requiredDuringSchedulingIgnoredDuringExecution[] .labelSelector .matchExpressions[] .key

• string required

  .spec .gateway .placement .podAntiAffinity .requiredDuringSchedulingIgnoredDuringExecution[] .labelSelector .matchExpressions[] .operator

• array

  .spec .gateway .placement .podAntiAffinity .requiredDuringSchedulingIgnoredDuringExecution[] .labelSelector .matchExpressions[] .values

• object

  .spec .gateway .placement .podAntiAffinity .requiredDuringSchedulingIgnoredDuringExecution[] .labelSelector .matchLabels

• array

  .spec .gateway .placement .podAntiAffinity .requiredDuringSchedulingIgnoredDuringExecution[] .matchLabelKeys

• array

  .spec .gateway .placement .podAntiAffinity .requiredDuringSchedulingIgnoredDuringExecution[] .mismatchLabelKeys

• object

  .spec .gateway .placement .podAntiAffinity .requiredDuringSchedulingIgnoredDuringExecution[] .namespaceSelector

• array

  .spec .gateway .placement .podAntiAffinity .requiredDuringSchedulingIgnoredDuringExecution[] .namespaceSelector .matchExpressions

• string required

  .spec .gateway .placement .podAntiAffinity .requiredDuringSchedulingIgnoredDuringExecution[] .namespaceSelector .matchExpressions[] .key

• string required

  .spec .gateway .placement .podAntiAffinity .requiredDuringSchedulingIgnoredDuringExecution[] .namespaceSelector .matchExpressions[] .operator

• array

  .spec .gateway .placement .podAntiAffinity .requiredDuringSchedulingIgnoredDuringExecution[] .namespaceSelector .matchExpressions[] .values

• object

  .spec .gateway .placement .podAntiAffinity .requiredDuringSchedulingIgnoredDuringExecution[] .namespaceSelector .matchLabels

• array

  .spec .gateway .placement .podAntiAffinity .requiredDuringSchedulingIgnoredDuringExecution[] .namespaces

• string required

  .spec .gateway .placement .podAntiAffinity .requiredDuringSchedulingIgnoredDuringExecution[] .topologyKey

• array

  .spec .gateway .placement .tolerations

• string

  .spec .gateway .placement .tolerations[] .effect

• string

  .spec .gateway .placement .tolerations[] .key

• string

  .spec .gateway .placement .tolerations[] .operator

• integer

  .spec .gateway .placement .tolerations[] .tolerationSeconds

• string

  .spec .gateway .placement .tolerations[] .value

• array

  .spec .gateway .placement .topologySpreadConstraints

• object

  .spec .gateway .placement .topologySpreadConstraints[] .labelSelector

• array

  .spec .gateway .placement .topologySpreadConstraints[] .labelSelector .matchExpressions

• string required

  .spec .gateway .placement .topologySpreadConstraints[] .labelSelector .matchExpressions[] .key

• string required

  .spec .gateway .placement .topologySpreadConstraints[] .labelSelector .matchExpressions[] .operator

• array

  .spec .gateway .placement .topologySpreadConstraints[] .labelSelector .matchExpressions[] .values

• object

  .spec .gateway .placement .topologySpreadConstraints[] .labelSelector .matchLabels

• array

  .spec .gateway .placement .topologySpreadConstraints[] .matchLabelKeys

• integer required

  .spec .gateway .placement .topologySpreadConstraints[] .maxSkew

• integer

  .spec .gateway .placement .topologySpreadConstraints[] .minDomains

• string

  .spec .gateway .placement .topologySpreadConstraints[] .nodeAffinityPolicy

• string

  .spec .gateway .placement .topologySpreadConstraints[] .nodeTaintsPolicy

• string required

  .spec .gateway .placement .topologySpreadConstraints[] .topologyKey

• string required

  .spec .gateway .placement .topologySpreadConstraints[] .whenUnsatisfiable

• integer

  .spec .gateway .port

  The port the rgw service will be listening on (http)

• string

  .spec .gateway .priorityClassName

  PriorityClassName sets priority classes on the rgw pods

• object

  .spec .gateway .readAffinity

  ReadAffinity defines the RGW read affinity policy to optimize the read requests for the RGW clients Note: Only supported from Ceph Tentacle (v20)

• string required

  .spec .gateway .readAffinity .type

  Type defines the RGW ReadAffinity type localize: read from the nearest OSD based on crush location of the RGW client balance: picks a random OSD from the PG’s active set default: read from the primary OSD

• object | null

  .spec .gateway .resources

  The resource requirements for the rgw pods

• array

  .spec .gateway .resources .claims

  Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container.

  This is an alpha field and requires enabling the DynamicResourceAllocation feature gate.

  This field is immutable. It can only be set for containers.

• string required

  .spec .gateway .resources .claims[] .name

  Name must match the name of one entry in pod.spec.resourceClaims of the Pod where this field is used. It makes that resource available inside a container.

• string

  .spec .gateway .resources .claims[] .request

  Request is the name chosen for a request in the referenced claim. If empty, everything from the claim is made available, otherwise only the result of this request.

• object

  .spec .gateway .resources .limits

  Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

• object

  .spec .gateway .resources .requests

  Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

• object | null

  .spec .gateway .rgwCommandFlags

  RgwCommandFlags sets Ceph RGW config values for the gateway clients that serve this object store. Values are modified at RGW startup, resulting in RGW pod restarts. This feature is intended for advanced users. It allows breaking configurations to be easily applied. Use with caution.

• object | null

  .spec .gateway .rgwConfig

  RgwConfig sets Ceph RGW config values for the gateway clients that serve this object store. Values are modified at runtime without RGW restart. This feature is intended for advanced users. It allows breaking configurations to be easily applied. Use with caution.

• object | null

  .spec .gateway .rgwConfigFromSecret

  RgwConfigFromSecret works exactly like RgwConfig but takes config value from Secret Key reference. Values are modified at runtime without RGW restart. This feature is intended for advanced users. It allows breaking configurations to be easily applied. Use with caution.

• integer | null

  .spec .gateway .securePort

  The port the rgw service will be listening on (https)

• object | null

  .spec .gateway .service

  The configuration related to add/set on each rgw service.

• object

  .spec .gateway .service .annotations

  The annotations-related configuration to add/set on each rgw service. nullable optional

• string | null

  .spec .gateway .sslCertificateRef

  The name of the secret that stores the ssl certificate for secure rgw connections

• object | null

  .spec .healthCheck

  The RGW health probes

• object

  .spec .healthCheck .readinessProbe

  ProbeSpec is a wrapper around Probe so it can be enabled or disabled for a Ceph daemon

• boolean

  .spec .healthCheck .readinessProbe .disabled

  Disabled determines whether probe is disable or not

• object

  .spec .healthCheck .readinessProbe .probe

  Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.

• object

  .spec .healthCheck .readinessProbe .probe .exec

  Exec specifies a command to execute in the container.

• array

  .spec .healthCheck .readinessProbe .probe .exec .command

  Command is the command line to execute inside the container, the working directory for the command is root (‘/’) in the container’s filesystem. The command is simply exec’d, it is not run inside a shell, so traditional shell instructions (‘|’, etc) won’t work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.

• integer

  .spec .healthCheck .readinessProbe .probe .failureThreshold

  Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.

• object

  .spec .healthCheck .readinessProbe .probe .grpc

  GRPC specifies a GRPC HealthCheckRequest.

• integer required

  .spec .healthCheck .readinessProbe .probe .grpc .port

  Port number of the gRPC service. Number must be in the range 1 to 65535.

• string

  .spec .healthCheck .readinessProbe .probe .grpc .service

  Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).

  If this is not specified, the default behavior is defined by gRPC.

• object

  .spec .healthCheck .readinessProbe .probe .httpGet

  HTTPGet specifies an HTTP GET request to perform.

• string

  .spec .healthCheck .readinessProbe .probe .httpGet .host

  Host name to connect to, defaults to the pod IP. You probably want to set “Host” in httpHeaders instead.

• array

  .spec .healthCheck .readinessProbe .probe .httpGet .httpHeaders

  Custom headers to set in the request. HTTP allows repeated headers.

• string required

  .spec .healthCheck .readinessProbe .probe .httpGet .httpHeaders[] .name

  The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.

• string required

  .spec .healthCheck .readinessProbe .probe .httpGet .httpHeaders[] .value

  The header field value

• string

  .spec .healthCheck .readinessProbe .probe .httpGet .path

  Path to access on the HTTP server.

• integer | string required

  .spec .healthCheck .readinessProbe .probe .httpGet .port

  Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.

• string

  .spec .healthCheck .readinessProbe .probe .httpGet .scheme

  Scheme to use for connecting to the host. Defaults to HTTP.

• integer

  .spec .healthCheck .readinessProbe .probe .initialDelaySeconds

  Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

• integer

  .spec .healthCheck .readinessProbe .probe .periodSeconds

  How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.

• integer

  .spec .healthCheck .readinessProbe .probe .successThreshold

  Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1.

• object

  .spec .healthCheck .readinessProbe .probe .tcpSocket

  TCPSocket specifies a connection to a TCP port.

• string

  .spec .healthCheck .readinessProbe .probe .tcpSocket .host

  Optional: Host name to connect to, defaults to the pod IP.

• integer | string required

  .spec .healthCheck .readinessProbe .probe .tcpSocket .port

  Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.

• integer

  .spec .healthCheck .readinessProbe .probe .terminationGracePeriodSeconds

• integer

  .spec .healthCheck .readinessProbe .probe .timeoutSeconds

  Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

• object

  .spec .healthCheck .startupProbe

  ProbeSpec is a wrapper around Probe so it can be enabled or disabled for a Ceph daemon

• boolean

  .spec .healthCheck .startupProbe .disabled

  Disabled determines whether probe is disable or not

• object

  .spec .healthCheck .startupProbe .probe

  Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.

• object

  .spec .healthCheck .startupProbe .probe .exec

  Exec specifies a command to execute in the container.

• array

  .spec .healthCheck .startupProbe .probe .exec .command

  Command is the command line to execute inside the container, the working directory for the command is root (‘/’) in the container’s filesystem. The command is simply exec’d, it is not run inside a shell, so traditional shell instructions (‘|’, etc) won’t work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.

• integer

  .spec .healthCheck .startupProbe .probe .failureThreshold

  Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.

• object

  .spec .healthCheck .startupProbe .probe .grpc

  GRPC specifies a GRPC HealthCheckRequest.

• integer required

  .spec .healthCheck .startupProbe .probe .grpc .port

  Port number of the gRPC service. Number must be in the range 1 to 65535.

• string

  .spec .healthCheck .startupProbe .probe .grpc .service

  Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).

  If this is not specified, the default behavior is defined by gRPC.

• object

  .spec .healthCheck .startupProbe .probe .httpGet

  HTTPGet specifies an HTTP GET request to perform.

• string

  .spec .healthCheck .startupProbe .probe .httpGet .host

  Host name to connect to, defaults to the pod IP. You probably want to set “Host” in httpHeaders instead.

• array

  .spec .healthCheck .startupProbe .probe .httpGet .httpHeaders

  Custom headers to set in the request. HTTP allows repeated headers.

• string required

  .spec .healthCheck .startupProbe .probe .httpGet .httpHeaders[] .name

  The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.

• string required

  .spec .healthCheck .startupProbe .probe .httpGet .httpHeaders[] .value

  The header field value

• string

  .spec .healthCheck .startupProbe .probe .httpGet .path

  Path to access on the HTTP server.

• integer | string required

  .spec .healthCheck .startupProbe .probe .httpGet .port

  Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.

• string

  .spec .healthCheck .startupProbe .probe .httpGet .scheme

  Scheme to use for connecting to the host. Defaults to HTTP.

• integer

  .spec .healthCheck .startupProbe .probe .initialDelaySeconds

  Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

• integer

  .spec .healthCheck .startupProbe .probe .periodSeconds

  How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.

• integer

  .spec .healthCheck .startupProbe .probe .successThreshold

  Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1.

• object

  .spec .healthCheck .startupProbe .probe .tcpSocket

  TCPSocket specifies a connection to a TCP port.

• string

  .spec .healthCheck .startupProbe .probe .tcpSocket .host

  Optional: Host name to connect to, defaults to the pod IP.

• integer | string required

  .spec .healthCheck .startupProbe .probe .tcpSocket .port

  Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.

• integer

  .spec .healthCheck .startupProbe .probe .terminationGracePeriodSeconds

• integer

  .spec .healthCheck .startupProbe .probe .timeoutSeconds

  Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

• object | null

  .spec .hosting

  Hosting settings for the object store. A common use case for hosting configuration is to inform Rook of endpoints that support DNS wildcards, which in turn allows virtual host-style bucket addressing.

• object | null

  .spec .hosting .advertiseEndpoint

  AdvertiseEndpoint is the default endpoint Rook will return for resources dependent on this object store. This endpoint will be returned to CephObjectStoreUsers, Object Bucket Claims, and COSI Buckets/Accesses. By default, Rook returns the endpoint for the object store’s Kubernetes service using HTTPS with gateway.securePort if it is defined (otherwise, HTTP with gateway.port).

• string required

  .spec .hosting .advertiseEndpoint .dnsName

  DnsName is the DNS name (in RFC-1123 format) of the endpoint. If the DNS name corresponds to an endpoint with DNS wildcard support, do not include the wildcard itself in the list of hostnames. E.g., use “mystore.example.com” instead of “*.mystore.example.com”.

• integer required

  .spec .hosting .advertiseEndpoint .port

  Port is the port on which S3 connections can be made for this endpoint.

• boolean required

  .spec .hosting .advertiseEndpoint .useTls

  UseTls defines whether the endpoint uses TLS (HTTPS) or not (HTTP).

• array

  .spec .hosting .dnsNames

  A list of DNS host names on which object store gateways will accept client S3 connections. When specified, object store gateways will reject client S3 connections to hostnames that are not present in this list, so include all endpoints. The object store’s advertiseEndpoint and Kubernetes service endpoint, plus CephObjectZone customEndpoints are automatically added to the list but may be set here again if desired. Each DNS name must be valid according RFC-1123. If the DNS name corresponds to an endpoint with DNS wildcard support, do not include the wildcard itself in the list of hostnames. E.g., use “mystore.example.com” instead of “*.mystore.example.com”.

• object | null

  .spec .metadataPool

  The metadata pool settings

• string

  .spec .metadataPool .application

  The application name to set on the pool. Only expected to be set for rgw pools.

• string | null

  .spec .metadataPool .compressionMode

  DEPRECATED: use Parameters instead, e.g., Parameters[“compression_mode”] = “force” The inline compression mode in Bluestore OSD to set to (options are: none, passive, aggressive, force) Do NOT set a default value for kubebuilder as this will override the Parameters

• string | null

  .spec .metadataPool .crushRoot

  The root of the crush hierarchy utilized by the pool

• string | null

  .spec .metadataPool .deviceClass

  The device class the OSD should set to for use in the pool

• boolean

  .spec .metadataPool .enableCrushUpdates

  Allow rook operator to change the pool CRUSH tunables once the pool is created

• boolean

  .spec .metadataPool .enableRBDStats

  EnableRBDStats is used to enable gathering of statistics for all RBD images in the pool

• object

  .spec .metadataPool .erasureCoded

  The erasure code settings

• string

  .spec .metadataPool .erasureCoded .algorithm

  The algorithm for erasure coding

• integer required

  .spec .metadataPool .erasureCoded .codingChunks

  Number of coding chunks per object in an erasure coded storage pool (required for erasure-coded pool type). This is the number of OSDs that can be lost simultaneously before data cannot be recovered.

• integer required

  .spec .metadataPool .erasureCoded .dataChunks

  Number of data chunks per object in an erasure coded storage pool (required for erasure-coded pool type). The number of chunks required to recover an object when any single OSD is lost is the same as dataChunks so be aware that the larger the number of data chunks, the higher the cost of recovery.

• string

  .spec .metadataPool .failureDomain

  The failure domain: osd/host/(region or zone if available) - technically also any type in the crush map

• object

  .spec .metadataPool .mirroring

  The mirroring settings

• boolean

  .spec .metadataPool .mirroring .enabled

  Enabled whether this pool is mirrored or not

• string

  .spec .metadataPool .mirroring .mode

  Mode is the mirroring mode: pool, image or init-only.

• object | null

  .spec .metadataPool .mirroring .peers

  Peers represents the peers spec

• array

  .spec .metadataPool .mirroring .peers .secretNames

  SecretNames represents the Kubernetes Secret names to add rbd-mirror or cephfs-mirror peers

• array

  .spec .metadataPool .mirroring .snapshotSchedules

  SnapshotSchedules is the scheduling of snapshot for mirrored images/pools

• string

  .spec .metadataPool .mirroring .snapshotSchedules[] .interval

  Interval represent the periodicity of the snapshot.

• string

  .spec .metadataPool .mirroring .snapshotSchedules[] .path

  Path is the path to snapshot, only valid for CephFS

• string

  .spec .metadataPool .mirroring .snapshotSchedules[] .startTime

  StartTime indicates when to start the snapshot

• object | null

  .spec .metadataPool .parameters

  Parameters is a list of properties to enable on a given pool

• object | null

  .spec .metadataPool .quotas

  The quota settings

• integer

  .spec .metadataPool .quotas .maxBytes

  MaxBytes represents the quota in bytes Deprecated in favor of MaxSize

• integer

  .spec .metadataPool .quotas .maxObjects

  MaxObjects represents the quota in objects

• string

  .spec .metadataPool .quotas .maxSize

  MaxSize represents the quota in bytes as a string

• object

  .spec .metadataPool .replicated

  The replication settings

• object | null

  .spec .metadataPool .replicated .hybridStorage

  HybridStorage represents hybrid storage tier settings

• string required

  .spec .metadataPool .replicated .hybridStorage .primaryDeviceClass

  PrimaryDeviceClass represents high performance tier (for example SSD or NVME) for Primary OSD

• string required

  .spec .metadataPool .replicated .hybridStorage .secondaryDeviceClass

  SecondaryDeviceClass represents low performance tier (for example HDDs) for remaining OSDs

• integer

  .spec .metadataPool .replicated .replicasPerFailureDomain

  ReplicasPerFailureDomain the number of replica in the specified failure domain

• boolean

  .spec .metadataPool .replicated .requireSafeReplicaSize

  RequireSafeReplicaSize if false allows you to set replica 1

• integer required

  .spec .metadataPool .replicated .size

  Size - Number of copies per object in a replicated storage pool, including the object itself (required for replicated pool type)

• string

  .spec .metadataPool .replicated .subFailureDomain

  SubFailureDomain the name of the sub-failure domain

• number

  .spec .metadataPool .replicated .targetSizeRatio

  TargetSizeRatio gives a hint (%) to Ceph in terms of expected consumption of the total cluster capacity

• object

  .spec .metadataPool .statusCheck

  The mirroring statusCheck

• object | null

  .spec .metadataPool .statusCheck .mirror

  HealthCheckSpec represents the health check of an object store bucket

• boolean

  .spec .metadataPool .statusCheck .mirror .disabled

• string

  .spec .metadataPool .statusCheck .mirror .interval

  Interval is the internal in second or minute for the health check to run like 60s for 60 seconds

• string

  .spec .metadataPool .statusCheck .mirror .timeout

• boolean

  .spec .preservePoolsOnDelete

  Preserve pools on object store deletion

• object

  .spec .protocols

  The protocol specification

• array | null

  .spec .protocols .enableAPIs

  Represents RGW ‘rgw_enable_apis’ config option. See: https://docs.ceph.com/en/reef/radosgw/config-ref/#confval-rgw_enable_apis If no value provided then all APIs will be enabled: s3, s3website, swift, swift_auth, admin, sts, iam, notifications If enabled APIs are set, all remaining APIs will be disabled. This option overrides S3.Enabled value.

• object | null

  .spec .protocols .s3

  The spec for S3

• boolean | null

  .spec .protocols .s3 .authUseKeystone

  Whether to use Keystone for authentication. This option maps directly to the rgw_s3_auth_use_keystone option. Enabling it allows generating S3 credentials via an OpenStack API call, see the docs. If not given, the defaults of the corresponding RGW option apply.

• boolean | null

  .spec .protocols .s3 .enabled

  Deprecated: use protocol.enableAPIs instead. Whether to enable S3. This defaults to true (even if protocols.s3 is not present in the CRD). This maintains backwards compatibility – by default S3 is enabled.

• object | null

  .spec .protocols .swift

  The spec for Swift

• boolean | null

  .spec .protocols .swift .accountInUrl

  Whether or not the Swift account name should be included in the Swift API URL. If set to false (the default), then the Swift API will listen on a URL formed like http://host:port//v1. If set to true, the Swift API URL will be http://host:port//v1/AUTH_. You must set this option to true (and update the Keystone service catalog) if you want radosgw to support publicly-readable containers and temporary URLs.

• string | null

  .spec .protocols .swift .urlPrefix

  The URL prefix for the Swift API, to distinguish it from the S3 API endpoint. The default is swift, which makes the Swift API available at the URL http://host:port/swift/v1 (or http://host:port/swift/v1/AUTH_%(tenant_id)s if rgw swift account in url is enabled).

• boolean | null

  .spec .protocols .swift .versioningEnabled

  Enables the Object Versioning of OpenStack Object Storage API. This allows clients to put the X-Versions-Location attribute on containers that should be versioned.

• object | null

  .spec .security

  Security represents security settings

• object | null

  .spec .security .keyRotation

  KeyRotation defines options for Key Rotation.

• boolean

  .spec .security .keyRotation .enabled

  Enabled represents whether the key rotation is enabled.

• string

  .spec .security .keyRotation .schedule

  Schedule represents the cron schedule for key rotation.

• object | null

  .spec .security .kms

  KeyManagementService is the main Key Management option

• object | null

  .spec .security .kms .connectionDetails

  ConnectionDetails contains the KMS connection details (address, port etc)

• string

  .spec .security .kms .tokenSecretName

  TokenSecretName is the kubernetes secret containing the KMS token

• object | null

  .spec .security .s3

  The settings for supporting AWS-SSE:S3 with RGW

• object | null

  .spec .security .s3 .connectionDetails

  ConnectionDetails contains the KMS connection details (address, port etc)

• string

  .spec .security .s3 .tokenSecretName

  TokenSecretName is the kubernetes secret containing the KMS token

• object | null

  .spec .sharedPools

  The pool information when configuring RADOS namespaces in existing pools.

• string

  .spec .sharedPools .dataPoolName

  The data pool used for creating RADOS namespaces in the object store

• string

  .spec .sharedPools .metadataPoolName

  The metadata pool used for creating RADOS namespaces in the object store

• array

  .spec .sharedPools .poolPlacements

  PoolPlacements control which Pools are associated with a particular RGW bucket. Once PoolPlacements are defined, RGW client will be able to associate pool with ObjectStore bucket by providing “

• string

  .spec .sharedPools .poolPlacements[] .dataNonECPoolName

  The data pool used to store ObjectStore data that cannot use erasure coding (ex: multi-part uploads). If dataPoolName is not erasure coded, then there is no need for dataNonECPoolName.

• string required

  .spec .sharedPools .poolPlacements[] .dataPoolName

  The data pool used to store ObjectStore objects data.

• boolean

  .spec .sharedPools .poolPlacements[] .default

  Sets given placement as default. Only one placement in the list can be marked as default. Default is false.

• string required

  .spec .sharedPools .poolPlacements[] .metadataPoolName

  The metadata pool used to store ObjectStore bucket index.

• string required

  .spec .sharedPools .poolPlacements[] .name

  Pool placement name. Name can be arbitrary. Placement with name “default” will be used as default.

• array

  .spec .sharedPools .poolPlacements[] .storageClasses

  StorageClasses can be selected by user to override dataPoolName during object creation. Each placement has default STANDARD StorageClass pointing to dataPoolName. This list allows defining additional StorageClasses on top of default STANDARD storage class.

• string required

  .spec .sharedPools .poolPlacements[] .storageClasses[] .dataPoolName

  DataPoolName is the data pool used to store ObjectStore objects data.

• string required

  .spec .sharedPools .poolPlacements[] .storageClasses[] .name

  Name is the StorageClass name. Ceph allows arbitrary name for StorageClasses, however most clients/libs insist on AWS names so it is recommended to use one of the valid x-amz-storage-class values for better compatibility: REDUCED_REDUNDANCY | STANDARD_IA | ONEZONE_IA | INTELLIGENT_TIERING | GLACIER | DEEP_ARCHIVE | OUTPOSTS | GLACIER_IR | SNOW | EXPRESS_ONEZONE See AWS docs: https://aws.amazon.com/de/s3/storage-classes/

• boolean

  .spec .sharedPools .preserveRadosNamespaceDataOnDelete

  Whether the RADOS namespaces should be preserved on deletion of the object store

• object | null

  .spec .zone

  The multisite info

• string required

  .spec .zone .name

  CephObjectStoreZone name this CephObjectStore is part of

• object

  .status

  ObjectStoreStatus represents the status of a Ceph Object Store resource

• array

  .status .conditions

• string

  .status .conditions[] .lastHeartbeatTime

• string

  .status .conditions[] .lastTransitionTime

• string

  .status .conditions[] .message

• string

  .status .conditions[] .reason

  ConditionReason is a reason for a condition

• string

  .status .conditions[] .status

• string

  .status .conditions[] .type

  ConditionType represent a resource’s status

• object

  .status .endpoints

• array | null

  .status .endpoints .insecure

• array | null

  .status .endpoints .secure

• object | null

  .status .info

• string

  .status .message

• integer

  .status .observedGeneration

  ObservedGeneration is the latest generation observed by the controller.

• string

  .status .phase

  ConditionType represent a resource’s status