[Feature] License V2 for ArangoDB 3.9.0+ (#870)

Author: ajanikow

CHANGELOG.md

@@ -7,6 +7,7 @@
 - Keep only recent terminations
 - Add endpoint into member status
 - Add debug mode (Golang DLV)
+- License V2 for ArangoDB 3.9.0+
 
 ## [1.2.6](https://github.com/arangodb/kube-arangodb/tree/1.2.6) (2021-12-15)
 - Add ArangoBackup backoff functionality

pkg/apis/deployment/v1/conditions.go

@@ -84,6 +84,9 @@ const (
 
 	// ConditionTypeTopologyAware indicates that the member is deployed with TopologyAwareness.
 	ConditionTypeTopologyAware ConditionType = "TopologyAware"
+
+	// ConditionTypeLicenseSet indicates that license V2 is set on cluster.
+	ConditionTypeLicenseSet ConditionType = "LicenseSet"
 )
 
 // Condition represents one current condition of a deployment or deployment member.
@@ -102,6 +105,8 @@ type Condition struct {
 	Reason string `json:"reason,omitempty"`
 	// A human readable message indicating details about the transition.
 	Message string `json:"message,omitempty"`
+	// Hash keep propagation hash id, for example checksum of secret
+	Hash string `json:"hash,omitempty"`
 }
 
 func (c Condition) IsTrue() bool {
@@ -139,7 +144,8 @@ func (c Condition) Equal(other Condition) bool {
 		util.TimeCompareEqual(c.LastUpdateTime, other.LastUpdateTime) &&
 		util.TimeCompareEqual(c.LastTransitionTime, other.LastTransitionTime) &&
 		c.Reason == other.Reason &&
-		c.Message == other.Message
+		c.Message == other.Message &&
+		c.Hash == other.Hash
 }
 
 // IsTrue return true when a condition with given type exists and its status is `True`.
@@ -178,47 +184,72 @@ func (list *ConditionList) Touch(conditionType ConditionType) bool {
 	return false
 }
 
-// Update the condition, replacing an old condition with same type (if any)
-// Returns true when changes were made, false otherwise.
-func (list *ConditionList) Update(conditionType ConditionType, status bool, reason, message string) bool {
+func (list ConditionList) Index(conditionType ConditionType) int {
+	for i, x := range list {
+		if x.Type == conditionType {
+			return i
+		}
+	}
+
+	return -1
+}
+
+func (list *ConditionList) update(conditionType ConditionType, status bool, reason, message, hash string) bool {
 	src := *list
 	statusX := v1.ConditionFalse
 	if status {
 		statusX = v1.ConditionTrue
 	}
-	for i, x := range src {
-		if x.Type == conditionType {
-			if x.Status != statusX {
-				// Transition to another status
-				src[i].Status = statusX
-				now := metav1.Now()
-				src[i].LastTransitionTime = now
-				src[i].LastUpdateTime = now
-				src[i].Reason = reason
-				src[i].Message = message
-			} else if x.Reason != reason || x.Message != message {
-				src[i].LastUpdateTime = metav1.Now()
-				src[i].Reason = reason
-				src[i].Message = message
-			} else {
-				return false
-			}
-			return true
-		}
+
+	index := list.Index(conditionType)
+
+	if index == -1 {
+		// Not found
+		now := metav1.Now()
+		*list = append(src, Condition{
+			Type:               conditionType,
+			LastUpdateTime:     now,
+			LastTransitionTime: now,
+			Status:             statusX,
+			Reason:             reason,
+			Message:            message,
+			Hash:               hash,
+		})
+		return true
+	}
+
+	if src[index].Status != statusX {
+		// Transition to another status
+		src[index].Status = statusX
+		now := metav1.Now()
+		src[index].LastTransitionTime = now
+		src[index].LastUpdateTime = now
+		src[index].Reason = reason
+		src[index].Message = message
+		src[index].Hash = hash
+	} else if src[index].Reason != reason || src[index].Message != message || src[index].Hash != hash {
+		src[index].LastUpdateTime = metav1.Now()
+		src[index].Reason = reason
+		src[index].Message = message
+		src[index].Hash = hash
+	} else {
+		return false
 	}
-	// Not found
-	now := metav1.Now()
-	*list = append(src, Condition{
-		Type:               conditionType,
-		LastUpdateTime:     now,
-		LastTransitionTime: now,
-		Status:             statusX,
-		Reason:             reason,
-		Message:            message,
-	})
 	return true
 }
 
+// Update the condition, replacing an old condition with same type (if any)
+// Returns true when changes were made, false otherwise.
+func (list *ConditionList) Update(conditionType ConditionType, status bool, reason, message string) bool {
+	return list.update(conditionType, status, reason, message, "")
+}
+
+// UpdateWithHash updates the condition, replacing an old condition with same type (if any)
+// Returns true when changes were made, false otherwise.
+func (list *ConditionList) UpdateWithHash(conditionType ConditionType, status bool, reason, message, hash string) bool {
+	return list.update(conditionType, status, reason, message, hash)
+}
+
 // Remove the condition with given type.
 // Returns true if removed, or false if not found.
 func (list *ConditionList) Remove(conditionType ConditionType) bool {

pkg/apis/deployment/v1/plan.go

@@ -49,7 +49,7 @@ func (a ActionType) String() string {
 // Priority returns plan priority
 func (a ActionType) Priority() ActionPriority {
 	switch a {
-	case ActionTypeMemberPhaseUpdate, ActionTypeMemberRIDUpdate, ActionTypeSetMemberCondition, ActionTypeSetCondition:
+	case ActionTypeMemberPhaseUpdate, ActionTypeMemberRIDUpdate, ActionTypeSetMemberCondition, ActionTypeSetCondition, ActionTypeSetMemberConditionV2:
 		return ActionPriorityHigh
 	default:
 		return ActionPriorityNormal
@@ -161,8 +161,12 @@ const (
 	ActionTypeMemberPhaseUpdate ActionType = "MemberPhaseUpdate"
 	// ActionTypeSetMemberCondition sets member condition. It is high priority action.
 	ActionTypeSetMemberCondition ActionType = "SetMemberCondition"
+	// ActionTypeSetMemberConditionV2 sets member condition. It is high priority action.
+	ActionTypeSetMemberConditionV2 ActionType = "SetMemberConditionV2"
 	// ActionTypeSetCondition sets condition. It is high priority action.
 	ActionTypeSetCondition ActionType = "SetCondition"
+	// ActionTypeSetConditionV2 sets condition. It is high priority action.
+	ActionTypeSetConditionV2 ActionType = "SetConditionV2"
 	// ActionTypeMemberRIDUpdate updated member Run ID (UID). High priority
 	ActionTypeMemberRIDUpdate ActionType = "MemberRIDUpdate"
 	// ActionTypeArangoMemberUpdatePodSpec updates pod spec

pkg/apis/deployment/v2alpha1/conditions.go

@@ -84,6 +84,9 @@ const (
 
 	// ConditionTypeTopologyAware indicates that the member is deployed with TopologyAwareness.
 	ConditionTypeTopologyAware ConditionType = "TopologyAware"
+
+	// ConditionTypeLicenseSet indicates that license V2 is set on cluster.
+	ConditionTypeLicenseSet ConditionType = "LicenseSet"
 )
 
 // Condition represents one current condition of a deployment or deployment member.
@@ -102,6 +105,8 @@ type Condition struct {
 	Reason string `json:"reason,omitempty"`
 	// A human readable message indicating details about the transition.
 	Message string `json:"message,omitempty"`
+	// Hash keep propagation hash id, for example checksum of secret
+	Hash string `json:"hash,omitempty"`
 }
 
 func (c Condition) IsTrue() bool {
@@ -139,7 +144,8 @@ func (c Condition) Equal(other Condition) bool {
 		util.TimeCompareEqual(c.LastUpdateTime, other.LastUpdateTime) &&
 		util.TimeCompareEqual(c.LastTransitionTime, other.LastTransitionTime) &&
 		c.Reason == other.Reason &&
-		c.Message == other.Message
+		c.Message == other.Message &&
+		c.Hash == other.Hash
 }
 
 // IsTrue return true when a condition with given type exists and its status is `True`.
@@ -178,47 +184,72 @@ func (list *ConditionList) Touch(conditionType ConditionType) bool {
 	return false
 }
 
-// Update the condition, replacing an old condition with same type (if any)
-// Returns true when changes were made, false otherwise.
-func (list *ConditionList) Update(conditionType ConditionType, status bool, reason, message string) bool {
+func (list ConditionList) Index(conditionType ConditionType) int {
+	for i, x := range list {
+		if x.Type == conditionType {
+			return i
+		}
+	}
+
+	return -1
+}
+
+func (list *ConditionList) update(conditionType ConditionType, status bool, reason, message, hash string) bool {
 	src := *list
 	statusX := v1.ConditionFalse
 	if status {
 		statusX = v1.ConditionTrue
 	}
-	for i, x := range src {
-		if x.Type == conditionType {
-			if x.Status != statusX {
-				// Transition to another status
-				src[i].Status = statusX
-				now := metav1.Now()
-				src[i].LastTransitionTime = now
-				src[i].LastUpdateTime = now
-				src[i].Reason = reason
-				src[i].Message = message
-			} else if x.Reason != reason || x.Message != message {
-				src[i].LastUpdateTime = metav1.Now()
-				src[i].Reason = reason
-				src[i].Message = message
-			} else {
-				return false
-			}
-			return true
-		}
+
+	index := list.Index(conditionType)
+
+	if index == -1 {
+		// Not found
+		now := metav1.Now()
+		*list = append(src, Condition{
+			Type:               conditionType,
+			LastUpdateTime:     now,
+			LastTransitionTime: now,
+			Status:             statusX,
+			Reason:             reason,
+			Message:            message,
+			Hash:               hash,
+		})
+		return true
+	}
+
+	if src[index].Status != statusX {
+		// Transition to another status
+		src[index].Status = statusX
+		now := metav1.Now()
+		src[index].LastTransitionTime = now
+		src[index].LastUpdateTime = now
+		src[index].Reason = reason
+		src[index].Message = message
+		src[index].Hash = hash
+	} else if src[index].Reason != reason || src[index].Message != message || src[index].Hash != hash {
+		src[index].LastUpdateTime = metav1.Now()
+		src[index].Reason = reason
+		src[index].Message = message
+		src[index].Hash = hash
+	} else {
+		return false
 	}
-	// Not found
-	now := metav1.Now()
-	*list = append(src, Condition{
-		Type:               conditionType,
-		LastUpdateTime:     now,
-		LastTransitionTime: now,
-		Status:             statusX,
-		Reason:             reason,
-		Message:            message,
-	})
 	return true
 }
 
+// Update the condition, replacing an old condition with same type (if any)
+// Returns true when changes were made, false otherwise.
+func (list *ConditionList) Update(conditionType ConditionType, status bool, reason, message string) bool {
+	return list.update(conditionType, status, reason, message, "")
+}
+
+// UpdateWithHash updates the condition, replacing an old condition with same type (if any)
+// Returns true when changes were made, false otherwise.
+func (list *ConditionList) UpdateWithHash(conditionType ConditionType, status bool, reason, message, hash string) bool {
+	return list.update(conditionType, status, reason, message, hash)
+}
+
 // Remove the condition with given type.
 // Returns true if removed, or false if not found.
 func (list *ConditionList) Remove(conditionType ConditionType) bool {

pkg/apis/deployment/v2alpha1/plan.go

@@ -49,7 +49,7 @@ func (a ActionType) String() string {
 // Priority returns plan priority
 func (a ActionType) Priority() ActionPriority {
 	switch a {
-	case ActionTypeMemberPhaseUpdate, ActionTypeMemberRIDUpdate, ActionTypeSetMemberCondition, ActionTypeSetCondition:
+	case ActionTypeMemberPhaseUpdate, ActionTypeMemberRIDUpdate, ActionTypeSetMemberCondition, ActionTypeSetCondition, ActionTypeSetMemberConditionV2:
 		return ActionPriorityHigh
 	default:
 		return ActionPriorityNormal
@@ -161,8 +161,12 @@ const (
 	ActionTypeMemberPhaseUpdate ActionType = "MemberPhaseUpdate"
 	// ActionTypeSetMemberCondition sets member condition. It is high priority action.
 	ActionTypeSetMemberCondition ActionType = "SetMemberCondition"
+	// ActionTypeSetMemberConditionV2 sets member condition. It is high priority action.
+	ActionTypeSetMemberConditionV2 ActionType = "SetMemberConditionV2"
 	// ActionTypeSetCondition sets condition. It is high priority action.
 	ActionTypeSetCondition ActionType = "SetCondition"
+	// ActionTypeSetConditionV2 sets condition. It is high priority action.
+	ActionTypeSetConditionV2 ActionType = "SetConditionV2"
 	// ActionTypeMemberRIDUpdate updated member Run ID (UID). High priority
 	ActionTypeMemberRIDUpdate ActionType = "MemberRIDUpdate"
 	// ActionTypeArangoMemberUpdatePodSpec updates pod spec

pkg/deployment/client/client.go

@@ -36,6 +36,8 @@ func NewClient(c driver.Connection) Client {
 }
 
 type Client interface {
+	LicenseClient
+
 	GetTLS(ctx context.Context) (TLSDetails, error)
 	RefreshTLS(ctx context.Context) (TLSDetails, error)