Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

refact(upgrade): scale down jiva target deploy before replica patch #1626

Merged
merged 4 commits into from
Mar 11, 2020
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
50 changes: 49 additions & 1 deletion pkg/kubernetes/deployment/appsv1/v1alpha1/kubernetes.go
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,10 @@ package v1alpha1

import (
"encoding/json"
"github.com/openebs/maya/pkg/debug"
"strings"

"github.com/openebs/maya/pkg/debug"

client "github.com/openebs/maya/pkg/kubernetes/client/v1alpha1"
"github.com/pkg/errors"
appsv1 "k8s.io/api/apps/v1"
Expand Down Expand Up @@ -61,6 +62,14 @@ type createFn func(
deploy *appsv1.Deployment,
) (*appsv1.Deployment, error)

// updateFn is a typed function that abstracts
// updating a deployment instance in kubernetes cluster
type updateFn func(
cli *kubernetes.Clientset,
namespace string,
deploy *appsv1.Deployment,
) (*appsv1.Deployment, error)

// deleteFn is a typed function that abstracts
// deleting a deployment from kubernetes cluster
type deleteFn func(
Expand Down Expand Up @@ -137,6 +146,17 @@ func defaultCreate(
return cli.AppsV1().Deployments(namespace).Create(deploy)
}

// defaultUpdate is the default implementation to update
// a deployment instance in kubernetes cluster
func defaultUpdate(
cli *kubernetes.Clientset,
namespace string,
deploy *appsv1.Deployment,
) (*appsv1.Deployment, error) {

return cli.AppsV1().Deployments(namespace).Update(deploy)
}

// defaultDel is the default implementation to delete a
// deployment instance in kubernetes cluster
func defaultDel(
Expand Down Expand Up @@ -193,6 +213,7 @@ type Kubeclient struct {
get getFn
list listFn
create createFn
update updateFn
del deleteFn
patch patchFn
rolloutStatus rolloutStatusFn
Expand Down Expand Up @@ -222,6 +243,9 @@ func (k *Kubeclient) withDefaults() {
if k.create == nil {
k.create = defaultCreate
}
if k.update == nil {
k.update = defaultUpdate
}
if k.del == nil {
k.del = defaultDel
}
Expand Down Expand Up @@ -394,6 +418,30 @@ func (k *Kubeclient) Create(deployment *appsv1.Deployment) (*appsv1.Deployment,
return k.create(cli, k.namespace, deployment)
}

// Update updates a deployment in specified namespace in kubernetes cluster
func (k *Kubeclient) Update(deployment *appsv1.Deployment) (*appsv1.Deployment, error) {

if debug.EI.IsDeploymentUpdateErrorInjected() {
return nil, errors.New("Deployment update error via injection")
}

if deployment == nil {
return nil, errors.New("failed to update deployment: nil deployment object")
}

cli, err := k.getClientOrCached()
if err != nil {
return nil, errors.Wrapf(
err,
"failed to update deployment {%s} in namespace {%s}",
deployment.Name,
deployment.Namespace,
)
}

return k.update(cli, k.namespace, deployment)
}

// RolloutStatusf returns deployment's rollout status for given name
// in raw bytes
func (k *Kubeclient) RolloutStatusf(name string) (op []byte, err error) {
Expand Down
55 changes: 28 additions & 27 deletions pkg/upgrade/templates/v1/jiva_target.go
Original file line number Diff line number Diff line change
Expand Up @@ -19,31 +19,32 @@ package templates
var (
// JivaTargetPatch is generic template for target patch
JivaTargetPatch = `{
"metadata": {
"labels": {
"openebs.io/version": "{{.UpgradeVersion}}"
}
},
"spec": {
"template": {
"metadata": {
"labels":{
"openebs.io/version": "{{.UpgradeVersion}}"
}
},
"spec": {
"containers": [
{
"name": "{{.ControllerContainerName}}",
"image": "{{.ControllerImage}}:{{.ImageTag}}"
},
{
"name": "maya-volume-exporter",
"image": "{{.MExporterImage}}:{{.ImageTag}}"
}
]
}
}
}
}`
"metadata": {
"labels": {
"openebs.io/version": "{{.UpgradeVersion}}"
}
},
"spec": {
"replicas": 1,
Copy link
Contributor

@akhilerm akhilerm Mar 11, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[doubt] replicas: 1 Is this where we scale down the target?, setting replica to 1.

It would be better if the indentation changes were excluded, since it is generating a huge diff.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Scale down is performed via update before patching. the replica deployment
This is where scale up the target back again while patching the new image and labels.

"template": {
"metadata": {
"labels": {
"openebs.io/version": "{{.UpgradeVersion}}"
}
},
"spec": {
"containers": [
{
"name": "{{.ControllerContainerName}}",
"image": "{{.ControllerImage}}:{{.ImageTag}}"
},
{
"name": "maya-volume-exporter",
"image": "{{.MExporterImage}}:{{.ImageTag}}"
}
]
}
}
}
}`
)
52 changes: 52 additions & 0 deletions pkg/upgrade/upgrader/jiva_upgrade.go
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ import (
templates "github.com/openebs/maya/pkg/upgrade/templates/v1"
errors "github.com/pkg/errors"
appsv1 "k8s.io/api/apps/v1"
corev1 "k8s.io/api/core/v1"
k8serror "k8s.io/apimachinery/pkg/api/errors"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
types "k8s.io/apimachinery/pkg/types"
Expand Down Expand Up @@ -419,6 +420,45 @@ func (j *jivaVolumeOptions) preupgrade(pvName, openebsNamespace string) error {
return nil
}

func scaleDownTargetDeploy(name, namespace string) error {
klog.Infof("Scaling down target deploy %s in %s namespace", name, namespace)
deployObj, err := deployClient.WithNamespace(namespace).Get(name)
if err != nil {
return err
}
pvLabelKey := "openebs.io/persistent-volume"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can we use existing variables here instead of new ones?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sure. Will fix this in upcoming PRs.

pvName := deployObj.Labels[pvLabelKey]
controllerLabel := "openebs.io/controller=jiva-controller," +
pvLabelKey + "=" + pvName
var zero int32
deployObj.Spec.Replicas = &zero
_, err = deployClient.WithNamespace(namespace).Update(deployObj)
if err != nil {
return err
}
podList := &corev1.PodList{}
// Wait for up to 5 minutes targe pod to go away.
shubham14bajpai marked this conversation as resolved.
Show resolved Hide resolved
for i := 0; i < 60; i++ {
shubham14bajpai marked this conversation as resolved.
Show resolved Hide resolved
podList, err = podClient.WithNamespace(namespace).List(
metav1.ListOptions{
LabelSelector: controllerLabel,
})
if err != nil {
return err
}
if len(podList.Items) > 0 {
time.Sleep(time.Second * 5)
} else {
break
}
}
// If pod is not deleted within 5 minutes return error.
if len(podList.Items) > 0 {
return errors.Errorf("target pod still present")
}
return nil
}

func (j *jivaVolumeOptions) replicaUpgrade(openebsNamespace string) error {
var err, uerr error
statusObj := utask.UpgradeDetailedStatuses{Step: utask.ReplicaUpgrade}
Expand All @@ -429,6 +469,18 @@ func (j *jivaVolumeOptions) replicaUpgrade(openebsNamespace string) error {
}

statusObj.Phase = utask.StepErrored

err = scaleDownTargetDeploy(j.controllerObj.name, j.ns)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

is j.controllerObj be NULL here? it seems to be populated in next step

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

if err != nil {
statusObj.Message = "failed to scale down target depoyment"
statusObj.Reason = strings.Replace(err.Error(), ":", "", -1)
j.utaskObj, uerr = updateUpgradeDetailedStatus(j.utaskObj, statusObj, openebsNamespace)
if uerr != nil && isENVPresent {
return uerr
}
return errors.Wrap(err, "failed to scale down target depoyment")
}

// replica patch
err = patchReplica(j.replicaObj, j.ns)
if err != nil {
Expand Down