#CephFilesystem [cephfilesystems.ceph.rook.io/v1]

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

ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.

FilesystemSpec represents the spec of a file system

CephFilesystemStatus represents the status of a Ceph Filesystem

The data pool settings, with optional predefined pool name.

The metadata pool settings

The mds pod info

The mirroring settings

Preserve the fs in the cluster on CephFilesystem CR deletion. Setting this to true automatically implies PreservePoolsOnDelete is true.

Preserve pool names as specified

Preserve pools on filesystem deletion

The mirroring statusCheck

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

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

The root of the crush hierarchy utilized by the pool

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

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

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

The erasure code settings

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

The mirroring settings

Name of the pool

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

The quota settings

The replication settings

The mirroring statusCheck

The algorithm for erasure coding. If absent, defaults to the plugin specified in osd_pool_default_erasure_code_profile.

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.

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.

Enabled whether this pool is mirrored or not

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

Peers represents the peers spec

SnapshotSchedules is the scheduling of snapshot for mirrored images/pools

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

Interval represent the periodicity of the snapshot.

Path is the path to snapshot, only valid for CephFS

StartTime indicates when to start the snapshot

MaxBytes represents the quota in bytes Deprecated in favor of MaxSize

MaxObjects represents the quota in objects

MaxSize represents the quota in bytes as a string

HybridStorage represents hybrid storage tier settings

ReplicasPerFailureDomain the number of replica in the specified failure domain

RequireSafeReplicaSize if false allows you to set replica 1

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

SubFailureDomain the name of the sub-failure domain

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

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

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

HealthCheckSpec represents the health check of an object store bucket

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

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

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

The root of the crush hierarchy utilized by the pool

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

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

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

The erasure code settings

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

The mirroring settings

Name of the pool

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

The quota settings

The replication settings

The mirroring statusCheck

The algorithm for erasure coding. If absent, defaults to the plugin specified in osd_pool_default_erasure_code_profile.

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.

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.

Enabled whether this pool is mirrored or not

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

Peers represents the peers spec

SnapshotSchedules is the scheduling of snapshot for mirrored images/pools

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

Interval represent the periodicity of the snapshot.

Path is the path to snapshot, only valid for CephFS

StartTime indicates when to start the snapshot

MaxBytes represents the quota in bytes Deprecated in favor of MaxSize

MaxObjects represents the quota in objects

MaxSize represents the quota in bytes as a string

HybridStorage represents hybrid storage tier settings

ReplicasPerFailureDomain the number of replica in the specified failure domain

RequireSafeReplicaSize if false allows you to set replica 1

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

SubFailureDomain the name of the sub-failure domain

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

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

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

HealthCheckSpec represents the health check of an object store bucket

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

The number of metadata servers that are active. The remaining servers in the cluster will be in standby mode.

Whether each active MDS instance will have an active standby with a warm metadata cache for faster failover. If false, standbys will still be available, but will not have a warm metadata cache.

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

CacheMemoryLimitFactor is the factor applied to the memory limit to determine the MDS cache memory limit. MDS cache memory limit should be set to 50-60% of RAM reserved for the MDS container. MDS uses approximately 125% of the value of mds_cache_memory_limit in RAM. This factor is applied when resources.limits.memory is set.

CacheMemoryRequestFactor is the factor applied to the memory request to determine the MDS cache memory limit. This factor is applied when resources.requests.memory is set and resources.limits.memory is not set.

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

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

PriorityClassName sets priority classes on components

The resource requirements for the mds pods

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

Disabled determines whether probe is disable or not

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

Exec specifies a command to execute in the container.

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

GRPC specifies a GRPC HealthCheckRequest.

HTTPGet specifies an HTTP GET request to perform.

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

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

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.

TCPSocket specifies a connection to a TCP port.

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

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.

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

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.

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

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

Path to access on the HTTP server.

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.

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

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

The header field value

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

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.

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

This field depends on the DynamicResourceAllocation feature gate.

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

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

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/

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.

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.

Disabled determines whether probe is disable or not

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

Exec specifies a command to execute in the container.

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

GRPC specifies a GRPC HealthCheckRequest.

HTTPGet specifies an HTTP GET request to perform.

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

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

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.

TCPSocket specifies a connection to a TCP port.

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

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.

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

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.

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

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

Path to access on the HTTP server.

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.

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

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

The header field value

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

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.

Enabled whether this filesystem is mirrored or not

Peers represents the peers spec

Retention is the retention policy for a snapshot schedule One path has exactly one retention policy. A policy can however contain multiple count-time period pairs in order to specify complex retention policies

SnapshotSchedules is the scheduling of snapshot for mirrored filesystems

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

Duration represents the retention duration for a snapshot

Path is the path to snapshot

Interval represent the periodicity of the snapshot.

Path is the path to snapshot, only valid for CephFS

StartTime indicates when to start the snapshot

HealthCheckSpec represents the health check of an object store bucket

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

Use only info and put mirroringStatus in it?

MirroringStatus is the filesystem mirroring status

ObservedGeneration is the latest generation observed by the controller.

ConditionType represent a resource's status

FilesystemSnapshotScheduleStatusSpec is the status of the snapshot schedule

Daemon shows the CephX key status for local Ceph daemons associated with this resources.

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 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.

ConditionReason is a reason for a condition

ConditionType represent a resource's status

PoolMirroringStatus is the mirroring status of a filesystem

Details contains potential status errors

LastChanged is the last time time the status last changed

LastChecked is the last time time the status was checked

DaemonID is the cephfs-mirror name

Filesystems is the list of filesystems managed by a given cephfs-mirror daemon

DirectoryCount is the number of directories in the filesystem

FilesystemID is the filesystem identifier

Name is name of the filesystem

Peers represents the mirroring peers

Remote are the remote cluster information

Stats are the stat a peer mirror

UUID is the peer unique identifier

ClientName is cephx name

ClusterName is the name of the cluster

FsName is the filesystem name

FailureCount is the number of mirroring failure

RecoveryCount is the number of recovery attempted after failures

Details contains potential status errors

LastChanged is the last time time the status last changed

LastChecked is the last time time the status was checked

SnapshotSchedules is the list of snapshots scheduled

Fs is the name of the Ceph Filesystem

Path is the path on the filesystem

FilesystemSnapshotScheduleStatusRetention is the retention specification for a filesystem snapshot schedule

Subvol is the name of the sub volume

Active is whether the scheduled is active or not

Created is when the snapshot schedule was created

CreatedCount is total amount of snapshots

First is when the first snapshot schedule was taken

Last is when the last snapshot schedule was taken

LastPruned is when the last snapshot schedule was pruned

PrunedCount is total amount of pruned snapshots

Start is when the snapshot schedule starts