Volume

longhorn.io / v1beta2

apiVersion: longhorn.io/v1beta2 kind: Volume metadata: name: example

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

spec object

VolumeSpec defines the desired state of the Longhorn volume

Standby boolean

accessMode string

enum: rwo, rwop, rwx

backingImage string

backupBlockSize string

BackupBlockSize indicate the block size to create backups. The block size is immutable.

enum: 2097152, 16777216

format: int64

backupCompressionMethod string

enum: none, lz4, gzip

backupTargetName string

The backup target name that the volume will be backed up to or is synced.

cloneMode string

enum: , full-copy, linked-clone

dataEngine string

enum: v1, v2

dataLocality string

enum: disabled, best-effort, strict-local

dataSource string

disableFrontend boolean

diskSelector []string

encrypted boolean

engineNodeID string

engineNodeID defines the node where the backend engine (target) runs. If empty, falls back to NodeID.

freezeFilesystemForSnapshot string

Setting that freezes the filesystem on the root partition before a snapshot is created.

enum: ignored, enabled, disabled

fromBackup string

frontend string

enum: blockdev, iscsi, nvmf, ublk,

image string

lastAttachedBy string

migratable boolean

migrationNodeID string

nodeID string

nodeID defines the node where the volume is attached (where the frontend initiator runs).

nodeSelector []string

numberOfReplicas integer

offlineRebuilding string

Specifies whether Longhorn should rebuild replicas while the detached volume is degraded. - ignored: Use the global setting for offline replica rebuilding. - enabled: Enable offline rebuilding for this volume, regardless of the global setting. - disabled: Disable offline rebuilding for this volume, regardless of the global setting

enum: ignored, disabled, enabled

rebuildConcurrentSyncLimit integer

RebuildConcurrentSyncLimit controls the maximum number of file synchronization operations that can run concurrently during a single replica rebuild. When set to 0, it means following the global setting.

minimum: 0

maximum: 5

replicaAutoBalance string

enum: ignored, disabled, least-effort, best-effort

replicaDiskSoftAntiAffinity string

Replica disk soft anti affinity of the volume. Set enabled to allow replicas to be scheduled in the same disk.

enum: ignored, enabled, disabled

replicaRebuildingBandwidthLimit integer

ReplicaRebuildingBandwidthLimit controls the maximum write bandwidth (in megabytes per second) allowed on the destination replica during the rebuilding process. Set this value to 0 to disable bandwidth limiting.

format: int64

minimum: 0

replicaSoftAntiAffinity string

Replica soft anti affinity of the volume. Set enabled to allow replicas to be scheduled on the same node.

enum: ignored, enabled, disabled

replicaZoneSoftAntiAffinity string

Replica zone soft anti affinity of the volume. Set enabled to allow replicas to be scheduled in the same zone.

enum: ignored, enabled, disabled

restoreVolumeRecurringJob string

enum: ignored, enabled, disabled

revisionCounterDisabled boolean

size string

format: int64

snapshotDataIntegrity string

enum: ignored, disabled, enabled, fast-check

snapshotHashingRequestedAt string

SnapshotHashingRequestedAt is the RFC3339 timestamp (e.g., "2026-03-16T10:30:00Z") when an on-demand snapshot checksum calculation is requested. When this value is set and is later than LastOnDemandSnapshotHashingCompleteAt, the system will calculate checksums for all user snapshots. If SnapshotHashingRequestedAt differs from LastOnDemandSnapshotHashingCompleteAt, it indicates that a hashing request is still in progress, and a new request will be rejected.

snapshotMaxCount integer

snapshotMaxSize string

format: int64

staleReplicaTimeout integer

ublkNumberOfQueue integer

ublkNumberOfQueue controls the number of queues for ublk frontend.

ublkQueueDepth integer

ublkQueueDepth controls the depth of each queue for ublk frontend.

unmapMarkSnapChainRemoved string

enum: ignored, disabled, enabled

status object

VolumeStatus defines the observed state of the Longhorn volume

actualSize integer

format: int64

cloneStatus object

attemptCount integer

nextAllowedAttemptAt string

snapshot string

sourceVolume string

state string

conditions []object

lastProbeTime string

Last time we probed the condition.

lastTransitionTime string

Last time the condition transitioned from one status to another.

message string

Human-readable message indicating details about last transition.

reason string

Unique, one-word, CamelCase reason for the condition's last transition.

status string

Status is the status of the condition. Can be True, False, Unknown.

type string

Type is the type of the condition.

currentEngineNodeID string

the node that the engine (target) is currently running on.

currentImage string

currentMigrationNodeID string

the node that this volume is currently migrating to

currentNodeID string

expansionRequired boolean

frontendDisabled boolean

isStandby boolean

kubernetesStatus object

lastPVCRefAt string

lastPodRefAt string

namespace string

determine if PVC/Namespace is history or not

pvName string

pvStatus string

pvcName string

workloadsStatus []object

determine if Pod/Workload is history or not

podName string

podStatus string

workloadName string

workloadType string

lastAutoSalvagedAt string

lastBackup string

lastBackupAt string

lastDegradedAt string

lastOnDemandSnapshotHashingCompleteAt string

LastOnDemandSnapshotHashingCompleteAt is the RFC3339 timestamp (e.g., "2026-03-16T10:30:00Z") when the most recent on-demand snapshot checksum calculation completed. When this value matches SnapshotHashingRequestedAt, the requested on-demand checksum calculation is considered complete.

ownerID string

remountRequestedAt string

restoreInitiated boolean

restoreRequired boolean

robustness string

shareEndpoint string

shareState string

state string

switchoverState string

SwitchoverState describes the current progress of a v2 engine live switchover. Empty when no switchover is in progress.

No matches. Try .spec.Standby for an exact path