Update command #673

alenkacz · 2019-07-31T17:58:29Z

What type of PR is this?
/component kudoctl
/kind enhancement

What this PR does / why we need it:
kudo update patches running instance with new parameter values.

Which issue(s) this PR fixes:

Special notes for your reviewer:

Does this PR introduce a user-facing change?:

Added `kudo update` command to change parameters of running operator.

jbarrick-mesosphere · 2019-07-31T22:52:26Z

pkg/kudoctl/cmd/update.go

+			}
+			return runUpdate(args, options)
+		},
+		SilenceUsage: true,


Why are we setting this?

lol good question :D I don't know. Copy-paste 😛

SilenceUsage is an option to silence usage when an error occurs. ... sounds reasonable to me though 🤷‍♀ lot of errors can come up from non-usage errors so maybe that's why we have decided to not print it there? No hard opinion though...

That seems like a debug remnant? Not sure why we would set it.

okay, should I remove it then from all comands?

zen-dog · 2019-08-01T09:20:51Z

pkg/kudoctl/cmd/update.go

+		The update argument must be a name of the instance.
+
+		# Update dev-flink instance with setting parameter param with value value
+		kubectl kudo upgrade dev-flink -p param=value


Lol

Suggested change

kubectl kudo upgrade dev-flink -p param=value

kubectl kudo update dev-flink -p param=value

zen-dog · 2019-08-01T09:21:16Z

pkg/kudoctl/cmd/update.go

+		kubectl kudo upgrade dev-flink -p param=value
+
+		# Update dev-flink instance in namespace services with setting parameter param with value value
+		kubectl kudo upgrade dev-flink -n services -p param=value`


Suggested change

kubectl kudo upgrade dev-flink -n services -p param=value`

kubectl kudo update dev-flink -n services -p param=value`

😉

zen-dog · 2019-08-01T09:51:10Z

pkg/kudoctl/cmd/update.go

+			}
+			return runUpdate(args, options)
+		},
+		SilenceUsage: true,


That seems like a debug remnant? Not sure why we would set it.

zen-dog · 2019-08-01T09:52:12Z

pkg/kudoctl/cmd/update.go

+	Namespace: "default",
+}
+
+// newUpgradeCmd creates the install command for the CLI


Suggested change

// newUpgradeCmd creates the install command for the CLI

// newUpdateCmd creates the install command for the CLI

zen-dog · 2019-08-01T09:52:25Z

pkg/kudoctl/cmd/update.go

+func newUpdateCmd() *cobra.Command {
+	options := defaultUpdateOptions
+	var parameters []string
+	upgradeCmd := &cobra.Command{


Suggested change

upgradeCmd := &cobra.Command{

updateCmd := &cobra.Command{

zen-dog · 2019-08-01T10:06:32Z

pkg/kudoctl/cmd/update.go

+	return nil
+}
+
+func runUpdate(args []string, options *updateOptions) error {


We have this patter (which I like) where we separate building of the command from the actual code that is executed in different files. It might seem like overkill here, but these things tend to grow 😉

yeah my current personal opinion is to keep it in one file as long as the command is simple enough...

...for now 😉 But I'll leave this up to you

zen-dog · 2019-08-01T10:14:04Z

pkg/kudoctl/cmd/upgrade.go

@@ -157,7 +158,7 @@ func upgrade(newOv *v1alpha1.OperatorVersion, kc *kudo.Client, options *options)
 	}

 	// Change instance to point to the new OV and optionally update parameters
-	err = kc.UpdateInstance(options.InstanceName, options.Namespace, newOv.Name, options.Parameters)
+	err = kc.UpdateInstance(options.InstanceName, options.Namespace, util.String(ov.Name), options.Parameters)


Hu? Why did this change from newOv to ov?

good catch :)

zen-dog · 2019-08-01T10:25:25Z

pkg/kudoctl/cmd/update.go

+		return fmt.Errorf("instance %s in namespace %s does not exist in the cluster", instanceToUpdate, options.Namespace)
+	}
+
+	// Change instance to point to the new OV and optionally update parameters


I don't think this comment makes sense here

zen-dog · 2019-08-01T10:40:41Z

pkg/kudoctl/cmd/update.go

+	}
+
+	// Change instance to point to the new OV and optionally update parameters
+	err = kc.UpdateInstance(instanceToUpdate, options.Namespace, nil, options.Parameters)


also, why do we pass nil as operatorVersionName here?

because we don't want to update the version in this call. I use nil here as I would use None in scala

zen-dog · 2019-08-01T11:04:23Z

pkg/kudoctl/cmd/update_test.go

+		errMessageContains string
+	}{
+		{"instance does not exist", false, map[string]string{"param": "value"}, "instance test in namespace default does not exist in the cluster"},
+		{"update parameters", true, map[string]string{"param": "value"}, ""},


Nice tests 👏 How about giving the testInstance an existing parameter param: oldValue?

yeah I think the current patch implementation is incorrect, since this code for patch is already on master, I'll address that in another PR and add the test as well

okay I did it in here

alenkacz · 2019-08-01T12:50:19Z

okay, the patch for parameters was not working 100% because if you had parameters in place, it dropped them and replaced with new, which is not correct. I switched to merge patch and now it seems to be OK (thx @zen-dog )

➜  kudo git:(av/update-command) ✗ k get instance zookeeper-qqv8ks -o yaml
apiVersion: kudo.dev/v1alpha1
kind: Instance
metadata:
  creationTimestamp: "2019-07-30T15:43:49Z"
  generation: 10
  labels:
    controller-tools.k8s.io: "1.0"
    kudo.dev/operator: zookeeper
  name: zookeeper-qqv8ks
  namespace: default
  resourceVersion: "532209"
  selfLink: /apis/kudo.dev/v1alpha1/namespaces/default/instances/zookeeper-qqv8ks
  uid: 748bd3dd-0ab3-430a-ac1d-c671f652b274
operatorVersion: {}
spec:
  operatorVersion:
    name: zookeeper-0.1.0
status:
  activePlan: {}
➜  kudo git:(av/update-command) ✗ ./bin/kubectl-kudo update zookeeper-qqv8ks -p param=value
Instance zookeeper-qqv8ks was updated ヽ(•‿•)ノ%                                                                                                                                   ➜  kudo git:(av/update-command) ✗ k get instance zookeeper-qqv8ks -o yaml
apiVersion: kudo.dev/v1alpha1
kind: Instance
metadata:
  creationTimestamp: "2019-07-30T15:43:49Z"
  generation: 11
  labels:
    controller-tools.k8s.io: "1.0"
    kudo.dev/operator: zookeeper
  name: zookeeper-qqv8ks
  namespace: default
  resourceVersion: "532233"
  selfLink: /apis/kudo.dev/v1alpha1/namespaces/default/instances/zookeeper-qqv8ks
  uid: 748bd3dd-0ab3-430a-ac1d-c671f652b274
operatorVersion: {}
spec:
  operatorVersion:
    name: zookeeper-0.1.0
  parameters:
    param: value
status:
  activePlan: {}
➜  kudo git:(av/update-command) ✗ ./bin/kubectl-kudo update zookeeper-qqv8ks -p param2=value2
Instance zookeeper-qqv8ks was updated ヽ(•‿•)ノ%                                                                                                                                   ➜  kudo git:(av/update-command) ✗ k get instance zookeeper-qqv8ks -o yaml
apiVersion: kudo.dev/v1alpha1
kind: Instance
metadata:
  creationTimestamp: "2019-07-30T15:43:49Z"
  generation: 12
  labels:
    controller-tools.k8s.io: "1.0"
    kudo.dev/operator: zookeeper
  name: zookeeper-qqv8ks
  namespace: default
  resourceVersion: "532251"
  selfLink: /apis/kudo.dev/v1alpha1/namespaces/default/instances/zookeeper-qqv8ks
  uid: 748bd3dd-0ab3-430a-ac1d-c671f652b274
operatorVersion: {}
spec:
  operatorVersion:
    name: zookeeper-0.1.0
  parameters:
    param: value
    param2: value2
status:
  activePlan: {}

zen-dog · 2019-08-01T12:57:30Z

pkg/kudoctl/cmd/update.go

+	updateCmd := &cobra.Command{
+		Use:     "update <instance-name>",
+		Short:   "Update installed KUDO operator.",
+		Long:    `Update installed KUDO operator with new parameters.`,


Should we also mention explicitly that one can not remove existing parameters this way?

Suggested change

Long: `Update installed KUDO operator with new parameters.`,

Long: `Update installed KUDO operator with new parameters. Existing parameters can not be removed for now.`,

zen-dog

🚢 (if you promise to add an IT ;)

kudo-ci · 2019-08-01T13:31:55Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: alenkacz, jbarrick-mesosphere, zen-dog

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

~~OWNERS~~ [alenkacz,jbarrick-mesosphere]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

Update command

4c678f9

alenkacz requested review from kensipe and jbarrick-mesosphere July 31, 2019 17:58

alenkacz requested a review from fabianbaier as a code owner July 31, 2019 17:58

kudo-ci requested a review from runyontr July 31, 2019 17:58

kudo-ci added approved needs-kind size/L labels Jul 31, 2019

Formatting

73180a2

jbarrick-mesosphere approved these changes Jul 31, 2019

View reviewed changes

Actually add the command

497c041

kudo-ci added kind/enhancement and removed needs-kind labels Aug 1, 2019

Print out happy message

502d895

zen-dog reviewed Aug 1, 2019

View reviewed changes

alenkacz added 3 commits August 1, 2019 13:21

PR feedback

c66c38a

Use merge patch instead of json patch

6f368ac

Move from json patch to merge patch

04612ca

zen-dog reviewed Aug 1, 2019

View reviewed changes

zen-dog approved these changes Aug 1, 2019

View reviewed changes

alenkacz merged commit f15ae36 into master Aug 1, 2019

kudo-ci deleted the av/update-command branch August 1, 2019 13:59

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update command #673

Update command #673

alenkacz commented Jul 31, 2019 •

edited

Loading

jbarrick-mesosphere Jul 31, 2019

alenkacz Aug 1, 2019

zen-dog Aug 1, 2019

alenkacz Aug 1, 2019

zen-dog Aug 1, 2019

zen-dog Aug 1, 2019

zen-dog Aug 1, 2019

zen-dog Aug 1, 2019

zen-dog Aug 1, 2019

zen-dog Aug 1, 2019

alenkacz Aug 1, 2019 •

edited

Loading

zen-dog Aug 1, 2019

zen-dog Aug 1, 2019

alenkacz Aug 1, 2019

zen-dog Aug 1, 2019

zen-dog Aug 1, 2019

alenkacz Aug 1, 2019

zen-dog Aug 1, 2019

alenkacz Aug 1, 2019 •

edited

Loading

alenkacz Aug 1, 2019

alenkacz commented Aug 1, 2019 •

edited

Loading

zen-dog Aug 1, 2019 •

edited

Loading

zen-dog left a comment

kudo-ci commented Aug 1, 2019

	kubectl kudo upgrade dev-flink -p param=value
	kubectl kudo update dev-flink -p param=value

	kubectl kudo upgrade dev-flink -n services -p param=value`
	kubectl kudo update dev-flink -n services -p param=value`

	// newUpgradeCmd creates the install command for the CLI
	// newUpdateCmd creates the install command for the CLI

	Long: `Update installed KUDO operator with new parameters.`,
	Long: `Update installed KUDO operator with new parameters. Existing parameters can not be removed for now.`,

Update command #673

Update command #673

Conversation

alenkacz commented Jul 31, 2019 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

alenkacz Aug 1, 2019 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

alenkacz Aug 1, 2019 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

alenkacz commented Aug 1, 2019 • edited Loading

zen-dog Aug 1, 2019 • edited Loading

Choose a reason for hiding this comment

zen-dog left a comment

Choose a reason for hiding this comment

kudo-ci commented Aug 1, 2019

alenkacz commented Jul 31, 2019 •

edited

Loading

alenkacz Aug 1, 2019 •

edited

Loading

alenkacz Aug 1, 2019 •

edited

Loading

alenkacz commented Aug 1, 2019 •

edited

Loading

zen-dog Aug 1, 2019 •

edited

Loading