Merge branch 'master' of github.com:arangodb/kube-arangodb

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:

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
+}

pkg/deployment/reconcile/action_upgrade_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"
@@ -126,3 +127,8 @@ func (a *actionUpgradeMember) CheckProgress(ctx context.Context) (bool, error) {
 	}
 	return isUpgrading, nil
 }
+
+// Timeout returns the amount of time after which this action will timeout.
+func (a *actionUpgradeMember) Timeout() time.Duration {
+	return upgradeMemberTimeout
+}

pkg/deployment/reconcile/action_wait_for_member_up.go

@@ -24,6 +24,7 @@ package reconcile
 
 import (
 	"context"
+	"time"
 
 	driver "github.com/arangodb/go-driver"
 	"github.com/arangodb/go-driver/agency"
@@ -164,3 +165,8 @@ func (a *actionWaitForMemberUp) checkProgressArangoSync(ctx context.Context) (bo
 	}
 	return true, nil
 }
+
+// Timeout returns the amount of time after which this action will timeout.
+func (a *actionWaitForMemberUp) Timeout() time.Duration {
+	return waitForMemberUpTimeout
+}

pkg/deployment/reconcile/context.go

@@ -54,6 +54,9 @@ type Context interface {
 	GetAgencyClients(ctx context.Context, predicate func(id string) bool) ([]driver.Connection, error)
 	// GetSyncServerClient returns a cached client for a specific arangosync server.
 	GetSyncServerClient(ctx context.Context, group api.ServerGroup, id string) (client.API, error)
+	// CreateEvent creates a given event.
+	// On error, the error is logged.
+	CreateEvent(evt *v1.Event)
 	// CreateMember adds a new member to the given group.
 	// If ID is non-empty, it will be used, otherwise a new ID is created.
 	CreateMember(group api.ServerGroup, id string) error

pkg/deployment/reconcile/plan_executor.go

@@ -25,11 +25,13 @@ package reconcile
 import (
 	"context"
 	"fmt"
+	"time"
 
+	"github.com/rs/zerolog"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 
 	api "github.com/arangodb/kube-arangodb/pkg/apis/deployment/v1alpha"
-	"github.com/rs/zerolog"
+	"github.com/arangodb/kube-arangodb/pkg/util/k8sutil"
 )
 
 // ExecutePlan tries to execute the plan as far as possible.
@@ -106,7 +108,21 @@ func (d *Reconciler) ExecutePlan(ctx context.Context) (bool, error) {
 			}
 			log.Debug().Bool("ready", ready).Msg("Action CheckProgress completed")
 			if !ready {
-				// Not ready check, come back soon
+				// Not ready yet, check timeout
+				deadline := planAction.CreationTime.Add(action.Timeout())
+				if time.Now().After(deadline) {
+					// Timeout has expired
+					log.Warn().Msg("Action not finished in time. Removing the entire plan")
+					d.context.CreateEvent(k8sutil.NewPlanTimeoutEvent(d.context.GetAPIObject(), string(planAction.Type), planAction.MemberID, planAction.Group.AsRole()))
+					// Replace plan with empty one and save it.
+					status.Plan = api.Plan{}
+					if err := d.context.UpdateStatus(status); err != nil {
+						log.Debug().Err(err).Msg("Failed to update CR status")
+						return false, maskAny(err)
+					}
+					return true, nil
+				}
+				// Timeout not yet expired, come back soon
 				return true, nil
 			}
 			// Continue with next action

pkg/deployment/reconcile/timeouts.go

@@ -0,0 +1,36 @@
+//
+// DISCLAIMER
+//
+// Copyright 2018 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
+//
+// Author Ewout Prangsma
+//
+
+package reconcile
+
+import "time"
+
+const (
+	addMemberTimeout           = time.Minute * 5
+	cleanoutMemberTimeout      = time.Hour * 12
+	removeMemberTimeout        = time.Minute * 15
+	renewTLSCertificateTimeout = time.Minute * 30
+	rotateMemberTimeout        = time.Minute * 30
+	shutdownMemberTimeout      = time.Minute * 30
+	upgradeMemberTimeout       = time.Hour * 6
+	waitForMemberUpTimeout     = time.Minute * 15
+)

pkg/deployment/resources/context.go

@@ -62,7 +62,7 @@ type Context interface {
 	GetLifecycleImage() string
 	// GetNamespace returns the namespace that contains the deployment
 	GetNamespace() string
-	// createEvent creates a given event.
+	// CreateEvent creates a given event.
 	// On error, the error is logged.
 	CreateEvent(evt *v1.Event)
 	// GetOwnedPods returns a list of all pods owned by the deployment.

pkg/util/k8sutil/events.go

@@ -145,6 +145,16 @@ func NewAccessPackageDeletedEvent(apiObject APIObject, apSecretName string) *v1.
 	return event
 }
 
+// NewPlanTimeoutEvent creates an event indicating that an item on a reconciliation plan did not
+// finish before its deadline.
+func NewPlanTimeoutEvent(apiObject APIObject, itemType, memberID, role string) *v1.Event {
+	event := newDeploymentEvent(apiObject)
+	event.Type = v1.EventTypeNormal
+	event.Reason = "Reconciliation Plan Timeout"
+	event.Message = fmt.Sprintf("An plan item of type %s or member %s with role %s did not finish in time", itemType, memberID, role)
+	return event
+}
+
 // NewErrorEvent creates an even of type error.
 func NewErrorEvent(reason string, err error, apiObject APIObject) *v1.Event {
 	event := newDeploymentEvent(apiObject)