Skip to content

Commit cac3c3a

Browse files
authored
Merge pull request #29095 from tengqm/kubeadm-config-122
Kubeadm config reference fix
2 parents 7ae9e45 + 1427bee commit cac3c3a

File tree

2 files changed

+120
-7
lines changed

2 files changed

+120
-7
lines changed

content/en/docs/reference/config-api/kubeadm-config.v1beta2.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -721,7 +721,7 @@ for, so other administrators can know its purpose.</td>
721721

722722

723723
<tr><td><code>expires</code> <B>[Required]</B><br/>
724-
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.20/#time-v1-meta"><code>meta/v1.Time</code></a>
724+
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.21/#time-v1-meta"><code>meta/v1.Time</code></a>
725725
</td>
726726
<td>
727727
`expires` specifies the timestamp when this token expires. Defaults to being set
@@ -1199,7 +1199,7 @@ HostPathMount contains elements describing volumes that are mounted from the hos
11991199

12001200

12011201
<tr><td><code>pathType</code> <B>[Required]</B><br/>
1202-
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.20/#hostpathtype-v1-core"><code>core/v1.HostPathType</code></a>
1202+
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.21/#hostpathtype-v1-core"><code>core/v1.HostPathType</code></a>
12031203
</td>
12041204
<td>
12051205
`pathType` is the type of the `hostPath` volume.</td>
@@ -1451,7 +1451,7 @@ annotated to the Node API object, for later re-use.</td>
14511451

14521452

14531453
<tr><td><code>taints</code> <B>[Required]</B><br/>
1454-
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.20/#taint-v1-core"><code>[]core/v1.Taint</code></a>
1454+
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.21/#taint-v1-core"><code>[]core/v1.Taint</code></a>
14551455
</td>
14561456
<td>
14571457
`taints` specifies the taints the Node API object should be registered with. If

content/en/docs/reference/config-api/kubeadm-config.v1beta3.md

Lines changed: 117 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -447,7 +447,7 @@ information.
447447

448448

449449
<tr><td><code>bootstrapTokens</code><br/>
450-
<code>[]github.com/tengqm/kubeconfig/config/bootstraptoken/v1.BootstrapToken</code>
450+
<a href="#BootstrapToken"><code>[]BootstrapToken</code></a>
451451
</td>
452452
<td>
453453
`bootstrapTokens` is respected at `kubeadm init` time and describes a set of Bootstrap Tokens to create.
@@ -1070,7 +1070,7 @@ HostPathMount contains elements describing volumes that are mounted from the hos
10701070

10711071

10721072
<tr><td><code>pathType</code><br/>
1073-
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.20/#hostpathtype-v1-core"><code>core/v1.HostPathType</code></a>
1073+
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.21/#hostpathtype-v1-core"><code>core/v1.HostPathType</code></a>
10741074
</td>
10751075
<td>
10761076
`pathType` is the type of the `hostPath` volume.</td>
@@ -1324,7 +1324,7 @@ annotated to the Node API object, for later re-use.</td>
13241324

13251325

13261326
<tr><td><code>taints</code> <B>[Required]</B><br/>
1327-
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.20/#taint-v1-core"><code>[]core/v1.Taint</code></a>
1327+
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.21/#taint-v1-core"><code>[]core/v1.Taint</code></a>
13281328
</td>
13291329
<td>
13301330
`taints` specifies the taints the Node API object should be registered with. If
@@ -1359,7 +1359,7 @@ the current node is registered.</td>
13591359

13601360

13611361
<tr><td><code>imagePullPolicy</code><br/>
1362-
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.20/#pullpolicy-v1-core"><code>core/v1.PullPolicy</code></a>
1362+
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.21/#pullpolicy-v1-core"><code>core/v1.PullPolicy</code></a>
13631363
</td>
13641364
<td>
13651365
`imagePullPolicy` specifies the policy for image pulling during `kubeadm init` and
@@ -1413,4 +1413,117 @@ first alpha-numerically.</td>
14131413
</tbody>
14141414
</table>
14151415

1416+
1417+
## `BootstrapToken` {#BootstrapToken}
1418+
1419+
**Appears in:**
1420+
1421+
- [InitConfiguration](#kubeadm-k8s-io-v1beta3-InitConfiguration)
1422+
1423+
1424+
BootstrapToken describes one bootstrap token, stored as a Secret in the cluster
1425+
1426+
<table class="table">
1427+
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
1428+
<tbody>
1429+
1430+
1431+
1432+
<tr><td><code>token</code> <B>[Required]</B><br/>
1433+
<a href="#BootstrapTokenString"><code>BootstrapTokenString</code></a>
1434+
</td>
1435+
<td>
1436+
`token` is used for establishing bidirectional trust between nodes and control-planes.
1437+
Used for joining nodes in the cluster.</td>
1438+
</tr>
1439+
1440+
1441+
<tr><td><code>description</code><br/>
1442+
<code>string</code>
1443+
</td>
1444+
<td>
1445+
`description` sets a human-friendly message why this token exists and what it's used
1446+
for, so other administrators can know its purpose.</td>
1447+
</tr>
1448+
1449+
1450+
<tr><td><code>ttl</code><br/>
1451+
<a href="https://godoc.org/k8s.io/apimachinery/pkg/apis/meta/v1#Duration"><code>meta/v1.Duration</code></a>
1452+
</td>
1453+
<td>
1454+
`ttl` defines the time to live for this token. Defaults to `24h`.
1455+
`expires` and `ttl` are mutually exclusive.</td>
1456+
</tr>
1457+
1458+
1459+
<tr><td><code>expires</code><br/>
1460+
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.21/#time-v1-meta"><code>meta/v1.Time</code></a>
1461+
</td>
1462+
<td>
1463+
`expires` specifies the timestamp when this token expires. Defaults to being set
1464+
dynamically at runtime based on the `ttl`. `expires` and `ttl` are mutually exclusive.</td>
1465+
</tr>
1466+
1467+
1468+
<tr><td><code>usages</code><br/>
1469+
<code>[]string</code>
1470+
</td>
1471+
<td>
1472+
`usages` describes the ways in which this token can be used. Can by default be used
1473+
for establishing bidirectional trust, but that can be changed here.</td>
1474+
</tr>
1475+
14161476

1477+
<tr><td><code>groups</code><br/>
1478+
<code>[]string</code>
1479+
</td>
1480+
<td>
1481+
`groups` specifies the extra groups that this token will authenticate as when/if
1482+
used for authentication</td>
1483+
</tr>
1484+
1485+
1486+
</tbody>
1487+
</table>
1488+
1489+
## `BootstrapTokenString` {#BootstrapTokenString}
1490+
1491+
1492+
1493+
1494+
**Appears in:**
1495+
1496+
- [BootstrapToken](#BootstrapToken)
1497+
1498+
1499+
BootstrapTokenString is a token of the format `abcdef.abcdef0123456789` that is used
1500+
for both validation of the practically of the API server from a joining node's point
1501+
of view and as an authentication method for the node in the bootstrap phase of
1502+
"kubeadm join". This token is and should be short-lived.
1503+
1504+
<table class="table">
1505+
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
1506+
<tbody>
1507+
1508+
1509+
1510+
<tr><td><code>-</code> <B>[Required]</B><br/>
1511+
<code>string</code>
1512+
</td>
1513+
<td>
1514+
<span class="text-muted">No description provided.</span>
1515+
</td>
1516+
</tr>
1517+
1518+
1519+
<tr><td><code>-</code> <B>[Required]</B><br/>
1520+
<code>string</code>
1521+
</td>
1522+
<td>
1523+
<span class="text-muted">No description provided.</span>
1524+
</td>
1525+
</tr>
1526+
1527+
1528+
</tbody>
1529+
</table>

0 commit comments

Comments
 (0)