kubeadm: refactor the dry-run logic #126776

neolit123 · 2024-08-19T06:48:46Z

What type of PR is this?

/kind cleanup

What this PR does / why we need it:

The current dryrun client implemnetation is suboptimal
and sparse. It has the following problems:

When an object CREATE or UPDATE reaches the default dryrun client
the operation is a NO-OP, which means subsequent GET calls must
fully emulate the object that exists in the store.
There are multiple implmentations of a DryRunGetter interface
such the one in init_dryrun.go but there are no implementations
for reset, upgrade, join.
There is a specific DryRunGetter that is backed by a real
client in clientbacked_dryrun.go, but this is used for upgrade
and does not work in conjuction with a fake client.

This commit does the following changes:

Removes all existing dryrun.go implementations.
Add a new DryRun implementation in dryrun.go that implements
3 clients - fake clientset, real clientset, real dynamic client.
The DryRun object uses the method chaining pattern.
Allows the user opt-in into real clients only if needed, by passing
a real kubeconfig. By default only constructs a fake client.
The default reactor chain for the fake client, always logs the
object action, then for GET or LIST actions attempts to use the
real dynamic client to get the object. If a real object does not
exist it attempts to get the object from the fake object store.
The user can prepend or append reactors to the chain.
All known needed reactors for operations during init, join,
reset, upgrade are added as methods of the DryRun struct.
Adds detailed unit test for the DryRun struct and its methods
including reactors.

Additional changes:

Use the new DryRun implementation in all command workflows -
init, join, reset, upgrade.
Ensure that --dry-run works even if there is no active cluster
by returning faked objects. For join, a faked cluster-info
with a fake bootstrap token and CA are used.

Which issue(s) this PR fixes:

Fixes kubernetes/kubeadm#2653
Fixes kubernetes/kubeadm#1932

Special notes for your reviewer:

NONE

Does this PR introduce a user-facing change?

kubeadm: increased the verbosity of API client dry-run actions during the subcommands "init", "join", "upgrade" and "reset". Allowed dry-run on 'kubeadm join' even if there is no existing cluster by utilizing a faked, in-memory cluster-info ConfigMap.

Additional documentation e.g., KEPs (Kubernetes Enhancement Proposals), usage docs, etc.:

neolit123 · 2024-08-19T06:50:41Z

/hold for

kubeadm: implement 'kubeadm upgrade apply phase' #126032

neolit123 · 2024-08-19T11:48:54Z

/triage accepted
/priority backlog

neolit123 · 2024-09-06T12:27:57Z

/retitle kubeadm: refactor the dry-run logic

this is ready for review

cmd/kubeadm/app/cmd/phases/reset/cleanupnode.go

pacoxu · 2024-09-29T08:59:16Z

cmd/kubeadm/app/cmd/phases/reset/cleanupnode.go

@@ -176,7 +176,7 @@ func resetConfigDir(configPathDir string, dirsToClean []string, isDryRun bool) {
 			}
 		}
 	} else {
-		fmt.Printf("[reset] Would delete files: %v\n", filesToClean)
+		fmt.Printf("[dryrun] Would delete files: %v\n", filesToClean)


Should file path be quoted using %q?

filesToClean is a slice of strings, so that's why here is %v

neolit123 · 2024-10-01T17:15:31Z

updated

carlory · 2024-10-07T14:57:29Z

/lgtm

k8s-ci-robot · 2024-10-07T14:57:36Z

LGTM label has been added.

Git tree hash: bc73c16edff62f82ad6ed983f48d13f07018621a

pacoxu · 2024-10-08T01:55:31Z

/lgtm

SataQiu · 2024-10-08T08:47:41Z

cmd/kubeadm/app/util/apiclient/dryrun.go

+	objBytes, err := d.marshalFunc(obj, gv)
+	if err == nil {
+		fmt.Fprintln(d.writer, "[dryrun] Attached object:")
+		fmt.Fprintf(d.writer, "%s", objBytes)


Don't we need to use fmt.Fprinln() here?

changed to:

fmt.Fprintln(d.writer, string(objBytes))

cmd/kubeadm/app/util/apiclient/dryrun.go

neolit123 · 2024-10-10T21:01:44Z

~~@SataQiu add comments if you have too.~~ x
~~i will try to merge this early next week and update the dry run e2e test.~~

NVM, i missed your review above.

neolit123 · 2024-10-10T21:11:04Z

@SataQiu updated.

The current dryrun client implemnetation is suboptimal and sparse. It has the following problems: - When an object CREATE or UPDATE reaches the default dryrun client the operation is a NO-OP, which means subsequent GET calls must fully emulate the object that exists in the store. - There are multiple implmentations of a DryRunGetter interface such the one in init_dryrun.go but there are no implementations for reset, upgrade, join. - There is a specific DryRunGetter that is backed by a real client in clientbacked_dryrun.go, but this is used for upgrade and does not work in conjuction with a fake client. This commit does the following changes: - Removes all existing *dryrun*.go implementations. - Add a new DryRun implementation in dryrun.go that implements 3 clients - fake clientset, real clientset, real dynamic client. - The DryRun object uses the method chaining pattern. - Allows the user opt-in into real clients only if needed, by passing a real kubeconfig. By default only constructs a fake client. - The default reactor chain for the fake client, always logs the object action, then for GET or LIST actions attempts to use the real dynamic client to get the object. If a real object does not exist it attempts to get the object from the fake object store. - The user can prepend or append reactors to the chain. - All known needed reactors for operations during init, join, reset, upgrade are added as methods of the DryRun struct. - Adds detailed unit test for the DryRun struct and its methods including reactors. Additional changes: - Use the new DryRun implementation in all command workflows - init, join, reset, upgrade. - Ensure that --dry-run works even if there is no active cluster by returning faked objects. For join, a faked cluster-info with a fake bootstrap token and CA are used.

neolit123 · 2024-10-14T06:48:36Z

@SataQiu @pacoxu @carlory
looking for LGTM so that i can merge this and update e2e tests.

pacoxu · 2024-10-14T06:51:00Z

/lgtm
/approve
(The only update after my last LGTM is a message format update according to Sata's comments. )

k8s-ci-robot · 2024-10-14T06:51:06Z

LGTM label has been added.

Git tree hash: 9f3c027fa029ac074dfd473646137e1ee4e369c6

k8s-ci-robot · 2024-10-14T06:51:15Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: neolit123, pacoxu

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:

~~cmd/kubeadm/OWNERS~~ [neolit123,pacoxu]

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

neolit123 · 2024-10-14T07:21:39Z

/hold cancel

k8s-ci-robot requested review from carlory and SataQiu August 19, 2024 06:49

k8s-ci-robot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Aug 19, 2024

neolit123 force-pushed the 1.31-improve-dry-run-logic branch 4 times, most recently from 174edd6 to 451fa49 Compare August 20, 2024 15:57

k8s-ci-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Sep 3, 2024

neolit123 force-pushed the 1.31-improve-dry-run-logic branch from 451fa49 to f277228 Compare September 3, 2024 14:33

k8s-ci-robot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Sep 3, 2024

neolit123 force-pushed the 1.31-improve-dry-run-logic branch from f277228 to 7dc40c5 Compare September 3, 2024 16:26

pacoxu reviewed Sep 29, 2024

View reviewed changes

cmd/kubeadm/app/cmd/phases/reset/cleanupnode.go Outdated Show resolved Hide resolved

pacoxu reviewed Sep 29, 2024

View reviewed changes

neolit123 force-pushed the 1.31-improve-dry-run-logic branch from 5b0a316 to 47f4232 Compare October 1, 2024 17:15

k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Oct 1, 2024

k8s-ci-robot requested a review from carlory October 1, 2024 17:15

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Oct 7, 2024

k8s-ci-robot assigned pacoxu Oct 8, 2024

SataQiu reviewed Oct 8, 2024

View reviewed changes

neolit123 force-pushed the 1.31-improve-dry-run-logic branch from 47f4232 to 693d4b3 Compare October 10, 2024 21:10

k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Oct 10, 2024

k8s-ci-robot requested a review from pacoxu October 10, 2024 21:11

neolit123 force-pushed the 1.31-improve-dry-run-logic branch from 693d4b3 to 30f9893 Compare October 10, 2024 21:16

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Oct 14, 2024

k8s-ci-robot removed the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Oct 14, 2024

k8s-ci-robot merged commit 769695a into kubernetes:master Oct 14, 2024
14 checks passed

k8s-ci-robot added this to the v1.32 milestone Oct 14, 2024

neolit123 mentioned this pull request Oct 14, 2024

add dry run e2e tests kubernetes/kubeadm#2653

Closed

3 tasks

neolit123 mentioned this pull request Oct 30, 2024

kubeadm: support dryrunning upgrade without a real cluster #128457

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

kubeadm: refactor the dry-run logic #126776

kubeadm: refactor the dry-run logic #126776

neolit123 commented Aug 19, 2024 •

edited

Loading

neolit123 commented Aug 19, 2024

neolit123 commented Aug 19, 2024 •

edited

Loading

neolit123 commented Sep 6, 2024

pacoxu Sep 29, 2024

neolit123 Oct 1, 2024

neolit123 commented Oct 1, 2024

carlory commented Oct 7, 2024

k8s-ci-robot commented Oct 7, 2024

pacoxu commented Oct 8, 2024

SataQiu Oct 8, 2024

neolit123 Oct 10, 2024 •

edited

Loading

neolit123 commented Oct 10, 2024 •

edited

Loading

neolit123 commented Oct 10, 2024

neolit123 commented Oct 14, 2024

pacoxu commented Oct 14, 2024

k8s-ci-robot commented Oct 14, 2024

k8s-ci-robot commented Oct 14, 2024

neolit123 commented Oct 14, 2024

kubeadm: refactor the dry-run logic #126776

kubeadm: refactor the dry-run logic #126776

Conversation

neolit123 commented Aug 19, 2024 • edited Loading

What type of PR is this?

What this PR does / why we need it:

Which issue(s) this PR fixes:

Special notes for your reviewer:

Does this PR introduce a user-facing change?

Additional documentation e.g., KEPs (Kubernetes Enhancement Proposals), usage docs, etc.:

neolit123 commented Aug 19, 2024

neolit123 commented Aug 19, 2024 • edited Loading

neolit123 commented Sep 6, 2024

pacoxu Sep 29, 2024

Choose a reason for hiding this comment

neolit123 Oct 1, 2024

Choose a reason for hiding this comment

neolit123 commented Oct 1, 2024

carlory commented Oct 7, 2024

k8s-ci-robot commented Oct 7, 2024

pacoxu commented Oct 8, 2024

SataQiu Oct 8, 2024

Choose a reason for hiding this comment

neolit123 Oct 10, 2024 • edited Loading

Choose a reason for hiding this comment

neolit123 commented Oct 10, 2024 • edited Loading

neolit123 commented Oct 10, 2024

neolit123 commented Oct 14, 2024

pacoxu commented Oct 14, 2024

k8s-ci-robot commented Oct 14, 2024

k8s-ci-robot commented Oct 14, 2024

neolit123 commented Oct 14, 2024

neolit123 commented Aug 19, 2024 •

edited

Loading

neolit123 commented Aug 19, 2024 •

edited

Loading

neolit123 Oct 10, 2024 •

edited

Loading

neolit123 commented Oct 10, 2024 •

edited

Loading