api

package

v0.5.0 Latest Latest Go to latest Published: Jul 27, 2026 License: Apache-2.0 Imports: 7 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/ironcore-dev/ceph-provider

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
func GetAnnotationsAnnotation(o metav1.Object) (map[string]string, error)
func GetAnnotationsAnnotationForMetadata(o apiutils.Metadata) (map[string]string, error)
func GetClassLabel(o metav1.Object) (string, bool)
func GetClassLabelFromObject(o apiutils.Object) (string, bool)
func GetLabelsAnnotation(o metav1.Object) (map[string]string, error)
func GetLabelsAnnotationForMetadata(o apiutils.Metadata) (map[string]string, error)
func GetObjectMetadata(o apiutils.Metadata) (*irimeta.ObjectMetadata, error)
func GetObjectMetadataFromK8s(o metav1.Object) (*irimeta.ObjectMetadata, error)
func GetObjectMetadataFromObjectID(o apiutils.Metadata) (*irimeta.ObjectMetadata, error)
func IsManagedBy(o metav1.Object, manager string) bool
func IsObjectManagedBy(o apiutils.Object, manager string) bool
func SetAnnotationsAnnotation(o metav1.Object, annotations map[string]string) error
func SetAnnotationsAnnotationForObject(o apiutils.Object, annotations map[string]string) error
func SetBucketManagerLabel(bucket *objectbucketv1alpha1.ObjectBucketClaim, manager string)
func SetClassLabel(o metav1.Object, class string)
func SetClassLabelForObject(o apiutils.Object, class string)
func SetLabelsAnnotation(o metav1.Object, labels map[string]string) error
func SetLabelsAnnotationForOject(o apiutils.Object, labels map[string]string) error
func SetManagerLabel(o apiutils.Object, manager string)
func SetObjectMetadata(o metav1.Object, metadata *irimeta.ObjectMetadata) error
func SetObjectMetadataFromMetadata(o apiutils.Object, metadata *irimeta.ObjectMetadata) error
type EncryptionSpec
type EncryptionState
type EncryptionType
type Image
type ImageAccess
type ImageSpec
type ImageState
type ImageStatus
type LimitType
type Limits
type Snapshot
type SnapshotSource
type SnapshotState
type SnapshotStatus

Constants ¶

View Source

const (
	LabelsAnnotation      = "ceph-provider.ironcore.dev/labels"
	AnnotationsAnnotation = "ceph-provider.ironcore.dev/annotations"
	ClassLabel            = "ceph-provider.ironcore.dev/class"
	ManagerLabel          = "ceph-provider.ironcore.dev/manager"
	BucketManager         = "ceph-bucket-provider"
	VolumeManager         = "ceph-volume-provider"

	MachineArchitectureLabel = "common.ironcore.dev/architecture"
)

Variables ¶

This section is empty.

Functions ¶

func GetAnnotationsAnnotation ¶

func GetAnnotationsAnnotation(o metav1.Object) (map[string]string, error)

func GetAnnotationsAnnotationForMetadata ¶

func GetAnnotationsAnnotationForMetadata(o apiutils.Metadata) (map[string]string, error)

func GetClassLabel ¶

func GetClassLabel(o metav1.Object) (string, bool)

func GetClassLabelFromObject ¶

func GetClassLabelFromObject(o apiutils.Object) (string, bool)

func GetLabelsAnnotation ¶

func GetLabelsAnnotation(o metav1.Object) (map[string]string, error)

func GetLabelsAnnotationForMetadata ¶

func GetLabelsAnnotationForMetadata(o apiutils.Metadata) (map[string]string, error)

func GetObjectMetadata ¶

func GetObjectMetadata(o apiutils.Metadata) (*irimeta.ObjectMetadata, error)

func GetObjectMetadataFromK8s ¶ added in v0.4.0

func GetObjectMetadataFromK8s(o metav1.Object) (*irimeta.ObjectMetadata, error)

func GetObjectMetadataFromObjectID ¶

func GetObjectMetadataFromObjectID(o apiutils.Metadata) (*irimeta.ObjectMetadata, error)

func IsManagedBy ¶

func IsManagedBy(o metav1.Object, manager string) bool

func IsObjectManagedBy ¶

func IsObjectManagedBy(o apiutils.Object, manager string) bool

func SetAnnotationsAnnotation ¶

func SetAnnotationsAnnotation(o metav1.Object, annotations map[string]string) error

func SetAnnotationsAnnotationForObject ¶

func SetAnnotationsAnnotationForObject(o apiutils.Object, annotations map[string]string) error

func SetBucketManagerLabel ¶

func SetBucketManagerLabel(bucket *objectbucketv1alpha1.ObjectBucketClaim, manager string)

func SetClassLabel ¶

func SetClassLabel(o metav1.Object, class string)

func SetClassLabelForObject ¶

func SetClassLabelForObject(o apiutils.Object, class string)

func SetLabelsAnnotation ¶

func SetLabelsAnnotation(o metav1.Object, labels map[string]string) error

func SetLabelsAnnotationForOject ¶

func SetLabelsAnnotationForOject(o apiutils.Object, labels map[string]string) error

func SetManagerLabel ¶

func SetManagerLabel(o apiutils.Object, manager string)

func SetObjectMetadata ¶

func SetObjectMetadata(o metav1.Object, metadata *irimeta.ObjectMetadata) error

func SetObjectMetadataFromMetadata ¶

func SetObjectMetadataFromMetadata(o apiutils.Object, metadata *irimeta.ObjectMetadata) error

Types ¶

type EncryptionSpec ¶

type EncryptionSpec struct {
	Type                EncryptionType `json:"type"`
	EncryptedPassphrase []byte         `json:"encryptedPassphrase"`
}

type EncryptionState ¶

type EncryptionState string

const (
	EncryptionStateHeaderSet EncryptionState = "EncryptionHeaderSet"
)

type EncryptionType ¶

type EncryptionType string

const (
	EncryptionTypeEncrypted   EncryptionType = "Encrypted"
	EncryptionTypeUnencrypted EncryptionType = "Unencrypted"
)

type Image ¶

type Image struct {
	apiutils.Metadata `json:"metadata,omitempty"`

	Spec   ImageSpec   `json:"spec"`
	Status ImageStatus `json:"status"`
}

type ImageAccess ¶

type ImageAccess struct {
	Monitors string `json:"monitors"`
	Handle   string `json:"handle"`

	User    string `json:"user"`
	UserKey string `json:"userKey"`
}

type ImageSpec ¶

type ImageSpec struct {
	Size              uint64          `json:"size"`
	WWN               string          `json:"wwn"`
	Limits            Limits          `json:"limits"`
	Image             string          `json:"image"`
	ImageArchitecture *string         `json:"imageArchitecture"`
	SnapshotRef       *string         `json:"snapshotRef"`
	Encryption        *EncryptionSpec `json:"encryption"`
}

type ImageState ¶

type ImageState string

const (
	ImageStatePending   ImageState = "Pending"
	ImageStateAvailable ImageState = "Available"
)

type ImageStatus ¶

type ImageStatus struct {
	State      ImageState      `json:"state"`
	Encryption EncryptionState `json:"encryption"`
	Access     *ImageAccess    `json:"access"`
	Size       uint64          `json:"size"`
}

type LimitType ¶

type LimitType string

const (
	IOPSLimit                   LimitType = "rbd_qos_iops_limit"
	IOPSBurstLimit              LimitType = "rbd_qos_iops_burst"
	IOPSBurstDurationLimit      LimitType = "rbd_qos_iops_burst_seconds"
	ReadIOPSLimit               LimitType = "rbd_qos_read_iops_limit"
	ReadIOPSBurstLimit          LimitType = "rbd_qos_read_iops_burst"
	ReadIOPSBurstDurationLimit  LimitType = "rbd_qos_read_iops_burst_seconds"
	WriteIOPSLimit              LimitType = "rbd_qos_write_iops_limit"
	WriteIOPSBurstLimit         LimitType = "rbd_qos_write_iops_burst"
	WriteIOPSBurstDurationLimit LimitType = "rbd_qos_write_iops_burst_seconds"
	BPSLimit                    LimitType = "rbd_qos_bps_limit"
	BPSBurstLimit               LimitType = "rbd_qos_bps_burst"
	BPSBurstDurationLimit       LimitType = "rbd_qos_bps_burst_seconds"
	ReadBPSLimit                LimitType = "rbd_qos_read_bps_limit"
	ReadBPSBurstLimit           LimitType = "rbd_qos_read_bps_burst"
	ReadBPSBurstDurationLimit   LimitType = "rbd_qos_read_bps_burst_seconds"
	WriteBPSLimit               LimitType = "rbd_qos_write_bps_limit"
	WriteBPSBurstLimit          LimitType = "rbd_qos_write_bps_burst"
	WriteBPSBurstDurationLimit  LimitType = "rbd_qos_write_bps_burst_seconds"
)

type Limits ¶

type Limits map[LimitType]int64

type Snapshot ¶

type Snapshot struct {
	apiutils.Metadata `json:"metadata,omitempty"`

	Source SnapshotSource `json:"source"`

	Status SnapshotStatus `json:"status"`
}

type SnapshotSource ¶

type SnapshotSource struct {
	IronCoreImage string `json:"ironcoreImage"`
	VolumeImageID string `json:"volumeImageId"`
}

type SnapshotState ¶

type SnapshotState string

const (
	SnapshotStatePending   SnapshotState = "Pending"
	SnapshotStatePopulated SnapshotState = "Populated"
	SnapshotStateReady     SnapshotState = "Ready"
	SnapshotStateFailed    SnapshotState = "Failed"
)

type SnapshotStatus ¶

type SnapshotStatus struct {
	State  SnapshotState `json:"state"`
	Digest string        `json:"digest"`
	Size   int64         `json:"size"`
}

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL