kubeadm: Introduce config print init/join-defaults #69617

rosti · 2018-10-10T09:05:43Z

What this PR does / why we need it:

In order to improve the UX of kubeadm, it was decided to introduce the
following subcommands:

kubeadm config print - this is currently only a placeholder for subcommands
that deal printing of some kind of configuration.
kubeadm config print init-defaults - prints the default combination of
InitConfiguration and ClusterConfiguration. Selected component configs can be
printed too if the --component-configs command line switch is used.
kubeadm config print join-defaults - prints the default JoinConfiguration.
This command also supports the use of --component-configs.
kubeadm config print-defaults is deprecated in favor of
kubeadm config print init/join-defaults.

Which issue(s) this PR fixes (optional, in fixes #<issue number>(, fixes #<issue_number>, ...) format, will close the issue(s) when PR gets merged):
Refs kubernetes/kubeadm#1152

Special notes for your reviewer:

/cc @kubernetes/sig-cluster-lifecycle-pr-reviews
/area kubeadm
/kind bug
/assign @fabriziopandini
/assign @timothysc
/cc @neolit123

Release note:

kubeadm: Introduce config print init/join-defaults that deprecate config print-defaults by decoupling init and join configs.

neolit123

thanks @rosti
added a couple of comments.

neolit123 · 2018-10-10T18:26:21Z

cmd/kubeadm/app/cmd/config.go

+	cmd := &cobra.Command{
+		Use:   "print",
+		Short: "Print configuration",
+		Long:  "This command serves as a wrapper for subcommands that are meant to print configuration or part of it.",


optionally:
meant to print configuration or part of it.
->
meant to print the default configuration or part of it.

"This command prints default configurations for subcommands provided"

Updated with Tim's version, but omitted the "default" word from it as kubectl config print may also be used to print non default configs in the future (such as current ClusterConfiguration from config map, etc.)

neolit123 · 2018-10-10T18:27:14Z

cmd/kubeadm/app/cmd/config.go

+
+			For documentation visit: https://godoc.org/k8s.io/kubernetes/cmd/kubeadm/app/apis/kubeadm/v1beta1
+
+			Note that sensitive values like the Bootstrap Token fields are replaced with silly values like %q in order to pass validation but


we should probably replace silly with placeholder.

+1 the language should be professional.

timothysc

/approve

I understand what you are doing, but the readability of having a single generic function needs to be broken up a bit.

timothysc · 2018-10-11T01:25:47Z

cmd/kubeadm/app/cmd/config.go

+	cmd := &cobra.Command{
+		Use:   "print",
+		Short: "Print configuration",
+		Long:  "This command serves as a wrapper for subcommands that are meant to print configuration or part of it.",


"This command prints default configurations for subcommands provided"

timothysc · 2018-10-11T01:27:18Z

cmd/kubeadm/app/cmd/config.go

+		Long: fmt.Sprintf(dedent.Dedent(`
+			This command prints objects such as the default %s configuration that is used for 'kubeadm %s'.
+
+			For documentation visit: https://godoc.org/k8s.io/kubernetes/cmd/kubeadm/app/apis/kubeadm/v1beta1


Yeah don't hard code this. We should provide a jump point otherwise this is a maintenance burden.

timothysc · 2018-10-11T01:28:01Z

cmd/kubeadm/app/cmd/config.go

+
+			For documentation visit: https://godoc.org/k8s.io/kubernetes/cmd/kubeadm/app/apis/kubeadm/v1beta1
+
+			Note that sensitive values like the Bootstrap Token fields are replaced with silly values like %q in order to pass validation but


+1 the language should be professional.

timothysc · 2018-10-11T01:29:16Z

cmd/kubeadm/app/cmd/config.go

+			not perform the real computation for creating a token.
+		`), action, action, sillyToken),
+		Run: func(cmd *cobra.Command, args []string) {
+			allBytes := [][]byte{}


split out the run into it's own function for readability, please.

rosti · 2018-10-11T11:05:50Z

Updated the PR. @neolit123 @timothysc, PTAL

neolit123 · 2018-10-11T12:06:40Z

LGTM, thanks.
/retest

fabriziopandini

@rosti sorry for the late review
I think that this PR could be further simplified by adding the "action" parameter to getSupportedAPIObjects and getAllAPIObjectNames (that we can eventually merge since there is no historical objects to manage now)

Then we can have the deprecated print-defaults, print init-defaults and join-defaults insisting on the same code.
wdyt?

rosti · 2018-10-11T16:27:04Z

@fabriziopandini my first idea was on those lines, but that way, when kubeadm config print-defaults goes away, the code will not get pretty straight.
In the current implementation the code for init/join-defaults is very simple (no YAML splitting, etc.) and when in the next release cycle the code for print-defaults gets deleted things will get really simple. Furthermore, getSupportedAPIObjects and getAllAPIObjectNames are only used by print-defaults, so they will be goners too.

fabriziopandini · 2018-10-12T06:19:40Z

@rosti thanks for the explanation.
Please open an issue for keeping track of the todo for the next cycle
/lgtm
/approve

fabriziopandini · 2018-10-12T06:22:27Z

/approve

rosti · 2018-10-12T11:53:04Z

For the docs approval:

/assign @brendandburns
/assign @pwittrock

fabriziopandini · 2018-10-14T17:06:19Z

/test pull-kubernetes-e2e-kops-aws

fabriziopandini · 2018-10-14T19:33:02Z

/approve

Bradamant3 · 2018-10-15T15:06:55Z

@tengqm do we have formatting issues here still with the generated docs? Or is the fix on our end anyway?

In order to improve the UX of kubeadm, it was decided to introduce the following subcommands: - `kubeadm config print` - this is currently only a placeholder for subcommands that deal printing of some kind of configuration. - `kubeadm config print init-defaults` - prints the default combination of InitConfiguration and ClusterConfiguration. Selected component configs can be printed too if the `--component-configs` command line switch is used. - `kubeadm config print join-defaults` - prints the default JoinConfiguration. This command also supports the use of `--component-configs`. - `kubeadm config print-defaults` is deprecated in favor of `kubeadm config print init/join-defaults`. Signed-off-by: Rostislav M. Georgiev <rostislavg@vmware.com>

k8s-ci-robot · 2018-10-18T11:23:04Z

New changes are detected. LGTM label has been removed.

k8s-ci-robot · 2018-10-20T11:51:38Z

[APPROVALNOTIFIER] This PR is APPROVED

Approval requirements bypassed by manually added approval.

This pull-request has been approved by: fabriziopandini, rosti, timothysc

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~~ [fabriziopandini,timothysc]
docs/OWNERS

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

rosti · 2018-10-20T14:17:24Z

/test pull-kubernetes-e2e-kops-aws

k8s-ci-robot added the release-note Denotes a PR that will be considered when it comes time to generate release notes. label Oct 10, 2018

k8s-ci-robot assigned fabriziopandini and timothysc Oct 10, 2018

k8s-ci-robot requested a review from neolit123 October 10, 2018 09:05

rosti force-pushed the config-defaults-split branch from 8687adf to 814c792 Compare October 10, 2018 11:42

neolit123 reviewed Oct 10, 2018

View reviewed changes

timothysc suggested changes Oct 11, 2018

View reviewed changes

rosti force-pushed the config-defaults-split branch 2 times, most recently from 8fc9955 to 0132bc2 Compare October 11, 2018 11:02

fabriziopandini suggested changes Oct 11, 2018

View reviewed changes

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

k8s-ci-robot assigned brendandburns and pwittrock Oct 12, 2018

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

rosti force-pushed the config-defaults-split branch from 0132bc2 to 91049ef Compare October 18, 2018 11:23

k8s-ci-robot removed lgtm "Looks good to me", indicates that a PR is ready to be merged. needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. labels Oct 18, 2018

neolit123 mentioned this pull request Oct 19, 2018

Documentation: how to enable alpha features kubernetes-sigs/kind#63

Closed

timothysc added lgtm "Looks good to me", indicates that a PR is ready to be merged. approved Indicates a PR has been approved by an approver from all required OWNERS files. labels Oct 20, 2018

k8s-ci-robot merged commit a6e2732 into kubernetes:master Oct 20, 2018

rosti deleted the config-defaults-split branch November 22, 2018 15:25

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

kubeadm: Introduce config print init/join-defaults #69617

kubeadm: Introduce config print init/join-defaults #69617

rosti commented Oct 10, 2018

neolit123 left a comment

neolit123 Oct 10, 2018

timothysc Oct 11, 2018

rosti Oct 11, 2018

neolit123 Oct 10, 2018

timothysc Oct 11, 2018

timothysc left a comment

timothysc Oct 11, 2018

timothysc Oct 11, 2018

timothysc Oct 11, 2018

timothysc Oct 11, 2018

rosti commented Oct 11, 2018

neolit123 commented Oct 11, 2018

fabriziopandini left a comment

rosti commented Oct 11, 2018

fabriziopandini commented Oct 12, 2018

fabriziopandini commented Oct 12, 2018

rosti commented Oct 12, 2018

fabriziopandini commented Oct 14, 2018

fabriziopandini commented Oct 14, 2018

Bradamant3 commented Oct 15, 2018 •

edited

Loading

k8s-ci-robot commented Oct 18, 2018

k8s-ci-robot commented Oct 20, 2018

rosti commented Oct 20, 2018


		For documentation visit: https://godoc.org/k8s.io/kubernetes/cmd/kubeadm/app/apis/kubeadm/v1beta1

		Note that sensitive values like the Bootstrap Token fields are replaced with silly values like %q in order to pass validation but

kubeadm: Introduce config print init/join-defaults #69617

kubeadm: Introduce config print init/join-defaults #69617

Conversation

rosti commented Oct 10, 2018

neolit123 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

timothysc 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

rosti commented Oct 11, 2018

neolit123 commented Oct 11, 2018

fabriziopandini left a comment

Choose a reason for hiding this comment

rosti commented Oct 11, 2018

fabriziopandini commented Oct 12, 2018

fabriziopandini commented Oct 12, 2018

rosti commented Oct 12, 2018

fabriziopandini commented Oct 14, 2018

fabriziopandini commented Oct 14, 2018

Bradamant3 commented Oct 15, 2018 • edited Loading

k8s-ci-robot commented Oct 18, 2018

k8s-ci-robot commented Oct 20, 2018

rosti commented Oct 20, 2018

Bradamant3 commented Oct 15, 2018 •

edited

Loading