Skip to content

Commit

Permalink
user-mantained kubeadm reference doc
Browse files Browse the repository at this point in the history
  • Loading branch information
fabriziopandini committed Nov 24, 2017
1 parent 1fb2858 commit 6b76bdb
Show file tree
Hide file tree
Showing 11 changed files with 1,072 additions and 1,041 deletions.
12 changes: 11 additions & 1 deletion _data/reference.yml
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,17 @@ toc:

- title: Setup Tools
section:
- docs/reference/generated/kubeadm.md
- title: Kubeadm
section:
- docs/reference/setup-tools/kubeadm/kubeadm.md
- docs/reference/setup-tools/kubeadm/kubeadm-init.md
- docs/reference/setup-tools/kubeadm/kubeadm-join.md
- docs/reference/setup-tools/kubeadm/kubeadm-upgrade.md
- docs/reference/setup-tools/kubeadm/kubeadm-config.md
- docs/reference/setup-tools/kubeadm/kubeadm-reset.md
- docs/reference/setup-tools/kubeadm/kubeadm-token.md
- docs/reference/setup-tools/kubeadm/kubeadm-version.md
- docs/reference/setup-tools/kubeadm/kubeadm-alpha.md
- title: Kubefed
section:
- docs/reference/generated/kubefed.md
Expand Down
1,040 changes: 0 additions & 1,040 deletions docs/reference/generated/kubeadm.md

This file was deleted.

261 changes: 261 additions & 0 deletions docs/reference/setup-tools/kubeadm/kubeadm-alpha.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,261 @@
---
approvers:
- mikedanese
- luxas
- jbeda
title: kubeadm alpha
---
`kubeadm alpha` provides a preview of a set of features made available for gathering feedback
from the community. Please try it out and give us feedback!
{: .caution}

In v1.8.0, kubeadm introduced the `kubeadm alpha phase` command with the aim of making kubeadm more modular. This modularity enables you to invoke atomic sub-steps of the boostrap process; you can let kubeadm do some parts and fill in yourself where you need customizations.

`kubeadm alpha phase` is consistent with [kubeadm init workflow](kubeadm-init.md#init-workflow),
and behind the scene both use the same code.

* [kubeadm alpha phase preflight](#cmd-phase-preflight)
* [kubeadm alpha phase certs](#cmd-phase-certs)
* [kubeadm alpha phase kubeconfig](#cmd-phase-kubeconfig)
* [kubeadm alpha phase controlplane](#cmd-phase-controlplane)
* [kubeadm alpha phase etcd](#cmd-phase-etcd)
* [kubeadm alpha phase mark-master](#cmd-phase-mark-master)
* [kubeadm alpha phase bootstrap-token](#cmd-phase-bootstrap-token)
* [kubeadm alpha phase upload-config](#cmd-phase-upload-config)
* [kubeadm alpha phase addon](#cmd-phase-addon)
* [kubeadm alpha phase selfhosting](#cmd-phase-self-hosting)

## kubeadm alpha phase preflight {#cmd-phase-preflight}

You can execute preflight checks both for he tmaster node, like in `kubeadm init`, or for the worker node
like in `kubeadm join`.

{% capture preflight_master %}
{% include_relative generated/kubeadm_alpha_phase_preflight_master.md %}
{% endcapture %}

{% capture preflight_node %}
{% include_relative generated/kubeadm_alpha_phase_preflight_node.md %}
{% endcapture %}

{% assign tab_set_name = "tab-preflight" %}
{% assign tab_names = "master,node" | split: ',' | compact %}
{% assign tab_contents = site.emptyArray | push: preflight_master | push: preflight_node %}

{% include tabs.md %}

## kubeadm alpha phase certs {#cmd-phase-certs}

You can create all required certificates with the `all` sub command or selectively create certificates.

{% capture certs_all %}
{% include_relative generated/kubeadm_alpha_phase_certs_all.md %}
{% endcapture %}

{% capture certs_ca %}
{% include_relative generated/kubeadm_alpha_phase_certs_ca.md %}
{% endcapture %}

{% capture certs_apiserver %}
{% include_relative generated/kubeadm_alpha_phase_certs_apiserver.md %}
{% endcapture %}

{% capture certs_apiserver-kubelet-client %}
{% include_relative generated/kubeadm_alpha_phase_certs_apiserver-kubelet-client.md %}
{% endcapture %}

{% capture certs_sa %}
{% include_relative generated/kubeadm_alpha_phase_certs_sa.md %}
{% endcapture %}

{% capture certs_front-proxy-ca %}
{% include_relative generated/kubeadm_alpha_phase_certs_front-proxy-ca.md %}
{% endcapture %}

{% capture certs_front-proxy-client %}
{% include_relative generated/kubeadm_alpha_phase_certs_front-proxy-client.md %}
{% endcapture %}

{% assign tab_set_name = "tab-certs" %}
{% assign tab_names = "all,ca,apiserver,apiserver-kubelet-client,sa,front-proxy-ca,front-proxy-client" | split: ',' | compact %}
{% assign tab_contents = site.emptyArray | push: certs_all | push: certs_ca | push: certs_apiserver | push: certs_apiserver-kubelet-client | push: certs_sa | push: certs_front-proxy-ca | push: certs_front-proxy-client %}

{% include tabs.md %}

## kubeadm alpha phase kubeconfig {#cmd-phase-kubeconfig}

You can create all required kubeconfig files with the `all` sub command, or selectively create the files. Additionally, the `user` sub command supports the creation of kubeconfig files for additional users.

{% capture kubeconfig_all %}
{% include_relative generated/kubeadm_alpha_phase_kubeconfig_all.md %}
{% endcapture %}

{% capture kubeconfig_admin %}
{% include_relative generated/kubeadm_alpha_phase_kubeconfig_admin.md %}
{% endcapture %}

{% capture kubeconfig_kubelet %}
{% include_relative generated/kubeadm_alpha_phase_kubeconfig_kubelet.md %}
{% endcapture %}

{% capture kubeconfig_controller-manager %}
{% include_relative generated/kubeadm_alpha_phase_kubeconfig_controller-manager.md %}
{% endcapture %}

{% capture kubeconfig_scheduler %}
{% include_relative generated/kubeadm_alpha_phase_kubeconfig_scheduler.md %}
{% endcapture %}

{% capture kubeconfig_user %}
{% include_relative generated/kubeadm_alpha_phase_kubeconfig_user.md %}
{% endcapture %}

{% assign tab_set_name = "tab-kubeconfig" %}
{% assign tab_names = "all,admin,kubelet,controller-manager,scheduler,user" | split: ',' | compact %}
{% assign tab_contents = site.emptyArray | push: kubeconfig_all | push: kubeconfig_admin | push: kubeconfig_kubelet | push: kubeconfig_controller-manager | push: kubeconfig_scheduler | push: kubeconfig_user %}

{% include tabs.md %}

## kubeadm alpha phase controlplane {#cmd-phase-controlplane}

You can create all required static pod files for control plane components with the `all` sub command,
or selectively create the files.

{% capture controlplane_all %}
{% include_relative generated/kubeadm_alpha_phase_controlplane_all.md %}
{% endcapture %}

{% capture controlplane_apiserver %}
{% include_relative generated/kubeadm_alpha_phase_controlplane_apiserver.md %}
{% endcapture %}

{% capture controlplane_controller-manager %}
{% include_relative generated/kubeadm_alpha_phase_controlplane_controller-manager.md %}
{% endcapture %}

{% capture controlplane_scheduler %}
{% include_relative generated/kubeadm_alpha_phase_controlplane_scheduler.md %}
{% endcapture %}

{% assign tab_set_name = "tab-controlplane" %}
{% assign tab_names = "all,apiserver,controller-manager,scheduler" | split: ',' | compact %}
{% assign tab_contents = site.emptyArray | push: controlplane_all | push: controlplane_apiserver | push: controlplane_controller-manager | push: controlplane_scheduler %}

{% include tabs.md %}

## kubeadm alpha phase etcd {#cmd-phase-etcd}

Use the following command to create a self-hosted, local etcd instance based on a static pod file.

{% capture etcd-local %}
{% include_relative generated/kubeadm_alpha_phase_etcd_local.md %}
{% endcapture %}

{% assign tab_set_name = "tab-etcd" %}
{% assign tab_names = "etcd local" | split: ',' | compact %}
{% assign tab_contents = site.emptyArray | push: etcd-local %}

{% include tabs.md %}

## kubeadm alpha phase mark-master {#cmd-phase-mark-master}

Use the following command to label the node with the `node-role.kubernetes.io/master` taint.

{% capture mark-master %}
{% include_relative generated/kubeadm_alpha_phase_mark-master.md %}
{% endcapture %}

{% assign tab_set_name = "tab-mark-master" %}
{% assign tab_names = "mark-master" | split: ',' | compact %}
{% assign tab_contents = site.emptyArray | push: mark-master %}

{% include tabs.md %}

## kubeadm alpha phase bootstrap-token {#cmd-phase-bootstrap-token}

Use the following actions to fully configure bootstrap tokens.
You can fully configure bootstrap tokens with the `all` sub command,
or selectively configure single elements.

{% capture bootstrap-token_all %}
{% include_relative generated/kubeadm_alpha_phase_bootstrap-token_all.md %}
{% endcapture %}

{% capture bootstrap-token_create %}
{% include_relative generated/kubeadm_alpha_phase_bootstrap-token_create.md %}
{% endcapture %}

{% capture bootstrap-token_cluster-info %}
{% include_relative generated/kubeadm_alpha_phase_bootstrap-token_cluster-info.md %}
{% endcapture %}

{% capture bootstrap-token_node_allow-auto-approve %}
{% include_relative generated/kubeadm_alpha_phase_bootstrap-token_node_allow-auto-approve.md %}
{% endcapture %}

{% capture bootstrap-token_node_allow-post-csrs %}
{% include_relative generated/kubeadm_alpha_phase_bootstrap-token_node_allow-post-csrs.md %}
{% endcapture %}

{% assign tab_set_name = "tab-bootstrap-token" %}
{% assign tab_names = "all,create,cluster-info,node allow-auto-approve,node allow-post-csrs" | split: ',' | compact %}
{% assign tab_contents = site.emptyArray | push: bootstrap-token_all | push: bootstrap-token_create | push: bootstrap-token_cluster-info | push: bootstrap-token_node_allow-auto-approve | push: bootstrap-token_node_allow-post-csrs %}

{% include tabs.md %}

## kubeadm alpha phase upload-config {#cmd-phase-upload-config}

You can use this command to upload the configuration of your cluster. Alternatively, you
can use [kubeadm config](kubeadm-config.md).

{% capture upload-config %}
{% include_relative generated/kubeadm_alpha_phase_upload-config.md %}
{% endcapture %}

{% assign tab_set_name = "tab-upload-config" %}
{% assign tab_names = "upload-config" | split: ',' | compact %}
{% assign tab_contents = site.emptyArray | push: upload-config %}

{% include tabs.md %}

## kubeadm alpha phase addon {#cmd-phase-addon}

You can install all the available addons with the `all` sub command, or
install them selectively.

{% capture addon-all %}
{% include_relative generated/kubeadm_alpha_phase_addon_all.md %}
{% endcapture %}

{% capture addon-kube-proxy %}
{% include_relative generated/kubeadm_alpha_phase_addon_kube-proxy.md %}
{% endcapture %}

{% capture addon-kube-dns %}
{% include_relative generated/kubeadm_alpha_phase_addon_kube-dns.md %}
{% endcapture %}

{% assign tab_set_name = "tab-addon" %}
{% assign tab_names = "all,kube-proxy,kube-dns" | split: ',' | compact %}
{% assign tab_contents = site.emptyArray | push: addon-all | push: addon-kube-proxy | push: addon-kube-dns %}

{% include tabs.md %}

## kubeadm alpha phase self-hosting {#cmd-phase-self-hosting}

**Caution:** Self-hosting is an alpha feature. See [kubeadm init](kubeadm-init.md) documentation for self-hosting limitations.
{: .caution}

{% capture self-hosting %}
{% include_relative generated/kubeadm_alpha_phase_selfhosting_convert-from-staticpods.md %}
{% endcapture %}

{% assign tab_set_name = "tab-self-hosting" %}
{% assign tab_names = "self-hosting" | split: ',' | compact %}
{% assign tab_contents = site.emptyArray | push: self-hosting %}

{% include tabs.md %}

## What's next
* [kubeadm init](kubeadm-init.md) to bootstrap a Kubernetes master node
* [kubeadm reset](kubeadm-reset.md) to revert any changes made to this host by `kubeadm init` or `kubeadm join`
31 changes: 31 additions & 0 deletions docs/reference/setup-tools/kubeadm/kubeadm-config.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
---
approvers:
- mikedanese
- luxas
- jbeda
title: kubeadm config
---
{% capture overview %}
Beginning with v1.8.0, kubeadm uploads the configuration of your cluster to a ConfigMap called
`kubeadm-config` in the `kube-system` namespace, and later reads the ConfigMap when upgrading. This enables correct configuration of system components, and provides a seamless user experience.

You can use `kubeadm config view` to view the ConfigMap. If you initialized your cluster using kubeadm v1.7.x or lower, you can use `kubeadm config upload` to create a ConfigMap before you execute `kubeadm upgrade`.

{% endcapture %}

{% capture body %}
## kubeadm config upload from-file {#cmd-config-from-file}
{% include_relative generated/kubeadm_config_upload_from-file.md %}

## kubeadm config upload from-flags {#cmd-config-from-flags}
{% include_relative generated/kubeadm_config_upload_from-flags.md %}

## kubeadm config view {#cmd-config-view}
{% include_relative generated/kubeadm_config_view.md %}
{% endcapture %}

{% capture whatsnext %}
* [kubeadm upgrade](kubeadm-upgrade.md) to upgrade a Kubernetes cluster to a newer version
{% endcapture %}

{% include templates/concept.md %}
Loading

0 comments on commit 6b76bdb

Please sign in to comment.