Skip to content

Commit 0661d65

Browse files
authored
Merge pull request #24076 from neolit123/1.20-add-link-in-kubeadm-config
kubeadm: improve links and information around using the config file
2 parents 2b9b86a + 188bd2e commit 0661d65

File tree

4 files changed

+19
-11
lines changed

4 files changed

+19
-11
lines changed

content/en/docs/reference/setup-tools/kubeadm/kubeadm-config.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,10 @@ You can use `kubeadm config print` to print the default configuration and `kubea
1616
convert your old configuration files to a newer version. `kubeadm config images list` and
1717
`kubeadm config images pull` can be used to list and pull the images that kubeadm requires.
1818

19+
For more information navigate to
20+
[Using kubeadm init with a configuration file](/docs/reference/setup-tools/kubeadm/kubeadm-init/#config-file)
21+
or [Using kubeadm join with a configuration file](/docs/reference/setup-tools/kubeadm/kubeadm-join/#config-file).
22+
1923
In Kubernetes v1.13.0 and later to list/pull kube-dns images instead of the CoreDNS image
2024
the `--config` method described [here](/docs/reference/setup-tools/kubeadm/kubeadm-init-phase/#cmd-phase-addon)
2125
has to be used.

content/en/docs/reference/setup-tools/kubeadm/kubeadm-init.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -114,16 +114,18 @@ The config file is still considered beta and may change in future versions.
114114

115115
It's possible to configure `kubeadm init` with a configuration file instead of command
116116
line flags, and some more advanced features may only be available as
117-
configuration file options. This file is passed with the `--config` option.
117+
configuration file options. This file is passed using the `--config` flag and it must
118+
contain a `ClusterConfiguration` structure and optionally more structures separated by `---\n`
119+
Mixing `--config` with others flags may not be allowed in some cases.
118120

119121
The default configuration can be printed out using the
120122
[kubeadm config print](/docs/reference/setup-tools/kubeadm/kubeadm-config/) command.
121123

122-
It is **recommended** that you migrate your old `v1beta1` configuration to `v1beta2` using
124+
If your configuration is not using the latest version it is **recommended** that you migrate using
123125
the [kubeadm config migrate](/docs/reference/setup-tools/kubeadm/kubeadm-config/) command.
124126

125-
For more details on each field in the `v1beta2` configuration you can navigate to our
126-
[API reference pages](https://godoc.org/k8s.io/kubernetes/cmd/kubeadm/app/apis/kubeadm/v1beta2).
127+
For more information on the fields and usage of the configuration you can navigate to our API reference
128+
page and pick a version from [the list](https://godoc.org/k8s.io/kubernetes/cmd/kubeadm/app/apis/kubeadm#pkg-subdirectories).
127129

128130
### Adding kube-proxy parameters {#kube-proxy}
129131

content/en/docs/reference/setup-tools/kubeadm/kubeadm-join.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -273,15 +273,17 @@ The config file is still considered beta and may change in future versions.
273273
It's possible to configure `kubeadm join` with a configuration file instead of command
274274
line flags, and some more advanced features may only be available as
275275
configuration file options. This file is passed using the `--config` flag and it must
276-
contain a `JoinConfiguration` structure.
276+
contain a `JoinConfiguration` structure. Mixing `--config` with others flags may not be
277+
allowed in some cases.
277278

278-
To print the default values of `JoinConfiguration` run the following command:
279+
The default configuration can be printed out using the
280+
[kubeadm config print](/docs/reference/setup-tools/kubeadm/kubeadm-config/) command.
279281

280-
```shell
281-
kubeadm config print join-defaults
282-
```
282+
If your configuration is not using the latest version it is **recommended** that you migrate using
283+
the [kubeadm config migrate](/docs/reference/setup-tools/kubeadm/kubeadm-config/) command.
283284

284-
For details on individual fields in `JoinConfiguration` see [the godoc](https://godoc.org/k8s.io/kubernetes/cmd/kubeadm/app/apis/kubeadm#JoinConfiguration).
285+
For more information on the fields and usage of the configuration you can navigate to our API reference
286+
page and pick a version from [the list](https://godoc.org/k8s.io/kubernetes/cmd/kubeadm/app/apis/kubeadm#pkg-subdirectories).
285287

286288
## {{% heading "whatsnext" %}}
287289

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -139,7 +139,7 @@ is not supported by kubeadm.
139139

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

142-
For a complete list of configuration options, see the [configuration file documentation](/docs/reference/setup-tools/kubeadm/kubeadm-init/#config-file).
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).
143143

144144
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/).
145145

0 commit comments

Comments
 (0)