Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Simplify Volume phase #395

Merged
merged 1 commit into from
May 5, 2022
Merged

Simplify Volume phase #395

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
87 changes: 10 additions & 77 deletions apis/storage/v1alpha1/volume_types.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,28 +70,23 @@ type ClaimReference struct {
type VolumeStatus struct {
// State represents the infrastructure state of a Volume.
State VolumeState `json:"state,omitempty"`
// Conditions represents different status aspects of a Volume.
Conditions []VolumeCondition `json:"conditions,omitempty"`
// LastStateTransitionTime is the last time the State transitioned between values.
LastStateTransitionTime *metav1.Time `json:"lastStateTransitionTime,omitempty"`

// Phase represents the binding phase of a Volume.
Phase VolumePhase `json:"phase,omitempty"`
// LastPhaseTransitionTime is the last time the Phase transitioned between values.
LastPhaseTransitionTime *metav1.Time `json:"lastPhaseTransitionTime,omitempty"`

// Access specifies how to access a Volume.
// This is set by the volume provider when the volume is provisioned.
Access *VolumeAccess `json:"access,omitempty"`
}

const (
// VolumeBoundReasonUnbound is used for any Volume that is not bound.
VolumeBoundReasonUnbound = "Unbound"
// VolumeBoundReasonPending is used for any Volume that is not available.
VolumeBoundReasonPending = "Pending"
// VolumeBoundReasonBound is used for any Volume that is bound.
VolumeBoundReasonBound = "Bound"
)

// VolumePhase is the binding phase of a volume.
// VolumePhase represents the binding phase of a Volume.
type VolumePhase string

const (
// VolumePhaseUnknown is used for any Volume for which it is unknown whether it can be used for binding.
VolumePhaseUnknown VolumePhase = "Unknown"
// VolumePhaseUnbound is used for any Volume that not bound.
VolumePhaseUnbound VolumePhase = "Unbound"
// VolumePhasePending is used for any Volume that is currently awaiting binding.
Expand All @@ -100,45 +95,10 @@ const (
VolumePhaseBound VolumePhase = "Bound"
)

func FindVolumeCondition(conditions []VolumeCondition, conditionType VolumeConditionType) (VolumeCondition, int) {
for i, condition := range conditions {
if condition.Type == conditionType {
return condition, i
}
}
return VolumeCondition{}, -1
}

func VolumePhaseFromBoundStatusAndReason(status corev1.ConditionStatus, reason string) VolumePhase {
switch {
case status == corev1.ConditionFalse && reason == VolumeBoundReasonPending:
return VolumePhasePending
case status == corev1.ConditionFalse && reason == VolumeBoundReasonUnbound:
return VolumePhaseUnbound
case status == corev1.ConditionTrue:
return VolumePhaseBound
default:
return VolumePhaseUnknown
}
}

func GetVolumePhaseAndCondition(volume *Volume) (VolumePhase, VolumeCondition, int) {
cond, idx := FindVolumeCondition(volume.Status.Conditions, VolumeBound)
phase := VolumePhaseFromBoundStatusAndReason(cond.Status, cond.Reason)
return phase, cond, idx
}

func GetVolumePhase(volume *Volume) VolumePhase {
phase, _, _ := GetVolumePhaseAndCondition(volume)
return phase
}

// VolumeState is a possible state a volume can be in.
// VolumeState represents the infrastructure state of a Volume.
type VolumeState string

const (
// VolumeStateUnknown reports whether a Volume is in an unknown state.
VolumeStateUnknown VolumeState = "Unknown"
// VolumeStatePending reports whether a Volume is about to be ready.
VolumeStatePending VolumeState = "Pending"
// VolumeStateAvailable reports whether a Volume is available to be used.
Expand All @@ -147,33 +107,6 @@ const (
VolumeStateError VolumeState = "Error"
)

// VolumeConditionType is a type a VolumeCondition can have.
type VolumeConditionType string

const (
// VolumeSynced represents the condition of a volume being synced with its backing resources
VolumeSynced VolumeConditionType = "Synced"

// VolumeBound represents the binding state of a Volume.
VolumeBound VolumeConditionType = "Bound"
)

// VolumeCondition is one of the conditions of a volume.
type VolumeCondition struct {
// Type is the type of the condition.
Type VolumeConditionType `json:"type"`
// Status is the status of the condition.
Status corev1.ConditionStatus `json:"status"`
// Reason is a machine-readable indication of why the condition is in a certain state.
Reason string `json:"reason"`
// Message is a human-readable explanation of why the condition has a certain reason / state.
Message string `json:"message"`
// ObservedGeneration represents the .metadata.generation that the condition was set based upon.
ObservedGeneration int64 `json:"observedGeneration,omitempty"`
// LastTransitionTime is the last time the status of a condition has transitioned from one state to another.
LastTransitionTime metav1.Time `json:"lastTransitionTime,omitempty"`
}

// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
// +genclient

Expand Down
48 changes: 6 additions & 42 deletions apis/storage/v1alpha1/zz_generated.conversion.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

30 changes: 7 additions & 23 deletions apis/storage/v1alpha1/zz_generated.deepcopy.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

87 changes: 10 additions & 77 deletions apis/storage/volume_types.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,28 +70,23 @@ type ClaimReference struct {
type VolumeStatus struct {
// State represents the infrastructure state of a Volume.
State VolumeState
// Conditions represents different status aspects of a Volume.
Conditions []VolumeCondition
// LastStateTransitionTime is the last time the State transitioned between values.
LastStateTransitionTime *metav1.Time

// Phase represents the binding phase of a Volume.
Phase VolumePhase
// LastPhaseTransitionTime is the last time the Phase transitioned between values.
LastPhaseTransitionTime *metav1.Time

// Access specifies how to access a Volume.
// This is set by the volume provider when the volume is provisioned.
Access *VolumeAccess
}

const (
// VolumeBoundReasonUnbound is used for any Volume that is not bound.
VolumeBoundReasonUnbound = "Unbound"
// VolumeBoundReasonPending is used for any Volume that is not available.
VolumeBoundReasonPending = "Pending"
// VolumeBoundReasonBound is used for any Volume that is bound.
VolumeBoundReasonBound = "Bound"
)

// VolumePhase is the binding phase of a volume.
// VolumePhase represents the binding phase of a Volume.
type VolumePhase string

const (
// VolumePhaseUnknown is used for any Volume for which it is unknown whether it can be used for binding.
VolumePhaseUnknown VolumePhase = "Unknown"
// VolumePhaseUnbound is used for any Volume that not bound.
VolumePhaseUnbound VolumePhase = "Unbound"
// VolumePhasePending is used for any Volume that is currently awaiting binding.
Expand All @@ -100,45 +95,10 @@ const (
VolumePhaseBound VolumePhase = "Bound"
)

func FindVolumeCondition(conditions []VolumeCondition, conditionType VolumeConditionType) (VolumeCondition, int) {
for i, condition := range conditions {
if condition.Type == conditionType {
return condition, i
}
}
return VolumeCondition{}, -1
}

func VolumePhaseFromBoundStatusAndReason(status corev1.ConditionStatus, reason string) VolumePhase {
switch {
case status == corev1.ConditionFalse && reason == VolumeBoundReasonPending:
return VolumePhasePending
case status == corev1.ConditionFalse && reason == VolumeBoundReasonUnbound:
return VolumePhaseUnbound
case status == corev1.ConditionTrue:
return VolumePhaseBound
default:
return VolumePhaseUnknown
}
}

func GetVolumePhaseAndCondition(volume *Volume) (VolumePhase, VolumeCondition, int) {
cond, idx := FindVolumeCondition(volume.Status.Conditions, VolumeBound)
phase := VolumePhaseFromBoundStatusAndReason(cond.Status, cond.Reason)
return phase, cond, idx
}

func GetVolumePhase(volume *Volume) VolumePhase {
phase, _, _ := GetVolumePhaseAndCondition(volume)
return phase
}

// VolumeState is a possible state a volume can be in.
// VolumeState represents the infrastructure state of a Volume.
type VolumeState string

const (
// VolumeStateUnknown reports whether a Volume is in an unknown state.
VolumeStateUnknown VolumeState = "Unknown"
// VolumeStateAvailable reports whether the volume is available to be used.
VolumeStateAvailable VolumeState = "Available"
// VolumeStatePending reports whether the volume is about to be ready.
Expand All @@ -147,33 +107,6 @@ const (
VolumeStateError VolumeState = "Error"
)

// VolumeConditionType is a type a VolumeCondition can have.
type VolumeConditionType string

const (
// VolumeSynced represents the condition of a volume being synced with its backing resources
VolumeSynced VolumeConditionType = "Synced"

// VolumeBound represents the binding state of a Volume.
VolumeBound VolumeConditionType = "Bound"
)

// VolumeCondition is one of the conditions of a volume.
type VolumeCondition struct {
// Type is the type of the condition.
Type VolumeConditionType
// Status is the status of the condition.
Status corev1.ConditionStatus
// Reason is a machine-readable indication of why the condition is in a certain state.
Reason string
// Message is a human-readable explanation of why the condition has a certain reason / state.
Message string
// ObservedGeneration represents the .metadata.generation that the condition was set based upon.
ObservedGeneration int64
// LastTransitionTime is the last time the status of a condition has transitioned from one state to another.
LastTransitionTime metav1.Time
}

// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
// +genclient

Expand Down
Loading