kubeadm-setup: add page about control plane flags #9067

neolit123 · 2018-06-13T22:54:02Z

This page adds instructions on how to use the kubeadm config
to pass flags to control plane components.

The provided examples are pretty basic. Later this can be expanded with
actual user stories.

Updates kubernetes/kubeadm#849

/cc @fabriziopandini @luxas @timstclair @kubernetes/sig-cluster-lifecycle-pr-reviews
/assign @Bradamant3

notes:

it's against the master branch as discussed on the kubeadm office hours from 13th June.
i've ended up picking setup/independent as the location for this.
let me know of changes that i need to make - e.g. hugo formatting?
this obviously has to be extended with actual user content but we plan to do that in time.

k8sio-netlify-preview-bot · 2018-06-13T22:57:32Z

Deploy preview for kubernetes-io-master-staging ready!

Built with commit dd838ab

https://deploy-preview-9067--kubernetes-io-master-staging.netlify.com

k8sio-netlify-preview-bot · 2018-06-13T22:58:08Z

Deploy preview for kubernetes-io-master-staging ready!

Built with commit 4e5e3de

https://deploy-preview-9067--kubernetes-io-master-staging.netlify.com

luxas

Thanks @neolit123 for this. A couple of comments

luxas · 2018-06-14T13:03:01Z

content/en/docs/setup/independent/control-plane-flags.md

+Example usage:
+```yaml
+schedulerExtraArgs:
+  address: 192.168.0.104


I'd do 0.0.0.0 as a generic reasonable value for this

luxas · 2018-06-14T13:03:29Z

content/en/docs/setup/independent/control-plane-flags.md

+schedulerExtraArgs:
+  address: 192.168.0.104
+  config: /home/johndoe/schedconfig
+  master: 192.168.0.103


this should be a URL, e.g. https://my-api-server.domain.com:6443

but preferably, I'd set kubeconfig to something here instead...

luxas · 2018-06-14T13:03:45Z

content/en/docs/setup/independent/control-plane-flags.md

+```yaml
+schedulerExtraArgs:
+  address: 192.168.0.104
+  config: /home/johndoe/schedconfig


luxas · 2018-06-14T13:04:23Z

content/en/docs/setup/independent/control-plane-flags.md

+```yaml
+controllerManagerExtraArgs:
+  cluster-signing-key-file: /home/johndoe/keys/ca.key
+  bind-address: 192.168.0.101


luxas · 2018-06-14T13:04:36Z

content/en/docs/setup/independent/control-plane-flags.md

+controllerManagerExtraArgs:
+  cluster-signing-key-file: /home/johndoe/keys/ca.key
+  bind-address: 192.168.0.101
+  deployment-controller-sync-period: 50


this is a duration right? 50s?

luxas · 2018-06-14T13:05:14Z

content/en/docs/setup/independent/control-plane-flags.md

+```yaml
+apiServerExtraArgs:
+  advertise-address: 192.168.0.103
+  allow-privileged: true


is deprecated I think... some other common value like enable-admission-control?

The most common uses are:

adding admission controllers
configuring audit log (soon to be webhook)

luxas · 2018-06-14T13:06:47Z

content/en/docs/setup/independent/control-plane-flags.md

+- `ControllerManagerExtraArgs`
+- `SchedulerExtraArgs`
+
+The fields can contain a list of `key: value` pairs. To override flags for a specific control plane component just include one of the fields above and start adding flags for it.


you can add a (it's serialized as a map[string]string, like Kubernetes labels or annotations)`

What value for a user does the content that luxas suggests add? This seems like an implementation detail that does not belong here. We've already got a larger confusion in the kubeadm docs between what a user needs and what a dev needs; let's not perpetuate it here.

Larger scale edit:

These fields consist of key: value pairs. To override a flag for a control plane component:

Add the appropriate field to your configuration.

Add the flags to override to the field.

luxas · 2018-06-14T13:07:04Z

content/en/docs/setup/independent/control-plane-flags.md

+
+Example usage:
+```yaml
+apiServerExtraArgs:


include full typemeta information in every example please

luxas · 2018-06-14T13:07:31Z

content/en/docs/setup/independent/control-plane-flags.md

+- fabriziopandini
+- luxas
+- timothysc 
+title: Customizing control plane flags with kubeadm


Customizing control plane configuration with kubeadm is more generic and future-proof

luxas · 2018-06-14T13:07:58Z

/assign

timothysc · 2018-06-14T14:11:03Z

Is this the right location?

timothysc

minor comments.

timothysc · 2018-06-14T14:13:26Z

content/en/docs/setup/independent/control-plane-flags.md

+- `ControllerManagerExtraArgs`
+- `SchedulerExtraArgs`
+
+The fields can contain a list of `key: value` pairs. To override flags for a specific control plane component just include one of the fields above and start adding flags for it.


timothysc · 2018-06-14T14:16:11Z

content/en/docs/setup/independent/control-plane-flags.md

+```yaml
+apiServerExtraArgs:
+  advertise-address: 192.168.0.103
+  allow-privileged: true


The most common uses are:

adding admission controllers
configuring audit log (soon to be webhook)

timothysc · 2018-06-14T14:16:38Z

content/en/docs/setup/independent/control-plane-flags.md

+controllerManagerExtraArgs:
+  cluster-signing-key-file: /home/johndoe/keys/ca.key
+  bind-address: 192.168.0.101
+  deployment-controller-sync-period: 50


neolit123 · 2018-06-14T21:56:51Z

@luxas, @timstclair thanks for the reviews. i will update this tomorrow.

Is this the right location?

it felt right to me to under setup and not tasks or cmd reference.
i'm not sure; maybe collect more opinions?

Bradamant3 · 2018-06-14T23:16:21Z

For location, see https://docs.google.com/document/d/1-pAxBmV7c0DfbJVU33oK4Cozd99Z_16HX1-MLZ-A6OY/edit?usp=sharing

Bradamant3

Copyedits for readability and usability, plus a question about requested information that doesn't seem to belong here.

Bradamant3 · 2018-06-15T12:27:32Z

content/en/docs/setup/independent/control-plane-flags.md

+- `ControllerManagerExtraArgs`
+- `SchedulerExtraArgs`
+
+The fields can contain a list of `key: value` pairs. To override flags for a specific control plane component just include one of the fields above and start adding flags for it.


What value for a user does the content that luxas suggests add? This seems like an implementation detail that does not belong here. We've already got a larger confusion in the kubeadm docs between what a user needs and what a dev needs; let's not perpetuate it here.

Bradamant3 · 2018-06-15T12:28:22Z

content/en/docs/setup/independent/control-plane-flags.md

+
+{{< note >}}
+In later versions of the kubeadm configuration these fields will be replaced by usage of a ComponentConfig and a ConfigMap.
+{{< /note >}}


Remove entire note. Future statements are dangerous, and of no use to current users. (Again, this is one of those user/developer confusions.)

Bradamant3 · 2018-06-15T12:30:49Z

content/en/docs/setup/independent/control-plane-flags.md

+
+## APIServer flags
+
+The list of possible APIServer flags and their descriptions can be found [here](https://kubernetes.io/docs/reference/command-line-tools-reference/kube-apiserver/).


edit to:
"For details, see the reference documentation for kube-apiserver."

(note formation of link also)

Bradamant3 · 2018-06-15T12:35:44Z

content/en/docs/setup/independent/control-plane-flags.md

+- `ControllerManagerExtraArgs`
+- `SchedulerExtraArgs`
+
+The fields can contain a list of `key: value` pairs. To override flags for a specific control plane component just include one of the fields above and start adding flags for it.


Larger scale edit:

These fields consist of key: value pairs. To override a flag for a control plane component:

Add the appropriate field to your configuration.

Add the flags to override to the field.

Bradamant3 · 2018-06-15T12:37:13Z

content/en/docs/setup/independent/control-plane-flags.md

+
+## ControllerManager flags
+
+The list of possible ControllerManager flags and their descriptions can be found [here](https://kubernetes.io/docs/reference/command-line-tools-reference/kube-controller-manager/).


See comment at line 27 -- follow the same pattern here.

Bradamant3 · 2018-06-15T12:37:37Z

content/en/docs/setup/independent/control-plane-flags.md

+
+## Scheduler flags
+
+The list of possible Scheduler flags and their descriptions can be found [here](https://kubernetes.io/docs/reference/command-line-tools-reference/kube-scheduler/).


See line 27, follow pattern.

neolit123 · 2018-06-15T21:06:54Z

i will update this tomorrow.

i'm going to have to delay the edits for the weekend or monday.

neolit123 · 2018-06-18T13:42:47Z

hi, @timstclair @luxas @Bradamant3
i've added the changes. LMK if this better and i will rebase / squash.

in terms of location i'm leaving this as is, unless someone objects?

@Bradamant3 thanks for taking the time to write the document:
https://docs.google.com/document/d/1-pAxBmV7c0DfbJVU33oK4Cozd99Z_16HX1-MLZ-A6OY/edit?usp=sharing

do we have a tracking issue for the kubeadm docs folder restructuring and if not do you want me to create one? also in which repo k/website or k/kubeadm?

timothysc · 2018-06-18T16:54:46Z

@neolit123 - only comment is the addition of the meta-data @luxas mentioned earlier, other

neolit123 · 2018-06-18T17:42:31Z

@timothysc

only comment is the addition of the meta-data @luxas mentioned earlier, other

i've included apiVersion and kind from the apimachinery/pkg/apis/meta/v1/TypeMeta embedded struct. is something else needed?

timothysc · 2018-06-18T18:40:35Z

@neolit123 I think adding:

metadata: 
   name: 1.11-sample

is useful to the readers w/possible link to https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.10/#objectmeta-v1-meta optional params.

neolit123 · 2018-06-18T20:32:50Z

added the metadata (metav1.ObjectMeta) field examples as @timothysc suggested.
added link to godocs, which should include metav1.ObjectMeta and the latest config when the new generated docs are up.

timothysc · 2018-06-18T20:54:33Z

/lgtm

neolit123 · 2018-06-18T23:18:27Z

squashed commits. waiting on approval.

Bradamant3 · 2018-06-25T18:48:26Z

content/en/docs/setup/independent/control-plane-flags.md

+
+{{% capture overview %}}
+
+kubeadm’s configuration exposes the following fields that can be used to override the default flags passed to control plane components such as the APISever, ControllerManager and Scheduler:


s/APISever/APIServer

Bradamant3 · 2018-06-25T18:55:36Z

approved review changes, not adding hold but in case anybody else is looking here: author is still fixing a typo and some template problems. I don't have commit access (GH ftw ...)

This page adds instructions on how to use the kubeadm config to pass flags to control plane components. The provided examples are pretty basic. Later this can be expanded with actual user stories.

Bradamant3 · 2018-06-25T20:09:07Z

/lgtm
/approve

k8s-ci-robot · 2018-06-25T20:09:19Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: Bradamant3

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

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

k8s-ci-robot assigned Bradamant3 Jun 13, 2018

k8s-ci-robot added sig/cluster-lifecycle Categorizes an issue or PR as relevant to SIG Cluster Lifecycle. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Jun 13, 2018

k8s-ci-robot requested review from xiangpengzhao and zhangxiaoyu-zidif June 13, 2018 22:54

luxas mentioned this pull request Jun 13, 2018

Create new documentation based on user stories kubernetes/kubeadm#849

Closed

9 tasks

luxas reviewed Jun 14, 2018

View reviewed changes

k8s-ci-robot assigned luxas Jun 14, 2018

timothysc reviewed Jun 14, 2018

View reviewed changes

Bradamant3 suggested changes Jun 15, 2018

View reviewed changes

k8s-ci-robot assigned timothysc Jun 18, 2018

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

neolit123 force-pushed the control-plane-components branch from 2245450 to 47a05ee Compare June 18, 2018 23:14

k8s-ci-robot added size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. and removed lgtm "Looks good to me", indicates that a PR is ready to be merged. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Jun 18, 2018

neolit123 force-pushed the control-plane-components branch from 47a05ee to f504ae2 Compare June 18, 2018 23:16

k8s-ci-robot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. labels Jun 18, 2018

timothysc added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jun 19, 2018

Bradamant3 reviewed Jun 25, 2018

View reviewed changes

Bradamant3 approved these changes Jun 25, 2018

View reviewed changes

neolit123 force-pushed the control-plane-components branch from f504ae2 to 580d3e4 Compare June 25, 2018 19:27

k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jun 25, 2018

neolit123 force-pushed the control-plane-components branch 3 times, most recently from ed0de5e to 953bdea Compare June 25, 2018 19:58

kubeadm-setup: add page about control plane flags

4e5e3de

This page adds instructions on how to use the kubeadm config to pass flags to control plane components. The provided examples are pretty basic. Later this can be expanded with actual user stories.

neolit123 force-pushed the control-plane-components branch from 953bdea to 4e5e3de Compare June 25, 2018 20:05

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

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

k8s-ci-robot merged commit bf23c87 into kubernetes:master Jun 25, 2018


		## APIServer flags

		The list of possible APIServer flags and their descriptions can be found [here](https://kubernetes.io/docs/reference/command-line-tools-reference/kube-apiserver/).


		## ControllerManager flags

		The list of possible ControllerManager flags and their descriptions can be found [here](https://kubernetes.io/docs/reference/command-line-tools-reference/kube-controller-manager/).


		## Scheduler flags

		The list of possible Scheduler flags and their descriptions can be found [here](https://kubernetes.io/docs/reference/command-line-tools-reference/kube-scheduler/).


		{{% capture overview %}}

		kubeadm’s configuration exposes the following fields that can be used to override the default flags passed to control plane components such as the APISever, ControllerManager and Scheduler:

kubeadm-setup: add page about control plane flags #9067

kubeadm-setup: add page about control plane flags #9067

Conversation

neolit123 commented Jun 13, 2018

k8sio-netlify-preview-bot commented Jun 13, 2018

k8sio-netlify-preview-bot commented Jun 13, 2018 • edited Loading

luxas 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

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

luxas commented Jun 14, 2018

timothysc commented Jun 14, 2018

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

neolit123 commented Jun 14, 2018

Bradamant3 commented Jun 14, 2018

Bradamant3 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

neolit123 commented Jun 15, 2018

neolit123 commented Jun 18, 2018

timothysc commented Jun 18, 2018

neolit123 commented Jun 18, 2018

timothysc commented Jun 18, 2018

neolit123 commented Jun 18, 2018

timothysc commented Jun 18, 2018

neolit123 commented Jun 18, 2018

Choose a reason for hiding this comment

Bradamant3 commented Jun 25, 2018

Bradamant3 commented Jun 25, 2018

k8s-ci-robot commented Jun 25, 2018

k8sio-netlify-preview-bot commented Jun 13, 2018 •

edited

Loading