[Feature] Headless DNS CommunicationMethod (#1282)

ajanikow · web-flow · commit 6a3b85940c63 · 2023-04-04T12:41:45.000+02:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -24,6 +24,7 @@
 - (Maintenance) Bump GO Modules
 - (Feature) Optional Graceful Restart
 - (Maintenance) Manual Recovery documentation
+- (Feature) Headless DNS CommunicationMethod
 
 ## [1.2.24](https://github.com/arangodb/kube-arangodb/tree/1.2.24) (2023-01-25)
 - (Bugfix) Fix deployment creation on ARM64
diff --git a/docs/generated/actions.md b/docs/generated/actions.md
@@ -13,6 +13,7 @@
 |         BackupRestoreClean         |    no    |  15m0s  |    no    |    Enterprise Only     |                                Clean restore status in case of restore spec change                                 |
 |        BootstrapSetPassword        |    no    |  10m0s  |    no    | Community & Enterprise |                                     Change password during bootstrap procedure                                     |
 |          BootstrapUpdate           |    no    |  10m0s  |    no    | Community & Enterprise |                                              Update bootstrap status                                               |
+|         CleanMemberService         |    no    |  30m0s  |    no    | Community & Enterprise |                                               Removes Server Service                                               |
 |           CleanOutMember           |    no    | 48h0m0s |    no    | Community & Enterprise |                                           Run the CleanOut job on member                                           |
 |       CleanTLSCACertificate        |    no    |  30m0s  |    no    |    Enterprise Only     |                                       Remove Certificate from CA TrustStore                                        |
 |     CleanTLSKeyfileCertificate     |    no    |  30m0s  |    no    |    Enterprise Only     |                                       Remove old TLS certificate from server                                       |
@@ -99,6 +100,7 @@ spec:
       BackupRestoreClean: 15m0s
       BootstrapSetPassword: 10m0s
       BootstrapUpdate: 10m0s
+      CleanMemberService: 30m0s
       CleanOutMember: 48h0m0s
       CleanTLSCACertificate: 30m0s
       CleanTLSKeyfileCertificate: 30m0s
diff --git a/go.mod b/go.mod
@@ -20,8 +20,6 @@ replace (
 	k8s.io/component-base => k8s.io/component-base v0.22.15
 	k8s.io/kubernetes => k8s.io/kubernetes v0.22.15
 	k8s.io/metrics => k8s.io/metrics v0.22.15
-
-	gopkg.in/yaml.v3 => gopkg.in/yaml.v3 v3.0.1
 )
 
 require (
@@ -54,7 +52,7 @@ require (
 	golang.org/x/time v0.0.0-20210723032227-1f47c861a9ac
 	google.golang.org/grpc v1.47.0
 	google.golang.org/protobuf v1.28.0
-	gopkg.in/yaml.v3 v3.0.0-20210107192922-496545a6307b
+	gopkg.in/yaml.v3 v3.0.1
 	k8s.io/api v0.22.15
 	k8s.io/apiextensions-apiserver v0.18.3
 	k8s.io/apimachinery v0.22.15
diff --git a/internal/actions.yaml b/internal/actions.yaml
@@ -55,6 +55,9 @@ actions:
     enterprise: true
     description: Recreate Server TLS Certificate secret
     timeout: 30m
+  CleanMemberService:
+    description: Removes Server Service
+    timeout: 30m
   RenewTLSCACertificate:
     enterprise: true
     description: Recreate Managed CA secret
diff --git a/pkg/apis/deployment/v1/actions.generated.go b/pkg/apis/deployment/v1/actions.generated.go
@@ -41,6 +41,8 @@ const (
 	ActionBootstrapSetPasswordDefaultTimeout time.Duration = ActionsDefaultTimeout
 	// ActionBootstrapUpdateDefaultTimeout define default timeout for action ActionBootstrapUpdate
 	ActionBootstrapUpdateDefaultTimeout time.Duration = ActionsDefaultTimeout
+	// ActionCleanMemberServiceDefaultTimeout define default timeout for action ActionCleanMemberService
+	ActionCleanMemberServiceDefaultTimeout time.Duration = 1800 * time.Second // 30m0s
 	// ActionCleanOutMemberDefaultTimeout define default timeout for action ActionCleanOutMember
 	ActionCleanOutMemberDefaultTimeout time.Duration = 172800 * time.Second // 48h0m0s
 	// ActionCleanTLSCACertificateDefaultTimeout define default timeout for action ActionCleanTLSCACertificate
@@ -196,6 +198,8 @@ const (
 	ActionTypeBootstrapSetPassword ActionType = "BootstrapSetPassword"
 	// ActionTypeBootstrapUpdate in scopes Normal. Update bootstrap status
 	ActionTypeBootstrapUpdate ActionType = "BootstrapUpdate"
+	// ActionTypeCleanMemberService in scopes Normal. Removes Server Service
+	ActionTypeCleanMemberService ActionType = "CleanMemberService"
 	// ActionTypeCleanOutMember in scopes Normal. Run the CleanOut job on member
 	ActionTypeCleanOutMember ActionType = "CleanOutMember"
 	// ActionTypeCleanTLSCACertificate in scopes Normal. Remove Certificate from CA TrustStore
@@ -352,6 +356,8 @@ func (a ActionType) DefaultTimeout() time.Duration {
 		return ActionBootstrapSetPasswordDefaultTimeout
 	case ActionTypeBootstrapUpdate:
 		return ActionBootstrapUpdateDefaultTimeout
+	case ActionTypeCleanMemberService:
+		return ActionCleanMemberServiceDefaultTimeout
 	case ActionTypeCleanOutMember:
 		return ActionCleanOutMemberDefaultTimeout
 	case ActionTypeCleanTLSCACertificate:
@@ -512,6 +518,8 @@ func (a ActionType) Priority() ActionPriority {
 		return ActionPriorityNormal
 	case ActionTypeBootstrapUpdate:
 		return ActionPriorityNormal
+	case ActionTypeCleanMemberService:
+		return ActionPriorityNormal
 	case ActionTypeCleanOutMember:
 		return ActionPriorityNormal
 	case ActionTypeCleanTLSCACertificate:
@@ -682,6 +690,8 @@ func (a ActionType) Optional() bool {
 		return false
 	case ActionTypeBootstrapUpdate:
 		return false
+	case ActionTypeCleanMemberService:
+		return false
 	case ActionTypeCleanOutMember:
 		return false
 	case ActionTypeCleanTLSCACertificate:
diff --git a/pkg/apis/deployment/v1/deployment_spec.go b/pkg/apis/deployment/v1/deployment_spec.go
@@ -59,13 +59,31 @@ func (d *DeploymentCommunicationMethod) Get() DeploymentCommunicationMethod {
 	}
 
 	switch v := *d; v {
-	case DeploymentCommunicationMethodHeadlessService, DeploymentCommunicationMethodDNS, DeploymentCommunicationMethodIP, DeploymentCommunicationMethodShortDNS:
+	case DeploymentCommunicationMethodHeadlessService, DeploymentCommunicationMethodDNS, DeploymentCommunicationMethodIP, DeploymentCommunicationMethodShortDNS, DeploymentCommunicationMethodHeadlessDNS:
 		return v
 	default:
 		return DefaultDeploymentCommunicationMethod
 	}
 }
 
+// ServiceType returns Service Type for communication method
+func (d *DeploymentCommunicationMethod) ServiceType() core.ServiceType {
+	switch d.Get() {
+	default:
+		return core.ServiceTypeClusterIP
+	}
+}
+
+// ServiceClusterIP returns Service ClusterIP for communication method
+func (d *DeploymentCommunicationMethod) ServiceClusterIP() string {
+	switch d.Get() {
+	case DeploymentCommunicationMethodHeadlessDNS:
+		return core.ClusterIPNone
+	default:
+		return ""
+	}
+}
+
 // String returns string representation of method.
 func (d DeploymentCommunicationMethod) String() string {
 	return string(d)
@@ -85,7 +103,9 @@ const (
 	DeploymentCommunicationMethodDNS DeploymentCommunicationMethod = "dns"
 	// DeploymentCommunicationMethodShortDNS define ClusterIP Service DNS based communication. Use namespaced short DNS (used in migration)
 	DeploymentCommunicationMethodShortDNS DeploymentCommunicationMethod = "short-dns"
-	// DeploymentCommunicationMethodIP define ClusterIP Servce IP based communication.
+	// DeploymentCommunicationMethodHeadlessDNS define Headless Service DNS based communication.
+	DeploymentCommunicationMethodHeadlessDNS DeploymentCommunicationMethod = "headless-dns"
+	// DeploymentCommunicationMethodIP define ClusterIP Service IP based communication.
 	DeploymentCommunicationMethodIP DeploymentCommunicationMethod = "ip"
 )
 
diff --git a/pkg/apis/deployment/v1/member_status.go b/pkg/apis/deployment/v1/member_status.go
@@ -1,7 +1,7 @@
 //
 // DISCLAIMER
 //
-// Copyright 2016-2022 ArangoDB GmbH, Cologne, Germany
+// Copyright 2016-2023 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.
diff --git a/pkg/apis/deployment/v2alpha1/actions.generated.go b/pkg/apis/deployment/v2alpha1/actions.generated.go
@@ -41,6 +41,8 @@ const (
 	ActionBootstrapSetPasswordDefaultTimeout time.Duration = ActionsDefaultTimeout
 	// ActionBootstrapUpdateDefaultTimeout define default timeout for action ActionBootstrapUpdate
 	ActionBootstrapUpdateDefaultTimeout time.Duration = ActionsDefaultTimeout
+	// ActionCleanMemberServiceDefaultTimeout define default timeout for action ActionCleanMemberService
+	ActionCleanMemberServiceDefaultTimeout time.Duration = 1800 * time.Second // 30m0s
 	// ActionCleanOutMemberDefaultTimeout define default timeout for action ActionCleanOutMember
 	ActionCleanOutMemberDefaultTimeout time.Duration = 172800 * time.Second // 48h0m0s
 	// ActionCleanTLSCACertificateDefaultTimeout define default timeout for action ActionCleanTLSCACertificate
@@ -196,6 +198,8 @@ const (
 	ActionTypeBootstrapSetPassword ActionType = "BootstrapSetPassword"
 	// ActionTypeBootstrapUpdate in scopes Normal. Update bootstrap status
 	ActionTypeBootstrapUpdate ActionType = "BootstrapUpdate"
+	// ActionTypeCleanMemberService in scopes Normal. Removes Server Service
+	ActionTypeCleanMemberService ActionType = "CleanMemberService"
 	// ActionTypeCleanOutMember in scopes Normal. Run the CleanOut job on member
 	ActionTypeCleanOutMember ActionType = "CleanOutMember"
 	// ActionTypeCleanTLSCACertificate in scopes Normal. Remove Certificate from CA TrustStore
@@ -352,6 +356,8 @@ func (a ActionType) DefaultTimeout() time.Duration {
 		return ActionBootstrapSetPasswordDefaultTimeout
 	case ActionTypeBootstrapUpdate:
 		return ActionBootstrapUpdateDefaultTimeout
+	case ActionTypeCleanMemberService:
+		return ActionCleanMemberServiceDefaultTimeout
 	case ActionTypeCleanOutMember:
 		return ActionCleanOutMemberDefaultTimeout
 	case ActionTypeCleanTLSCACertificate:
@@ -512,6 +518,8 @@ func (a ActionType) Priority() ActionPriority {
 		return ActionPriorityNormal
 	case ActionTypeBootstrapUpdate:
 		return ActionPriorityNormal
+	case ActionTypeCleanMemberService:
+		return ActionPriorityNormal
 	case ActionTypeCleanOutMember:
 		return ActionPriorityNormal
 	case ActionTypeCleanTLSCACertificate:
@@ -682,6 +690,8 @@ func (a ActionType) Optional() bool {
 		return false
 	case ActionTypeBootstrapUpdate:
 		return false
+	case ActionTypeCleanMemberService:
+		return false
 	case ActionTypeCleanOutMember:
 		return false
 	case ActionTypeCleanTLSCACertificate:
diff --git a/pkg/apis/deployment/v2alpha1/deployment_spec.go b/pkg/apis/deployment/v2alpha1/deployment_spec.go
@@ -59,13 +59,31 @@ func (d *DeploymentCommunicationMethod) Get() DeploymentCommunicationMethod {
 	}
 
 	switch v := *d; v {
-	case DeploymentCommunicationMethodHeadlessService, DeploymentCommunicationMethodDNS, DeploymentCommunicationMethodIP, DeploymentCommunicationMethodShortDNS:
+	case DeploymentCommunicationMethodHeadlessService, DeploymentCommunicationMethodDNS, DeploymentCommunicationMethodIP, DeploymentCommunicationMethodShortDNS, DeploymentCommunicationMethodHeadlessDNS:
 		return v
 	default:
 		return DefaultDeploymentCommunicationMethod
 	}
 }
 
+// ServiceType returns Service Type for communication method
+func (d *DeploymentCommunicationMethod) ServiceType() core.ServiceType {
+	switch d.Get() {
+	default:
+		return core.ServiceTypeClusterIP
+	}
+}
+
+// ServiceClusterIP returns Service ClusterIP for communication method
+func (d *DeploymentCommunicationMethod) ServiceClusterIP() string {
+	switch d.Get() {
+	case DeploymentCommunicationMethodHeadlessDNS:
+		return core.ClusterIPNone
+	default:
+		return ""
+	}
+}
+
 // String returns string representation of method.
 func (d DeploymentCommunicationMethod) String() string {
 	return string(d)
@@ -85,7 +103,9 @@ const (
 	DeploymentCommunicationMethodDNS DeploymentCommunicationMethod = "dns"
 	// DeploymentCommunicationMethodShortDNS define ClusterIP Service DNS based communication. Use namespaced short DNS (used in migration)
 	DeploymentCommunicationMethodShortDNS DeploymentCommunicationMethod = "short-dns"
-	// DeploymentCommunicationMethodIP define ClusterIP Servce IP based communication.
+	// DeploymentCommunicationMethodHeadlessDNS define Headless Service DNS based communication.
+	DeploymentCommunicationMethodHeadlessDNS DeploymentCommunicationMethod = "headless-dns"
+	// DeploymentCommunicationMethodIP define ClusterIP Service IP based communication.
 	DeploymentCommunicationMethodIP DeploymentCommunicationMethod = "ip"
 )
 
diff --git a/pkg/apis/deployment/v2alpha1/member_status.go b/pkg/apis/deployment/v2alpha1/member_status.go
@@ -1,7 +1,7 @@
 //
 // DISCLAIMER
 //
-// Copyright 2016-2022 ArangoDB GmbH, Cologne, Germany
+// Copyright 2016-2023 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.
diff --git a/pkg/deployment/agency/state.go b/pkg/deployment/agency/state.go
@@ -1,7 +1,7 @@
 //
 // DISCLAIMER
 //
-// Copyright 2016-2022 ArangoDB GmbH, Cologne, Germany
+// Copyright 2016-2023 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.
diff --git a/pkg/deployment/features/graceful.go b/pkg/deployment/features/graceful.go
@@ -1,7 +1,7 @@
 //
 // DISCLAIMER
 //
-// Copyright 2016-2022 ArangoDB GmbH, Cologne, Germany
+// Copyright 2016-2023 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.
diff --git a/pkg/deployment/pod/utils.go b/pkg/deployment/pod/utils.go
@@ -43,13 +43,17 @@ func GenerateMemberEndpoint(services service.Inspector, apiObject meta.Object, s
 func GenerateMemberEndpointFromService(svc *core.Service, apiObject meta.Object, spec api.DeploymentSpec, group api.ServerGroup, member api.MemberStatus) (string, error) {
 	if group.IsArangod() {
 		switch method := spec.CommunicationMethod.Get(); method {
-		case api.DeploymentCommunicationMethodDNS:
+		case api.DeploymentCommunicationMethodDNS, api.DeploymentCommunicationMethodHeadlessDNS:
 			return k8sutil.CreateServiceDNSNameWithDomain(svc, spec.ClusterDomain), nil
 		case api.DeploymentCommunicationMethodIP:
 			if svc.Spec.ClusterIP == "" {
 				return "", errors.Newf("ClusterIP of service %s is empty", svc.GetName())
 			}
 
+			if svc.Spec.ClusterIP == core.ClusterIPNone {
+				return k8sutil.CreateServiceDNSNameWithDomain(svc, spec.ClusterDomain), nil
+			}
+
 			return svc.Spec.ClusterIP, nil
 		case api.DeploymentCommunicationMethodShortDNS:
 			return svc.GetName(), nil
diff --git a/pkg/deployment/reconcile/action.register.generated.go b/pkg/deployment/reconcile/action.register.generated.go
@@ -51,6 +51,9 @@ var (
 	_ Action        = &actionBootstrapUpdate{}
 	_ actionFactory = newBootstrapUpdateAction
 
+	_ Action        = &actionCleanMemberService{}
+	_ actionFactory = newCleanMemberServiceAction
+
 	_ Action        = &actionCleanOutMember{}
 	_ actionFactory = newCleanOutMemberAction
 
@@ -355,6 +358,18 @@ func init() {
 		registerAction(action, function)
 	}
 
+	// CleanMemberService
+	{
+		// Get Action defition
+		function := newCleanMemberServiceAction
+		action := api.ActionTypeCleanMemberService
+
+		// Wrap action main function
+
+		// Register action
+		registerAction(action, function)
+	}
+
 	// CleanOutMember
 	{
 		// Get Action defition
diff --git a/pkg/deployment/reconcile/action.register.generated_test.go b/pkg/deployment/reconcile/action.register.generated_test.go
@@ -110,6 +110,16 @@ func Test_Actions(t *testing.T) {
 		})
 	})
 
+	t.Run("CleanMemberService", func(t *testing.T) {
+		ActionsExistence(t, api.ActionTypeCleanMemberService)
+		t.Run("Internal", func(t *testing.T) {
+			require.False(t, api.ActionTypeCleanMemberService.Internal())
+		})
+		t.Run("Optional", func(t *testing.T) {
+			require.False(t, api.ActionTypeCleanMemberService.Optional())
+		})
+	})
+
 	t.Run("CleanOutMember", func(t *testing.T) {
 		ActionsExistence(t, api.ActionTypeCleanOutMember)
 		t.Run("Internal", func(t *testing.T) {
diff --git a/pkg/deployment/reconcile/action_clean_member_service.go b/pkg/deployment/reconcile/action_clean_member_service.go
diff --git a/pkg/deployment/reconcile/helper_shutdown.go b/pkg/deployment/reconcile/helper_shutdown.go
diff --git a/pkg/deployment/reconcile/plan_builder_rotate_upgrade.go b/pkg/deployment/reconcile/plan_builder_rotate_upgrade.go
diff --git a/pkg/deployment/reconcile/plan_builder_utils.go b/pkg/deployment/reconcile/plan_builder_utils.go
diff --git a/pkg/deployment/resources/pod_leader.go b/pkg/deployment/resources/pod_leader.go
diff --git a/pkg/deployment/resources/services.go b/pkg/deployment/resources/services.go
diff --git a/pkg/util/k8sutil/services.go b/pkg/util/k8sutil/services.go
