Skip to content

Commit 506ee6f

Browse files
authored
Merge pull request #28876 from tengqm/kubeadm-config-ref
Kubeadm config reference
2 parents fa8b7be + 6c542e8 commit 506ee6f

File tree

8 files changed

+28
-15
lines changed

8 files changed

+28
-15
lines changed

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -144,7 +144,7 @@ install them selectively.
144144
{{< /tabs >}}
145145

146146
For more details on each field in the `v1beta2` configuration you can navigate to our
147-
[API reference pages.] (https://godoc.org/k8s.io/kubernetes/cmd/kubeadm/app/apis/kubeadm/v1beta2)
147+
[API reference pages.] (/docs/reference/config-api/kubeadm-config.v1beta2/)
148148

149149
## {{% heading "whatsnext" %}}
150150

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -122,8 +122,8 @@ The default configuration can be printed out using the
122122
If your configuration is not using the latest version it is **recommended** that you migrate using
123123
the [kubeadm config migrate](/docs/reference/setup-tools/kubeadm/kubeadm-config/) command.
124124

125-
For more information on the fields and usage of the configuration you can navigate to our API reference
126-
page and pick a version from [the list](https://pkg.go.dev/k8s.io/kubernetes/cmd/kubeadm/app/apis/kubeadm#section-directories).
125+
For more information on the fields and usage of the configuration you can navigate to our
126+
[API reference page](/docs/reference/config-api/kubeadm-config.v1beta2/).
127127

128128
### Adding kube-proxy parameters {#kube-proxy}
129129

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -282,8 +282,8 @@ The default configuration can be printed out using the
282282
If your configuration is not using the latest version it is **recommended** that you migrate using
283283
the [kubeadm config migrate](/docs/reference/setup-tools/kubeadm/kubeadm-config/) command.
284284

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).
285+
For more information on the fields and usage of the configuration you can navigate to our
286+
[API reference](/docs/reference/config-api/kubeadm-config.v1beta2/).
287287

288288
## {{% heading "whatsnext" %}}
289289

content/en/docs/setup/production-environment/tools/kubeadm/control-plane-flags.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ The `extraArgs` field consist of `key: value` pairs. To override a flag for a co
2424
3. Run `kubeadm init` with `--config <YOUR CONFIG YAML>`.
2525

2626
For more details on each field in the configuration you can navigate to our
27-
[API reference pages](https://godoc.org/k8s.io/kubernetes/cmd/kubeadm/app/apis/kubeadm/v1beta2#ClusterConfiguration).
27+
[API reference pages](/docs/reference/config-api/kubeadm-config.v1beta2/).
2828

2929
{{< note >}}
3030
You can generate a `ClusterConfiguration` object with default values by running `kubeadm config print init-defaults` and saving the output to a file of your choice.

content/en/docs/setup/production-environment/tools/kubeadm/dual-stack-support.md

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,9 @@ similar to the following example:
4545
kubeadm init --pod-network-cidr=10.244.0.0/16,2001:db8:42:0::/56 --service-cidr=10.96.0.0/16,2001:db8:42:1::/112
4646
```
4747

48-
To make things clearer, here is an example kubeadm [configuration file](https://pkg.go.dev/k8s.io/kubernetes/cmd/kubeadm/app/apis/kubeadm/v1beta2) `kubeadm-config.yaml` for the primary dual-stack control plane node.
48+
To make things clearer, here is an example kubeadm
49+
[configuration file](/docs/reference/config-api/kubeadm-config.v1beta2/) `kubeadm-config.yaml`
50+
for the primary dual-stack control plane node.
4951

5052
```yaml
5153
---
@@ -85,7 +87,8 @@ The `--apiserver-advertise-address` flag does not support dual-stack.
8587

8688
Before joining a node, make sure that the node has IPv6 routable network interface and allows IPv6 forwarding.
8789

88-
Here is an example kubeadm [configuration file](https://pkg.go.dev/k8s.io/kubernetes/cmd/kubeadm/app/apis/kubeadm/v1beta2) `kubeadm-config.yaml` for joining a worker node to the cluster.
90+
Here is an example kubeadm [configuration file](/docs/reference/config-api/kubeadm-config.v1beta2/)
91+
`kubeadm-config.yaml` for joining a worker node to the cluster.
8992

9093
```yaml
9194
apiVersion: kubeadm.k8s.io/v1beta2
@@ -98,7 +101,9 @@ nodeRegistration:
98101
node-ip: 10.100.0.3,fd00:1:2:3::3
99102
```
100103

101-
Also, here is an example kubeadm [configuration file](https://pkg.go.dev/k8s.io/kubernetes/cmd/kubeadm/app/apis/kubeadm/v1beta2) `kubeadm-config.yaml` for joining another control plane node to the cluster.
104+
Also, here is an example kubeadm [configuration file](/docs/reference/config-api/kubeadm-config.v1beta2/)
105+
`kubeadm-config.yaml` for joining another control plane node to the cluster.
106+
102107
```yaml
103108
apiVersion: kubeadm.k8s.io/v1beta2
104109
kind: JoinConfiguration
@@ -134,7 +139,9 @@ In 1.21 the `IPv6DualStack` feature is Beta and the feature gate is defaulted to
134139
kubeadm init --feature-gates IPv6DualStack=false
135140
```
136141

137-
To make things more clear, here is an example kubeadm [configuration file](https://pkg.go.dev/k8s.io/kubernetes/cmd/kubeadm/app/apis/kubeadm/v1beta2) `kubeadm-config.yaml` for the single-stack control plane node.
142+
To make things more clear, here is an example kubeadm
143+
[configuration file](/docs/reference/config-api/kubeadm-config.v1beta2/)
144+
`kubeadm-config.yaml` for the single-stack control plane node.
138145

139146
```yaml
140147
apiVersion: kubeadm.k8s.io/v1beta2
@@ -150,3 +157,4 @@ networking:
150157

151158
* [Validate IPv4/IPv6 dual-stack](/docs/tasks/network/validate-dual-stack) networking
152159
* Read about [Dual-stack](/docs/concepts/services-networking/dual-stack/) cluster networking
160+
* Learn more about the kubeadm [configuration format](/docs/reference/config-api/kubeadm-config.v1beta2/)

content/en/docs/setup/production-environment/tools/kubeadm/high-availability.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -115,7 +115,7 @@ option. Your cluster requirements may need a different configuration.
115115

116116
{{< note >}}
117117
The `kubeadm init` flags `--config` and `--certificate-key` cannot be mixed, therefore if you want
118-
to use the [kubeadm configuration](https://godoc.org/k8s.io/kubernetes/cmd/kubeadm/app/apis/kubeadm/v1beta2)
118+
to use the [kubeadm configuration](/docs/reference/config-api/kubeadm-config.v1beta2/)
119119
you must add the `certificateKey` field in the appropriate config locations
120120
(under `InitConfiguration` and `JoinConfiguration: controlPlane`).
121121
{{< /note >}}

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

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -258,7 +258,12 @@ Error from server: Get https://10.19.0.41:10250/containerLogs/default/mysql-ddc6
258258
curl http://169.254.169.254/metadata/v1/interfaces/public/0/anchor_ipv4/address
259259
```
260260

261-
The workaround is to tell `kubelet` which IP to use using `--node-ip`. When using DigitalOcean, it can be the public one (assigned to `eth0`) or the private one (assigned to `eth1`) should you want to use the optional private network. The [`KubeletExtraArgs` section of the kubeadm `NodeRegistrationOptions` structure](https://github.com/kubernetes/kubernetes/blob/release-1.13/cmd/kubeadm/app/apis/kubeadm/v1beta1/types.go) can be used for this.
261+
The workaround is to tell `kubelet` which IP to use using `--node-ip`.
262+
When using DigitalOcean, it can be the public one (assigned to `eth0`) or
263+
the private one (assigned to `eth1`) should you want to use the optional
264+
private network. The `kubeletExtraArgs` section of the kubeadm
265+
[`NodeRegistrationOptions` structure](/docs/reference/config-api/kubeadm-config.v1beta2/#kubeadm-k8s-io-v1beta2-NodeRegistrationOptions)
266+
can be used for this.
262267

263268
Then restart `kubelet`:
264269

@@ -331,7 +336,7 @@ Alternatively, you can try separating the `key=value` pairs like so:
331336
`--apiserver-extra-args "enable-admission-plugins=LimitRanger,enable-admission-plugins=NamespaceExists"`
332337
but this will result in the key `enable-admission-plugins` only having the value of `NamespaceExists`.
333338

334-
A known workaround is to use the kubeadm [configuration file](/docs/setup/production-environment/tools/kubeadm/control-plane-flags/#apiserver-flags).
339+
A known workaround is to use the kubeadm [configuration file](/docs/reference/config-api/kubeadm-config.v1beta2/).
335340

336341
## kube-proxy scheduled before node is initialized by cloud-controller-manager
337342

@@ -381,7 +386,7 @@ Kubernetes components like the kubelet and kube-controller-manager use the defau
381386
for the feature to work.
382387

383388
To workaround this issue you can configure the flex-volume directory using the kubeadm
384-
[configuration file](https://godoc.org/k8s.io/kubernetes/cmd/kubeadm/app/apis/kubeadm/v1beta2).
389+
[configuration file](/docs/reference/config-api/kubeadm-config.v1beta2/).
385390

386391
On the primary control-plane Node (created using `kubeadm init`) pass the following
387392
file using `--config`:

content/en/docs/tasks/administer-cluster/kubeadm/kubeadm-certs.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -161,7 +161,7 @@ The built-in signer is part of [`kube-controller-manager`](/docs/reference/comma
161161

162162
To activate the built-in signer, you must pass the `--cluster-signing-cert-file` and `--cluster-signing-key-file` flags.
163163

164-
If you're creating a new cluster, you can use a kubeadm [configuration file](https://godoc.org/k8s.io/kubernetes/cmd/kubeadm/app/apis/kubeadm/v1beta2):
164+
If you're creating a new cluster, you can use a kubeadm [configuration file](/docs/reference/config-api/kubeadm-config.v1beta2/):
165165

166166
```yaml
167167
apiVersion: kubeadm.k8s.io/v1beta2

0 commit comments

Comments
 (0)