📖 Add CAPI book section on `clusterctl alpha rollout` #4328

Arvinderpal · 2021-03-16T14:04:36Z

What this PR does / why we need it:

Documents the clusterctl alpha rollout feature.

Related Issue:
#3439

k8s-ci-robot · 2021-03-16T14:04:44Z

Hi @Arvinderpal. Thanks for your PR.

I'm waiting for a kubernetes-sigs member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

fabriziopandini · 2021-03-16T17:10:15Z

/milestone v0.4.0
/ok-to-test

fabriziopandini

overall lgtm, only few nits

fabriziopandini · 2021-03-22T11:20:35Z

docs/book/src/clusterctl/commands/alpha-rollout.md

+
+### Restart 
+
+Use the `restart` sub-command to force an immediate rollout. For example, here the MchineDeployment `my-md-0` will be immediately rolled out:


Should we add a note explaining what rollout means: deleting machines (including cordon/drain of workloads), recreating new ones according to maxUnavailable/maxSurge

fabriziopandini · 2021-03-22T11:21:41Z

docs/book/src/clusterctl/commands/alpha-rollout.md

+
+### Undo
+
+Use the `undo` sub-command to rollback to an ealier revision. For example, here the MachineDeployment `my-md-0` will be rolled back to revison number 3. If the `--to-revision` flag is omited, the MachineDeployment will be rolled back to the revision immediately preceding the current one. 


should we document what happen if the requested revision/the immediate preceding revision does not exists?

Added: "If the desired revision does not exist, the undo will return an error."

fabriziopandini · 2021-03-22T11:25:40Z

docs/book/src/clusterctl/commands/alpha-rollout.md

+
+### Pause/Resume
+
+Use the `pause` sub-command to pause a Cluster API resource. 


Should we document what happens if if are pausing an already paused rollout (or if we are unpausing something not currently paused)

fabriziopandini · 2021-03-22T11:27:10Z

docs/book/src/clusterctl/commands/alpha-rollout.md

+
+<h1> Warning </h1>
+
+Paused resources will not be reconciled by a controller. By resuming a resource, we allow it to be reconciled again. 


Are we using paused at object level or machineDeployments.spec.Paused?
In case we are using the first, should we document that pausing could imply also some undesired side effects because nothing gets updated, including e.g. the ObservedGeneration, replica counters etc.

I added this comment: "Note that internally, this command sets the Paused field within the resource spec (e.g. MachineDeployment.Spec.Paused) to true."

furkatgofurov7

Overall looks good, really like the idea and also +1 to the idea if we can make this to work in kubectl!
There are few nits, please see below:

docs/book/src/clusterctl/commands/alpha-rollout.md

furkatgofurov7 · 2021-03-24T20:12:09Z

docs/book/src/clusterctl/commands/alpha-rollout.md

@@ -0,0 +1,51 @@
+# clusterctl alpha rollout
+
+The `clusterctl alpha rollout` command manages the rollout of a cluster-api resource. It consists of several sub-commands which are documented below. 


maybe we should make cluster-api OR Cluster API word consistent throughout this document? (Cluster API seems to be more frequently used in the repo)

Using Cluster API now.

vincepri · 2021-03-31T15:16:27Z

@Arvinderpal Are you able to address the comments above?

Arvinderpal

@fabriziopandini @furkatgofurov7 I addressed your comments. PTAL

Arvinderpal · 2021-03-31T15:07:00Z

docs/book/src/clusterctl/commands/alpha-rollout.md

@@ -0,0 +1,51 @@
+# clusterctl alpha rollout
+
+The `clusterctl alpha rollout` command manages the rollout of a cluster-api resource. It consists of several sub-commands which are documented below. 


Using Cluster API now.

Arvinderpal · 2021-03-31T15:14:23Z

docs/book/src/clusterctl/commands/alpha-rollout.md

+
+### Restart 
+
+Use the `restart` sub-command to force an immediate rollout. For example, here the MchineDeployment `my-md-0` will be immediately rolled out:


Arvinderpal · 2021-03-31T15:18:05Z

docs/book/src/clusterctl/commands/alpha-rollout.md

+
+### Undo
+
+Use the `undo` sub-command to rollback to an ealier revision. For example, here the MachineDeployment `my-md-0` will be rolled back to revison number 3. If the `--to-revision` flag is omited, the MachineDeployment will be rolled back to the revision immediately preceding the current one. 


Added: "If the desired revision does not exist, the undo will return an error."

Arvinderpal · 2021-03-31T15:20:35Z

docs/book/src/clusterctl/commands/alpha-rollout.md

+
+### Pause/Resume
+
+Use the `pause` sub-command to pause a Cluster API resource. 


Arvinderpal · 2021-03-31T15:29:01Z

docs/book/src/clusterctl/commands/alpha-rollout.md

+
+<h1> Warning </h1>
+
+Paused resources will not be reconciled by a controller. By resuming a resource, we allow it to be reconciled again. 


I added this comment: "Note that internally, this command sets the Paused field within the resource spec (e.g. MachineDeployment.Spec.Paused) to true."

Arvinderpal · 2021-03-31T15:35:34Z

@Arvinderpal Are you able to address the comments above?

@vincepri I just did. PTAL

Arvinderpal · 2021-03-31T16:51:13Z

/retest

fabriziopandini · 2021-04-02T12:16:55Z

/lgtm

fabriziopandini · 2021-04-02T12:17:04Z

/retest

detiber · 2021-04-02T13:46:17Z

/approve

k8s-ci-robot · 2021-04-02T13:46:39Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: detiber

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~~ [detiber]

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

detiber · 2021-04-02T14:07:08Z

/test pull-cluster-api-test-main

k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Mar 16, 2021

k8s-ci-robot added the needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. label Mar 16, 2021

k8s-ci-robot requested review from JoelSpeed and vincepri March 16, 2021 14:04

k8s-ci-robot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Mar 16, 2021

Arvinderpal mentioned this pull request Mar 16, 2021

clusterctl rollout #3439

Closed

9 tasks

k8s-ci-robot added the ok-to-test Indicates a non-member PR verified by an org member that is safe to test. label Mar 16, 2021

k8s-ci-robot added this to the v0.4.0 milestone Mar 16, 2021

k8s-ci-robot removed the needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. label Mar 16, 2021

fabriziopandini reviewed Mar 22, 2021

View reviewed changes

furkatgofurov7 reviewed Mar 24, 2021

View reviewed changes

Add CAPI book section on clusterctl alpha rollout

b323861

Arvinderpal commented Mar 31, 2021

View reviewed changes

Arvinderpal force-pushed the clusterctl-alpha-rollout-book branch from a1e0e24 to b323861 Compare March 31, 2021 15:30

k8s-ci-robot assigned fabriziopandini Apr 2, 2021

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Apr 2, 2021

k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Apr 2, 2021

k8s-ci-robot merged commit 8a54688 into kubernetes-sigs:master Apr 2, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

📖 Add CAPI book section on `clusterctl alpha rollout` #4328

📖 Add CAPI book section on `clusterctl alpha rollout` #4328

Arvinderpal commented Mar 16, 2021

k8s-ci-robot commented Mar 16, 2021

fabriziopandini commented Mar 16, 2021

fabriziopandini left a comment

fabriziopandini Mar 22, 2021

Arvinderpal Mar 31, 2021

fabriziopandini Mar 22, 2021

Arvinderpal Mar 31, 2021

fabriziopandini Mar 22, 2021

Arvinderpal Mar 31, 2021

fabriziopandini Mar 22, 2021

Arvinderpal Mar 31, 2021

furkatgofurov7 left a comment

furkatgofurov7 Mar 24, 2021

Arvinderpal Mar 31, 2021

vincepri commented Mar 31, 2021 •

edited

Loading

Arvinderpal left a comment

Arvinderpal Mar 31, 2021

Arvinderpal Mar 31, 2021

Arvinderpal Mar 31, 2021

Arvinderpal Mar 31, 2021

Arvinderpal Mar 31, 2021

Arvinderpal commented Mar 31, 2021

Arvinderpal commented Mar 31, 2021

fabriziopandini commented Apr 2, 2021

fabriziopandini commented Apr 2, 2021

detiber commented Apr 2, 2021

k8s-ci-robot commented Apr 2, 2021

detiber commented Apr 2, 2021


		### Restart

		Use the `restart` sub-command to force an immediate rollout. For example, here the MchineDeployment `my-md-0` will be immediately rolled out:


		### Undo

		Use the `undo` sub-command to rollback to an ealier revision. For example, here the MachineDeployment `my-md-0` will be rolled back to revison number 3. If the `--to-revision` flag is omited, the MachineDeployment will be rolled back to the revision immediately preceding the current one.


		### Pause/Resume

		Use the `pause` sub-command to pause a Cluster API resource.


		<h1> Warning </h1>

		Paused resources will not be reconciled by a controller. By resuming a resource, we allow it to be reconciled again.

		@@ -0,0 +1,51 @@
		# clusterctl alpha rollout

		The `clusterctl alpha rollout` command manages the rollout of a cluster-api resource. It consists of several sub-commands which are documented below.

📖 Add CAPI book section on clusterctl alpha rollout #4328

📖 Add CAPI book section on clusterctl alpha rollout #4328

Conversation

Arvinderpal commented Mar 16, 2021

k8s-ci-robot commented Mar 16, 2021

fabriziopandini commented Mar 16, 2021

fabriziopandini left a 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

furkatgofurov7 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

vincepri commented Mar 31, 2021 • edited Loading

Arvinderpal left a 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

Arvinderpal commented Mar 31, 2021

Arvinderpal commented Mar 31, 2021

fabriziopandini commented Apr 2, 2021

fabriziopandini commented Apr 2, 2021

detiber commented Apr 2, 2021

k8s-ci-robot commented Apr 2, 2021

detiber commented Apr 2, 2021

📖 Add CAPI book section on `clusterctl alpha rollout` #4328

📖 Add CAPI book section on `clusterctl alpha rollout` #4328

vincepri commented Mar 31, 2021 •

edited

Loading