[Feature] Split & Unify Lifecycle management functionality

CHANGELOG.md

@@ -1,6 +1,7 @@
 # Change Log
 
 ## [master](https://github.com/arangodb/kube-arangodb/tree/master) (N/A)
+- Split & Unify Lifecycle management functionality
 
 ## [1.2.4](https://github.com/arangodb/kube-arangodb/tree/1.2.4) (2021-10-22)
 - Replace `beta.kubernetes.io/arch` Pod label with `kubernetes.io/arch` using Silent Rotation

lifecycle.go

@@ -47,7 +47,11 @@ var (
 
 	cmdLifecyclePreStop = &cobra.Command{
 		Use:    "preStop",
-		Run:    cmdLifecyclePreStopRun,
+		Hidden: true,
+	}
+	cmdLifecyclePreStopFinalizers = &cobra.Command{
+		Use:    "finalizers",
+		Run:    cmdLifecyclePreStopRunFinalizer,
 		Hidden: true,
 	}
 	cmdLifecycleCopy = &cobra.Command{
@@ -63,6 +67,9 @@ var (
 
 func init() {
 	cmdMain.AddCommand(cmdLifecycle)
+
+	cmdLifecyclePreStop.AddCommand(cmdLifecyclePreStopFinalizers)
+
 	cmdLifecycle.AddCommand(cmdLifecyclePreStop)
 	cmdLifecycle.AddCommand(cmdLifecycleCopy)
 	cmdLifecycle.AddCommand(cmdLifecycleProbe)
@@ -71,7 +78,7 @@ func init() {
 }
 
 // Wait until all finalizers of the current pod have been removed.
-func cmdLifecyclePreStopRun(cmd *cobra.Command, args []string) {
+func cmdLifecyclePreStopRunFinalizer(cmd *cobra.Command, args []string) {
 
 	cliLog.Info().Msgf("Starting arangodb-operator (%s), lifecycle preStop, version %s build %s", version.GetVersionV1().Edition.Title(), version.GetVersionV1().Version, version.GetVersionV1().Build)
 

main.go

@@ -362,13 +362,12 @@ func newOperatorConfigAndDeps(id, namespace, name string) (operator.Config, oper
 		Namespace:                   namespace,
 		PodName:                     name,
 		ServiceAccount:              serviceAccount,
-		LifecycleImage:              image,
+		OperatorImage:               image,
 		EnableDeployment:            operatorOptions.enableDeployment,
 		EnableDeploymentReplication: operatorOptions.enableDeploymentReplication,
 		EnableStorage:               operatorOptions.enableStorage,
 		EnableBackup:                operatorOptions.enableBackup,
 		AllowChaos:                  chaosOptions.allowed,
-		MetricsExporterImage:        operatorOptions.metricsExporterImage,
 		ArangoImage:                 operatorOptions.arangoImage,
 		SingleMode:                  operatorOptions.singleMode,
 		Scope:                       scope,

pkg/apis/deployment/v1/deployment_metrics_spec.go

@@ -41,6 +41,7 @@ func (m MetricsMode) New() *MetricsMode {
 	return &m
 }
 
+// deprecated
 func (m MetricsMode) GetMetricsEndpoint() string {
 	switch m {
 	case MetricsModeInternal:
@@ -51,9 +52,12 @@ func (m MetricsMode) GetMetricsEndpoint() string {
 }
 
 const (
+	// deprecated
 	// MetricsModeExporter exporter mode for old exporter type
 	MetricsModeExporter MetricsMode = "exporter"
-	MetricsModeSidecar  MetricsMode = "sidecar"
+	// deprecated
+	MetricsModeSidecar MetricsMode = "sidecar"
+	// deprecated
 	MetricsModeInternal MetricsMode = "internal"
 )
 
@@ -67,12 +71,14 @@ func (m *MetricsMode) Get() MetricsMode {
 
 // MetricsSpec contains spec for arangodb exporter
 type MetricsSpec struct {
-	Enabled        *bool                     `json:"enabled,omitempty"`
+	Enabled *bool `json:"enabled,omitempty"`
+	// deprecated
 	Image          *string                   `json:"image,omitempty"`
 	Authentication MetricsAuthenticationSpec `json:"authentication,omitempty"`
 	Resources      v1.ResourceRequirements   `json:"resources,omitempty"`
-	Mode           *MetricsMode              `json:"mode,omitempty"`
-	TLS            *bool                     `json:"tls,omitempty"`
+	// deprecated
+	Mode *MetricsMode `json:"mode,omitempty"`
+	TLS  *bool        `json:"tls,omitempty"`
 
 	ServiceMonitor *MetricsServiceMonitorSpec `json:"serviceMonitor,omitempty"`
 
@@ -100,11 +106,13 @@ func (s *MetricsSpec) IsEnabled() bool {
 	return util.BoolOrDefault(s.Enabled, false)
 }
 
+// deprecated
 // HasImage returns whether a image was specified or not
 func (s *MetricsSpec) HasImage() bool {
 	return s.Image != nil
 }
 
+// deprecated
 // GetImage returns the Image or empty string
 func (s *MetricsSpec) GetImage() string {
 	return util.StringOrDefault(s.Image)

pkg/apis/deployment/v1/server_group_containers.go

@@ -0,0 +1,35 @@
+//
+// DISCLAIMER
+//
+// Copyright 2016-2021 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
+
+const (
+	ServerGroupReservedContainerNameServer   = "server"
+	ServerGroupReservedContainerNameExporter = "exporter"
+)
+
+func IsReservedServerGroupContainerName(name string) bool {
+	switch name {
+	case ServerGroupReservedContainerNameServer, ServerGroupReservedContainerNameExporter:
+		return true
+	default:
+		return false
+	}
+}

pkg/deployment/context_impl.go

@@ -115,14 +115,8 @@ func (d *Deployment) GetScope() scope.Scope {
 	return d.config.Scope
 }
 
-// GetLifecycleImage returns the image name containing the lifecycle helper (== name of operator image)
-func (d *Deployment) GetLifecycleImage() string {
-	return d.config.LifecycleImage
-}
-
-// GetOperatorUUIDImage returns the image name containing the uuid helper (== name of operator image)
-func (d *Deployment) GetOperatorUUIDImage() string {
-	return d.config.OperatorUUIDInitImage
+func (d *Deployment) GetOperatorImage() string {
+	return d.config.OperatorImage
 }
 
 // GetNamespace returns the kubernetes namespace that contains
@@ -591,10 +585,6 @@ func (d *Deployment) SelectImageForMember(spec api.DeploymentSpec, status api.De
 	return d.resources.SelectImageForMember(spec, status, member)
 }
 
-func (d *Deployment) GetMetricsExporterImage() string {
-	return d.config.MetricsExporterImage
-}
-
 func (d *Deployment) GetArangoImage() string {
 	return d.config.ArangoImage
 }

pkg/deployment/deployment.go

@@ -69,13 +69,11 @@ import (
 
 // Config holds configuration settings for a Deployment
 type Config struct {
-	ServiceAccount        string
-	AllowChaos            bool
-	LifecycleImage        string
-	OperatorUUIDInitImage string
-	MetricsExporterImage  string
-	ArangoImage           string
-	Scope                 scope.Scope
+	ServiceAccount string
+	AllowChaos     bool
+	OperatorImage  string
+	ArangoImage    string
+	Scope          scope.Scope
 }
 
 // Dependencies holds dependent services for a Deployment

pkg/deployment/deployment_core_test.go

@@ -33,7 +33,6 @@ import (
 
 	api "github.com/arangodb/kube-arangodb/pkg/apis/deployment/v1"
 	"github.com/arangodb/kube-arangodb/pkg/util"
-	"github.com/arangodb/kube-arangodb/pkg/util/constants"
 	"github.com/arangodb/kube-arangodb/pkg/util/k8sutil"
 )
 
@@ -276,7 +275,7 @@ func TestEnsurePod_ArangoDB_Core(t *testing.T) {
 				},
 			},
 			config: Config{
-				OperatorUUIDInitImage: testImageOperatorUUIDInit,
+				OperatorImage: testImageOperator,
 			},
 			Helper: func(t *testing.T, deployment *Deployment, testCase *testCaseStruct) {
 				deployment.status.last = api.DeploymentStatus{
@@ -505,7 +504,7 @@ func TestEnsurePod_ArangoDB_Core(t *testing.T) {
 				},
 			},
 			config: Config{
-				OperatorUUIDInitImage: testImageOperatorUUIDInit,
+				OperatorImage: testImageOperator,
 			},
 			Helper: func(t *testing.T, deployment *Deployment, testCase *testCaseStruct) {
 				deployment.status.last = api.DeploymentStatus{
@@ -1090,7 +1089,7 @@ func TestEnsurePod_ArangoDB_Core(t *testing.T) {
 				testCase.ExpectedPod.ObjectMeta.Labels[k8sutil.LabelKeyArangoExporter] = testYes
 			},
 			config: Config{
-				LifecycleImage: testImageLifecycle,
+				OperatorImage: testImageOperator,
 			},
 			ExpectedEvent: "member dbserver is created",
 			ExpectedPod: core.Pod{
@@ -1108,13 +1107,7 @@ func TestEnsurePod_ArangoDB_Core(t *testing.T) {
 							Name:    k8sutil.ServerContainerName,
 							Image:   testImage,
 							Command: createTestCommandForDBServer(firstDBServerStatus.ID, false, false, false),
-							Env: []core.EnvVar{
-								k8sutil.CreateEnvFieldPath(constants.EnvOperatorPodName, "metadata.name"),
-								k8sutil.CreateEnvFieldPath(constants.EnvOperatorPodNamespace, "metadata.namespace"),
-								k8sutil.CreateEnvFieldPath(constants.EnvOperatorNodeName, "spec.nodeName"),
-								k8sutil.CreateEnvFieldPath(constants.EnvOperatorNodeNameArango, "spec.nodeName"),
-							},
-							Ports: createTestPorts(),
+							Ports:   createTestPorts(),
 							VolumeMounts: []core.VolumeMount{
 								k8sutil.ArangodVolumeMount(),
 								k8sutil.LifecycleVolumeMount(),
@@ -1160,16 +1153,14 @@ func TestEnsurePod_ArangoDB_Core(t *testing.T) {
 				testCase.ExpectedPod.ObjectMeta.Labels[k8sutil.LabelKeyArangoExporter] = testYes
 			},
 			config: Config{
-				LifecycleImage:        testImageLifecycle,
-				OperatorUUIDInitImage: testImageOperatorUUIDInit,
+				OperatorImage: testImageOperator,
 			},
 			ExpectedEvent: "member dbserver is created",
 			ExpectedPod: core.Pod{
 				Spec: core.PodSpec{
 					Volumes: []core.Volume{
 						k8sutil.CreateVolumeEmptyDir(k8sutil.ArangodVolumeName),
 						k8sutil.CreateVolumeWithSecret(k8sutil.ExporterJWTVolumeName, testExporterToken),
-						k8sutil.LifecycleVolume(),
 					},
 					InitContainers: []core.Container{
 						createTestLifecycleContainer(emptyResources),
@@ -1180,13 +1171,7 @@ func TestEnsurePod_ArangoDB_Core(t *testing.T) {
 							Name:    k8sutil.ServerContainerName,
 							Image:   testImage,
 							Command: createTestCommandForDBServer(firstDBServerStatus.ID, false, false, false),
-							Env: []core.EnvVar{
-								k8sutil.CreateEnvFieldPath(constants.EnvOperatorPodName, "metadata.name"),
-								k8sutil.CreateEnvFieldPath(constants.EnvOperatorPodNamespace, "metadata.namespace"),
-								k8sutil.CreateEnvFieldPath(constants.EnvOperatorNodeName, "spec.nodeName"),
-								k8sutil.CreateEnvFieldPath(constants.EnvOperatorNodeNameArango, "spec.nodeName"),
-							},
-							Ports: createTestPorts(),
+							Ports:   createTestPorts(),
 							VolumeMounts: []core.VolumeMount{
 								k8sutil.ArangodVolumeMount(),
 								k8sutil.LifecycleVolumeMount(),
@@ -1208,102 +1193,6 @@ func TestEnsurePod_ArangoDB_Core(t *testing.T) {
 				},
 			},
 		},
-		{
-			Name: "DBserver Pod with metrics exporter, lifecycle, tls, authentication, license, rocksDB encryption, secured liveness",
-			ArangoDeployment: &api.ArangoDeployment{
-				Spec: api.DeploymentSpec{
-					Image:          util.NewString(testImage),
-					Authentication: authenticationSpec,
-					TLS:            tlsSpec,
-					Metrics:        metricsSpec,
-					RocksDB:        rocksDBSpec,
-					Environment:    api.NewEnvironment(api.EnvironmentProduction),
-					License: api.LicenseSpec{
-						SecretName: util.NewString(testLicense),
-					},
-				},
-			},
-			Helper: func(t *testing.T, deployment *Deployment, testCase *testCaseStruct) {
-				deployment.status.last = api.DeploymentStatus{
-					Members: api.DeploymentStatusMembers{
-						DBServers: api.MemberStatusList{
-							firstDBServerStatus,
-						},
-					},
-					Images: createTestImages(false),
-				}
-
-				testCase.createTestPodData(deployment, api.ServerGroupDBServers, firstDBServerStatus)
-				testCase.ExpectedPod.ObjectMeta.Labels[k8sutil.LabelKeyArangoExporter] = testYes
-
-				key := make([]byte, 32)
-				k8sutil.CreateEncryptionKeySecret(deployment.SecretsModInterface(), testRocksDBEncryptionKey, key)
-
-				authorization, err := createTestToken(deployment, testCase, []string{"/_api/version"})
-				require.NoError(t, err)
-
-				testCase.ExpectedPod.Spec.Containers[0].LivenessProbe = createTestLivenessProbe(httpProbe, true,
-					authorization, k8sutil.ArangoPort)
-			},
-			config: Config{
-				LifecycleImage: testImageLifecycle,
-			},
-			ExpectedEvent: "member dbserver is created",
-			ExpectedPod: core.Pod{
-				Spec: core.PodSpec{
-					Volumes: []core.Volume{
-						k8sutil.CreateVolumeEmptyDir(k8sutil.ArangodVolumeName),
-						createTestTLSVolume(api.ServerGroupDBServersString, firstDBServerStatus.ID),
-						k8sutil.CreateVolumeWithSecret(k8sutil.RocksdbEncryptionVolumeName, testRocksDBEncryptionKey),
-						k8sutil.CreateVolumeWithSecret(k8sutil.ExporterJWTVolumeName, testExporterToken),
-						k8sutil.CreateVolumeWithSecret(k8sutil.ClusterJWTSecretVolumeName, testJWTSecretName),
-						k8sutil.LifecycleVolume(),
-					},
-					InitContainers: []core.Container{
-						createTestLifecycleContainer(emptyResources),
-					},
-					Containers: []core.Container{
-						{
-							Name:    k8sutil.ServerContainerName,
-							Image:   testImage,
-							Command: createTestCommandForDBServer(firstDBServerStatus.ID, true, true, true),
-							Env: []core.EnvVar{
-								k8sutil.CreateEnvSecretKeySelector(constants.EnvArangoLicenseKey,
-									testLicense, constants.SecretKeyToken),
-								k8sutil.CreateEnvFieldPath(constants.EnvOperatorPodName, "metadata.name"),
-								k8sutil.CreateEnvFieldPath(constants.EnvOperatorPodNamespace, "metadata.namespace"),
-								k8sutil.CreateEnvFieldPath(constants.EnvOperatorNodeName, "spec.nodeName"),
-								k8sutil.CreateEnvFieldPath(constants.EnvOperatorNodeNameArango, "spec.nodeName"),
-							},
-							Ports:           createTestPorts(),
-							Lifecycle:       createTestLifecycle(),
-							LivenessProbe:   createTestLivenessProbe(httpProbe, false, "", k8sutil.ArangoPort),
-							ImagePullPolicy: core.PullIfNotPresent,
-							SecurityContext: securityContext.NewSecurityContext(),
-							VolumeMounts: []core.VolumeMount{
-								k8sutil.ArangodVolumeMount(),
-								k8sutil.LifecycleVolumeMount(),
-								k8sutil.TlsKeyfileVolumeMount(),
-								k8sutil.RocksdbEncryptionVolumeMount(),
-								k8sutil.ClusterJWTVolumeMount(),
-							},
-							Resources: emptyResources,
-						},
-						func() core.Container {
-							c := testArangodbInternalExporterContainer(true, emptyResources)
-							c.VolumeMounts = append(c.VolumeMounts, k8sutil.TlsKeyfileVolumeMount())
-							return c
-						}(),
-					},
-					RestartPolicy:                 core.RestartPolicyNever,
-					TerminationGracePeriodSeconds: &defaultDBServerTerminationTimeout,
-					Hostname:                      testDeploymentName + "-" + api.ServerGroupDBServersString + "-" + firstDBServerStatus.ID,
-					Subdomain:                     testDeploymentName + "-int",
-					Affinity: k8sutil.CreateAffinity(testDeploymentName, api.ServerGroupDBServersString,
-						true, ""),
-				},
-			},
-		},
 		{
 			Name: "Coordinator Pod with TLS and authentication and readiness and liveness",
 			ArangoDeployment: &api.ArangoDeployment{