Feature/new resize mode (#524)

Author: ajanikow

CHANGELOG.md

@@ -1,5 +1,10 @@
 # Change Log
 
+## [master](https://github.com/arangodb/kube-arangodb/tree/master) (N/A)
+- Add new VolumeResize mode to be compatible with Azure flow
+- Allow to customize probe configuration options
+- Add new upgrade flag for ArangoDB 3.6.0<=
+
 ## [0.4.3](https://github.com/arangodb/kube-arangodb/tree/0.4.3) (2020-01-31)
 - Prevent DBServer deletion if there are any shards active on it
 - Add Maintenance mode annotation for ArangoDeployment

Dockerfile.ubi

@@ -0,0 +1,4 @@
+ARG IMAGE=registry.access.redhat.com/ubi8/ubi-minimal:8.0
+FROM ${IMAGE}
+
+RUN microdnf update && microdnf clean all

Makefile

@@ -221,14 +221,15 @@ $(BIN): $(SOURCES) dashboard/assets.go VERSION
 
 .PHONY: docker
 docker: check-vars $(BIN)
-	docker build -f $(DOCKERFILE) --build-arg "VERSION=${VERSION_MAJOR_MINOR_PATCH}" -t $(OPERATORIMAGE) .
+	docker build --no-cache -f $(DOCKERFILE) --build-arg "VERSION=${VERSION_MAJOR_MINOR_PATCH}" -t $(OPERATORIMAGE) .
 ifdef PUSHIMAGES
 	docker push $(OPERATORIMAGE)
 endif
 
 .PHONY: docker-ubi
 docker-ubi: check-vars $(BIN)
-	docker build -f $(DOCKERFILE) --build-arg "VERSION=${VERSION_MAJOR_MINOR_PATCH}" --build-arg "IMAGE=$(BASEUBIIMAGE)" -t $(OPERATORUBIIMAGE) .
+	docker build --no-cache -f "$(DOCKERFILE).ubi" --build-arg "VERSION=${VERSION_MAJOR_MINOR_PATCH}" --build-arg "IMAGE=$(BASEUBIIMAGE)" -t $(OPERATORUBIIMAGE)-local-only-build .
+	docker build --no-cache -f $(DOCKERFILE) --build-arg "VERSION=${VERSION_MAJOR_MINOR_PATCH}" --build-arg "IMAGE=$(OPERATORUBIIMAGE)-local-only-build" -t $(OPERATORUBIIMAGE) .
 ifdef PUSHIMAGES
 	docker push $(OPERATORUBIIMAGE)
 endif

chart/kube-arangodb/templates/deployment-operator/cluster-role.yaml

@@ -17,7 +17,7 @@ rules:
       resources: ["customresourcedefinitions"]
       verbs: ["get", "list", "watch"]
     - apiGroups: [""]
-      resources: ["namespaces", "nodes"]
+      resources: ["namespaces", "nodes", "persistentvolumes"]
       verbs: ["get", "list"]
     - apiGroups: ["storage.k8s.io"]
       resources: ["storageclasses"]

pkg/apis/deployment/v1/plan.go

@@ -44,6 +44,10 @@ const (
 	ActionTypeShutdownMember ActionType = "ShutdownMember"
 	// ActionTypeRotateMember causes a member to be shutdown and have it's pod removed.
 	ActionTypeRotateMember ActionType = "RotateMember"
+	// ActionTypeRotateStartMember causes a member to be shutdown and have it's pod removed. Do not wait to pod recover.
+	ActionTypeRotateStartMember ActionType = "RotateStartMember"
+	// ActionTypeRotateMember causes a member to be restored.
+	ActionTypeRotateStopMember ActionType = "RotateStopMember"
 	// ActionTypeUpgradeMember causes a member to be shutdown and have it's pod removed, restarted with AutoUpgrade option, waited until termination and the restarted again.
 	ActionTypeUpgradeMember ActionType = "UpgradeMember"
 	// ActionTypeWaitForMemberUp causes the plan to wait until the member is considered "up".
@@ -58,6 +62,10 @@ const (
 	ActionTypeDisableClusterScaling ActionType = "ScalingDisabled"
 	// ActionTypeEnableClusterScaling turns on scaling DBservers and coordinators
 	ActionTypeEnableClusterScaling ActionType = "ScalingEnabled"
+	// ActionTypePVCResize resize event for PVC
+	ActionTypePVCResize ActionType = "PVCResize"
+	// ActionTypePVCResized waits for PVC to resize for defined time
+	ActionTypePVCResized ActionType = "PVCResized"
 )
 
 const (

pkg/apis/deployment/v1/pvc.go

@@ -0,0 +1,42 @@
+//
+// DISCLAIMER
+//
+// Copyright 2020 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 Adam Janikowski
+//
+
+package v1
+
+type PVCResizeMode string
+
+const (
+	PVCResizeModeRuntime PVCResizeMode = "runtime"
+	PVCResizeModeRotate  PVCResizeMode = "rotate"
+)
+
+func (p *PVCResizeMode) Get() PVCResizeMode {
+	if p == nil {
+		return PVCResizeModeRuntime
+	}
+
+	return *p
+}
+
+func (p PVCResizeMode) String() string {
+	return string(p)
+}

pkg/apis/deployment/v1/server_group_spec.go

@@ -64,6 +64,8 @@ type ServerGroupSpec struct {
 	PriorityClassName string `json:"priorityClassName,omitempty"`
 	// VolumeClaimTemplate specifies a template for volume claims
 	VolumeClaimTemplate *v1.PersistentVolumeClaim `json:"volumeClaimTemplate,omitempty"`
+	// VolumeResizeMode specified resize mode for pvc
+	VolumeResizeMode *PVCResizeMode `json:"pvcResizeMode,omitempty"`
 	// Sidecars specifies a list of additional containers to be started
 	Sidecars []v1.Container `json:"sidecars,omitempty"`
 }

pkg/deployment/context_impl.go

@@ -25,6 +25,7 @@ package deployment
 import (
 	"context"
 	"fmt"
+	"k8s.io/apimachinery/pkg/api/errors"
 	"net"
 	"strconv"
 
@@ -309,6 +310,31 @@ func (d *Deployment) DeletePvc(pvcName string) error {
 	return nil
 }
 
+// UpdatePvc updated a persistent volume claim in the namespace
+// of the deployment. If the pvc does not exist, the error is ignored.
+func (d *Deployment) UpdatePvc(pvc *v1.PersistentVolumeClaim) error {
+	_, err := d.GetKubeCli().CoreV1().PersistentVolumeClaims(d.GetNamespace()).Update(pvc)
+	if err == nil {
+		return nil
+	}
+
+	if errors.IsNotFound(err) {
+		return nil
+	}
+
+	return maskAny(err)
+}
+
+// GetPv returns PV info about PV with given name.
+func (d *Deployment) GetPv(pvName string) (*v1.PersistentVolume, error) {
+	pv, err := d.GetKubeCli().CoreV1().PersistentVolumes().Get(pvName, metav1.GetOptions{})
+	if err == nil {
+		return pv, nil
+	}
+
+	return nil, maskAny(err)
+}
+
 // GetOwnedPods returns a list of all pods owned by the deployment.
 func (d *Deployment) GetOwnedPods() ([]v1.Pod, error) {
 	// Get all current pods

pkg/deployment/reconcile/action_context.go

@@ -25,9 +25,9 @@ package reconcile
 import (
 	"context"
 	"fmt"
-	v1 "k8s.io/api/core/v1"
-
 	"github.com/arangodb/go-driver/agency"
+	"github.com/arangodb/kube-arangodb/pkg/util/k8sutil"
+	v1 "k8s.io/api/core/v1"
 
 	"github.com/arangodb/arangosync-client/client"
 	driver "github.com/arangodb/go-driver"
@@ -40,6 +40,8 @@ import (
 // ActionContext provides methods to the Action implementations
 // to control their context.
 type ActionContext interface {
+	// GetAPIObject returns the deployment as k8s object.
+	GetAPIObject() k8sutil.APIObject
 	// Gets the specified mode of deployment
 	GetMode() api.DeploymentMode
 	// GetDatabaseClient returns a cached client for the entire database (cluster coordinators or single server),
@@ -53,6 +55,9 @@ type ActionContext interface {
 	GetAgency(ctx context.Context) (agency.Agency, 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 *k8sutil.Event)
 	// GetMemberStatusByID returns the current member status
 	// for the member with given id.
 	// Returns member status, true when found, or false
@@ -74,6 +79,11 @@ type ActionContext interface {
 	// GetPvc returns PVC info about PVC with given name in the namespace
 	// of the deployment.
 	GetPvc(pvcName string) (*v1.PersistentVolumeClaim, error)
+	// GetPv returns PV info about PV with given name.
+	GetPv(pvName string) (*v1.PersistentVolume, error)
+	// UpdatePvc update PVC with given name in the namespace
+	// of the deployment.
+	UpdatePvc(pvc *v1.PersistentVolumeClaim) error
 	// RemovePodFinalizers removes all the finalizers from the Pod with given name in the namespace
 	// of the deployment. If the pod does not exist, the error is ignored.
 	RemovePodFinalizers(podName string) error
@@ -103,7 +113,7 @@ type ActionContext interface {
 // newActionContext creates a new ActionContext implementation.
 func newActionContext(log zerolog.Logger, context Context) ActionContext {
 	return &actionContext{
-		log:     log,
+		log:      log,
 		context: context,
 	}
 }
@@ -114,6 +124,22 @@ type actionContext struct {
 	context Context
 }
 
+func (ac *actionContext) GetPv(pvName string) (*v1.PersistentVolume, error) {
+	return ac.context.GetPv(pvName)
+}
+
+func (ac *actionContext) GetAPIObject() k8sutil.APIObject {
+	return ac.context.GetAPIObject()
+}
+
+func (ac *actionContext) UpdatePvc(pvc *v1.PersistentVolumeClaim) error {
+	return ac.context.UpdatePvc(pvc)
+}
+
+func (ac *actionContext) CreateEvent(evt *k8sutil.Event) {
+	ac.context.CreateEvent(evt)
+}
+
 func (ac *actionContext) GetPvc(pvcName string) (*v1.PersistentVolumeClaim, error) {
 	return ac.context.GetPvc(pvcName)
 }

pkg/deployment/reconcile/action_pvc_resize.go

@@ -0,0 +1,159 @@
+//
+// 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 (
+	"context"
+	"time"
+
+	"github.com/arangodb/kube-arangodb/pkg/util/k8sutil"
+	core "k8s.io/api/core/v1"
+	"k8s.io/apimachinery/pkg/api/errors"
+
+	api "github.com/arangodb/kube-arangodb/pkg/apis/deployment/v1"
+	"github.com/rs/zerolog"
+)
+
+// NewRotateMemberAction creates a new Action that implements the given
+// planned RotateMember action.
+func NewPVCResizeAction(log zerolog.Logger, action api.Action, actionCtx ActionContext) Action {
+	return &actionPVCResize{
+		log:       log,
+		action:    action,
+		actionCtx: actionCtx,
+	}
+}
+
+// actionRotateMember implements an RotateMember.
+type actionPVCResize struct {
+	log       zerolog.Logger
+	action    api.Action
+	actionCtx ActionContext
+}
+
+// Start performs the start of the action.
+// Returns true if the action is completely finished, false in case
+// the start time needs to be recorded and a ready condition needs to be checked.
+func (a *actionPVCResize) Start(ctx context.Context) (bool, error) {
+	log := a.log
+	group := a.action.Group
+	groupSpec := a.actionCtx.GetSpec().GetServerGroupSpec(group)
+	m, ok := a.actionCtx.GetMemberStatusByID(a.action.MemberID)
+	if !ok {
+		log.Error().Msg("No such member")
+		return true, nil
+	}
+
+	if m.PersistentVolumeClaimName == "" {
+		// Nothing to do, PVC is empty
+		return true, nil
+	}
+
+	pvc, err := a.actionCtx.GetPvc(m.PersistentVolumeClaimName)
+	if err != nil {
+		if errors.IsNotFound(err) {
+			return true, nil
+		}
+
+		return false, err
+	}
+
+	var res core.ResourceList
+	if groupSpec.HasVolumeClaimTemplate() {
+		res = groupSpec.GetVolumeClaimTemplate().Spec.Resources.Requests
+	} else {
+		res = groupSpec.Resources.Requests
+	}
+
+	if requestedSize, ok := res[core.ResourceStorage]; ok {
+		if volumeSize, ok := pvc.Spec.Resources.Requests[core.ResourceStorage]; ok {
+			cmp := volumeSize.Cmp(requestedSize)
+			if cmp < 0 {
+				pvc.Spec.Resources.Requests[core.ResourceStorage] = requestedSize
+				if err := a.actionCtx.UpdatePvc(pvc); err != nil {
+					return false, err
+				}
+
+				return false, nil
+			} else if cmp > 0 {
+				log.Error().Str("server-group", group.AsRole()).Str("pvc-storage-size", volumeSize.String()).Str("requested-size", requestedSize.String()).
+					Msg("Volume size should not shrink")
+				a.actionCtx.CreateEvent(k8sutil.NewCannotShrinkVolumeEvent(a.actionCtx.GetAPIObject(), pvc.Name))
+				return false, nil
+			}
+		}
+	}
+
+	return true, nil
+}
+
+// CheckProgress checks the progress of the action.
+// Returns: ready, abort, error.
+func (a *actionPVCResize) CheckProgress(ctx context.Context) (bool, bool, error) {
+	// Check that pod is removed
+	log := a.log
+	m, found := a.actionCtx.GetMemberStatusByID(a.action.MemberID)
+	if !found {
+		log.Error().Msg("No such member")
+		return true, false, nil
+	}
+
+	pvc, err := a.actionCtx.GetPvc(m.PersistentVolumeClaimName)
+	if err != nil {
+		if errors.IsNotFound(err) {
+			return true, false, nil
+		}
+
+		return false, true, err
+	}
+
+	pv, err := a.actionCtx.GetPv(pvc.Spec.VolumeName)
+	if err != nil {
+		if errors.IsNotFound(err) {
+			return true, false, nil
+		}
+
+		return false, true, err
+	}
+
+	if requestedSize, ok := pvc.Spec.Resources.Requests[core.ResourceStorage]; ok {
+		if volumeSize, ok := pv.Spec.Capacity[core.ResourceStorage]; ok {
+			cmp := volumeSize.Cmp(requestedSize)
+			if cmp >= 0 {
+				return true, false, nil
+			}
+		}
+	}
+
+	return false, false, nil
+}
+
+// Timeout returns the amount of time after which this action will timeout.
+func (a *actionPVCResize) Timeout() time.Duration {
+	return pvcResizeTimeout
+}
+
+// Return the MemberID used / created in this action
+func (a *actionPVCResize) MemberID() string {
+	return a.action.MemberID
+}