[Improvement] Add ServerGroup details into ServerGroupSpec (#1191)

Author: ajanikow

CHANGELOG.md

@@ -26,6 +26,7 @@
 - (Bugfix) Check ArangoSync availability without checking healthiness
 - (Improvement) Add Anonymous Inspector mods
 - (Improvement) Do not check checksums for DeploymentReplicationStatus.IncomingSynchronization field values
+- (Improvement) Add ServerGroup details into ServerGroupSpec
 
 ## [1.2.20](https://github.com/arangodb/kube-arangodb/tree/1.2.20) (2022-10-25)
 - (Feature) Add action progress

pkg/apis/deployment/v1/deployment_spec.go

@@ -286,17 +286,17 @@ func (s DeploymentSpec) IsSecure() bool {
 func (s DeploymentSpec) GetServerGroupSpec(group ServerGroup) ServerGroupSpec {
 	switch group {
 	case ServerGroupSingle:
-		return s.Single
+		return s.Single.WithGroup(group)
 	case ServerGroupAgents:
-		return s.Agents
+		return s.Agents.WithGroup(group)
 	case ServerGroupDBServers:
-		return s.DBServers
+		return s.DBServers.WithGroup(group)
 	case ServerGroupCoordinators:
-		return s.Coordinators
+		return s.Coordinators.WithGroup(group)
 	case ServerGroupSyncMasters:
-		return s.SyncMasters
+		return s.SyncMasters.WithGroup(group)
 	case ServerGroupSyncWorkers:
-		return s.SyncWorkers
+		return s.SyncWorkers.WithGroup(group)
 	default:
 		return ServerGroupSpec{}
 	}

pkg/apis/deployment/v1/server_group_spec.go

@@ -66,6 +66,8 @@ const (
 
 // ServerGroupSpec contains the specification for all servers in a specific group (e.g. all agents)
 type ServerGroupSpec struct {
+	group ServerGroup `json:"-"`
+
 	// Count holds the requested number of servers
 	Count *int `json:"count,omitempty"`
 	// MinCount specifies a lower limit for count
@@ -343,7 +345,7 @@ func (s ServerGroupSpec) GetOverrideDetectedTotalMemory() bool {
 	return *s.OverrideDetectedTotalMemory
 }
 
-// OverrideDetectedNumberOfCores returns OverrideDetectedNumberOfCores with default value (false)
+// GetOverrideDetectedNumberOfCores returns OverrideDetectedNumberOfCores with default value (false)
 func (s ServerGroupSpec) GetOverrideDetectedNumberOfCores() bool {
 	if s.OverrideDetectedNumberOfCores == nil {
 		return true
@@ -354,6 +356,10 @@ func (s ServerGroupSpec) GetOverrideDetectedNumberOfCores() bool {
 
 // Validate the given group spec
 func (s ServerGroupSpec) Validate(group ServerGroup, used bool, mode DeploymentMode, env Environment) error {
+	if s.group != group {
+		return errors.WithStack(errors.Wrapf(ValidationError, "Group is not set"))
+	}
+
 	if used {
 		minCount := 1
 		if env == EnvironmentProduction {
@@ -484,8 +490,27 @@ func (s *ServerGroupSpec) validateVolumes() error {
 	return nil
 }
 
+// WithGroup copy deployment with missing group
+func (s ServerGroupSpec) WithGroup(group ServerGroup) ServerGroupSpec {
+	s.group = group
+	return s
+}
+
+// WithDefaults copy deployment with missing defaults
+func (s ServerGroupSpec) WithDefaults(group ServerGroup, used bool, mode DeploymentMode) ServerGroupSpec {
+	q := s.DeepCopy()
+	q.SetDefaults(group, used, mode)
+	return *q
+}
+
 // SetDefaults fills in missing defaults
 func (s *ServerGroupSpec) SetDefaults(group ServerGroup, used bool, mode DeploymentMode) {
+	if s == nil {
+		return
+	}
+
+	s.group = group
+
 	if s.GetCount() == 0 && used {
 		switch group {
 		case ServerGroupSingle:
@@ -636,3 +661,11 @@ func (s ServerGroupSpec) GetExternalPortEnabled() bool {
 		return *v
 	}
 }
+
+func (s *ServerGroupSpec) Group() ServerGroup {
+	if s == nil {
+		return ServerGroupUnknown
+	}
+
+	return s.group
+}

pkg/apis/deployment/v1/server_group_spec_test.go

@@ -78,6 +78,8 @@ const (
 	ConditionTypeUpgradeFailed ConditionType = "UpgradeFailed"
 	// ConditionTypeArchitectureMismatch indicates that the member has a different architecture than the deployment.
 	ConditionTypeArchitectureMismatch ConditionType = "ArchitectureMismatch"
+	// ConditionTypeArchitectureChangeCannotBeApplied indicates that the member has a different architecture than the requested one.
+	ConditionTypeArchitectureChangeCannotBeApplied ConditionType = "ArchitectureChangeCannotBeApplied"
 
 	// ConditionTypeMemberMaintenanceMode indicates that Maintenance is enabled on particular member
 	ConditionTypeMemberMaintenanceMode ConditionType = "MemberMaintenanceMode"

pkg/apis/deployment/v2alpha1/conditions.go

@@ -286,17 +286,17 @@ func (s DeploymentSpec) IsSecure() bool {
 func (s DeploymentSpec) GetServerGroupSpec(group ServerGroup) ServerGroupSpec {
 	switch group {
 	case ServerGroupSingle:
-		return s.Single
+		return s.Single.WithGroup(group)
 	case ServerGroupAgents:
-		return s.Agents
+		return s.Agents.WithGroup(group)
 	case ServerGroupDBServers:
-		return s.DBServers
+		return s.DBServers.WithGroup(group)
 	case ServerGroupCoordinators:
-		return s.Coordinators
+		return s.Coordinators.WithGroup(group)
 	case ServerGroupSyncMasters:
-		return s.SyncMasters
+		return s.SyncMasters.WithGroup(group)
 	case ServerGroupSyncWorkers:
-		return s.SyncWorkers
+		return s.SyncWorkers.WithGroup(group)
 	default:
 		return ServerGroupSpec{}
 	}

pkg/apis/deployment/v2alpha1/deployment_spec.go

@@ -66,6 +66,8 @@ const (
 
 // ServerGroupSpec contains the specification for all servers in a specific group (e.g. all agents)
 type ServerGroupSpec struct {
+	group ServerGroup `json:"-"`
+
 	// Count holds the requested number of servers
 	Count *int `json:"count,omitempty"`
 	// MinCount specifies a lower limit for count
@@ -343,7 +345,7 @@ func (s ServerGroupSpec) GetOverrideDetectedTotalMemory() bool {
 	return *s.OverrideDetectedTotalMemory
 }
 
-// OverrideDetectedNumberOfCores returns OverrideDetectedNumberOfCores with default value (false)
+// GetOverrideDetectedNumberOfCores returns OverrideDetectedNumberOfCores with default value (false)
 func (s ServerGroupSpec) GetOverrideDetectedNumberOfCores() bool {
 	if s.OverrideDetectedNumberOfCores == nil {
 		return true
@@ -354,6 +356,10 @@ func (s ServerGroupSpec) GetOverrideDetectedNumberOfCores() bool {
 
 // Validate the given group spec
 func (s ServerGroupSpec) Validate(group ServerGroup, used bool, mode DeploymentMode, env Environment) error {
+	if s.group != group {
+		return errors.WithStack(errors.Wrapf(ValidationError, "Group is not set"))
+	}
+
 	if used {
 		minCount := 1
 		if env == EnvironmentProduction {
@@ -484,8 +490,27 @@ func (s *ServerGroupSpec) validateVolumes() error {
 	return nil
 }
 
+// WithGroup copy deployment with missing group
+func (s ServerGroupSpec) WithGroup(group ServerGroup) ServerGroupSpec {
+	s.group = group
+	return s
+}
+
+// WithDefaults copy deployment with missing defaults
+func (s ServerGroupSpec) WithDefaults(group ServerGroup, used bool, mode DeploymentMode) ServerGroupSpec {
+	q := s.DeepCopy()
+	q.SetDefaults(group, used, mode)
+	return *q
+}
+
 // SetDefaults fills in missing defaults
 func (s *ServerGroupSpec) SetDefaults(group ServerGroup, used bool, mode DeploymentMode) {
+	if s == nil {
+		return
+	}
+
+	s.group = group
+
 	if s.GetCount() == 0 && used {
 		switch group {
 		case ServerGroupSingle:
@@ -636,3 +661,11 @@ func (s ServerGroupSpec) GetExternalPortEnabled() bool {
 		return *v
 	}
 }
+
+func (s *ServerGroupSpec) Group() ServerGroup {
+	if s == nil {
+		return ServerGroupUnknown
+	}
+
+	return s.group
+}