Packages:

• storage.ironcore.dev/v1alpha1

storage.ironcore.dev/v1alpha1

Package v1alpha1 is the v1alpha1 version of the API.

Resource Types:

• Bucket
• BucketClass
• BucketPool
• Volume
• VolumeClass
• VolumePool

Bucket

Bucket is the Schema for the buckets API

Field	Description
apiVersion string	storage.ironcore.dev/v1alpha1
kind string	Bucket
metadata Kubernetes meta/v1.ObjectMeta	Refer to the Kubernetes API documentation for the fields of the metadata field.
spec BucketSpec	bucketClassRef Kubernetes core/v1.LocalObjectReference BucketClassRef is the BucketClass of a bucket If empty, an external controller has to provision the bucket. bucketPoolSelector map[string]string BucketPoolSelector selects a suitable BucketPoolRef by the given labels. bucketPoolRef Kubernetes core/v1.LocalObjectReference BucketPoolRef indicates which BucketPool to use for a bucket. If unset, the scheduler will figure out a suitable BucketPoolRef. tolerations []github.com/ironcore-dev/ironcore/api/common/v1alpha1.Toleration Tolerations define tolerations the Bucket has. Only any BucketPool whose taints covered by Tolerations will be considered to host the Bucket.
status BucketStatus

BucketClass

BucketClass is the Schema for the bucketclasses API

Field	Description
apiVersion string	storage.ironcore.dev/v1alpha1
kind string	BucketClass
metadata Kubernetes meta/v1.ObjectMeta	Refer to the Kubernetes API documentation for the fields of the metadata field.
capabilities github.com/ironcore-dev/ironcore/api/core/v1alpha1.ResourceList	Capabilities describes the capabilities of a BucketClass.

BucketPool

BucketPool is the Schema for the bucketpools API

Field	Description
apiVersion string	storage.ironcore.dev/v1alpha1
kind string	BucketPool
metadata Kubernetes meta/v1.ObjectMeta	Refer to the Kubernetes API documentation for the fields of the metadata field.
spec BucketPoolSpec	providerID string ProviderID identifies the BucketPool on provider side. taints []github.com/ironcore-dev/ironcore/api/common/v1alpha1.Taint Taints of the BucketPool. Only Buckets who tolerate all the taints will land in the BucketPool.
status BucketPoolStatus

Volume

Volume is the Schema for the volumes API

Field	Description
apiVersion string	storage.ironcore.dev/v1alpha1
kind string	Volume
metadata Kubernetes meta/v1.ObjectMeta	Refer to the Kubernetes API documentation for the fields of the metadata field.
spec VolumeSpec	volumeClassRef Kubernetes core/v1.LocalObjectReference VolumeClassRef is the VolumeClass of a volume If empty, an external controller has to provision the volume. volumePoolSelector map[string]string VolumePoolSelector selects a suitable VolumePoolRef by the given labels. volumePoolRef Kubernetes core/v1.LocalObjectReference VolumePoolRef indicates which VolumePool to use for a volume. If unset, the scheduler will figure out a suitable VolumePoolRef. claimRef github.com/ironcore-dev/ironcore/api/common/v1alpha1.LocalUIDReference ClaimRef is the reference to the claiming entity of the Volume. resources github.com/ironcore-dev/ironcore/api/core/v1alpha1.ResourceList Resources is a description of the volume’s resources and capacity. image string Image is an optional image to bootstrap the volume with. imagePullSecretRef Kubernetes core/v1.LocalObjectReference ImagePullSecretRef is an optional secret for pulling the image of a volume. unclaimable bool Unclaimable marks the volume as unclaimable. tolerations []github.com/ironcore-dev/ironcore/api/common/v1alpha1.Toleration Tolerations define tolerations the Volume has. Only any VolumePool whose taints covered by Tolerations will be considered to host the Volume. encryption VolumeEncryption Encryption is an optional field which provides attributes to encrypt Volume.
status VolumeStatus

VolumeClass

VolumeClass is the Schema for the volumeclasses API

Field	Description
apiVersion string	storage.ironcore.dev/v1alpha1
kind string	VolumeClass
metadata Kubernetes meta/v1.ObjectMeta	Refer to the Kubernetes API documentation for the fields of the metadata field.
capabilities github.com/ironcore-dev/ironcore/api/core/v1alpha1.ResourceList	Capabilities describes the capabilities of a VolumeClass.
resizePolicy ResizePolicy	ResizePolicy describes the supported expansion policy of a VolumeClass. If not set default to Static expansion policy.

VolumePool

VolumePool is the Schema for the volumepools API

Field	Description
apiVersion string	storage.ironcore.dev/v1alpha1
kind string	VolumePool
metadata Kubernetes meta/v1.ObjectMeta	Refer to the Kubernetes API documentation for the fields of the metadata field.
spec VolumePoolSpec	providerID string ProviderID identifies the VolumePool on provider side. taints []github.com/ironcore-dev/ironcore/api/common/v1alpha1.Taint Taints of the VolumePool. Only Volumes who tolerate all the taints will land in the VolumePool.
status VolumePoolStatus

BucketAccess

(Appears on:BucketStatus)

BucketAccess represents information on how to access a bucket.

Field	Description
secretRef Kubernetes core/v1.LocalObjectReference	SecretRef references the Secret containing the access credentials to consume a Bucket.
endpoint string	Endpoint defines address of the Bucket REST-API.

BucketCondition

(Appears on:BucketStatus)

BucketCondition is one of the conditions of a bucket.

Field	Description
type BucketConditionType	Type is the type of the condition.
status Kubernetes core/v1.ConditionStatus	Status is the status of the condition.
reason string	Reason is a machine-readable indication of why the condition is in a certain state.
message string	Message is a human-readable explanation of why the condition has a certain reason / state.
observedGeneration int64	ObservedGeneration represents the .metadata.generation that the condition was set based upon.
lastTransitionTime Kubernetes meta/v1.Time	LastTransitionTime is the last time the status of a condition has transitioned from one state to another.

BucketConditionType (string alias)

(Appears on:BucketCondition)

BucketConditionType is a type a BucketCondition can have.

BucketPoolSpec

(Appears on:BucketPool)

BucketPoolSpec defines the desired state of BucketPool

Field	Description
providerID string	ProviderID identifies the BucketPool on provider side.
taints []github.com/ironcore-dev/ironcore/api/common/v1alpha1.Taint	Taints of the BucketPool. Only Buckets who tolerate all the taints will land in the BucketPool.

BucketPoolState (string alias)

(Appears on:BucketPoolStatus)

Value	Description
"Available"
"Pending"
"Unavailable"

BucketPoolStatus

(Appears on:BucketPool)

BucketPoolStatus defines the observed state of BucketPool

Field	Description
state BucketPoolState	State represents the infrastructure state of a BucketPool.
availableBucketClasses []Kubernetes core/v1.LocalObjectReference	AvailableBucketClasses list the references of any supported BucketClass of this pool

BucketSpec

(Appears on:Bucket, BucketTemplateSpec)

BucketSpec defines the desired state of Bucket

Field	Description
bucketClassRef Kubernetes core/v1.LocalObjectReference	BucketClassRef is the BucketClass of a bucket If empty, an external controller has to provision the bucket.
bucketPoolSelector map[string]string	BucketPoolSelector selects a suitable BucketPoolRef by the given labels.
bucketPoolRef Kubernetes core/v1.LocalObjectReference	BucketPoolRef indicates which BucketPool to use for a bucket. If unset, the scheduler will figure out a suitable BucketPoolRef.
tolerations []github.com/ironcore-dev/ironcore/api/common/v1alpha1.Toleration	Tolerations define tolerations the Bucket has. Only any BucketPool whose taints covered by Tolerations will be considered to host the Bucket.

BucketState (string alias)

(Appears on:BucketStatus)

BucketState represents the infrastructure state of a Bucket.

Value	Description
"Available"	BucketStateAvailable reports whether a Bucket is available to be used.
"Error"	BucketStateError reports that a Bucket is in an error state.
"Pending"	BucketStatePending reports whether a Bucket is about to be ready.

BucketStatus

(Appears on:Bucket)

BucketStatus defines the observed state of Bucket

Field	Description
bucketID string	BucketID is the provider-specific bucket ID in the format ‘TYPE://BUCKET_ID’.
state BucketState	State represents the infrastructure state of a Bucket.
lastStateTransitionTime Kubernetes meta/v1.Time	LastStateTransitionTime is the last time the State transitioned between values.
access BucketAccess	Access specifies how to access a Bucket. This is set by the bucket provider when the bucket is provisioned.
conditions []BucketCondition	Conditions are the conditions of a bucket.

BucketTemplateSpec

BucketTemplateSpec is the specification of a Bucket template.

Field	Description
metadata Kubernetes meta/v1.ObjectMeta	Refer to the Kubernetes API documentation for the fields of the metadata field.
spec BucketSpec	bucketClassRef Kubernetes core/v1.LocalObjectReference BucketClassRef is the BucketClass of a bucket If empty, an external controller has to provision the bucket. bucketPoolSelector map[string]string BucketPoolSelector selects a suitable BucketPoolRef by the given labels. bucketPoolRef Kubernetes core/v1.LocalObjectReference BucketPoolRef indicates which BucketPool to use for a bucket. If unset, the scheduler will figure out a suitable BucketPoolRef. tolerations []github.com/ironcore-dev/ironcore/api/common/v1alpha1.Toleration Tolerations define tolerations the Bucket has. Only any BucketPool whose taints covered by Tolerations will be considered to host the Bucket.

ResizePolicy (string alias)

(Appears on:VolumeClass)

ResizePolicy is a type of policy.

Value	Description
"ExpandOnly"	ResizePolicyExpandOnly is a policy that only allows the expansion of a Volume.
"Static"	ResizePolicyStatic is a policy that does not allow the expansion of a Volume.

VolumeAccess

(Appears on:VolumeStatus)

VolumeAccess represents information on how to access a volume.

Field	Description
secretRef Kubernetes core/v1.LocalObjectReference	SecretRef references the Secret containing the access credentials to consume a Volume.
driver string	Driver is the name of the drive to use for this volume. Required.
handle string	Handle is the unique handle of the volume.
volumeAttributes map[string]string	VolumeAttributes are attributes of the volume to use.

VolumeCondition

(Appears on:VolumeStatus)

VolumeCondition is one of the conditions of a volume.

Field	Description
type VolumeConditionType	Type is the type of the condition.
status Kubernetes core/v1.ConditionStatus	Status is the status of the condition.
reason string	Reason is a machine-readable indication of why the condition is in a certain state.
message string	Message is a human-readable explanation of why the condition has a certain reason / state.
observedGeneration int64	ObservedGeneration represents the .metadata.generation that the condition was set based upon.
lastTransitionTime Kubernetes meta/v1.Time	LastTransitionTime is the last time the status of a condition has transitioned from one state to another.

VolumeConditionType (string alias)

(Appears on:VolumeCondition)

VolumeConditionType is a type a VolumeCondition can have.

VolumeEncryption

(Appears on:VolumeSpec)

VolumeEncryption represents information to encrypt a volume.

Field	Description
secretRef Kubernetes core/v1.LocalObjectReference	SecretRef references the Secret containing the encryption key to encrypt a Volume. This secret is created by user with encryptionKey as Key and base64 encoded 256-bit encryption key as Value.

VolumePoolCondition

(Appears on:VolumePoolStatus)

VolumePoolCondition is one of the conditions of a volume.

Field	Description
type VolumePoolConditionType	Type is the type of the condition.
status Kubernetes core/v1.ConditionStatus	Status is the status of the condition.
reason string	Reason is a machine-readable indication of why the condition is in a certain state.
message string	Message is a human-readable explanation of why the condition has a certain reason / state.
observedGeneration int64	ObservedGeneration represents the .metadata.generation that the condition was set based upon.
lastTransitionTime Kubernetes meta/v1.Time	LastTransitionTime is the last time the status of a condition has transitioned from one state to another.

VolumePoolConditionType (string alias)

(Appears on:VolumePoolCondition)

VolumePoolConditionType is a type a VolumePoolCondition can have.

VolumePoolSpec

(Appears on:VolumePool)

VolumePoolSpec defines the desired state of VolumePool

Field	Description
providerID string	ProviderID identifies the VolumePool on provider side.
taints []github.com/ironcore-dev/ironcore/api/common/v1alpha1.Taint	Taints of the VolumePool. Only Volumes who tolerate all the taints will land in the VolumePool.

VolumePoolState (string alias)

(Appears on:VolumePoolStatus)

Value	Description
"Available"
"Pending"
"Unavailable"

VolumePoolStatus

(Appears on:VolumePool)

VolumePoolStatus defines the observed state of VolumePool

Field	Description
state VolumePoolState
conditions []VolumePoolCondition
availableVolumeClasses []Kubernetes core/v1.LocalObjectReference	AvailableVolumeClasses list the references of any supported VolumeClass of this pool
capacity github.com/ironcore-dev/ironcore/api/core/v1alpha1.ResourceList	Capacity represents the total resources of a machine pool.
allocatable github.com/ironcore-dev/ironcore/api/core/v1alpha1.ResourceList	Allocatable represents the resources of a machine pool that are available for scheduling.

VolumeSpec

(Appears on:Volume, VolumeTemplateSpec)

VolumeSpec defines the desired state of Volume

Field	Description
volumeClassRef Kubernetes core/v1.LocalObjectReference	VolumeClassRef is the VolumeClass of a volume If empty, an external controller has to provision the volume.
volumePoolSelector map[string]string	VolumePoolSelector selects a suitable VolumePoolRef by the given labels.
volumePoolRef Kubernetes core/v1.LocalObjectReference	VolumePoolRef indicates which VolumePool to use for a volume. If unset, the scheduler will figure out a suitable VolumePoolRef.
claimRef github.com/ironcore-dev/ironcore/api/common/v1alpha1.LocalUIDReference	ClaimRef is the reference to the claiming entity of the Volume.
resources github.com/ironcore-dev/ironcore/api/core/v1alpha1.ResourceList	Resources is a description of the volume’s resources and capacity.
image string	Image is an optional image to bootstrap the volume with.
imagePullSecretRef Kubernetes core/v1.LocalObjectReference	ImagePullSecretRef is an optional secret for pulling the image of a volume.
unclaimable bool	Unclaimable marks the volume as unclaimable.
tolerations []github.com/ironcore-dev/ironcore/api/common/v1alpha1.Toleration	Tolerations define tolerations the Volume has. Only any VolumePool whose taints covered by Tolerations will be considered to host the Volume.
encryption VolumeEncryption	Encryption is an optional field which provides attributes to encrypt Volume.

VolumeState (string alias)

(Appears on:VolumeStatus)

VolumeState represents the infrastructure state of a Volume.

Value	Description
"Available"	VolumeStateAvailable reports whether a Volume is available to be used.
"Error"	VolumeStateError reports that a Volume is in an error state.
"Pending"	VolumeStatePending reports whether a Volume is about to be ready.

VolumeStatus

(Appears on:Volume)

VolumeStatus defines the observed state of Volume

Field	Description
volumeID string	VolumeID is the provider-specific volume ID in the format ‘TYPE://VOLUME_ID’.
state VolumeState	State represents the infrastructure state of a Volume.
lastStateTransitionTime Kubernetes meta/v1.Time	LastStateTransitionTime is the last time the State transitioned between values.
access VolumeAccess	Access specifies how to access a Volume. This is set by the volume provider when the volume is provisioned.
conditions []VolumeCondition	Conditions are the conditions of a volume.
resources github.com/ironcore-dev/ironcore/api/core/v1alpha1.ResourceList	Resources is a effective volume’s resources.

VolumeTemplateSpec

VolumeTemplateSpec is the specification of a Volume template.

Field	Description
metadata Kubernetes meta/v1.ObjectMeta	Refer to the Kubernetes API documentation for the fields of the metadata field.
spec VolumeSpec	volumeClassRef Kubernetes core/v1.LocalObjectReference VolumeClassRef is the VolumeClass of a volume If empty, an external controller has to provision the volume. volumePoolSelector map[string]string VolumePoolSelector selects a suitable VolumePoolRef by the given labels. volumePoolRef Kubernetes core/v1.LocalObjectReference VolumePoolRef indicates which VolumePool to use for a volume. If unset, the scheduler will figure out a suitable VolumePoolRef. claimRef github.com/ironcore-dev/ironcore/api/common/v1alpha1.LocalUIDReference ClaimRef is the reference to the claiming entity of the Volume. resources github.com/ironcore-dev/ironcore/api/core/v1alpha1.ResourceList Resources is a description of the volume’s resources and capacity. image string Image is an optional image to bootstrap the volume with. imagePullSecretRef Kubernetes core/v1.LocalObjectReference ImagePullSecretRef is an optional secret for pulling the image of a volume. unclaimable bool Unclaimable marks the volume as unclaimable. tolerations []github.com/ironcore-dev/ironcore/api/common/v1alpha1.Toleration Tolerations define tolerations the Volume has. Only any VolumePool whose taints covered by Tolerations will be considered to host the Volume. encryption VolumeEncryption Encryption is an optional field which provides attributes to encrypt Volume.

---

Generated with gen-crd-api-reference-docs