[Feature] Container runtime image update (#787)

Author: ajanikow

CHANGELOG.md

@@ -3,6 +3,7 @@
 ## [master](https://github.com/arangodb/kube-arangodb/tree/master) (N/A)
 - Update UBI Image to 8.4
 - Fix ArangoSync Liveness Prove
+- Allow runtime update of Sidecar images
 
 ## [1.2.2](https://github.com/arangodb/kube-arangodb/tree/1.2.2) (2021-09-09)
 - Update 'github.com/arangodb/arangosync-client' dependency to v0.7.0

pkg/apis/deployment/v1/arango_member_pod_template.go

@@ -36,10 +36,16 @@ func GetArangoMemberPodTemplate(pod *core.PodTemplateSpec, podSpecChecksum strin
 		return nil, err
 	}
 
+	checksum := fmt.Sprintf("%0x", sha256.Sum256(data))
+
+	if podSpecChecksum == "" {
+		podSpecChecksum = checksum
+	}
+
 	return &ArangoMemberPodTemplate{
 		PodSpec:         pod,
 		PodSpecChecksum: podSpecChecksum,
-		Checksum:        fmt.Sprintf("%0x", sha256.Sum256(data)),
+		Checksum:        checksum,
 	}, nil
 }
 
@@ -49,6 +55,13 @@ type ArangoMemberPodTemplate struct {
 	Checksum        string                `json:"checksum,omitempty"`
 }
 
+func (a *ArangoMemberPodTemplate) GetChecksum() string {
+	if a == nil {
+		return ""
+	}
+	return a.Checksum
+}
+
 func (a *ArangoMemberPodTemplate) Equals(b *ArangoMemberPodTemplate) bool {
 	if a == nil && b == nil {
 		return true
@@ -58,7 +71,7 @@ func (a *ArangoMemberPodTemplate) Equals(b *ArangoMemberPodTemplate) bool {
 		return false
 	}
 
-	return a.Checksum == b.Checksum && a.PodSpecChecksum == b.PodSpecChecksum
+	return a.Checksum == b.Checksum
 }
 
 func (a *ArangoMemberPodTemplate) RotationNeeded(b *ArangoMemberPodTemplate) bool {
@@ -70,7 +83,7 @@ func (a *ArangoMemberPodTemplate) RotationNeeded(b *ArangoMemberPodTemplate) boo
 		return true
 	}
 
-	return a.PodSpecChecksum != b.PodSpecChecksum
+	return a.Checksum != b.Checksum
 }
 
 func (a *ArangoMemberPodTemplate) EqualPodSpecChecksum(checksum string) bool {

pkg/apis/deployment/v1/arango_member_status.go

@@ -22,16 +22,8 @@
 
 package v1
 
-const (
-	ArangoMemberConditionPendingRestart ConditionType = "pending-restart"
-)
-
 type ArangoMemberStatus struct {
 	Conditions ConditionList `json:"conditions,omitempty"`
 
 	Template *ArangoMemberPodTemplate `json:"template,omitempty"`
 }
-
-func (a ArangoMemberStatus) IsPendingRestart() bool {
-	return a.Conditions.IsTrue(ArangoMemberConditionPendingRestart)
-}

pkg/apis/deployment/v1/conditions.go

@@ -77,6 +77,12 @@ const (
 	ConditionTypeRestart ConditionType = "Restart"
 	// ConditionTypePendingTLSRotation indicates that TLS rotation is pending
 	ConditionTypePendingTLSRotation ConditionType = "PendingTLSRotation"
+	// ConditionTypePendingUpdate indicates that runtime update is pending
+	ConditionTypePendingUpdate ConditionType = "PendingUpdate"
+	// ConditionTypeUpdating indicates that runtime update is in progress
+	ConditionTypeUpdating ConditionType = "Updating"
+	// ConditionTypeUpdateFailed indicates that runtime update failed
+	ConditionTypeUpdateFailed ConditionType = "UpdateFailed"
 )
 
 // Condition represents one current condition of a deployment or deployment member.

pkg/apis/deployment/v1/plan.go

@@ -165,6 +165,10 @@ const (
 	ActionTypeArangoMemberUpdatePodSpec ActionType = "ArangoMemberUpdatePodSpec"
 	// ActionTypeArangoMemberUpdatePodStatus updates pod spec
 	ActionTypeArangoMemberUpdatePodStatus ActionType = "ArangoMemberUpdatePodStatus"
+
+	// Runtime Updates
+	// ActionTypeRuntimeContainerImageUpdate updates container image in runtime
+	ActionTypeRuntimeContainerImageUpdate ActionType = "RuntimeContainerImageUpdate"
 )
 
 const (
@@ -245,6 +249,29 @@ func NewAction(actionType ActionType, group ServerGroup, memberID string, reason
 	return a
 }
 
+// ActionBuilder allows to generate actions based on predefined group and member id
+type ActionBuilder interface {
+	// NewAction instantiates a new Action.
+	NewAction(actionType ActionType, reason ...string) Action
+}
+
+type actionBuilder struct {
+	group    ServerGroup
+	memberID string
+}
+
+func (a actionBuilder) NewAction(actionType ActionType, reason ...string) Action {
+	return NewAction(actionType, a.group, a.memberID, reason...)
+}
+
+// NewActionBuilder create new action builder with provided group and id
+func NewActionBuilder(group ServerGroup, memberID string) ActionBuilder {
+	return actionBuilder{
+		group:    group,
+		memberID: memberID,
+	}
+}
+
 // SetImage sets the Image field to the given value and returns the modified
 // action.
 func (a Action) SetImage(image string) Action {

pkg/apis/deployment/v1/timeouts.go

@@ -33,9 +33,14 @@ const (
 )
 
 type Timeouts struct {
+	// AddMember action timeout
 	AddMember *Timeout `json:"addMember,omitempty"`
 
+	// MaintenanceGracePeriod action timeout
 	MaintenanceGracePeriod *Timeout `json:"maintenanceGracePeriod,omitempty"`
+
+	// RuntimeContainerImageUpdate action timeout
+	RuntimeContainerImageUpdate *Timeout `json:"runtimeContainerImageUpdate,omitempty"`
 }
 
 func (t *Timeouts) GetMaintenanceGracePeriod() time.Duration {

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

@@ -36,10 +36,16 @@ func GetArangoMemberPodTemplate(pod *core.PodTemplateSpec, podSpecChecksum strin
 		return nil, err
 	}
 
+	checksum := fmt.Sprintf("%0x", sha256.Sum256(data))
+
+	if podSpecChecksum == "" {
+		podSpecChecksum = checksum
+	}
+
 	return &ArangoMemberPodTemplate{
 		PodSpec:         pod,
 		PodSpecChecksum: podSpecChecksum,
-		Checksum:        fmt.Sprintf("%0x", sha256.Sum256(data)),
+		Checksum:        checksum,
 	}, nil
 }
 
@@ -49,6 +55,13 @@ type ArangoMemberPodTemplate struct {
 	Checksum        string                `json:"checksum,omitempty"`
 }
 
+func (a *ArangoMemberPodTemplate) GetChecksum() string {
+	if a == nil {
+		return ""
+	}
+	return a.Checksum
+}
+
 func (a *ArangoMemberPodTemplate) Equals(b *ArangoMemberPodTemplate) bool {
 	if a == nil && b == nil {
 		return true
@@ -58,7 +71,7 @@ func (a *ArangoMemberPodTemplate) Equals(b *ArangoMemberPodTemplate) bool {
 		return false
 	}
 
-	return a.Checksum == b.Checksum && a.PodSpecChecksum == b.PodSpecChecksum
+	return a.Checksum == b.Checksum
 }
 
 func (a *ArangoMemberPodTemplate) RotationNeeded(b *ArangoMemberPodTemplate) bool {
@@ -70,7 +83,7 @@ func (a *ArangoMemberPodTemplate) RotationNeeded(b *ArangoMemberPodTemplate) boo
 		return true
 	}
 
-	return a.PodSpecChecksum != b.PodSpecChecksum
+	return a.Checksum != b.Checksum
 }
 
 func (a *ArangoMemberPodTemplate) EqualPodSpecChecksum(checksum string) bool {

pkg/apis/deployment/v2alpha1/arango_member_pod_template.go

@@ -22,16 +22,8 @@
 
 package v2alpha1
 
-const (
-	ArangoMemberConditionPendingRestart ConditionType = "pending-restart"
-)
-
 type ArangoMemberStatus struct {
 	Conditions ConditionList `json:"conditions,omitempty"`
 
 	Template *ArangoMemberPodTemplate `json:"template,omitempty"`
 }
-
-func (a ArangoMemberStatus) IsPendingRestart() bool {
-	return a.Conditions.IsTrue(ArangoMemberConditionPendingRestart)
-}

pkg/apis/deployment/v2alpha1/arango_member_status.go

@@ -77,6 +77,12 @@ const (
 	ConditionTypeRestart ConditionType = "Restart"
 	// ConditionTypePendingTLSRotation indicates that TLS rotation is pending
 	ConditionTypePendingTLSRotation ConditionType = "PendingTLSRotation"
+	// ConditionTypePendingUpdate indicates that runtime update is pending
+	ConditionTypePendingUpdate ConditionType = "PendingUpdate"
+	// ConditionTypeUpdating indicates that runtime update is in progress
+	ConditionTypeUpdating ConditionType = "Updating"
+	// ConditionTypeUpdateFailed indicates that runtime update failed
+	ConditionTypeUpdateFailed ConditionType = "UpdateFailed"
 )
 
 // Condition represents one current condition of a deployment or deployment member.