[Feature] PVC Member Status info (#1145)

Author: ajanikow

CHANGELOG.md

@@ -7,6 +7,7 @@
 - (Bugfix) Prevent Member Maintenance Error log
 - (Feature) ID ServerGroup
 - (Bugfix) Propagate Lifecycle Mount
+- (Feature) PVC Member Status info
 
 ## [1.2.19](https://github.com/arangodb/kube-arangodb/tree/1.2.19) (2022-10-05)
 - (Bugfix) Prevent changes when UID is wrong

pkg/apis/deployment/v1/member_pvc_status.go

@@ -0,0 +1,55 @@
+//
+// DISCLAIMER
+//
+// Copyright 2016-2022 ArangoDB GmbH, Cologne, Germany
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+//
+// Copyright holder is ArangoDB GmbH, Cologne, Germany
+//
+
+package v1
+
+type MemberPersistentVolumeClaimStatus struct {
+	Name string `json:"name"`
+}
+
+func (m *MemberPersistentVolumeClaimStatus) Equal(other *MemberPersistentVolumeClaimStatus) bool {
+	if m == nil && other == nil {
+		return true
+	}
+	if m == nil || other == nil {
+		return false
+	}
+	return m.Name == other.Name
+}
+
+func (m *MemberPersistentVolumeClaimStatus) GetName() string {
+	if m == nil {
+		return ""
+	}
+
+	return m.Name
+}
+
+func (m *MemberPersistentVolumeClaimStatus) Propagate(s *MemberStatus) {
+	if s == nil {
+		return
+	}
+
+	if m == nil {
+		s.PersistentVolumeClaimName = ""
+	} else {
+		s.PersistentVolumeClaimName = m.Name
+	}
+}

pkg/apis/deployment/v1/member_status.go

@@ -50,8 +50,6 @@ type MemberStatus struct {
 	Phase MemberPhase `json:"phase"`
 	// CreatedAt holds the creation timestamp of this member.
 	CreatedAt meta.Time `json:"created-at"`
-	// PersistentVolumeClaimName holds the name of the persistent volume claim used for this member (if any).
-	PersistentVolumeClaimName string `json:"persistentVolumeClaimName,omitempty"`
 	// Conditions specific to this member
 	Conditions ConditionList `json:"conditions,omitempty"`
 	// RecentTerminatons holds the times when this member was recently terminated.
@@ -81,6 +79,12 @@ type MemberStatus struct {
 	Pod          *MemberPodStatus      `json:"pod,omitempty"`
 	SecondaryPod *MemberPodStatus      `json:"secondaryPod,omitempty"`
 
+	// PersistentVolumeClaim keeps information about PVC for Primary Pod
+	PersistentVolumeClaim *MemberPersistentVolumeClaimStatus `json:"persistentVolumeClaim,omitempty"`
+
+	// SecondaryPersistentVolumeClaim keeps information about PVC for SecondaryPod
+	SecondaryPersistentVolumeClaim *MemberPersistentVolumeClaimStatus `json:"secondaryPersistentVolumeClaim,omitempty"`
+
 	// deprecated
 	// SideCarSpecs contains list of specifications specified for side cars
 	SideCarSpecs map[string]core.Container `json:"sidecars-specs,omitempty"`
@@ -93,6 +97,9 @@ type MemberStatus struct {
 	// deprecated
 	// PodSpecVersion holds the checksum of Pod spec that currently runs this member. Used to rotate pods
 	PodSpecVersion string `json:"podSpecVersion,omitempty"`
+	// deprecated
+	// PersistentVolumeClaimName holds the name of the persistent volume claim used for this member (if any).
+	PersistentVolumeClaimName string `json:"persistentVolumeClaimName,omitempty"`
 }
 
 // Equal checks for equality
@@ -103,7 +110,8 @@ func (s MemberStatus) Equal(other MemberStatus) bool {
 		s.ClusterID == other.ClusterID &&
 		s.Phase == other.Phase &&
 		util.TimeCompareEqual(s.CreatedAt, other.CreatedAt) &&
-		s.PersistentVolumeClaimName == other.PersistentVolumeClaimName &&
+		s.PersistentVolumeClaim.Equal(other.PersistentVolumeClaim) &&
+		s.SecondaryPersistentVolumeClaim.Equal(other.SecondaryPersistentVolumeClaim) &&
 		s.Pod.Equal(other.Pod) &&
 		s.SecondaryPod.Equal(other.SecondaryPod) &&
 		s.Conditions.Equal(other.Conditions) &&

pkg/apis/deployment/v1/zz_generated.deepcopy.go

@@ -0,0 +1,55 @@
+//
+// DISCLAIMER
+//
+// Copyright 2016-2022 ArangoDB GmbH, Cologne, Germany
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+//
+// Copyright holder is ArangoDB GmbH, Cologne, Germany
+//
+
+package v2alpha1
+
+type MemberPersistentVolumeClaimStatus struct {
+	Name string `json:"name"`
+}
+
+func (m *MemberPersistentVolumeClaimStatus) Equal(other *MemberPersistentVolumeClaimStatus) bool {
+	if m == nil && other == nil {
+		return true
+	}
+	if m == nil || other == nil {
+		return false
+	}
+	return m.Name == other.Name
+}
+
+func (m *MemberPersistentVolumeClaimStatus) GetName() string {
+	if m == nil {
+		return ""
+	}
+
+	return m.Name
+}
+
+func (m *MemberPersistentVolumeClaimStatus) Propagate(s *MemberStatus) {
+	if s == nil {
+		return
+	}
+
+	if m == nil {
+		s.PersistentVolumeClaimName = ""
+	} else {
+		s.PersistentVolumeClaimName = m.Name
+	}
+}

pkg/apis/deployment/v2alpha1/member_pvc_status.go

@@ -50,8 +50,6 @@ type MemberStatus struct {
 	Phase MemberPhase `json:"phase"`
 	// CreatedAt holds the creation timestamp of this member.
 	CreatedAt meta.Time `json:"created-at"`
-	// PersistentVolumeClaimName holds the name of the persistent volume claim used for this member (if any).
-	PersistentVolumeClaimName string `json:"persistentVolumeClaimName,omitempty"`
 	// Conditions specific to this member
 	Conditions ConditionList `json:"conditions,omitempty"`
 	// RecentTerminatons holds the times when this member was recently terminated.
@@ -81,6 +79,12 @@ type MemberStatus struct {
 	Pod          *MemberPodStatus      `json:"pod,omitempty"`
 	SecondaryPod *MemberPodStatus      `json:"secondaryPod,omitempty"`
 
+	// PersistentVolumeClaim keeps information about PVC for Primary Pod
+	PersistentVolumeClaim *MemberPersistentVolumeClaimStatus `json:"persistentVolumeClaim,omitempty"`
+
+	// SecondaryPersistentVolumeClaim keeps information about PVC for SecondaryPod
+	SecondaryPersistentVolumeClaim *MemberPersistentVolumeClaimStatus `json:"secondaryPersistentVolumeClaim,omitempty"`
+
 	// deprecated
 	// SideCarSpecs contains list of specifications specified for side cars
 	SideCarSpecs map[string]core.Container `json:"sidecars-specs,omitempty"`
@@ -93,6 +97,9 @@ type MemberStatus struct {
 	// deprecated
 	// PodSpecVersion holds the checksum of Pod spec that currently runs this member. Used to rotate pods
 	PodSpecVersion string `json:"podSpecVersion,omitempty"`
+	// deprecated
+	// PersistentVolumeClaimName holds the name of the persistent volume claim used for this member (if any).
+	PersistentVolumeClaimName string `json:"persistentVolumeClaimName,omitempty"`
 }
 
 // Equal checks for equality
@@ -103,7 +110,8 @@ func (s MemberStatus) Equal(other MemberStatus) bool {
 		s.ClusterID == other.ClusterID &&
 		s.Phase == other.Phase &&
 		util.TimeCompareEqual(s.CreatedAt, other.CreatedAt) &&
-		s.PersistentVolumeClaimName == other.PersistentVolumeClaimName &&
+		s.PersistentVolumeClaim.Equal(other.PersistentVolumeClaim) &&
+		s.SecondaryPersistentVolumeClaim.Equal(other.SecondaryPersistentVolumeClaim) &&
 		s.Pod.Equal(other.Pod) &&
 		s.SecondaryPod.Equal(other.SecondaryPod) &&
 		s.Conditions.Equal(other.Conditions) &&

pkg/apis/deployment/v2alpha1/member_status.go

@@ -457,7 +457,9 @@ func TestEnsurePod_ArangoDB_Core(t *testing.T) {
 					Images: createTestImages(false),
 				}
 
-				deployment.currentObjectStatus.Members.DBServers[0].PersistentVolumeClaimName = testPersistentVolumeClaimName
+				deployment.currentObjectStatus.Members.DBServers[0].PersistentVolumeClaim = &api.MemberPersistentVolumeClaimStatus{
+					Name: testPersistentVolumeClaimName,
+				}
 				testCase.createTestPodData(deployment, api.ServerGroupDBServers, firstDBServerStatus)
 			},
 			ExpectedEvent: "member dbserver is created",
@@ -614,7 +616,9 @@ func TestEnsurePod_ArangoDB_Core(t *testing.T) {
 			},
 			Helper: func(t *testing.T, deployment *Deployment, testCase *testCaseStruct) {
 				agentWithPersistentVolumeClaim := firstAgentStatus
-				agentWithPersistentVolumeClaim.PersistentVolumeClaimName = testPersistentVolumeClaimName
+				agentWithPersistentVolumeClaim.PersistentVolumeClaim = &api.MemberPersistentVolumeClaimStatus{
+					Name: testPersistentVolumeClaimName,
+				}
 
 				deployment.currentObjectStatus = &api.DeploymentStatus{
 					Members: api.DeploymentStatusMembers{

pkg/apis/deployment/v2alpha1/zz_generated.deepcopy.go

@@ -40,6 +40,20 @@ func RecoverPodDetails(in *api.DeploymentStatus) (changed bool, _ error) {
 				changed = true
 			}
 		}
+
+		if p := m.Member.PersistentVolumeClaim; p == nil {
+			// Recovery is nil, recovery might be needed
+			if m.Member.PersistentVolumeClaimName != "" {
+				m.Member.PersistentVolumeClaim = &api.MemberPersistentVolumeClaimStatus{
+					Name: m.Member.PersistentVolumeClaimName,
+				}
+
+				if err := in.Members.Update(m.Member, m.Group); err != nil {
+					return false, err
+				}
+				changed = true
+			}
+		}
 	}
 	return
 }