Merged master

Author: ewoutp

docs/Manual/Deployment/Kubernetes/ServicesAndLoadBalancer.md

@@ -39,50 +39,53 @@ If you want to create external access services manually, follow the instructions
 ### Single server
 
 For a single server deployment, the operator creates a single
-`Service` named `<cluster-name>`. This service has a normal cluster IP
+`Service` named `<deployment-name>`. This service has a normal cluster IP
 address.
 
 ### Full cluster
 
 For a full cluster deployment, the operator creates two `Services`.
 
-- `<cluster-name>_servers` a headless `Service` intended to provide
+- `<deployment-name>-int` a headless `Service` intended to provide
   DNS names for all pods created by the operator.
   It selects all ArangoDB & ArangoSync servers in the cluster.
 
-- `<cluster-name>` a normal `Service` that selects only the coordinators
+- `<deployment-name>` a normal `Service` that selects only the coordinators
   of the cluster. This `Service` is configured with `ClientIP` session
   affinity. This is needed for cursor requests, since they are bound to
   a specific coordinator.
 
 When the coordinators are asked to provide endpoints of the cluster
 (e.g. when calling `client.SynchronizeEndpoints()` in the go driver)
 the DNS names of the individual `Pods` will be returned
-(`<pod>.<cluster-name>_servers.<namespace>.svc`)
+(`<pod>.<deployment-name>-int.<namespace>.svc`)
 
 ### Full cluster with DC2DC
 
 For a full cluster with datacenter replication deployment,
 the same `Services` are created as for a Full cluster, with the following
 additions:
 
-- `<cluster-name>_sync` a normal `Service` that selects only the syncmasters
+- `<deployment-name>-sync` a normal `Service` that selects only the syncmasters
   of the cluster.
 
 ## Load balancer
 
-To reach the ArangoDB servers from outside the Kubernetes cluster, you
-have to deploy additional services.
+If you want full control of the `Services` needed to access the ArangoDB deployment
+from outside your Kubernetes cluster, set `spec.externalAccess.Type` of the `ArangoDeployment` to `None`
+and create a `Service` as specified below.
 
-You can use `LoadBalancer` or `NodePort` services, depending on your
+Create  a `Service` of type `LoadBalancer` or `NodePort`, depending on your
 Kubernetes deployment.
 
 This service should select:
 
-- `arangodb_cluster_name: <cluster-name>`
+- `arango_deployment: <deployment-name>`
 - `role: coordinator`
 
-For example:
+The following example yields a service of type `LoadBalancer` with a specific
+load balancer IP address.
+With this service, the ArangoDB cluster can now be reached on `https://1.2.3.4:8529`.
 
 ```yaml
 kind: Service
@@ -91,7 +94,27 @@ metadata:
   name: arangodb-cluster-exposed
 spec:
   selector:
-    arangodb_cluster_name: arangodb-cluster
+    arango_deployment: arangodb-cluster
+    role: coordinator
+  type: LoadBalancer
+  loadBalancerIP: 1.2.3.4
+  ports:
+  - protocol: TCP
+    port: 8529
+    targetPort: 8529
+```
+
+The following example yields a service of type `NodePort` with the ArangoDB
+cluster exposed on port 30529 of all nodes of the Kubernetes cluster.
+
+```yaml
+kind: Service
+apiVersion: v1
+metadata:
+  name: arangodb-cluster-exposed
+spec:
+  selector:
+    arango_deployment: arangodb-cluster
     role: coordinator
   type: NodePort
   ports:

examples/production-cluster.yaml

@@ -0,0 +1,8 @@
+apiVersion: "database.arangodb.com/v1alpha"
+kind: "ArangoDeployment"
+metadata:
+  name: "production-cluster"
+spec:
+  mode: Cluster
+  image: arangodb/arangodb:3.3.10
+  environment: Production

pkg/apis/deployment/v1alpha/environment.go

@@ -47,6 +47,11 @@ func (e Environment) Validate() error {
 	}
 }
 
+// IsProduction returns true when the given environment is a production environment.
+func (e Environment) IsProduction() bool {
+	return e == EnvironmentProduction
+}
+
 // NewEnvironment returns a reference to a string with given value.
 func NewEnvironment(input Environment) *Environment {
 	return &input

pkg/deployment/reconcile/action.go

@@ -24,6 +24,7 @@ package reconcile
 
 import (
 	"context"
+	"time"
 )
 
 // Action executes a single Plan item.
@@ -35,4 +36,6 @@ type Action interface {
 	// CheckProgress checks the progress of the action.
 	// Returns true if the action is completely finished, false otherwise.
 	CheckProgress(ctx context.Context) (bool, error)
+	// Timeout returns the amount of time after which this action will timeout.
+	Timeout() time.Duration
 }

pkg/deployment/reconcile/action_add_member.go

@@ -24,6 +24,7 @@ package reconcile
 
 import (
 	"context"
+	"time"
 
 	api "github.com/arangodb/kube-arangodb/pkg/apis/deployment/v1alpha"
 	"github.com/rs/zerolog"
@@ -64,3 +65,8 @@ func (a *actionAddMember) CheckProgress(ctx context.Context) (bool, error) {
 	// Nothing todo
 	return true, nil
 }
+
+// Timeout returns the amount of time after which this action will timeout.
+func (a *actionAddMember) Timeout() time.Duration {
+	return addMemberTimeout
+}

pkg/deployment/reconcile/action_cleanout_member.go

@@ -24,6 +24,7 @@ package reconcile
 
 import (
 	"context"
+	"time"
 
 	api "github.com/arangodb/kube-arangodb/pkg/apis/deployment/v1alpha"
 	"github.com/rs/zerolog"
@@ -114,3 +115,8 @@ func (a *actionCleanoutMember) CheckProgress(ctx context.Context) (bool, error)
 	// Cleanout completed
 	return true, nil
 }
+
+// Timeout returns the amount of time after which this action will timeout.
+func (a *actionCleanoutMember) Timeout() time.Duration {
+	return cleanoutMemberTimeout
+}

pkg/deployment/reconcile/action_remove_member.go

@@ -24,6 +24,7 @@ package reconcile
 
 import (
 	"context"
+	"time"
 
 	"github.com/pkg/errors"
 	"github.com/rs/zerolog"
@@ -94,3 +95,8 @@ func (a *actionRemoveMember) CheckProgress(ctx context.Context) (bool, error) {
 	// Nothing todo
 	return true, nil
 }
+
+// Timeout returns the amount of time after which this action will timeout.
+func (a *actionRemoveMember) Timeout() time.Duration {
+	return removeMemberTimeout
+}

pkg/deployment/reconcile/action_renew_tls_certificate.go

@@ -24,6 +24,7 @@ package reconcile
 
 import (
 	"context"
+	"time"
 
 	api "github.com/arangodb/kube-arangodb/pkg/apis/deployment/v1alpha"
 	"github.com/rs/zerolog"
@@ -69,3 +70,8 @@ func (a *renewTLSCertificateAction) Start(ctx context.Context) (bool, error) {
 func (a *renewTLSCertificateAction) CheckProgress(ctx context.Context) (bool, error) {
 	return true, nil
 }
+
+// Timeout returns the amount of time after which this action will timeout.
+func (a *renewTLSCertificateAction) Timeout() time.Duration {
+	return renewTLSCertificateTimeout
+}

pkg/deployment/reconcile/action_rotate_member.go

@@ -24,6 +24,7 @@ package reconcile
 
 import (
 	"context"
+	"time"
 
 	api "github.com/arangodb/kube-arangodb/pkg/apis/deployment/v1alpha"
 	"github.com/rs/zerolog"
@@ -116,3 +117,8 @@ func (a *actionRotateMember) CheckProgress(ctx context.Context) (bool, error) {
 	}
 	return true, nil
 }
+
+// Timeout returns the amount of time after which this action will timeout.
+func (a *actionRotateMember) Timeout() time.Duration {
+	return rotateMemberTimeout
+}

pkg/deployment/reconcile/action_shutdown_member.go

@@ -111,3 +111,8 @@ func (a *actionShutdownMember) CheckProgress(ctx context.Context) (bool, error)
 	// Member still not shutdown, retry soon
 	return false, nil
 }
+
+// Timeout returns the amount of time after which this action will timeout.
+func (a *actionShutdownMember) Timeout() time.Duration {
+	return shutdownMemberTimeout
+}