description: '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'
type:string
kind:
description: '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'
description:BackingImageDataSource is where Longhorn stores backing image data source object.
properties:
apiVersion:
description: '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'
type:string
kind:
description: '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'
type:string
metadata:
type:object
spec:
description:BackingImageDataSourceSpec defines the desired state of the Longhorn backing image data source
properties:
checksum:
type:string
diskPath:
type:string
diskUUID:
type:string
fileTransferred:
type:boolean
nodeID:
type:string
parameters:
additionalProperties:
type:string
type:object
sourceType:
enum:
- download
- upload
- export-from-volume
type:string
uuid:
type:string
type:object
status:
description:BackingImageDataSourceStatus defines the observed state of the Longhorn backing image data source
description: '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'
type:string
kind:
description: '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'
description:BackingImageManager is where Longhorn stores backing image manager object.
properties:
apiVersion:
description: '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'
type:string
kind:
description: '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'
type:string
metadata:
type:object
spec:
description:BackingImageManagerSpec defines the desired state of the Longhorn backing image manager
properties:
backingImages:
additionalProperties:
type:string
type:object
diskPath:
type:string
diskUUID:
type:string
image:
type:string
nodeID:
type:string
type:object
status:
description:BackingImageManagerStatus defines the observed state of the Longhorn backing image manager
description:BackingImage is where Longhorn stores backing image object.
properties:
apiVersion:
description: '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'
type:string
kind:
description: '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'
description:BackingImage is where Longhorn stores backing image object.
properties:
apiVersion:
description: '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'
type:string
kind:
description: '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'
type:string
metadata:
type:object
spec:
description:BackingImageSpec defines the desired state of the Longhorn backing image
properties:
checksum:
type:string
disks:
additionalProperties:
type:string
type:object
sourceParameters:
additionalProperties:
type:string
type:object
sourceType:
enum:
- download
- upload
- export-from-volume
type:string
type:object
status:
description:BackingImageStatus defines the observed state of the Longhorn backing image status
description: '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'
type:string
kind:
description: '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'
description:Backup is where Longhorn stores backup object.
properties:
apiVersion:
description: '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'
type:string
kind:
description: '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'
type:string
metadata:
type:object
spec:
description:BackupSpec defines the desired state of the Longhorn backup
properties:
labels:
additionalProperties:
type:string
description:The labels of snapshot backup.
type:object
snapshotName:
description:The snapshot name.
type:string
syncRequestedAt:
description:The time to request run sync the remote backup.
format:date-time
nullable:true
type:string
type:object
status:
description:BackupStatus defines the observed state of the Longhorn backup
description: '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'
type:string
kind:
description: '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'
- description:Indicate whether the backup target is available or not
jsonPath:.status.available
name:Available
type:boolean
- description:The backup target last synced time
jsonPath:.status.lastSyncedAt
name:LastSyncedAt
type:string
name:v1beta2
schema:
openAPIV3Schema:
description:BackupTarget is where Longhorn stores backup target object.
properties:
apiVersion:
description: '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'
type:string
kind:
description: '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'
type:string
metadata:
type:object
spec:
description:BackupTargetSpec defines the desired state of the Longhorn backup target
properties:
backupTargetURL:
description:The backup target URL.
type:string
credentialSecret:
description:The backup target credential secret.
type:string
pollInterval:
description:The interval that the cluster needs to run sync with the backup target.
type:string
syncRequestedAt:
description:The time to request run sync the remote backup target.
format:date-time
nullable:true
type:string
type:object
status:
description:BackupTargetStatus defines the observed state of the Longhorn backup target
properties:
available:
description:Available indicates if the remote backup target is available or not.
type:boolean
conditions:
description:Records the reason on why the backup target is unavailable.
items:
properties:
lastProbeTime:
description:Last time we probed the condition.
type:string
lastTransitionTime:
description:Last time the condition transitioned from one status to another.
type:string
message:
description:Human-readable message indicating details about last transition.
type:string
reason:
description:Unique, one-word, CamelCase reason for the condition's last transition.
type:string
status:
description:Status is the status of the condition. Can be True, False, Unknown.
type:string
type:
description:Type is the type of the condition.
type:string
type:object
nullable:true
type:array
lastSyncedAt:
description:The last time that the controller synced with the remote backup target.
format:date-time
nullable:true
type:string
ownerID:
description:The node ID on which the controller is responsible to reconcile this backup target CR.
description:BackupVolume is where Longhorn stores backup volume object.
properties:
apiVersion:
description: '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'
type:string
kind:
description: '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'
type:string
metadata:
type:object
spec:
x-kubernetes-preserve-unknown-fields:true
status:
x-kubernetes-preserve-unknown-fields:true
type:object
served:true
storage:false
subresources:
status:{}
- additionalPrinterColumns:
- description:The backup volume creation time
jsonPath:.status.createdAt
name:CreatedAt
type:string
- description:The backup volume last backup name
jsonPath:.status.lastBackupName
name:LastBackupName
type:string
- description:The backup volume last backup time
jsonPath:.status.lastBackupAt
name:LastBackupAt
type:string
- description:The backup volume last synced time
jsonPath:.status.lastSyncedAt
name:LastSyncedAt
type:string
name:v1beta2
schema:
openAPIV3Schema:
description:BackupVolume is where Longhorn stores backup volume object.
properties:
apiVersion:
description: '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'
type:string
kind:
description: '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'
type:string
metadata:
type:object
spec:
description:BackupVolumeSpec defines the desired state of the Longhorn backup volume
properties:
syncRequestedAt:
description:The time to request run sync the remote backup volume.
format:date-time
nullable:true
type:string
type:object
status:
description:BackupVolumeStatus defines the observed state of the Longhorn backup volume
properties:
backingImageChecksum:
description:the backing image checksum.
type:string
backingImageName:
description:The backing image name.
type:string
createdAt:
description:The backup volume creation time.
type:string
dataStored:
description:The backup volume block count.
type:string
labels:
additionalProperties:
type:string
description:The backup volume labels.
nullable:true
type:object
lastBackupAt:
description:The latest volume backup time.
type:string
lastBackupName:
description:The latest volume backup name.
type:string
lastModificationTime:
description:The backup volume config last modification time.
format:date-time
nullable:true
type:string
lastSyncedAt:
description:The last time that the backup volume was synced into the cluster.
format:date-time
nullable:true
type:string
messages:
additionalProperties:
type:string
description:The error messages when call longhorn engine on list or inspect backup volumes.
nullable:true
type:object
ownerID:
description:The node ID on which the controller is responsible to reconcile this backup volume CR.
type:string
size:
description:The backup volume size.
type:string
storageClassName:
description:the storage class name of pv/pvc binding with the volume.
- description:Number of resources using the engine image
jsonPath:.status.refCount
name:RefCount
type:integer
- description:The build date of the engine image
jsonPath:.status.buildDate
name:BuildDate
type:date
- jsonPath:.metadata.creationTimestamp
name:Age
type:date
name:v1beta1
schema:
openAPIV3Schema:
description:EngineImage is where Longhorn stores engine image object.
properties:
apiVersion:
description: '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'
type:string
kind:
description: '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'
type:string
metadata:
type:object
spec:
x-kubernetes-preserve-unknown-fields:true
status:
x-kubernetes-preserve-unknown-fields:true
type:object
served:true
storage:false
subresources:
status:{}
- additionalPrinterColumns:
- description:State of the engine image
jsonPath:.status.state
name:State
type:string
- description:The Longhorn engine image
jsonPath:.spec.image
name:Image
type:string
- description:Number of resources using the engine image
description:EngineImage is where Longhorn stores engine image object.
properties:
apiVersion:
description: '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'
type:string
kind:
description: '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'
type:string
metadata:
type:object
spec:
description:EngineImageSpec defines the desired state of the Longhorn engine image
properties:
image:
minLength:1
type:string
required:
- image
type:object
status:
description:EngineImageStatus defines the observed state of the Longhorn engine image
properties:
buildDate:
type:string
cliAPIMinVersion:
type:integer
cliAPIVersion:
type:integer
conditions:
items:
properties:
lastProbeTime:
description:Last time we probed the condition.
type:string
lastTransitionTime:
description:Last time the condition transitioned from one status to another.
type:string
message:
description:Human-readable message indicating details about last transition.
type:string
reason:
description:Unique, one-word, CamelCase reason for the condition's last transition.
type:string
status:
description:Status is the status of the condition. Can be True, False, Unknown.
description: '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'
type:string
kind:
description: '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'
description:Engine is where Longhorn stores engine object.
properties:
apiVersion:
description: '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'
type:string
kind:
description: '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'
type:string
metadata:
type:object
spec:
description:EngineSpec defines the desired state of the Longhorn engine
properties:
active:
type:boolean
backendStoreDriver:
enum:
- v1
- v2
type:string
backupVolume:
type:string
desireState:
type:string
disableFrontend:
type:boolean
engineImage:
type:string
frontend:
enum:
- blockdev
- iscsi
- nvmf
- ""
type:string
logRequested:
type:boolean
nodeID:
type:string
replicaAddressMap:
additionalProperties:
type:string
type:object
requestedBackupRestore:
type:string
requestedDataSource:
type:string
revisionCounterDisabled:
type:boolean
salvageRequested:
type:boolean
unmapMarkSnapChainRemovedEnabled:
type:boolean
upgradedReplicaAddressMap:
additionalProperties:
type:string
type:object
volumeName:
type:string
volumeSize:
format:int64
type:string
type:object
status:
description:EngineStatus defines the observed state of the Longhorn engine
properties:
backupStatus:
additionalProperties:
properties:
backupURL:
type:string
error:
type:string
progress:
type:integer
replicaAddress:
type:string
snapshotName:
type:string
state:
type:string
type:object
nullable:true
type:object
cloneStatus:
additionalProperties:
properties:
error:
type:string
fromReplicaAddress:
type:string
isCloning:
type:boolean
progress:
type:integer
snapshotName:
type:string
state:
type:string
type:object
nullable:true
type:object
conditions:
items:
properties:
lastProbeTime:
description:Last time we probed the condition.
type:string
lastTransitionTime:
description:Last time the condition transitioned from one status to another.
type:string
message:
description:Human-readable message indicating details about last transition.
type:string
reason:
description:Unique, one-word, CamelCase reason for the condition's last transition.
type:string
status:
description:Status is the status of the condition. Can be True, False, Unknown.
description: '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'
type:string
kind:
description: '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'
description:InstanceManager is where Longhorn stores instance manager object.
properties:
apiVersion:
description: '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'
type:string
kind:
description: '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'
type:string
metadata:
type:object
spec:
description:InstanceManagerSpec defines the desired state of the Longhorn instancer manager
properties:
image:
type:string
nodeID:
type:string
type:
enum:
- aio
- engine
- replica
type:string
type:object
status:
description:InstanceManagerStatus defines the observed state of the Longhorn instance manager
properties:
apiMinVersion:
type:integer
apiVersion:
type:integer
proxyApiMinVersion:
type:integer
proxyApiVersion:
type:integer
currentState:
type:string
instanceEngines:
additionalProperties:
properties:
spec:
properties:
backendStoreDriver:
type:string
name:
type:string
type:object
status:
properties:
endpoint:
type:string
errorMsg:
type:string
listen:
type:string
portEnd:
format:int32
type:integer
portStart:
format:int32
type:integer
resourceVersion:
format:int64
type:integer
state:
type:string
type:
type:string
type:object
type:object
nullable:true
type:object
instanceReplicas:
additionalProperties:
properties:
spec:
properties:
backendStoreDriver:
type:string
name:
type:string
type:object
status:
properties:
endpoint:
type:string
errorMsg:
type:string
listen:
type:string
portEnd:
format:int32
type:integer
portStart:
format:int32
type:integer
resourceVersion:
format:int64
type:integer
state:
type:string
type:
type:string
type:object
type:object
nullable:true
type:object
instances:
additionalProperties:
properties:
spec:
properties:
backendStoreDriver:
type:string
name:
type:string
type:object
status:
properties:
endpoint:
type:string
errorMsg:
type:string
listen:
type:string
portEnd:
format:int32
type:integer
portStart:
format:int32
type:integer
resourceVersion:
format:int64
type:integer
state:
type:string
type:
type:string
type:object
type:object
nullable:true
description: 'Deprecated:Replaced by InstanceEngines and InstanceReplicas'
description:Node is where Longhorn stores Longhorn node object.
properties:
apiVersion:
description: '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'
type:string
kind:
description: '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'
description:Node is where Longhorn stores Longhorn node object.
properties:
apiVersion:
description: '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'
type:string
kind:
description: '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'
type:string
metadata:
type:object
spec:
description:NodeSpec defines the desired state of the Longhorn node
properties:
allowScheduling:
type:boolean
disks:
additionalProperties:
properties:
allowScheduling:
type:boolean
evictionRequested:
type:boolean
path:
type:string
storageReserved:
format:int64
type:integer
tags:
items:
type:string
type:array
diskType:
enum:
- filesystem
- block
type:string
type:object
type:object
evictionRequested:
type:boolean
instanceManagerCPURequest:
type:integer
name:
type:string
tags:
items:
type:string
type:array
type:object
status:
description:NodeStatus defines the observed state of the Longhorn node
properties:
conditions:
items:
properties:
lastProbeTime:
description:Last time we probed the condition.
type:string
lastTransitionTime:
description:Last time the condition transitioned from one status to another.
type:string
message:
description:Human-readable message indicating details about last transition.
type:string
reason:
description:Unique, one-word, CamelCase reason for the condition's last transition.
type:string
status:
description:Status is the status of the condition. Can be True, False, Unknown.
type:string
type:
description:Type is the type of the condition.
type:string
type:object
nullable:true
type:array
diskStatus:
additionalProperties:
properties:
conditions:
items:
properties:
lastProbeTime:
description:Last time we probed the condition.
type:string
lastTransitionTime:
description:Last time the condition transitioned from one status to another.
type:string
message:
description:Human-readable message indicating details about last transition.
type:string
reason:
description:Unique, one-word, CamelCase reason for the condition's last transition.
type:string
status:
description:Status is the status of the condition. Can be True, False, Unknown.
description:Orphan is where Longhorn stores orphan object.
properties:
apiVersion:
description: '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'
type:string
kind:
description: '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'
type:string
metadata:
type:object
spec:
description:OrphanSpec defines the desired state of the Longhorn orphaned data
properties:
nodeID:
description:The node ID on which the controller is responsible to reconcile this orphan CR.
type:string
orphanType:
description:The type of the orphaned data. Can be "replica".
type:string
parameters:
additionalProperties:
type:string
description:The parameters of the orphaned data
type:object
type:object
status:
description:OrphanStatus defines the observed state of the Longhorn orphaned data
properties:
conditions:
items:
properties:
lastProbeTime:
description:Last time we probed the condition.
type:string
lastTransitionTime:
description:Last time the condition transitioned from one status to another.
type:string
message:
description:Human-readable message indicating details about last transition.
type:string
reason:
description:Unique, one-word, CamelCase reason for the condition's last transition.
type:string
status:
description:Status is the status of the condition. Can be True, False, Unknown.
- description:The number of snapshots/backups to keep for the volume
jsonPath:.spec.retain
name:Retain
type:integer
- description:The concurrent job to run by each cron job
jsonPath:.spec.concurrency
name:Concurrency
type:integer
- jsonPath:.metadata.creationTimestamp
name:Age
type:date
- description:Specify the labels
jsonPath:.spec.labels
name:Labels
type:string
name:v1beta1
schema:
openAPIV3Schema:
description:RecurringJob is where Longhorn stores recurring job object.
properties:
apiVersion:
description: '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'
type:string
kind:
description: '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'
type:string
metadata:
type:object
spec:
x-kubernetes-preserve-unknown-fields:true
status:
x-kubernetes-preserve-unknown-fields:true
type:object
served:true
storage:false
subresources:
status:{}
- additionalPrinterColumns:
- description:Sets groupings to the jobs. When set to "default" group will be added to the volume label when no other job label exist in volume
jsonPath:.spec.groups
name:Groups
type:string
- description:Should be one of "snapshot", "snapshot-force-create", "snapshot-cleanup", "snapshot-delete", "backup", "backup-force-create" or "filesystem-trim"
- description:The number of snapshots/backups to keep for the volume
jsonPath:.spec.retain
name:Retain
type:integer
- description:The concurrent job to run by each cron job
jsonPath:.spec.concurrency
name:Concurrency
type:integer
- jsonPath:.metadata.creationTimestamp
name:Age
type:date
- description:Specify the labels
jsonPath:.spec.labels
name:Labels
type:string
name:v1beta2
schema:
openAPIV3Schema:
description:RecurringJob is where Longhorn stores recurring job object.
properties:
apiVersion:
description: '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'
type:string
kind:
description: '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'
type:string
metadata:
type:object
spec:
description:RecurringJobSpec defines the desired state of the Longhorn recurring job
properties:
concurrency:
description:The concurrency of taking the snapshot/backup.
type:integer
cron:
description:The cron setting.
type:string
groups:
description:The recurring job group.
items:
type:string
type:array
labels:
additionalProperties:
type:string
description:The label of the snapshot/backup.
type:object
name:
description:The recurring job name.
type:string
retain:
description:The retain count of the snapshot/backup.
type:integer
task:
description:The recurring job task. Can be "snapshot", "snapshot-force-create", "snapshot-cleanup", "snapshot-delete", "backup", "backup-force-create" or "filesystem-trim"
enum:
- snapshot
- snapshot-force-create
- snapshot-cleanup
- snapshot-delete
- backup
- backup-force-create
- filesystem-trim
type:string
type:object
status:
description:RecurringJobStatus defines the observed state of the Longhorn recurring job
properties:
ownerID:
description:The owner ID which is responsible to reconcile this recurring job CR.
description:Replica is where Longhorn stores replica object.
properties:
apiVersion:
description: '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'
type:string
kind:
description: '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'
type:string
metadata:
type:object
spec:
x-kubernetes-preserve-unknown-fields:true
status:
x-kubernetes-preserve-unknown-fields:true
type:object
served:true
storage:false
subresources:
status:{}
- additionalPrinterColumns:
- description:The current state of the replica
jsonPath:.status.currentState
name:State
type:string
- description:The node that the replica is on
jsonPath:.spec.nodeID
name:Node
type:string
- description:The disk that the replica is on
jsonPath:.spec.diskID
name:Disk
type:string
- description:The instance manager of the replica
jsonPath:.status.instanceManagerName
name:InstanceManager
type:string
- description:The current image of the replica
jsonPath:.status.currentImage
name:Image
type:string
- jsonPath:.metadata.creationTimestamp
name:Age
type:date
name:v1beta2
schema:
openAPIV3Schema:
description:Replica is where Longhorn stores replica object.
properties:
apiVersion:
description: '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'
type:string
kind:
description: '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'
type:string
metadata:
type:object
spec:
description:ReplicaSpec defines the desired state of the Longhorn replica
properties:
active:
type:boolean
backendStoreDriver:
enum:
- v1
- v2
type:string
backingImage:
type:string
dataDirectoryName:
type:string
desireState:
type:string
diskID:
type:string
diskPath:
type:string
engineImage:
type:string
engineName:
type:string
failedAt:
type:string
hardNodeAffinity:
type:string
healthyAt:
type:string
logRequested:
type:boolean
nodeID:
type:string
rebuildRetryCount:
type:integer
revisionCounterDisabled:
type:boolean
salvageRequested:
type:boolean
unmapMarkDiskChainRemovedEnabled:
type:boolean
volumeName:
type:string
volumeSize:
format:int64
type:string
type:object
status:
description:ReplicaStatus defines the observed state of the Longhorn replica
properties:
conditions:
items:
properties:
lastProbeTime:
description:Last time we probed the condition.
type:string
lastTransitionTime:
description:Last time the condition transitioned from one status to another.
type:string
message:
description:Human-readable message indicating details about last transition.
type:string
reason:
description:Unique, one-word, CamelCase reason for the condition's last transition.
type:string
status:
description:Status is the status of the condition. Can be True, False, Unknown.
description:Setting is where Longhorn stores setting object.
properties:
apiVersion:
description: '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'
type:string
kind:
description: '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'
type:string
metadata:
type:object
value:
type:string
required:
- value
type:object
served:true
storage:false
subresources:
status:{}
- additionalPrinterColumns:
- description:The value of the setting
jsonPath:.value
name:Value
type:string
- jsonPath:.metadata.creationTimestamp
name:Age
type:date
name:v1beta2
schema:
openAPIV3Schema:
description:Setting is where Longhorn stores setting object.
properties:
apiVersion:
description: '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'
type:string
kind:
description: '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'
- description:The node that the share manager is owned by
jsonPath:.status.ownerID
name:Node
type:string
- jsonPath:.metadata.creationTimestamp
name:Age
type:date
name:v1beta1
schema:
openAPIV3Schema:
description:ShareManager is where Longhorn stores share manager object.
properties:
apiVersion:
description: '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'
type:string
kind:
description: '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'
type:string
metadata:
type:object
spec:
x-kubernetes-preserve-unknown-fields:true
status:
x-kubernetes-preserve-unknown-fields:true
type:object
served:true
storage:false
subresources:
status:{}
- additionalPrinterColumns:
- description:The state of the share manager
jsonPath:.status.state
name:State
type:string
- description:The node that the share manager is owned by
jsonPath:.status.ownerID
name:Node
type:string
- jsonPath:.metadata.creationTimestamp
name:Age
type:date
name:v1beta2
schema:
openAPIV3Schema:
description:ShareManager is where Longhorn stores share manager object.
properties:
apiVersion:
description: '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'
type:string
kind:
description: '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'
type:string
metadata:
type:object
spec:
description:ShareManagerSpec defines the desired state of the Longhorn share manager
properties:
image:
description:Share manager image used for creating a share manager pod
type:string
type:object
status:
description:ShareManagerStatus defines the observed state of the Longhorn share manager
properties:
endpoint:
description:NFS endpoint that can access the mounted filesystem of the volume
type:string
ownerID:
description:The node ID on which the controller is responsible to reconcile this share manager resource
type:string
state:
description:The state of the share manager resource
- description:The volume that this snapshot belongs to
jsonPath:.spec.volume
name:Volume
type:string
- description:Timestamp when the point-in-time snapshot was taken
jsonPath:.status.creationTime
name:CreationTime
type:string
- description:Indicates if the snapshot is ready to be used to restore/backup a volume
jsonPath:.status.readyToUse
name:ReadyToUse
type:boolean
- description:Represents the minimum size of volume required to rehydrate from this snapshot
jsonPath:.status.restoreSize
name:RestoreSize
type:string
- description:The actual size of the snapshot
jsonPath:.status.size
name:Size
type:string
- jsonPath:.metadata.creationTimestamp
name:Age
type:date
name:v1beta2
schema:
openAPIV3Schema:
description:Snapshot is the Schema for the snapshots API
properties:
apiVersion:
description: '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'
type:string
kind:
description: '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'
type:string
metadata:
type:object
spec:
description:SnapshotSpec defines the desired state of Longhorn Snapshot
properties:
createSnapshot:
description:require creating a new snapshot
type:boolean
labels:
additionalProperties:
type:string
description:The labels of snapshot
nullable:true
type:object
volume:
description:the volume that this snapshot belongs to. This field is immutable after creation. Required
type:string
required:
- volume
type:object
status:
description:SnapshotStatus defines the observed state of Longhorn Snapshot
description:SupportBundle is where Longhorn stores support bundle object
properties:
apiVersion:
description: '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'
type:string
kind:
description: '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'
type:string
metadata:
type:object
spec:
description:SupportBundleSpec defines the desired state of the Longhorn SupportBundle
- description:The last time that the system backup was synced into the cluster
jsonPath:.status.lastSyncedAt
name:LastSyncedAt
type:string
name:v1beta2
schema:
openAPIV3Schema:
description:SystemBackup is where Longhorn stores system backup object
properties:
apiVersion:
description: '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'
type:string
kind:
description: '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'
type:string
metadata:
type:object
spec:
description:SystemBackupSpec defines the desired state of the Longhorn SystemBackup
properties:
volumeBackupPolicy:
description:The create volume backup policy Can be "if-not-present", "always" or "disabled"
nullable:true
type:string
type:object
status:
description:SystemBackupStatus defines the observed state of the Longhorn SystemBackup
properties:
conditions:
items:
properties:
lastProbeTime:
description:Last time we probed the condition.
type:string
lastTransitionTime:
description:Last time the condition transitioned from one status to another.
type:string
message:
description:Human-readable message indicating details about last transition.
type:string
reason:
description:Unique, one-word, CamelCase reason for the condition's last transition.
type:string
status:
description:Status is the status of the condition. Can be True, False, Unknown.
description:SystemRestore is where Longhorn stores system restore object
properties:
apiVersion:
description: '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'
type:string
kind:
description: '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'
type:string
metadata:
type:object
spec:
description:SystemRestoreSpec defines the desired state of the Longhorn SystemRestore
properties:
systemBackup:
description:The system backup name in the object store.
type:string
required:
- systemBackup
type:object
status:
description:SystemRestoreStatus defines the observed state of the Longhorn SystemRestore
properties:
conditions:
items:
properties:
lastProbeTime:
description:Last time we probed the condition.
type:string
lastTransitionTime:
description:Last time the condition transitioned from one status to another.
type:string
message:
description:Human-readable message indicating details about last transition.
type:string
reason:
description:Unique, one-word, CamelCase reason for the condition's last transition.
type:string
status:
description:Status is the status of the condition. Can be True, False, Unknown.
type:string
type:
description:Type is the type of the condition.
type:string
type:object
nullable:true
type:array
ownerID:
description:The node ID of the responsible controller to reconcile this SystemRestore.
- description:The node that the volume is currently attaching to
jsonPath:.status.currentNodeID
name:Node
type:string
- jsonPath:.metadata.creationTimestamp
name:Age
type:date
name:v1beta1
schema:
openAPIV3Schema:
description:Volume is where Longhorn stores volume object.
properties:
apiVersion:
description: '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'
type:string
kind:
description: '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'
type:string
metadata:
type:object
spec:
x-kubernetes-preserve-unknown-fields:true
status:
x-kubernetes-preserve-unknown-fields:true
type:object
served:true
storage:false
subresources:
status:{}
- additionalPrinterColumns:
- description:The state of the volume
jsonPath:.status.state
name:State
type:string
- description:The robustness of the volume
jsonPath:.status.robustness
name:Robustness
type:string
- description:The scheduled condition of the volume
- description:The node that the volume is currently attaching to
jsonPath:.status.currentNodeID
name:Node
type:string
- jsonPath:.metadata.creationTimestamp
name:Age
type:date
name:v1beta2
schema:
openAPIV3Schema:
description:Volume is where Longhorn stores volume object.
properties:
apiVersion:
description: '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'
type:string
kind:
description: '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'
type:string
metadata:
type:object
spec:
description:VolumeSpec defines the desired state of the Longhorn volume
properties:
Standby:
type:boolean
accessMode:
enum:
- rwo
- rwx
type:string
backendStoreDriver:
enum:
- v1
- v2
type:string
backingImage:
type:string
backupCompressionMethod:
enum:
- none
- lz4
- gzip
type:string
dataLocality:
enum:
- disabled
- best-effort
- strict-local
type:string
dataSource:
type:string
disableFrontend:
type:boolean
diskSelector:
items:
type:string
type:array
encrypted:
type:boolean
engineImage:
type:string
fromBackup:
type:string
frontend:
enum:
- blockdev
- iscsi
- nvmf
- ""
type:string
lastAttachedBy:
type:string
migratable:
type:boolean
migrationNodeID:
type:string
nodeID:
type:string
nodeSelector:
items:
type:string
type:array
numberOfReplicas:
type:integer
offlineReplicaRebuilding:
description:OfflineReplicaRebuilding is used to determine if the offline replica rebuilding feature is enabled or not
enum:
- ignored
- disabled
- enabled
type:string
replicaAutoBalance:
enum:
- ignored
- disabled
- least-effort
- best-effort
type:string
replicaSoftAntiAffinity:
description:Replica soft anti affinity of the volume. Set enabled to allow replicas to be scheduled on the same node
enum:
- ignored
- enabled
- disabled
type:string
replicaZoneSoftAntiAffinity:
description:Replica zone soft anti affinity of the volume. Set enabled to allow replicas to be scheduled in the same zone
enum:
- ignored
- enabled
- disabled
type:string
restoreVolumeRecurringJob:
enum:
- ignored
- enabled
- disabled
type:string
revisionCounterDisabled:
type:boolean
size:
format:int64
type:string
snapshotDataIntegrity:
enum:
- ignored
- disabled
- enabled
- fast-check
type:string
staleReplicaTimeout:
type:integer
unmapMarkSnapChainRemoved:
enum:
- ignored
- disabled
- enabled
type:string
type:object
status:
description:VolumeStatus defines the observed state of the Longhorn volume
properties:
actualSize:
format:int64
type:integer
cloneStatus:
properties:
snapshot:
type:string
sourceVolume:
type:string
state:
type:string
type:object
conditions:
items:
properties:
lastProbeTime:
description:Last time we probed the condition.
type:string
lastTransitionTime:
description:Last time the condition transitioned from one status to another.
type:string
message:
description:Human-readable message indicating details about last transition.
type:string
reason:
description:Unique, one-word, CamelCase reason for the condition's last transition.
type:string
status:
description:Status is the status of the condition. Can be True, False, Unknown.
type:string
type:
description:Type is the type of the condition.
type:string
type:object
nullable:true
type:array
currentImage:
type:string
currentMigrationNodeID:
description:the node that this volume is currently migrating to
type:string
currentNodeID:
type:string
expansionRequired:
type:boolean
frontendDisabled:
type:boolean
isStandby:
type:boolean
kubernetesStatus:
properties:
lastPVCRefAt:
type:string
lastPodRefAt:
type:string
namespace:
description:determine if PVC/Namespace is history or not
type:string
pvName:
type:string
pvStatus:
type:string
pvcName:
type:string
workloadsStatus:
description:determine if Pod/Workload is history or not
description:VolumeAttachment stores attachment information of a Longhorn volume
properties:
apiVersion:
description: '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'
type:string
kind:
description: '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'
type:string
metadata:
type:object
spec:
description:VolumeAttachmentSpec defines the desired state of Longhorn VolumeAttachment
properties:
attachmentTickets:
additionalProperties:
properties:
generation:
description:A sequence number representing a specific generation of the desired state. Populated by the system. Read-only.
format:int64
type:integer
id:
description:The unique ID of this attachment. Used to differentiate different attachments of the same volume.
type:string
nodeID:
description:The node that this attachment is requesting
type:string
parameters:
additionalProperties:
type:string
description:Optional additional parameter for this attachment
type:object
type:
type:string
type:object
type:object
volume:
description:The name of Longhorn volume of this VolumeAttachment
type:string
required:
- volume
type:object
status:
description:VolumeAttachmentStatus defines the observed state of Longhorn VolumeAttachment
properties:
attachmentTicketStatuses:
additionalProperties:
properties:
conditions:
description:Record any error when trying to fulfill this attachment
items:
properties:
lastProbeTime:
description:Last time we probed the condition.
type:string
lastTransitionTime:
description:Last time the condition transitioned from one status to another.
type:string
message:
description:Human-readable message indicating details about last transition.
type:string
reason:
description:Unique, one-word, CamelCase reason for the condition's last transition.
type:string
status:
description:Status is the status of the condition. Can be True, False, Unknown.
type:string
type:
description:Type is the type of the condition.
type:string
type:object
nullable:true
type:array
generation:
description:A sequence number representing a specific generation of the desired state. Populated by the system. Read-only.
format:int64
type:integer
id:
description:The unique ID of this attachment. Used to differentiate different attachments of the same volume.
type:string
satisfied:
description:Indicate whether this attachment ticket has been satisfied