Add documentation for certificate rotation. #5639

jcbsmpsn · 2017-09-26T16:50:56Z

This change is

k8sio-netlify-preview-bot · 2017-09-26T16:53:12Z

Deploy preview ready!

Built with commit 4a085f5

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

mikedanese · 2017-09-26T17:00:39Z

Can you put the new doc in docs/tasks/tls?

jcbsmpsn · 2017-09-26T17:12:31Z

Move to docs/tasks/tls

chenopis · 2017-09-26T18:54:41Z

@jcbsmpsn This looks related to the 1.8 release. If so, I will move it to the release-1.8 branch.

chenopis

A couple minor edit suggestions.

chenopis · 2017-09-26T18:58:44Z

docs/tasks/tls/certificate-rotation.md

+the certificate currently in use approaches. Since certificate rotation is a
+beta feature, the feature flag must also be enabled, with
+`--feature-gates=RotateKubeletClientCertificate=true` for the feature to be
+enabled.


"enabled" mentioned twice; simplify:

Since certificate rotation is a beta feature, the feature flag must also be enabled with `--feature-gates=RotateKubeletClientCertificate=true`.

chenopis · 2017-09-26T19:01:37Z

docs/tasks/tls/certificate-rotation.md

+
+The kubelet uses certificates for authenticating to the Kubernetes API.
+Normally, these certificates are issued with a long expiry date, such that
+normally they do not need to be renewed.


"normally" used twice; simplify:

Normally, these certificates are issued with a long expiry date so that they do not need to be renewed.

jcbsmpsn · 2017-09-26T19:49:44Z

@chenopis It is 1.8 related.

chenopis

Sorry, I missed this one earlier.

chenopis · 2017-09-26T20:14:16Z

docs/tasks/tls/certificate-rotation.md

+
+When a kubelet starts up, if it is configured to bootstrap (using the
+`--bootstrap-kubeconfig` flag) it will use it's initial certificate to connect
+to the Kubernetes API and issue a certificate signing request. You can view the


punctuation:

When a kubelet starts up, if it is configured to bootstrap (using the `--bootstrap-kubeconfig` flag), it will use its initial certificate to connect to the Kubernetes API and issue a certificate signing request.

jdumars · 2017-09-26T20:39:15Z

@jcbsmpsn so we can avoid this in the future, is there a reason this PR is coming in the day before the release ships? Docs were due 2 weeks ago. I'm not sure if this got overlooked, or maybe we didn't radiate the deadline clearly enough.

jcbsmpsn · 2017-09-26T21:06:36Z

I overlooked this. I found the email with the deadline for documentation in my inbox this morning.

k8sio-netlify-preview-bot · 2017-09-26T21:06:42Z

Deploy preview ready!

Built with commit 09b250e

https://deploy-preview-5639--kubernetes-io-vnext-staging.netlify.com

chenopis · 2017-09-26T21:20:36Z

@jcbsmpsn Ok, we're almost there. Is there someone you can ping who can do a quick tech review and give a tech lgtm?

mikedanese · 2017-09-26T22:32:55Z

docs/tasks/tls/certificate-rotation.md

+approvers:
+- jcbsmpsn
+- mikedanese
+title: Certificate rotation


Capitalize "Rotation"

mikedanese · 2017-09-26T22:33:41Z

docs/tasks/tls/certificate-rotation.md

+
+{% capture prerequisites %}
+
+* {% include task-tutorial-prereqs.md %}


I'm not sure if these are useful for advanced tasks.

mikedanese · 2017-09-26T22:34:34Z

docs/tasks/tls/certificate-rotation.md

+Kubernetes 1.8 contains [kubelet certificate
+rotation](/docs/tasks/administer-cluster/certificate-rotation/), a beta feature
+that will automatically generate a new key and request a new certificate from
+the Kubernetes API to use for authenticating connections.


Can you specify when it will automatically generate a new cert?

I guess you say below.

mikedanese · 2017-09-26T22:38:06Z

docs/tasks/tls/certificate-rotation.md

+
+The kubelet will retrieve the signed certificate from the Kubernetes API and
+write that to disk, in the location specified by `--cert-dir`. Then the kubelet
+will restart itself and use the new certificate to connect to the Kubernetes


The kubelet restarts itself?

Doesn't the kubelet restart when it writes the new config file during a bootstrap?

em ... I don't believe so.

Removed that.

tengqm · 2017-09-27T10:56:56Z

docs/tasks/tls/certificate-rotation.md

+
+{% capture prerequisites %}
+
+* Kubernetes version 1.8.0 or later is required


Are we supposed to mention that this feature was available as Alpha in v1.7?

There was a stability problem with certificate approval in 1.7, and the --rotate-certificates option was introduced in 1.8. I would prefer to just document 1.8.

tengqm · 2017-09-27T11:00:37Z

docs/tasks/tls/certificate-rotation.md

+
+* Kubernetes version 1.8.0 or later is required
+
+* Encryption at rest is beta in 1.8.0 which means it may change without notice.


Seems encryption is not strongly tied to this (rotation) topic?

Oops, conflated two features I'm thinking about. Changed to "Kubelet certificate rotation"

tengqm · 2017-09-27T11:08:18Z

docs/tasks/tls/certificate-rotation.md

+## Overview
+
+The kubelet uses certificates for authenticating to the Kubernetes API.
+Normally, these certificates are issued with a long expiry date so that they do


Better mention that the default duration is 1 year, so users get more serious about the rotation feature.

tengqm · 2017-09-27T11:11:24Z

docs/tasks/tls/certificate-rotation.md

+that will automatically generate a new key and request a new certificate from
+the Kubernetes API to use for authenticating connections.
+
+## Configuration and determining whether certificate rotation is already enabled


This could be just "Enabling client certificate rotation" because it was not mentioned below how to determine whether the feature has been enabled.

tengqm · 2017-09-27T11:24:50Z

docs/tasks/tls/certificate-rotation.md

+
+The kubelet will retrieve the signed certificate from the Kubernetes API and
+write that to disk, in the location specified by `--cert-dir`. Then the kubelet
+will restart itself and use the new certificate to connect to the Kubernetes


em ... I don't believe so.

fix the command output

chenopis · 2017-09-27T18:15:04Z

Is this Tech LGTM? Can I merge this?

mikedanese · 2017-09-27T18:32:11Z

Yes, Tech LGTM

@chenopis

* GC now supports non-core resources * Add two examples about how to analysis audits of kube-apiserver (#4264) * Deprecate system:nodes binding * [1.8] StatefulSet `initialized` annotation is now ignored. * inits the kubeadm upgrade docs addresses /issues/4689 * adds kubeadm upgrade cmd to ToC addresses /issues/4689 * add workload placement docs * ScaleIO - document udpate for 1.8 * Add documentation on storageClass.mountOptions and PV.mountOptions (#5254) * Add documentation on storageClass.mountOptions and PV.mountOptions * convert notes into callouts * Add docs for CustomResource validation add info about supported fields * advanced audit beta features (#5300) * Update job workload doc with backoff failure policy (#5319) Add to the Jobs documentation how to use the new backoffLimit field that limit the number of Pod failure before considering the Job as failed. * Documented additional AWS Service annotations (#4864) * Add device plugin doc under concepts/cluster-administration. (#5261) * Add device plugin doc under concepts/cluster-administration. * Update device-plugins.md * Update device-plugins.md Add meta description. Fix typo. Change bare metal deployment to manual deployment. * Update device-plugins.md Fix typo again. * Update page.version. (#5341) * Add documentation on storageClass.reclaimPolicy (#5171) * [Advanced audit] use new herf for audit-api (#5349) This tag contains all the changes in v1beta1 version. Update it now. * Added documentation around creating the InitializerConfiguration for the persistent volume label controller in the cloud-controller-manager (#5255) * Documentation for kubectl plugins (#5294) * Documentation for kubectl plugins * Update kubectl-plugins.md * Update kubectl-plugins.md * Updated CPU manager docs to match implementation. (#5332) * Noted limitation of alpha static cpumanager. * Updated CPU manager docs to match implementation. - Removed references to CPU pressure node condition and evictions. - Added note about new --cpu-manager-reconcile-period flag. - Added note about node allocatable requirements for static policy. - Noted limitation of alpha static cpumanager. * Move cpu-manager task link to rsc mgmt section. * init containers annotation removed in 1.8 (#5390) * Add documentation for TaintNodesByCondition (#5352) * Add documentation for TaintNodesByCondition * Update nodes.md * Update taint-and-toleration.md * Update daemonset.md * Update nodes.md * Update taint-and-toleration.md * Update daemonset.md * Fix deployments (#5421) * Document extended resources and OIR deprecation. (#5399) * Document extended resources and OIR deprecation. * Updated extended resources doc per reviews. * reverts extra spacing in _data/tasks.yml * addresses `kubeadm upgrade` review comments Feedback from @chenopis, @luxas, and @steveperry-53 addressed with this commit * HugePages documentation (#5419) * Update cpu-management-policies.md (#5407) Fixed the bad link. Modified "cpu" to "CPU". Added more 'yaml' as supplement. * Update RBAC docs for v1 (#5445) * Add user docs for pod priority and preemption (#5328) * Add user docs for pod priority and preemption * Update pod-priority-preemption.md * More updates * Update docs/admin/kubeadm.md for 1.8 (#5440) - Made a couple of minor wording changes (not strictly 1.8 related). - Did some reformatting (not strictly 1.8 related). - Updated references to the default token TTL (was infinite, now 24 hours). - Documented the new `--discovery-token-ca-cert-hash` and `--discovery-token-unsafe-skip-ca-verification` flags for `kubeadm join`. - Added references to the new `--discovery-token-ca-cert-hash` flag in all the default examples. - Added a new _Security model_ section that describes the security tradeoffs of the various discovery modes. - Documented the new `--groups` flag for `kubeadm token create`. - Added a note of caution under _Automating kubeadm_ that references the _Security model_ section. - Updated the component version table to drop 1.6 and add 1.8. - Update `_data/reference.yml` to try to get the sidebar fixed up and more consistent with `kubefed`. * Update StatefulSet Basics for 1.8 release (#5398) * addresses `kubeadm upgrade` review comments 2nd iteration review comments by @luxas * adds kubelet upgrade section to kubeadm upgrade * Fix a bulleted list on docs/admin/kubeadm.md. (#5458) I updated this doc yesterday and I was absolutely sure I fixed this, but I just saw that this commit got lost somehow. This was introduced recently in #5440. * Clarify the API to check for device plugins * Moving Flexvolume to separate out-of-tree section * addresses `kubeadm upgrade` review comments CC: @luxas * fixes kubeadm upgrade index * Update Stackdriver Logging documentation (#5495) * Re-update WordPress and MySQL PV doc to use apps/v1beta2 APIs (#5526) * Update statefulset concepts doc to use apps/v1beta2 APIs (#5420) * add document on kubectl's behavior regarding initializers (#5505) * Update docs/admin/kubeadm.md to cover self-hosting in 1.8. (#5497) This is a new beta feature in 1.8. * Update kubectl patch doc to use apps/v1beta2 APIs (#5422) * [1.8] Update "Run Applications" tasks to apps/v1beta2. (#5525) * Update replicated stateful application task for 1.8. * Update single instance stateful app task for 1.8. * Update stateless app task for 1.8. * Update kubectl patch task for 1.8. * fix the link of persistent storage (#5515) * update the admission-controllers.md index.md what-is-kubernetes.md link * fix the link of persistent storage * Add quota support for local ephemeral storage (#5493) * Add quota support for local ephemeral storage update the doc to this alpha feature * Update resource-quotas.md * Updated Deployments concepts doc (#5491) * Updated Deployments concepts doc * Addressed comments * Addressed more comments * Modify allocatable storage to ephemeral-storage (#5490) Update the doc to use ephemeral-storage instead of storage * Revamped concepts doc for ReplicaSet (#5463) * Revamped concepts doc for ReplicaSet * Minor changes to call out specific versions for selector defaulting and immutability * Addressed doc review comments * Remove petset documentations (#5395) * Update docs to use batch/v1beta1 cronjobs (#5475) * add federation job doc (#5485) * add federation job doc * Update job.md Edits for clarity and consistency * Update job.md Fixed a typo * update DaemonSet concept for 1.8 release (#5397) * update DaemonSet concept for 1.8 release * Update daemonset.md Fix typo. than -> then * Update bootstrap tokens doc for 1.8. (#5479) * Update bootstrap tokens doc for 1.8. This has some changes I missed when I was updating the main kubeadm documention: - Bootstrap tokens are now beta, not alpha (kubernetes/enhancements#130) - The apiserver flag to enable the authenticator changedin 1.8 (kubernetes/kubernetes#51198) - Added `auth-extra-groups` documentaion (kubernetes/kubernetes#50933) - Updated the _Token Management with `kubeadm`_ section to link to the main kubeadm docs, since it was just duplicated information. * Update bootstrap-tokens.md * Updated the Cassandra tutorial to use apps/v1beta2 (#5548) * add docs for AllowPrivilegeEscalation (#5448) Signed-off-by: Jess Frazelle <[email protected]> * Add local ephemeral storage alpha feature in managing compute resource (#5522) * Add local ephemeral storage alpha feature in managing compute resource Since 1.8, we add the local ephemeral storage alpha feature as one resource type to manage. Add this feature into the doc. * Update manage-compute-resources-container.md * Update manage-compute-resources-container.md * Update manage-compute-resources-container.md * Update manage-compute-resources-container.md * Update manage-compute-resources-container.md * Update manage-compute-resources-container.md * Added documentation for Metrics Server (#5560) * authorization: improve authorization debugging docs (#5549) * Document mount propagation (#5544) * Update /docs/setup/independent/create-cluster-kubeadm.md for 1.8. (#5524) This introduction needed a couple of small tweaks to cover the `--discovery-token-ca-cert-hash` flag added in kubernetes/kubernetes#49520 and some version bumps. * Add task doc for alpha dynamic kubelet configuration (#5523) * Fix input/output of selfsubjectaccess review (#5593) * Add docs for implementing resize (#5528) * Add docs for implementing resize * Update admission-controllers.md * Added link to PVC section * minor typo fixes * Update NetworkPolicy concept guide with egress and CIDR changes (#5529) * update zookeeper tutorial for 1.8 release * add doc for hostpath type (#5503) * Federated Hpa feature doc (#5487) * Federated Hpa feature doc * Federated Hpa feature doc review fixes * Update hpa.md * Update hpa.md * update cloud controller manager docs for v1.8 * Update cronjob with defaults information (#5556) * Kubernetes 1.8 reference docs (#5632) * Kubernetes 1.8 reference docs * Kubectl reference docs for 1.8 * Update side bar with 1.8 kubectl and api ref docs links * remove petset.md * update on state of HostAlias in 1.8 with hostNetwork Pod support (#5644) * Fix cron job deletion section (#5655) * update imported docs (#5656) * Add documentation for certificate rotation. (#5639) * Link to using kubeadm page * fix the command output fix the command output * fix typo in api/resources reference: "Worloads" * Add documentation for certificate rotation. * Create TOC entry for cloud controller manager. (#5662) * Updates for new versions of API types * Followup 5655: fix link to garbage collection (#5666) * Temporarily redirect resources-reference to api-reference. (#5668) * Update config for 1.8 release. (#5661) * Update config for 1.8 release. * Address reviewer comments. * Switch references in HPA docs from alpha to beta (#5671) The HPA docs still referenced the alpha version. This switches them to talk about v2beta1, which is the appropriate version for Kubernetes 1.8 * Deprecate openstack heat (#5670) * Fix typo in pod preset conflict example Move container port definition to the correct line. * Highlight openstack-heat provider deprecation The openstack-heat provider for kube-up is being deprecated and will be removed in a future release. * Temporarily fix broken links by redirecting. (#5672) * Fix broken links. (#5675) * Fix render of code block (#5674) * Fix broken links. (#5677) * Add a small note about auto-bootstrapped CSR ClusterRoles (#5660) * Update kubeadm install doc for v1.8 (#5676) * add draft workloads api content for 1.8 (#5650) * add draft workloads api content for 1.8 * edits per review, add tables, for 1.8 workloads api doc * fix typo * Minor fixes to kubeadm 1.8 upgrade guide. (#5678) - The kubelet upgrade instructions should be done on every host, not just worker nodes. - We should just upgrade all packages, instead of calling out kubelet specifically. This will also upgrade kubectl, kubeadm, and kubernetes-cni, if installed. - Draining nodes should also ignore daemonsets, and master errors can be ignored. - Make sure that the new kubeadm download is chmoded correctly. - Add a step to run `kubeadm version` to verify after downloading. - Manually approve new kubelet CSRs if rotation is enabled (known issue). * Release 1.8 (#5680) * Fix versions for 1.8 API ref docs * Updates for 1.8 kubectl reference docs * Kubeadm /docs/admin/kubeadm.md cleanup, editing. (#5681) * Update docs/admin/kubeadm.md (mostly 1.8 related). This is Fabrizio's work, which I'm committing along with my edits (in a commit on top of this). * A few of my own edits to clarify and clean up some Markdown.

k8s-ci-robot added 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 Sep 26, 2017

k8s-github-robot assigned chenopis Sep 26, 2017

jcbsmpsn mentioned this pull request Sep 26, 2017

Kubelet Client TLS Certificate Rotation kubernetes/enhancements#266

Closed

jcbsmpsn force-pushed the add-certificate-rotation-doc branch from 6e8a89a to 815fe80 Compare September 26, 2017 17:01

jcbsmpsn force-pushed the add-certificate-rotation-doc branch from a9c2586 to 3597d64 Compare September 26, 2017 17:13

chenopis added this to the 1.8 milestone Sep 26, 2017

chenopis assigned steveperry-53 Sep 26, 2017

chenopis added Needs Docs Review labels Sep 26, 2017

chenopis requested a review from mikedanese September 26, 2017 18:55

chenopis suggested changes Sep 26, 2017

View reviewed changes

chenopis added Docs Review: Open Issues and removed Needs Docs Review labels Sep 26, 2017

chenopis changed the base branch from master to release-1.8 September 26, 2017 19:12

chenopis changed the base branch from release-1.8 to master September 26, 2017 19:13

jcbsmpsn force-pushed the add-certificate-rotation-doc branch from 3597d64 to 4a085f5 Compare September 26, 2017 19:49

chenopis changed the base branch from master to release-1.8 September 26, 2017 20:11

chenopis suggested changes Sep 26, 2017

View reviewed changes

jcbsmpsn force-pushed the add-certificate-rotation-doc branch from 4a085f5 to bdf6c8a Compare September 26, 2017 21:04

chenopis approved these changes Sep 26, 2017

View reviewed changes

chenopis added the Docs LGTM label Sep 26, 2017

chenopis removed the Docs Review: Open Issues label Sep 26, 2017

mikedanese reviewed Sep 26, 2017

View reviewed changes

jcbsmpsn force-pushed the add-certificate-rotation-doc branch from bdf6c8a to c4a7305 Compare September 26, 2017 22:44

chenopis force-pushed the release-1.8 branch from 4ec33fd to 4ad495b Compare September 27, 2017 00:29

chenopis added Tech Review: Open Issues and removed Needs Tech Review labels Sep 27, 2017

tengqm reviewed Sep 27, 2017

View reviewed changes

kairen and others added 3 commits September 27, 2017 09:24

Link to using kubeadm page

63b8e39

fix the command output

267c026

fix the command output

fix typo in api/resources reference: "Worloads"

ed94d73

jcbsmpsn force-pushed the add-certificate-rotation-doc branch from c4a7305 to 312dfdd Compare September 27, 2017 17:30

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

jcbsmpsn force-pushed the add-certificate-rotation-doc branch from 312dfdd to 2022b59 Compare September 27, 2017 17:31

Add documentation for certificate rotation.

09b250e

jcbsmpsn force-pushed the add-certificate-rotation-doc branch from 2022b59 to 09b250e Compare September 27, 2017 18:30

steveperry-53 added Tech Review LGTM and removed Tech Review: Open Issues labels Sep 27, 2017

steveperry-53 merged commit 1ff7648 into kubernetes:release-1.8 Sep 27, 2017


		{% capture prerequisites %}

		* {% include task-tutorial-prereqs.md %}


		{% capture prerequisites %}

		* Kubernetes version 1.8.0 or later is required


		* Kubernetes version 1.8.0 or later is required

		* Encryption at rest is beta in 1.8.0 which means it may change without notice.

Add documentation for certificate rotation. #5639

Add documentation for certificate rotation. #5639

Conversation

jcbsmpsn commented Sep 26, 2017 • edited Loading

k8sio-netlify-preview-bot commented Sep 26, 2017 • edited Loading

mikedanese commented Sep 26, 2017

jcbsmpsn commented Sep 26, 2017

chenopis commented Sep 26, 2017

chenopis 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

jcbsmpsn commented Sep 26, 2017

chenopis left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jdumars commented Sep 26, 2017

jcbsmpsn commented Sep 26, 2017

k8sio-netlify-preview-bot commented Sep 26, 2017 • edited Loading

chenopis commented Sep 26, 2017

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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

chenopis commented Sep 27, 2017

mikedanese commented Sep 27, 2017

jcbsmpsn commented Sep 26, 2017 •

edited

Loading

k8sio-netlify-preview-bot commented Sep 26, 2017 •

edited

Loading

k8sio-netlify-preview-bot commented Sep 26, 2017 •

edited

Loading