Skip to content

Commit 2948ff2

Browse files
authored
Merge pull request #29127 from tengqm/amend-kubeadm-join
Amend kubeadm join doc for node preparation
2 parents fec7dce + 87e92d4 commit 2948ff2

File tree

1 file changed

+20
-10
lines changed

1 file changed

+20
-10
lines changed

content/en/docs/setup/production-environment/tools/kubeadm/create-cluster-kubeadm.md

Lines changed: 20 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,12 @@ weight: 30
88

99
<!-- overview -->
1010

11-
<img src="https://raw.githubusercontent.com/kubernetes/kubeadm/master/logos/stacked/color/kubeadm-stacked-color.png" align="right" width="150px">Using `kubeadm`, you can create a minimum viable Kubernetes cluster that conforms to best practices. In fact, you can use `kubeadm` to set up a cluster that will pass the [Kubernetes Conformance tests](https://kubernetes.io/blog/2017/10/software-conformance-certification).
12-
`kubeadm` also supports other cluster
13-
lifecycle functions, such as [bootstrap tokens](/docs/reference/access-authn-authz/bootstrap-tokens/) and cluster upgrades.
11+
<img src="https://raw.githubusercontent.com/kubernetes/kubeadm/master/logos/stacked/color/kubeadm-stacked-color.png" align="right" width="150px">
12+
Using `kubeadm`, you can create a minimum viable Kubernetes cluster that conforms to best practices.
13+
In fact, you can use `kubeadm` to set up a cluster that will pass the
14+
[Kubernetes Conformance tests](https://kubernetes.io/blog/2017/10/software-conformance-certification).
15+
`kubeadm` also supports other cluster lifecycle functions, such as
16+
[bootstrap tokens](/docs/reference/access-authn-authz/bootstrap-tokens/) and cluster upgrades.
1417

1518
The `kubeadm` tool is good if you need:
1619

@@ -42,7 +45,8 @@ To follow this guide, you need:
4245
You also need to use a version of `kubeadm` that can deploy the version
4346
of Kubernetes that you want to use in your new cluster.
4447

45-
[Kubernetes' version and version skew support policy](/docs/setup/release/version-skew-policy/#supported-versions) applies to `kubeadm` as well as to Kubernetes overall.
48+
[Kubernetes' version and version skew support policy](/docs/setup/release/version-skew-policy/#supported-versions)
49+
applies to `kubeadm` as well as to Kubernetes overall.
4650
Check that policy to learn about what versions of Kubernetes and `kubeadm`
4751
are supported. This page is written for Kubernetes {{< param "version" >}}.
4852

@@ -97,7 +101,8 @@ a provider-specific value. See [Installing a Pod network add-on](#pod-network).
97101
1. (Optional) Since version 1.14, `kubeadm` tries to detect the container runtime on Linux
98102
by using a list of well known domain socket paths. To use different container runtime or
99103
if there are more than one installed on the provisioned node, specify the `--cri-socket`
100-
argument to `kubeadm init`. See [Installing runtime](/docs/setup/production-environment/tools/kubeadm/install-kubeadm/#installing-runtime).
104+
argument to `kubeadm init`. See
105+
[Installing a runtime](/docs/setup/production-environment/tools/kubeadm/install-kubeadm/#installing-runtime).
101106
1. (Optional) Unless otherwise specified, `kubeadm` uses the network interface associated
102107
with the default gateway to set the advertise address for this particular control-plane node's API server.
103108
To use a different network interface, specify the `--apiserver-advertise-address=<ip-address>` argument
@@ -139,9 +144,12 @@ is not supported by kubeadm.
139144

140145
For more information about `kubeadm init` arguments, see the [kubeadm reference guide](/docs/reference/setup-tools/kubeadm/).
141146

142-
To configure `kubeadm init` with a configuration file see [Using kubeadm init with a configuration file](/docs/reference/setup-tools/kubeadm/kubeadm-init/#config-file).
147+
To configure `kubeadm init` with a configuration file see
148+
[Using kubeadm init with a configuration file](/docs/reference/setup-tools/kubeadm/kubeadm-init/#config-file).
143149

144-
To customize control plane components, including optional IPv6 assignment to liveness probe for control plane components and etcd server, provide extra arguments to each component as documented in [custom arguments](/docs/setup/production-environment/tools/kubeadm/control-plane-flags/).
150+
To customize control plane components, including optional IPv6 assignment to liveness probe
151+
for control plane components and etcd server, provide extra arguments to each component as documented in
152+
[custom arguments](/docs/setup/production-environment/tools/kubeadm/control-plane-flags/).
145153

146154
To run `kubeadm init` again, you must first [tear down the cluster](#tear-down).
147155

@@ -292,11 +300,13 @@ The nodes are where your workloads (containers and Pods, etc) run. To add new no
292300

293301
* SSH to the machine
294302
* Become root (e.g. `sudo su -`)
303+
* [Install a runtime](/docs/setup/production-environment/tools/kubeadm/install-kubeadm/#installing-runtime)
304+
if needed
295305
* Run the command that was output by `kubeadm init`. For example:
296306

297-
```bash
298-
kubeadm join --token <token> <control-plane-host>:<control-plane-port> --discovery-token-ca-cert-hash sha256:<hash>
299-
```
307+
```bash
308+
kubeadm join --token <token> <control-plane-host>:<control-plane-port> --discovery-token-ca-cert-hash sha256:<hash>
309+
```
300310

301311
If you do not have the token, you can get it by running the following command on the control-plane node:
302312

0 commit comments

Comments
 (0)