[kubeadm] Add support for clusterName in config file. #60852

karan · 2018-03-06T19:56:02Z

What this PR does / why we need it: Adds a --cluster-name arg to kubeadm init.

Which issue(s) this PR fixes (optional, in fixes #<issue number>(, fixes #<issue_number>, ...) format, will close the issue(s) when PR gets merged):
See kubernetes-retired/kube-deploy#636
Code inspired by #52470

Special notes for your reviewer:

Release note:

Adds --cluster-name to kubeadm init for specifying the cluster name in kubeconfig.

karan · 2018-03-06T20:10:18Z

/retest

karan · 2018-03-06T20:15:17Z

/retest

karan · 2018-03-06T21:09:52Z

Tests seem to be failing with merge conflicts - my branch and this PR are up-to-date so not sure why.

$ co master
Switched to branch 'master'
Your branch is up to date with 'origin/master'.

karangoel at karangoel-macbookpro in ~/.gvm/pkgsets/go1.9.2/global/src/k8s.io/kubernetes/cmd/kubeadm/app/cmd/phases on master (go1.9.2)
$ git sync
Already up to date.
Everything up-to-date

karangoel at karangoel-macbookpro in ~/.gvm/pkgsets/go1.9.2/global/src/k8s.io/kubernetes/cmd/kubeadm/app/cmd/phases on master (go1.9.2)
$ co -
Switched to branch 'kubeadm-cluster-name'

karangoel at karangoel-macbookpro in ~/.gvm/pkgsets/go1.9.2/global/src/k8s.io/kubernetes/cmd/kubeadm/app/cmd/phases on kubeadm-cluster-name (go1.9.2)
$ git rebase origin/master
Current branch kubeadm-cluster-name is up to date.

karan · 2018-03-06T21:10:03Z

/assign @krousey

krousey · 2018-03-06T21:21:55Z

@karan
I assume you have a remote defined called upstream that points to github.com/kubernetes/kubernetes (git remotes list). Rebase like this:

$ git fetch upstream
$ git checkout kubeadm-cluster-name
$ git rebase upstream/master

karan · 2018-03-06T21:24:02Z

Correct, upstream is k8s/k8s.

$ co master
Switched to branch 'master'
Your branch is up to date with 'origin/master'.

$ git fetch upstream

$ co -
Switched to branch 'kubeadm-cluster-name'

$ git rebase upstream/master
Current branch kubeadm-cluster-name is up to date.

krousey · 2018-03-06T21:37:47Z

I see build errors:

      # k8s.io/kubernetes/cmd/kubeadm/app/phases/certs
cmd/kubeadm/app/phases/certs/certs.go:353:63: not enough arguments in call to pkiutil.NewCertificateAuthority
	have ()
	want (string)
# k8s.io/kubernetes/cmd/kubeadm/test/certs
cmd/kubeadm/test/certs/util.go:31:55: not enough arguments in call to pkiutil.NewCertificateAuthority
	have ()

Seems like you didn't update the logic that generates ETCD certs as well.

karan · 2018-03-06T22:32:19Z

With the latest changes, this builds locally now.

$ bazel build //cmd/kubeadm/...:all
INFO: Analysed 177 targets (1 packages loaded).
INFO: Found 177 targets...
INFO: Elapsed time: 65.023s, Critical Path: 41.15s
INFO: Build completed successfully, 22 total actions

karan · 2018-03-07T16:09:30Z

/assign luxas

luxas

What's the use-case / motivation behind this?
I'm very hesitant against adding more flags to kubeadm init, in fact I think we've declared a freeze there. I could maybe see it going into the config file, but I don't want to over-engineer that either. We have phases for a reason, can the use case here be done via that API instead? In other words, is this an advanced use-case enough to justify going phases route vs the init one?

/assign @timothysc

karan · 2018-03-22T17:45:36Z

The use case here is to be able to generate a kubeconfig that references the cluster with a name other than "kubernetes" so we can have multiple clusters in the same config file. The motivation is to allow the cluster-api tooling to manage multiple clusters, by referencing names rather than IP addresses.

This PR is not urgent so we can wait until the freeze.

xiangpengzhao

just a couple of nits. otherwise LGTM. However, @luxas concern sounds reasonable.

xiangpengzhao · 2018-04-03T07:17:43Z

cmd/kubeadm/app/apis/kubeadm/v1alpha1/types.go

@@ -224,6 +227,8 @@ type NodeConfiguration struct {
 	Token string `json:"token"`
 	// CRISocket is used to retrieve container runtime info.
 	CRISocket string `json:"criSocket,omitempty"`
+	// ClusterName is the name for the cluster in kubeconfig.
+	ClusterName string `json:"clusterName"`


It should be an optional field, right?

Right. made it so

xiangpengzhao · 2018-04-03T07:22:11Z

cmd/kubeadm/app/cmd/init.go

@@ -107,7 +107,7 @@ var (

 // NewCmdInit returns "kubeadm init" command.
 func NewCmdInit(out io.Writer) *cobra.Command {
-	cfg := &kubeadmapiext.MasterConfiguration{}
+	cfg := &kubeadmapiext.MasterConfiguration{ClusterName: kubeadmapiext.DefaultClusterName}


Is ClusterName: kubeadmapiext.DefaultClusterName needed to be specified here? I think it will be defaulted to the value by legacyscheme.Scheme.Default.

You're right. Did not know that's what legacyscheme did. Thanks

xiangpengzhao · 2018-04-03T07:22:46Z

cmd/kubeadm/app/cmd/join.go

@@ -101,7 +101,7 @@ var (

 // NewCmdJoin returns "kubeadm join" command.
 func NewCmdJoin(out io.Writer) *cobra.Command {
-	cfg := &kubeadmapiext.NodeConfiguration{}
+	cfg := &kubeadmapiext.NodeConfiguration{ClusterName: kubeadmapiext.DefaultClusterName}


same as above

karan · 2018-04-12T17:26:44Z

This is now not using a flag but config file.

timothysc

Thank you for scoping this down.

/lgtm
/approve

k8s-ci-robot · 2018-04-12T20:11:17Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: karan, 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~~ [timothysc]

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

k8s-github-robot · 2018-04-12T22:40:07Z

Automatic merge from submit-queue (batch tested with PRs 58178, 62491, 60852). If you want to cherry-pick this change to another branch, please follow the instructions here.

jorhett · 2019-02-19T18:43:42Z

So I am concerned with how this PR played out. @luxas said

I'm very hesitant against adding more flags to kubeadm init, in fact I think we've declared a freeze there. I could maybe see it going into the config file,

As of the current version of Kubernetes 10 months later, there doesn't appear to be any documentation for the config file. The only thing said here: https://kubernetes.io/docs/reference/setup-tools/kubeadm/kubeadm-init/#config-file is

Caution: The config file is still considered beta and may change in future versions.

And worse, the man page which does show the config file option continues to say:

--config string Path to kubeadm config file. WARNING: Usage of a configuration file is experimental.

So it this experimental, or beta? Those would indicate very different levels of support. And either way, there's no clear documentation of what the config file should look like. Is this what it refers to? https://godoc.org/k8s.io/kubernetes/cmd/kubeadm/app/apis/kubeadm/v1beta1#hdr-Kubeadm_init_configuration_types

While I much prefer config files to command line arguments, and agree this was the right approach, it seems we need to button this up a bit more with consistent documentation.

k8s-ci-robot requested review from dmmcquay and mattmoyer March 6, 2018 19:56

k8s-ci-robot added release-note Denotes a PR that will be considered when it comes time to generate release notes. and removed do-not-merge/release-note-label-needed Indicates that a PR should not merge because it's missing one of the release note labels. labels Mar 6, 2018

karan force-pushed the kubeadm-cluster-name branch from 2cf6031 to ca6e681 Compare March 6, 2018 20:08

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

karan force-pushed the kubeadm-cluster-name branch from ca6e681 to 668bf1d Compare March 6, 2018 20:09

karan force-pushed the kubeadm-cluster-name branch from 668bf1d to 2f4a878 Compare March 6, 2018 20:15

k8s-ci-robot assigned krousey Mar 6, 2018

karan force-pushed the kubeadm-cluster-name branch 4 times, most recently from 14a9d56 to 836696d Compare March 6, 2018 22:32

karan changed the title ~~Add cluster-name to kubeadm init~~ Add --cluster-name to kubeadm init Mar 6, 2018

karan force-pushed the kubeadm-cluster-name branch 2 times, most recently from ba345d7 to ff14e48 Compare March 7, 2018 00:39

k8s-ci-robot assigned luxas Mar 7, 2018

karan force-pushed the kubeadm-cluster-name branch from 6fe67bb to 36ce347 Compare March 22, 2018 15:48

luxas reviewed Mar 22, 2018

View reviewed changes

k8s-ci-robot assigned timothysc Mar 22, 2018

xiangpengzhao reviewed Apr 3, 2018

View reviewed changes

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

Add --cluster-name to kubeadm

24d6483

karan force-pushed the kubeadm-cluster-name branch from 36ce347 to 24d6483 Compare April 11, 2018 16:42

k8s-ci-robot added area/kubeadm sig/cluster-lifecycle Categorizes an issue or PR as relevant to SIG Cluster Lifecycle. and removed needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. labels Apr 11, 2018

Remove the default clustername, and make it optional in api

169792b

karan force-pushed the kubeadm-cluster-name branch from 93f41c6 to 169792b Compare April 11, 2018 16:57

karan added 2 commits April 11, 2018 11:12

optional field removed in test

73bb511

Remove clusterName flag, just use config file

2ca8d95

k8s-ci-robot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Apr 12, 2018

karan changed the title ~~Add --cluster-name to kubeadm init~~ [kubeadm] Add support for clusterName in config file. Apr 12, 2018

timothysc approved these changes Apr 12, 2018

View reviewed changes

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

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

rsdcastro mentioned this pull request Apr 12, 2018

Use the cluster name in cluster.yaml in admin.conf kubernetes-sigs/cluster-api#49

Closed

k8s-github-robot merged commit 38da981 into kubernetes:master Apr 12, 2018

xmudrii mentioned this pull request Apr 13, 2018

Cluster name in kubeconfig should reflect cluster name kubicorn/kubicorn#56

Open

timothysc mentioned this pull request Apr 20, 2018

Ability to configure user and cluster name in AdminKubeConfigFile kubernetes/kubeadm#416

Closed

xmudrii mentioned this pull request Jul 30, 2018

do: set cluster name for ubuntu clusters kubicorn/bootstrap#22

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[kubeadm] Add support for clusterName in config file. #60852

[kubeadm] Add support for clusterName in config file. #60852

karan commented Mar 6, 2018 •

edited

Loading

karan commented Mar 6, 2018

karan commented Mar 6, 2018

karan commented Mar 6, 2018

karan commented Mar 6, 2018

krousey commented Mar 6, 2018

karan commented Mar 6, 2018

krousey commented Mar 6, 2018

karan commented Mar 6, 2018

karan commented Mar 7, 2018

luxas left a comment •

edited

Loading

karan commented Mar 22, 2018

xiangpengzhao left a comment

xiangpengzhao Apr 3, 2018

karan Apr 11, 2018

xiangpengzhao Apr 3, 2018

karan Apr 11, 2018

xiangpengzhao Apr 3, 2018

karan Apr 11, 2018

karan commented Apr 12, 2018

timothysc left a comment

k8s-ci-robot commented Apr 12, 2018

k8s-github-robot commented Apr 12, 2018

jorhett commented Feb 19, 2019

[kubeadm] Add support for clusterName in config file. #60852

[kubeadm] Add support for clusterName in config file. #60852

Conversation

karan commented Mar 6, 2018 • edited Loading

karan commented Mar 6, 2018

karan commented Mar 6, 2018

karan commented Mar 6, 2018

karan commented Mar 6, 2018

krousey commented Mar 6, 2018

karan commented Mar 6, 2018

krousey commented Mar 6, 2018

karan commented Mar 6, 2018

karan commented Mar 7, 2018

luxas left a comment • edited Loading

Choose a reason for hiding this comment

karan commented Mar 22, 2018

xiangpengzhao left a comment

Choose a reason for hiding this comment

xiangpengzhao Apr 3, 2018

Choose a reason for hiding this comment

karan Apr 11, 2018

Choose a reason for hiding this comment

xiangpengzhao Apr 3, 2018

Choose a reason for hiding this comment

karan Apr 11, 2018

Choose a reason for hiding this comment

xiangpengzhao Apr 3, 2018

Choose a reason for hiding this comment

karan Apr 11, 2018

Choose a reason for hiding this comment

karan commented Apr 12, 2018

timothysc left a comment

Choose a reason for hiding this comment

k8s-ci-robot commented Apr 12, 2018

k8s-github-robot commented Apr 12, 2018

jorhett commented Feb 19, 2019

karan commented Mar 6, 2018 •

edited

Loading

luxas left a comment •

edited

Loading