[Refactor] Split API and Core cross-dependency (#942)

Author: ajanikow

CHANGELOG.md

@@ -14,6 +14,7 @@
 - (Refactor) Configurable throttle inspector
 - (Bugfix) Skip Replace operation on DBServer if they need to be scaled down
 - (Feature) Upgrade procedure steps
+- (Refactor) Remove API and Core cross-dependency
 
 ## [1.2.8](https://github.com/arangodb/kube-arangodb/tree/1.2.8) (2022-02-24)
 - Do not check License V2 on Community images

cmd/admin.go

@@ -43,6 +43,7 @@ import (
 	"github.com/arangodb/go-driver/jwt"
 	"github.com/arangodb/go-driver/v2/connection"
 	api "github.com/arangodb/kube-arangodb/pkg/apis/deployment/v1"
+	"github.com/arangodb/kube-arangodb/pkg/apis/shared"
 	"github.com/arangodb/kube-arangodb/pkg/util/constants"
 	"github.com/arangodb/kube-arangodb/pkg/util/errors"
 	"github.com/arangodb/kube-arangodb/pkg/util/k8sutil"
@@ -222,10 +223,10 @@ func getDeploymentAndCredentials(ctx context.Context,
 // getArangoEndpoint returns ArangoDB endpoint with scheme and port for the given dnsName.
 func getArangoEndpoint(secure bool, dnsName string) string {
 	if secure {
-		return "https://" + net.JoinHostPort(dnsName, strconv.Itoa(k8sutil.ArangoPort))
+		return "https://" + net.JoinHostPort(dnsName, strconv.Itoa(shared.ArangoPort))
 	}
 
-	return "http://" + net.JoinHostPort(dnsName, strconv.Itoa(k8sutil.ArangoPort))
+	return "http://" + net.JoinHostPort(dnsName, strconv.Itoa(shared.ArangoPort))
 }
 
 // getAgencyLeader returns the leader ID of the agency.

cmd/lifecycle.go

@@ -38,6 +38,7 @@ import (
 	"github.com/spf13/cobra"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 
+	"github.com/arangodb/kube-arangodb/pkg/apis/shared"
 	"github.com/arangodb/kube-arangodb/pkg/util/constants"
 	"github.com/arangodb/kube-arangodb/pkg/util/k8sutil"
 	"github.com/arangodb/kube-arangodb/pkg/util/kclient"
@@ -187,7 +188,7 @@ type cmdLifecyclePreStopRunPort struct {
 
 // Wait until port 8529 is closed.
 func (c *cmdLifecyclePreStopRunPort) run(cmd *cobra.Command, args []string) error {
-	address := net.JoinHostPort("127.0.0.1", strconv.Itoa(k8sutil.ArangoPort))
+	address := net.JoinHostPort("127.0.0.1", strconv.Itoa(shared.ArangoPort))
 
 	// Get environment
 	namespace := os.Getenv(constants.EnvOperatorPodNamespace)

cmd/lifecycle_probes.go

@@ -29,9 +29,9 @@ import (
 	"path"
 
 	"github.com/arangodb/go-driver/jwt"
+	"github.com/arangodb/kube-arangodb/pkg/apis/shared"
 	"github.com/arangodb/kube-arangodb/pkg/deployment/pod"
 	"github.com/arangodb/kube-arangodb/pkg/util/constants"
-	"github.com/arangodb/kube-arangodb/pkg/util/k8sutil"
 	"github.com/pkg/errors"
 	"github.com/rs/zerolog/log"
 	"github.com/spf13/cobra"
@@ -57,7 +57,7 @@ func init() {
 	f.BoolVarP(&probeInput.SSL, "ssl", "", false, "Determines if SSL is enabled")
 	f.BoolVarP(&probeInput.Auth, "auth", "", false, "Determines if authentication is enabled")
 	f.StringVarP(&probeInput.Endpoint, "endpoint", "", "/_api/version", "Endpoint (path) to call for lifecycle probe")
-	f.StringVarP(&probeInput.JWTPath, "jwt", "", k8sutil.ClusterJWTSecretVolumeMountDir, "Path to the JWT tokens")
+	f.StringVarP(&probeInput.JWTPath, "jwt", "", shared.ClusterJWTSecretVolumeMountDir, "Path to the JWT tokens")
 }
 
 func probeClient() *http.Client {
@@ -80,7 +80,7 @@ func probeEndpoint(endpoint string) string {
 		proto = "https"
 	}
 
-	return fmt.Sprintf("%s://%s:%d%s", proto, "127.0.0.1", k8sutil.ArangoPort, endpoint)
+	return fmt.Sprintf("%s://%s:%d%s", proto, "127.0.0.1", shared.ArangoPort, endpoint)
 }
 
 func readJWTFile(file string) ([]byte, error) {

pkg/apis/deployment/v1/architecture.go

@@ -23,8 +23,7 @@ package v1
 import (
 	"runtime"
 
-	"github.com/arangodb/kube-arangodb/pkg/util/k8sutil"
-
+	"github.com/arangodb/kube-arangodb/pkg/apis/shared"
 	"github.com/pkg/errors"
 	core "k8s.io/api/core/v1"
 )
@@ -77,7 +76,7 @@ func (a ArangoDeploymentArchitectureType) AsNodeSelectorRequirement() core.NodeS
 	return core.NodeSelectorTerm{
 		MatchExpressions: []core.NodeSelectorRequirement{
 			{
-				Key:      k8sutil.NodeArchAffinityLabel,
+				Key:      shared.NodeArchAffinityLabel,
 				Operator: "In",
 				Values:   []string{string(a)},
 			},
@@ -90,7 +89,7 @@ func GetArchsFromNodeSelector(selectors []core.NodeSelectorTerm) map[ArangoDeplo
 	for _, selector := range selectors {
 		if selector.MatchExpressions != nil {
 			for _, req := range selector.MatchExpressions {
-				if req.Key == k8sutil.NodeArchAffinityLabel || req.Key == k8sutil.NodeArchAffinityLabelBeta {
+				if req.Key == shared.NodeArchAffinityLabel || req.Key == shared.NodeArchAffinityLabelBeta {
 					for _, arch := range req.Values {
 						result[ArangoDeploymentArchitectureType(arch)] = true
 					}

pkg/apis/deployment/v1/authentication_spec.go

@@ -21,9 +21,9 @@
 package v1
 
 import (
+	"github.com/arangodb/kube-arangodb/pkg/apis/shared"
 	"github.com/arangodb/kube-arangodb/pkg/util"
 	"github.com/arangodb/kube-arangodb/pkg/util/errors"
-	"github.com/arangodb/kube-arangodb/pkg/util/k8sutil"
 )
 
 // AuthenticationSpec holds authentication specific configuration settings
@@ -53,7 +53,7 @@ func (s AuthenticationSpec) Validate(required bool) error {
 		return errors.WithStack(errors.Wrap(ValidationError, "JWT secret is required"))
 	}
 	if s.IsAuthenticated() {
-		if err := k8sutil.ValidateResourceName(s.GetJWTSecretName()); err != nil {
+		if err := shared.ValidateResourceName(s.GetJWTSecretName()); err != nil {
 			return errors.WithStack(err)
 		}
 	}

pkg/apis/deployment/v1/bootstrap.go

@@ -23,7 +23,7 @@ package v1
 import (
 	"github.com/arangodb/kube-arangodb/pkg/util/errors"
 
-	"github.com/arangodb/kube-arangodb/pkg/util/k8sutil"
+	"github.com/arangodb/kube-arangodb/pkg/apis/shared"
 )
 
 const (
@@ -76,7 +76,7 @@ func (s PasswordSecretNameList) GetSecretName(user string) PasswordSecretName {
 
 // getSecretNameForUserPassword returns the default secret name for the given user
 func getSecretNameForUserPassword(deploymentname, username string) PasswordSecretName {
-	return PasswordSecretName(k8sutil.FixupResourceName(deploymentname + "-" + username + "-password"))
+	return PasswordSecretName(shared.FixupResourceName(deploymentname + "-" + username + "-password"))
 }
 
 // Validate the specification.
@@ -92,7 +92,7 @@ func (b *BootstrapSpec) Validate() error {
 				return errors.Newf("magic value None not allowed for %s", username)
 			}
 		} else {
-			if err := k8sutil.ValidateResourceName(string(secretname)); err != nil {
+			if err := shared.ValidateResourceName(string(secretname)); err != nil {
 				return errors.WithStack(err)
 			}
 		}

pkg/apis/deployment/v1/deployment_metrics_spec.go

@@ -22,8 +22,8 @@
 package v1
 
 import (
+	"github.com/arangodb/kube-arangodb/pkg/apis/shared"
 	"github.com/arangodb/kube-arangodb/pkg/util"
-	"github.com/arangodb/kube-arangodb/pkg/util/k8sutil"
 	v1 "k8s.io/api/core/v1"
 )
 
@@ -44,9 +44,9 @@ func (m MetricsMode) New() *MetricsMode {
 func (m MetricsMode) GetMetricsEndpoint() string {
 	switch m {
 	case MetricsModeInternal:
-		return k8sutil.ArangoExporterInternalEndpoint
+		return shared.ArangoExporterInternalEndpoint
 	default:
-		return k8sutil.ArangoExporterDefaultEndpoint
+		return shared.ArangoExporterDefaultEndpoint
 	}
 }
 
@@ -94,7 +94,7 @@ func (s *MetricsSpec) IsTLS() bool {
 
 func (s *MetricsSpec) GetPort() uint16 {
 	if s == nil || s.Port == nil {
-		return k8sutil.ArangoExporterPort
+		return shared.ArangoExporterPort
 	}
 
 	return *s.Port
@@ -156,7 +156,7 @@ func (s *MetricsSpec) SetDefaultsFrom(source MetricsSpec) {
 func (s *MetricsSpec) Validate() error {
 
 	if s.HasJWTTokenSecretName() {
-		if err := k8sutil.ValidateResourceName(s.GetJWTTokenSecretName()); err != nil {
+		if err := shared.ValidateResourceName(s.GetJWTTokenSecretName()); err != nil {
 			return err
 		}
 	}

pkg/apis/deployment/v1/deployment_spec.go

@@ -28,10 +28,10 @@ import (
 
 	core "k8s.io/api/core/v1"
 
+	"github.com/arangodb/kube-arangodb/pkg/apis/shared"
 	"github.com/arangodb/kube-arangodb/pkg/handlers/utils"
 	"github.com/arangodb/kube-arangodb/pkg/util"
 	"github.com/arangodb/kube-arangodb/pkg/util/errors"
-	"github.com/arangodb/kube-arangodb/pkg/util/k8sutil"
 )
 
 var (
@@ -547,12 +547,12 @@ func (s DeploymentSpec) Checksum() (string, error) {
 func (s DeploymentSpec) GetCoreContainers(group ServerGroup) utils.StringList {
 	groupSpec := s.GetServerGroupSpec(group)
 	if len(groupSpec.SidecarCoreNames) == 0 {
-		return utils.StringList{k8sutil.ServerContainerName}
+		return utils.StringList{shared.ServerContainerName}
 	}
 
 	result := make(utils.StringList, 0, len(groupSpec.SidecarCoreNames)+1)
-	if !utils.StringList(groupSpec.SidecarCoreNames).Has(k8sutil.ServerContainerName) {
-		result = append(result, k8sutil.ServerContainerName)
+	if !utils.StringList(groupSpec.SidecarCoreNames).Has(shared.ServerContainerName) {
+		result = append(result, shared.ServerContainerName)
 	}
 	result = append(result, groupSpec.SidecarCoreNames...)
 

pkg/apis/deployment/v1/license_spec.go

@@ -21,8 +21,8 @@
 package v1
 
 import (
+	"github.com/arangodb/kube-arangodb/pkg/apis/shared"
 	"github.com/arangodb/kube-arangodb/pkg/util"
-	"github.com/arangodb/kube-arangodb/pkg/util/k8sutil"
 )
 
 // LicenseSpec holds the license related information
@@ -43,7 +43,7 @@ func (s LicenseSpec) GetSecretName() string {
 // Validate validates the LicenseSpec
 func (s LicenseSpec) Validate() error {
 	if s.HasSecretName() {
-		if err := k8sutil.ValidateResourceName(s.GetSecretName()); err != nil {
+		if err := shared.ValidateResourceName(s.GetSecretName()); err != nil {
 			return err
 		}
 	}