Improve Kubeadm reference doc #6103
Conversation
k8s-ci-robot
added
do-not-merge/work-in-progress
|
Deploy preview ready! Built with commit 6b76bdb https://deploy-preview-6103--kubernetes-io-vnext-staging.netlify.com |
|
Awesome! Thx @fabriziopandini ! /cc @luxas @roberthbailey |
There was a problem hiding this comment.
Awesome, thanks for doing this @fabriziopandini. Really like the new organisation here.
I know you didn't author a lot of this content, but I went through and tried to find any existing spelling/grammar bugs in our docs since we're in the process of refactoring. Would be great to get these fixed up
docs/admin/kubeadm-alpha.md
Outdated
| --- | ||
|
|
||
| # Kubeadm alpha | ||
| `Kubeam alpha` provides a preview of a set of features made available for gathering feedbacks |
There was a problem hiding this comment.
s/kubeam/kubeadm/
s/feedbacks/feedback/
docs/admin/kubeadm-alpha.md
Outdated
|
|
||
| ## Kubeadm alpha phase certs {#cmd-phase-certs} | ||
|
|
||
| You can create all required certificates with `all` sub command, or create selectively certificates. |
There was a problem hiding this comment.
with the all subcommand or selectively create certificates
docs/admin/kubeadm-alpha.md
Outdated
|
|
||
| ## Kubeadm alpha phase kubeconfig {#cmd-phase-kubeconfig} | ||
|
|
||
| You can create all required kubeconfig files with `all` sub command, or create selectively kubeconfig file; additionally, it is also available the `user` sub command supporting creation of kubeconfig files for additional users. |
There was a problem hiding this comment.
with the all subcommand, or selectively create the file. Additionally, the user subcommand supports the creation of ...
docs/admin/kubeadm-alpha.md
Outdated
|
|
||
| ## Kubeadm alpha phase controlplane {#cmd-phase-controlplane} | ||
|
|
||
| You can create all required static pod files for control plane components with `all` sub command, or |
There was a problem hiding this comment.
with the all subcommand, or selectively create the files
docs/admin/kubeadm-alpha.md
Outdated
|
|
||
| ## Kubeadm alpha phase etcd {#cmd-phase-etcd} | ||
|
|
||
| Use following command to create a self-hosted, local etcd instance based on a static pod file. |
There was a problem hiding this comment.
Use the following command
docs/admin/kubeadm-init.md
Outdated
| 1. Kubeadm creates DaemonSets in the `kube-system` namespace and waits for the | ||
| resulting pods to be running. | ||
|
|
||
| 1. Once the new control plane is running (but not yet active), kubeadm deletes |
There was a problem hiding this comment.
We actually delete the static pods after the self-hosted pod is active. So maybe change this to:
kubeadm then waits for a self-hosted pod to be running. Once it's operational, it's associated static pod is deleted and kubeadm moves on to install the next component.
docs/admin/kubeadm-init.md
Outdated
| | gcr.io/google_containers/k8s-dns-sidecar-${ARCH} | 1.14.4 | 1.14.4 | ||
| | gcr.io/google_containers/k8s-dns-kube-dns-${ARCH} | 1.14.4 | 1.14.4 | ||
| | gcr.io/google_containers/k8s-dns-dnsmasq-nanny-${ARCH} | 1.14.4 | 1.14.4 | ||
|
|
There was a problem hiding this comment.
This can probably be reduced if they choose to use a universal hyperkube image.
docs/admin/kubeadm-init.md
Outdated
| kubeadm token generate | ||
| ``` | ||
|
|
||
| 1. Start both the master node and the worker nodes concurrently with this token. |
There was a problem hiding this comment.
Doesn't the worker node need to start up after the master's apiserver is running?
docs/admin/kubeadm-join.md
Outdated
| `kubeadm init` bootstraps a Kubernetes master node by executing the | ||
| following steps: | ||
|
|
||
| The `kubeadm join` bootstraps a Kubernetes worker node and join it to the cluster. |
docs/admin/kubeadm-join.md
Outdated
| authenticity of that data. The root CA can also be discovered directly via a | ||
| file or URL. | ||
|
|
||
| 1. Once the cluster information are known, kubelet can start the TLS bootstrapping |
There was a problem hiding this comment.
I didn't read quite as closely as @jamiehannaford but I agree that the overall organization looks good.
docs/admin/_kubeadm/kubeadm.md
Outdated
| kubeadm: easily bootstrap a secure Kubernetes cluster. | ||
|
|
||
| ┌──────────────────────────────────────────────────────────┐ | ||
| │ KUBEADM IS BETA, DO NOT USE IT FOR PRODUCTION CLUSTERS! │ |
There was a problem hiding this comment.
Can we change this from "DO NOT USE" to something a bit softer, like "kubeadm is beta, use at your own risk" or "kubeadm is currently in beta"?
There was a problem hiding this comment.
@roberthbailey this is part of the generate docs. I will take charge to implement this suggesting on the corresponding code in kubernetes repo
There was a problem hiding this comment.
really good point @roberthbailey, we REALLY should reword this, had totally forgot about it
There was a problem hiding this comment.
+1 to re-wording "production" is a ill-defined term btw.
fabriziopandini
force-pushed
the
kubeadm-doc
branch
3 times, most recently
from
0099a3f to
9981b6b
Compare
|
@jamiehannaford thanks a lot! |
|
@fabriziopandini Cool! Yeah sgtm. feel free to either cherry pick that commit or just reuse the content in your own commit |
docs/admin/kubeadm-init.md
Outdated
| * [kubeadm upgrade](kubeadm-upgrade.md) to upgrade a Kubernetes cluster to a newer version | ||
| * [kubeadm reset](kubeadm-reset.md) to revert any changes made to this host by `kubeadm init` or `kubeadm join` | ||
| {% endcapture %} | ||
|
|
There was a problem hiding this comment.
how about a new section here:
### Using internal IPs in your cluster
In order to set up a cluster where the master and worker nodes communicate with internal IP addresses (instead of publicly addressable ones), you will need to follow these steps.
1. When running init, you must make sure you specify an internal IP for the apiserver's bind address, like so:
kubeadm init --apiserver-advertise-address=<private-master-ip> init
2. When a worker node has been provisioned, add a flag to /etc/systemd/system/kubelet.service.d/10-kubeadm.conf that specifes the private IP of the worker node:
--node-ip=<private-node-ip>
3. Finally, when you run `kubeadm join` make sure you provide the private IP of the apiserver addressed as defined in step 1.
c9bd1f6 to
b423e01
Compare
|
@fabriziopandini Travis CI is failing on the title and ToC checks (see below). You will need to add titles to the top of each page, e.g.: You will also need to add the new docs to the Reference ToC YAML file: Here are the Travis CI errors:
|
|
@chenopis I just checked Travis CI error, and the problem is about files in docs/admin/_kubeadm folder basically contains automatically generated files which are used as include in |
|
@fabriziopandini Ok, in that case, just add them to the |
|
@chenopis what about adding the |
There was a problem hiding this comment.
Very minor comments, absolutely amazing work @fabriziopandini! Let us know when this can be merged!
docs/admin/_kubeadm/kubeadm.md
Outdated
| kubeadm: easily bootstrap a secure Kubernetes cluster. | ||
|
|
||
| ┌──────────────────────────────────────────────────────────┐ | ||
| │ KUBEADM IS BETA, DO NOT USE IT FOR PRODUCTION CLUSTERS! │ |
There was a problem hiding this comment.
really good point @roberthbailey, we REALLY should reword this, had totally forgot about it
docs/admin/_kubeadm/kubeadm.md
Outdated
| ### Options | ||
|
|
||
| ``` | ||
| --azure-container-registry-config string Path to the file container Azure container registry configuration information. |
There was a problem hiding this comment.
gah globals. We do hide these in the actual binary... is there any way we could hide them there as well @fabriziopandini?
There was a problem hiding this comment.
I think I managed to do this in a clean way. I will send a new PR for improving the cmd\genkubedocs in kubernets repo asap. In the meantime I updated all the generated files here
docs/admin/kubeadm-version.md
Outdated
| approvers: | ||
| - mikedanese | ||
| - luxas | ||
| - errordeveloper |
There was a problem hiding this comment.
..doesn't want to be here in this list anymore
There was a problem hiding this comment.
please remove him in all places here
docs/admin/kubeadm-init.md
Outdated
| * `--cadvisor-port=0` disables cAdvisor from listening to `0.0.0.0:4194` by default. | ||
| cAdvisor will still be run inside of the kubelet and its API can be accessed at | ||
| `https://{node-ip}:10250/stats/`. If you want to enable cAdvisor to listen on a | ||
| wide-open port, run: |
There was a problem hiding this comment.
I think this is ok; may require an update every quarter which is kinda cheap in the end
docs/admin/kubeadm-token.md
Outdated
| --- | ||
| {% capture overview %} | ||
| # Kubeadm token | ||
| Bootstrap Tokens are used for establishing bidirectional trust between a node joining |
There was a problem hiding this comment.
Link here to the bootstrap token doc
fabriziopandini
force-pushed
the
kubeadm-doc
branch
from
b423e01 to
031cdb0
Compare
docs/admin/_kubeadm/kubeadm.md
Outdated
| kubeadm: easily bootstrap a secure Kubernetes cluster. | ||
|
|
||
| ┌──────────────────────────────────────────────────────────┐ | ||
| │ KUBEADM IS BETA, DO NOT USE IT FOR PRODUCTION CLUSTERS! │ |
There was a problem hiding this comment.
+1 to re-wording "production" is a ill-defined term btw.
|
|
||
| ### Options | ||
|
|
||
| ``` |
There was a problem hiding this comment.
Is this stuff generated? I'd be a fan to reduce maintenance by linking in auto-generated stuffs.
There was a problem hiding this comment.
yes, all the synopsis, options, inherited options paragraphs are generated starting from kubeadm code.
Generated files are then copied in the website and, using an inline jekyll command, included into the pages you see in the menu, where there is also some additions/extra content not derived from cobra.commands.
For alpha commands, there are no additional context so far (only page structure)
There was a problem hiding this comment.
For alpha commands, there are no additional context so far (only page structure)
We should add that eventually, but please in an other PR
|
|
||
| ### Options | ||
|
|
||
| ``` |
There was a problem hiding this comment.
same - especially seeing how alpha cmd line features change.
There was a problem hiding this comment.
same :-)
by the way, I'm going to add alpha disclaimer where missing in kubeadm code
There was a problem hiding this comment.
Yes, adding the alpha disclaimer would be great!
k8s-ci-robot
added
the
lgtm
|
Just one question to the team before clicking merge button: shall we place the generated files into a subdirectory named 'v1_8' for example? kubeadm is moving fast so we'd better clarify the versions. |
|
@fabianofranz When you feel it is ready to merge, please remove WIP from title. Just a reminder. |
fabriziopandini
changed the title
k8s-ci-robot
removed
the
do-not-merge/work-in-progress
|
@tengqm The versioning for kubeadm is in lock-step w/ Kubernetes, so I think for simplicity's sake, we should keep the kubeadm v1.8 docs in the |
|
@steveperry-53 Is this docs lgtm? |
|
@chenopis I think I got the idea. I was raising this question because there are now and then questions about how readers can switch to docs for different versions at will. Is there an existing mechanism (or ongoing effort) to make it possible? For example, a user may want to view docs about kubeadm. On k8s.io/docs, it is always the latest version. However, he/she wants to switch to docs kubeadm 1.8... |
|
@tengqm Yes, there is now a version selector in the upper righthand corner. You can use that to navigate to older versions of the docs, e.g. https://v1-7.docs.kubernetes.io/docs/home/, so users should be able to browse the corresponding version of kubeadm.
|
|
Thanks @chenopis for the merge 👍! |
|
@chenopis @steveperry-53 @zacharysarah @Bradamant3 @heckj @tengqm |
* Trivial change to open release branch * Undo trivial change * add service ipvs overview * Add instructions on how to setup kubectl * Document conntrack dependency for kube-proxy * Add an a This is kind of jarring / missing an article. I'm guessing it should either be ' to a rack of bare metal servers.' or '...to racks of bare metal servers.'. * adding example responses for common issues - support request - code bug report * Trivial change to open release branch * Undo trivial change * Signed-off-by: Ziqi Zhao <zhaoziqi@qiniu.com> (#5366) Fix the not-working test case yaml for /doc/concepts/storage/volumes.md * kubectl-overview * temp fix for broken pod and deployment links * Update Table of Solutions for Juju * Revise certificates documentation (#5965) * Update review-issues.md Some edits for clarity and condensed language. * Update init-containers.md Fix leading spaces in commands. * Update kubectl-overview.md Fix format. * Update clc.md Fix format. * Update openstack-heat.md The url no need. just highlight. * Typo I believe this should be "users" not "uses" * making explicit hostname uniq requirement * Update scheduling-hugepages.md * Update update-daemon-set.md * fix redirection of PersistentVolume * Update hpa.md * update kubectl instruction * Use the format of kubeadm init * fix spelling error guarnatees to guarantees * add matchLabels description (#6020) * search and replace for k8s.github.io to website (#6019) * fix scale command of object-management (#6011) * Update replicaset.md (#6009) * Update secret.md (#6008) * specify password for mysql image (#5990) * specify password for mysql image * specify password for mysql image * link error for run-stateless-application-deployment.md (#5985) * link error for run-stateless-application-deployment.md * link error for run-stateless-application-deployment.md * Add performance implications of inter-pod affinity/anti-affinity (#5979) * 404 monthly maintenance - October 2017 (#5977) * Updated redirects * More redirects * Add conjure-up to Turnkey Cloud Solutions list (#5973) * Add conjure-up to Turnkey Cloud Solutions list * Changed wording slightly * change the StatefulSet to ReplicaSet in reference (#5968) * Clarification of failureThreshold of probes (#5963) * Mention usage of block storage version param (#5925) Mention usage of block storage version (bs-version) parameter to workaround attachment issues using older K8S versions on an OpenStack cloud with path-based endpoints. Resolves: #5924 * Update sysctl-cluster.md (#5894) Include guide on enabling unsafe sysctls in minikube * Avoid Latin phrases & format note (#5889) * Avoid Latin phrases & format note according the Documentation Style Guide * Update scratch.md * Update scratch.md * resolves jekyll rendering error (#5976) - chinese isn't understood for keys in YAML frontmatter in jekyll, so replaced it with the english equivalent that doesn't throw the following error on rendering: Error reading file src/kubernetes.github.io/cn/docs/concepts/cluster-administration/device-plugins.md: (<unknown>): could not find expected ':' while scanning a simple key at line 4 column 1 * Change VM to pod. (#6022) * Add link to custom metrics. (#6023) * Rephrase core group. (#6024) * Added explanation on context to when joining (#6018) * Update create-cluster-kubeadm.md (#5761) Update Canal version in pod network apply commands * Fixes issue #5620 (#5869) * Fixes issue #5620 Signed-off-by: Brad Topol <btopol@us.ibm.com> * Restructured so that review process is for both current and upcoming releases. Added content describing the use of tech reviewers. * Removed incorrect Kubernetes reviewer link. * Fixed tech reviewer URL to now use website * Update pod-priority-preemption.md fix-wrong-link-to-pod-preemption * pod-security-policy.md: add links to the page about admission plugins. * Adding all files for BlaBlaCar case study (#5857) * Adding all files for BlaBlaCar case study * Update blablacar.html * Fix changed URL for google containers * Add /docs/reference/auto-generated directory * correct the downwardapi redirect * Remove links using "here" * Rename to /docs/reference/generated directory * add Concept template * Change title to just Ingress * Link mistake (#6038) * link mistake * link mistake * skip title check for skip_title_check.txt * skip title check for skip_title_check.txt * remove doesn't exist link. * Fix podpreset task (#5705) * Add a simple pod manifest to pod overview (#5986) * Split PodPreset concept out from task doc (#5984) * Add selector spec description (#5789) * Add selector spec description * Fix selector field explanation * Put orphaned topics in TOC. (#6051) * static-pod example bad format in the final page (#6050) * static-pod example bad format in the final page * static-pod example bad format in the final page * static-pod example bad format in the final page * static-pod example bad format in the final page * static-pod example bad format in the final page * Fix `backoffLimit` field misplacement (#6042) It should be placed in JobSpec according to: https://github.com/kubernetes/kubernetes/blob/master/api/swagger-spec/batch_v1.json#L1488-L1514 * Update addons.md (#6061) * add info about VMware NSX-T CNI plugin (#5987) * add info about VMware NSX-T CNI plugin Hello, I'm VMware Networking and Security Architect and would like to include short information about our CNI plugin implementation similar to what other vendors did Best regards Emil Gagala * Update networking.md * Update networking.md * Update networking.md * Update: Using universal zsh configuration (#5669) * Update install-kubectl.md Zsh is not only oh-my-zsh, so I added universal configuration for zsh that also can be used in prezto. * fix merge error after rebase * Operating etcd cluster for Kubernetes bad format in the final page (#6056) * Operating etcd cluster for Kubernetes bad format in the final page * Update configure-upgrade-etcd.md * Update configure-upgrade-etcd.md * Usage note and warning tags. (#6053) * Usage note and warning tags. * Update configure-upgrade-etcd.md * Update configure-upgrade-etcd.md * Document jekyll includes snippets * Add jekyll includes to docs home toc - Remove extra kubernetes home in toc * document docker cgroupdriver req (#5937) * Update test blacklists (#6063) * Update toc check blacklist * Update title check blacklist * wip * wip * Fix typo * Document unconfined apparmor profile * Revert "Document the unconfined profile for AppArmor" (#6268) * CRD Validation: remove alpha warning, change enable instructions to (#6066) disable * Documented service annotation for AWS ELB SSL policy * kubeadm: add a note about the new `--print-join-command` flag. This is a new flag for the `kubeadm token create` command. * Add a note to PDB page * Improve Kubeadm reference doc (#6103) * automatically-generated kubeadm reference doc * user-mantained kubeadm reference doc * Documentation for CSIPersistentVolume * change replicaset documentation to use apps/v1 APIs * Update service.md ipvs alpha version -> beta version * Updated Deployment concept docs (#6494) * Updated Deployment concept docs * Addressed comments * Documentation for volume scheduling alpha feature * Update admission control docs for webhooks * Improve DNS documentation (#6479) * update ds for 1.9 * Update service.md * Update service.md * Revert "begin updating webhook documentation" (#6575) * Update version numbers to include 1.9 (#6518) * Update site versions for 1.9 * Removed 1.4 docs * Update _config.yml * Update _config.yml * updates for raw block devices * rbac: docs for aggregated cluster roles (#6474) * Added IPv6 information for Kubelet arguments (#6498) * Added IPv6 info to kube-proxy arguments * Added IPv6 information for argument for kubelet * Update PVC resizing documentation (#6487) * Updates for Windows Server version 1709 with K8s v1.8 (#6180) * Updated for WSv1709 and K8s v1.8 * Updated picture and CNI config * Fixed formatting on CNI Config * Updated docs to reference Microsoft/SDN GitHub docs * fix typo * Workaround for Jekyllr frontmatter * Added section on features and limitations, with example yaml files. * Update index.md * Added kubeadm section, few other small fixes * Few minor grammar fixes * Update access-cluster.md with a comment that for IPv6 the user should use [::1] for the localhost * Addressed a number of issues brought up against the base PR * Fixed windows-host-setup link * Rewrite PodSecurityPolicy guide * Update index.md Signed-off-by: Alin Balutoiu <abalutoiu@cloudbasesolutions.com> Signed-off-by: Alin Gabriel Serdean <aserdean@ovn.org> * Spelling correction and sentence capitalization. - Corrected the spelling error for storing, was put in as 'stoing'. - Capitalized list items. - Added '.' at end of sentences in the list items. * Update index.md * Update index.md * Addressed comments and rebased * Fixed formatting * Fixed formatting * Updated header link * Updated hyperlinks * Updated warning * formatting * formatting * formatting * Revert "Update access-cluster.md with a comment that for IPv6" This reverts commit 31e4dbd. * Revert "fix typo" This reverts commit c056787. * Revert "Workaround for Jekyllr frontmatter" This reverts commit b84ac59. * Fixed grammatical issues and reverted non-related commits * Revert "Rewrite PodSecurityPolicy guide" This reverts commit 5d39cfe. * Revert "Spelling correction and sentence capitalization." This reverts commit 47eed43. * Fixed auto-numbering * Minor formatting updates * CoreDNS feature documentation (#6463) * Initial placeholder PR for CoreDNS feature documentation * Remove from admin, add content * Fix missing endcapture * Add to tasks.yml * Review feedback * Postpone Deletion of a Persistent Volume Claim in case It Is Used by a Pod (#6415) * Postpone Deletion of a Persistent Volume Claim in case It Is Used by a Pod A new feature PVC Protection was added into K8s 1.9 that's why this documentation change is needed. * Added tag at the top of each new area. * Fix typo * Fix: switched on in (all kubelets) -> (all K8s components). * Added link to admission controller * Moved PVC Protection configuration into Before you begin section. * Added steps how to verify PVC Protection feature. * Fixes for admission controller plugin description and for PVC Protection description in PVC lifecycle. * Testing official rendering of enumerations (1., 2., 3., etc.) * Re-write to address comments from review. * Fixed definition when a PVC is in active use by a pod. * Change auditing docs page for 1.9 release (#6427) * Change auditing docs page for 1.9 release Signed-off-by: Mik Vyatskov <vmik@google.com> * Address review comments Signed-off-by: Mik Vyatskov <vmik@google.com> * Address review comments Signed-off-by: Mik Vyatskov <vmik@google.com> * Address review comments Signed-off-by: Mik Vyatskov <vmik@google.com> * Fix broken link Signed-off-by: Mik Vyatskov <vmik@google.com> * short circuit deny docs (#6536) * line wrap * short circuit deny * address comments * Add kubeadm 1.9 upgrade docs (#6485) * kubeadm: Improve kubeadm documentation for v1.9 (#6645) * Update admission control docs for webhooks (re-send #6368) (#6650) * Update admission control docs for webhooks * update in response to comments * Revamp rkt and add CRI-O as alternative runtime (#6371) Signed-off-by: Lorenzo Fontana <lo@linux.com> * Documented NLB for Kubernetes 1.9 (#6260) * Added IPV6 information to setup cluster using kubeadm (#6465) * Added IPV6 information to setup cluster using kubeadm * Updated kubeadm.md & create-cluster-kubeadm.md with IPv6 related information * Added IPv6 options for kubeadm --init & automated address binding for kube-proxy based on version of IP configured for API server) * Changes to kubeadm.md as per comments * Modified kubeadm.md and create-cluster-kubeadm.md * Implemented changes requested by zacharysarah * Removed autogenerated kubeadm.md changes * StatefulSet 1.9 updates. (#6550) * updates sts concept and tutorials to use 1.9 apps/v1 * Update statefulset.md * clarify pod name label * Garbage collection updates for 1.9 (#6555) * 1.9 gc policy update * carify deletion * Couple nits for dnsConfig doc (#6652) * Add doc for AllowedFlexVolume (#6563) * Update OpenStack Cloud Provider API support for v1.9 (#6638) * Flex volume is GA. Remove alpha notation. (#6666) * Update generated ref docs for Kubernetes and Federation components. (#6658) * Update generated ref docs for Kubernetes and Federation components. * Rename kubectl-options to kubectl. * Add title to kubectl. * Fix double synopsis. * Update Federation API ref docs for 1.9. (#6636) * Update federation API ref docs. * Move and redirect. * Move generated Federation docs to the generated directory. * Fix titles. * Type * Fix titles * Update auto-generated Kubernetes APi ref docs. (#6646) * Update kubectl commands for 1.9 (#6635) * add ExtendedResourceToleration admission controller (#6618) * Update API reference paths for v1.9 (#6681)
* Trivial change to open release branch * Undo trivial change * add service ipvs overview * Add instructions on how to setup kubectl * Document conntrack dependency for kube-proxy * Add an a This is kind of jarring / missing an article. I'm guessing it should either be ' to a rack of bare metal servers.' or '...to racks of bare metal servers.'. * adding example responses for common issues - support request - code bug report * Trivial change to open release branch * Undo trivial change * Signed-off-by: Ziqi Zhao <zhaoziqi@qiniu.com> (#5366) Fix the not-working test case yaml for /doc/concepts/storage/volumes.md * kubectl-overview * temp fix for broken pod and deployment links * Update Table of Solutions for Juju * Revise certificates documentation (#5965) * Update review-issues.md Some edits for clarity and condensed language. * Update init-containers.md Fix leading spaces in commands. * Update kubectl-overview.md Fix format. * Update clc.md Fix format. * Update openstack-heat.md The url no need. just highlight. * Typo I believe this should be "users" not "uses" * making explicit hostname uniq requirement * Update scheduling-hugepages.md * Update update-daemon-set.md * fix redirection of PersistentVolume * Update hpa.md * update kubectl instruction * Use the format of kubeadm init * fix spelling error guarnatees to guarantees * add matchLabels description (#6020) * search and replace for k8s.github.io to website (#6019) * fix scale command of object-management (#6011) * Update replicaset.md (#6009) * Update secret.md (#6008) * specify password for mysql image (#5990) * specify password for mysql image * specify password for mysql image * link error for run-stateless-application-deployment.md (#5985) * link error for run-stateless-application-deployment.md * link error for run-stateless-application-deployment.md * Add performance implications of inter-pod affinity/anti-affinity (#5979) * 404 monthly maintenance - October 2017 (#5977) * Updated redirects * More redirects * Add conjure-up to Turnkey Cloud Solutions list (#5973) * Add conjure-up to Turnkey Cloud Solutions list * Changed wording slightly * change the StatefulSet to ReplicaSet in reference (#5968) * Clarification of failureThreshold of probes (#5963) * Mention usage of block storage version param (#5925) Mention usage of block storage version (bs-version) parameter to workaround attachment issues using older K8S versions on an OpenStack cloud with path-based endpoints. Resolves: #5924 * Update sysctl-cluster.md (#5894) Include guide on enabling unsafe sysctls in minikube * Avoid Latin phrases & format note (#5889) * Avoid Latin phrases & format note according the Documentation Style Guide * Update scratch.md * Update scratch.md * resolves jekyll rendering error (#5976) - chinese isn't understood for keys in YAML frontmatter in jekyll, so replaced it with the english equivalent that doesn't throw the following error on rendering: Error reading file src/kubernetes.github.io/cn/docs/concepts/cluster-administration/device-plugins.md: (<unknown>): could not find expected ':' while scanning a simple key at line 4 column 1 * Change VM to pod. (#6022) * Add link to custom metrics. (#6023) * Rephrase core group. (#6024) * Added explanation on context to when joining (#6018) * Update create-cluster-kubeadm.md (#5761) Update Canal version in pod network apply commands * Fixes issue #5620 (#5869) * Fixes issue #5620 Signed-off-by: Brad Topol <btopol@us.ibm.com> * Restructured so that review process is for both current and upcoming releases. Added content describing the use of tech reviewers. * Removed incorrect Kubernetes reviewer link. * Fixed tech reviewer URL to now use website * Update pod-priority-preemption.md fix-wrong-link-to-pod-preemption * pod-security-policy.md: add links to the page about admission plugins. * Adding all files for BlaBlaCar case study (#5857) * Adding all files for BlaBlaCar case study * Update blablacar.html * Fix changed URL for google containers * Add /docs/reference/auto-generated directory * correct the downwardapi redirect * Remove links using "here" * Rename to /docs/reference/generated directory * add Concept template * Change title to just Ingress * Link mistake (#6038) * link mistake * link mistake * skip title check for skip_title_check.txt * skip title check for skip_title_check.txt * remove doesn't exist link. * Fix podpreset task (#5705) * Add a simple pod manifest to pod overview (#5986) * Split PodPreset concept out from task doc (#5984) * Add selector spec description (#5789) * Add selector spec description * Fix selector field explanation * Put orphaned topics in TOC. (#6051) * static-pod example bad format in the final page (#6050) * static-pod example bad format in the final page * static-pod example bad format in the final page * static-pod example bad format in the final page * static-pod example bad format in the final page * static-pod example bad format in the final page * Fix `backoffLimit` field misplacement (#6042) It should be placed in JobSpec according to: https://github.com/kubernetes/kubernetes/blob/master/api/swagger-spec/batch_v1.json#L1488-L1514 * Update addons.md (#6061) * add info about VMware NSX-T CNI plugin (#5987) * add info about VMware NSX-T CNI plugin Hello, I'm VMware Networking and Security Architect and would like to include short information about our CNI plugin implementation similar to what other vendors did Best regards Emil Gagala * Update networking.md * Update networking.md * Update networking.md * Update: Using universal zsh configuration (#5669) * Update install-kubectl.md Zsh is not only oh-my-zsh, so I added universal configuration for zsh that also can be used in prezto. * fix merge error after rebase * Operating etcd cluster for Kubernetes bad format in the final page (#6056) * Operating etcd cluster for Kubernetes bad format in the final page * Update configure-upgrade-etcd.md * Update configure-upgrade-etcd.md * Usage note and warning tags. (#6053) * Usage note and warning tags. * Update configure-upgrade-etcd.md * Update configure-upgrade-etcd.md * Document jekyll includes snippets * Add jekyll includes to docs home toc - Remove extra kubernetes home in toc * document docker cgroupdriver req (#5937) * Update test blacklists (#6063) * Update toc check blacklist * Update title check blacklist * wip * wip * Fix typo * Document unconfined apparmor profile * Revert "Document the unconfined profile for AppArmor" (#6268) * CRD Validation: remove alpha warning, change enable instructions to (#6066) disable * Documented service annotation for AWS ELB SSL policy * kubeadm: add a note about the new `--print-join-command` flag. This is a new flag for the `kubeadm token create` command. * Add a note to PDB page * Improve Kubeadm reference doc (#6103) * automatically-generated kubeadm reference doc * user-mantained kubeadm reference doc * Documentation for CSIPersistentVolume * change replicaset documentation to use apps/v1 APIs * Update service.md ipvs alpha version -> beta version * Updated Deployment concept docs (#6494) * Updated Deployment concept docs * Addressed comments * Documentation for volume scheduling alpha feature * Update admission control docs for webhooks * Improve DNS documentation (#6479) * update ds for 1.9 * Update service.md * Update service.md * Revert "begin updating webhook documentation" (#6575) * Update version numbers to include 1.9 (#6518) * Update site versions for 1.9 * Removed 1.4 docs * Update _config.yml * Update _config.yml * updates for raw block devices * rbac: docs for aggregated cluster roles (#6474) * Added IPv6 information for Kubelet arguments (#6498) * Added IPv6 info to kube-proxy arguments * Added IPv6 information for argument for kubelet * Update PVC resizing documentation (#6487) * Updates for Windows Server version 1709 with K8s v1.8 (#6180) * Updated for WSv1709 and K8s v1.8 * Updated picture and CNI config * Fixed formatting on CNI Config * Updated docs to reference Microsoft/SDN GitHub docs * fix typo * Workaround for Jekyllr frontmatter * Added section on features and limitations, with example yaml files. * Update index.md * Added kubeadm section, few other small fixes * Few minor grammar fixes * Update access-cluster.md with a comment that for IPv6 the user should use [::1] for the localhost * Addressed a number of issues brought up against the base PR * Fixed windows-host-setup link * Rewrite PodSecurityPolicy guide * Update index.md Signed-off-by: Alin Balutoiu <abalutoiu@cloudbasesolutions.com> Signed-off-by: Alin Gabriel Serdean <aserdean@ovn.org> * Spelling correction and sentence capitalization. - Corrected the spelling error for storing, was put in as 'stoing'. - Capitalized list items. - Added '.' at end of sentences in the list items. * Update index.md * Update index.md * Addressed comments and rebased * Fixed formatting * Fixed formatting * Updated header link * Updated hyperlinks * Updated warning * formatting * formatting * formatting * Revert "Update access-cluster.md with a comment that for IPv6" This reverts commit 31e4dbd. * Revert "fix typo" This reverts commit c056787. * Revert "Workaround for Jekyllr frontmatter" This reverts commit b84ac59. * Fixed grammatical issues and reverted non-related commits * Revert "Rewrite PodSecurityPolicy guide" This reverts commit 5d39cfe. * Revert "Spelling correction and sentence capitalization." This reverts commit 47eed43. * Fixed auto-numbering * Minor formatting updates * CoreDNS feature documentation (#6463) * Initial placeholder PR for CoreDNS feature documentation * Remove from admin, add content * Fix missing endcapture * Add to tasks.yml * Review feedback * Postpone Deletion of a Persistent Volume Claim in case It Is Used by a Pod (#6415) * Postpone Deletion of a Persistent Volume Claim in case It Is Used by a Pod A new feature PVC Protection was added into K8s 1.9 that's why this documentation change is needed. * Added tag at the top of each new area. * Fix typo * Fix: switched on in (all kubelets) -> (all K8s components). * Added link to admission controller * Moved PVC Protection configuration into Before you begin section. * Added steps how to verify PVC Protection feature. * Fixes for admission controller plugin description and for PVC Protection description in PVC lifecycle. * Testing official rendering of enumerations (1., 2., 3., etc.) * Re-write to address comments from review. * Fixed definition when a PVC is in active use by a pod. * Change auditing docs page for 1.9 release (#6427) * Change auditing docs page for 1.9 release Signed-off-by: Mik Vyatskov <vmik@google.com> * Address review comments Signed-off-by: Mik Vyatskov <vmik@google.com> * Address review comments Signed-off-by: Mik Vyatskov <vmik@google.com> * Address review comments Signed-off-by: Mik Vyatskov <vmik@google.com> * Fix broken link Signed-off-by: Mik Vyatskov <vmik@google.com> * short circuit deny docs (#6536) * line wrap * short circuit deny * address comments * Add kubeadm 1.9 upgrade docs (#6485) * kubeadm: Improve kubeadm documentation for v1.9 (#6645) * Update admission control docs for webhooks (re-send #6368) (#6650) * Update admission control docs for webhooks * update in response to comments * Revamp rkt and add CRI-O as alternative runtime (#6371) Signed-off-by: Lorenzo Fontana <lo@linux.com> * Documented NLB for Kubernetes 1.9 (#6260) * Added IPV6 information to setup cluster using kubeadm (#6465) * Added IPV6 information to setup cluster using kubeadm * Updated kubeadm.md & create-cluster-kubeadm.md with IPv6 related information * Added IPv6 options for kubeadm --init & automated address binding for kube-proxy based on version of IP configured for API server) * Changes to kubeadm.md as per comments * Modified kubeadm.md and create-cluster-kubeadm.md * Implemented changes requested by zacharysarah * Removed autogenerated kubeadm.md changes * StatefulSet 1.9 updates. (#6550) * updates sts concept and tutorials to use 1.9 apps/v1 * Update statefulset.md * clarify pod name label * Garbage collection updates for 1.9 (#6555) * 1.9 gc policy update * carify deletion * Couple nits for dnsConfig doc (#6652) * Add doc for AllowedFlexVolume (#6563) * Update OpenStack Cloud Provider API support for v1.9 (#6638) * Flex volume is GA. Remove alpha notation. (#6666) * Update generated ref docs for Kubernetes and Federation components. (#6658) * Update generated ref docs for Kubernetes and Federation components. * Rename kubectl-options to kubectl. * Add title to kubectl. * Fix double synopsis. * Update Federation API ref docs for 1.9. (#6636) * Update federation API ref docs. * Move and redirect. * Move generated Federation docs to the generated directory. * Fix titles. * Type * Fix titles * Update auto-generated Kubernetes APi ref docs. (#6646) * Update kubectl commands for 1.9 (#6635) * add ExtendedResourceToleration admission controller (#6618) * Update API reference paths for v1.9 (#6681)
What this PR does / why we need it:
Improve kubeadm reference doc by splitting current page into more focused pages, following the same approach used by other tools like e.g. kubefed, but with the difference that
in kubeadm reference doc pages, we are going to mix in a seamless way automatically generated content with extra content - manually maintained -.
IMPORTANT: This is a work-in-progress, and the goal of this PR is to generate a first live preview and collect feedbacks both from sig-docs and sig-cluster-lifecycle. DO NOT MERGE!
Which issue this PR fixes
initial work for #265
Special notes for your reviewer:
This document contains the design proposal for this PR, implemented partially in #54616 and partially in this PR.
This PR has two commits:
Please focus review/comments on the first commit; review/comments on the automatically-generated kubeadm should be instead filed in kubernetes (or kubeadm) repo, but feel free to add a note here and I will take charge creating the issue in the proper place.
Notes for sig-docs reviewers
gen_kube_docs.go.Notes for technical-reviewers
Please provide feedbacks about this first preview!
cc @kubernetes/sig-cluster-lifecycle-feature-requests @Bradamant3 @heckj
This change is