Skip to content

Commit

Permalink
kubeadm: update the reference documentation for 1.15 (#14596)
Browse files Browse the repository at this point in the history
* kubeadm-ref: update placeholder generated files

* kubeadm-ref: include reset-phase.md document

Also update reset.md to reflect the addition of reset phases.

* kubeadm-ref: update authored content

* kubeadm-ref: remove imports for removed "config upload" commands

* kubeadm-ref: add page for kubeadm upgrade phases
  • Loading branch information
neolit123 authored and k8s-ci-robot committed Jun 11, 2019
1 parent 3d1d270 commit 2a0f39f
Show file tree
Hide file tree
Showing 125 changed files with 1,609 additions and 5,876 deletions.
30 changes: 4 additions & 26 deletions content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@ kubeadm: easily bootstrap a secure Kubernetes cluster




┌──────────────────────────────────────────────────────────┐
│ KUBEADM │
│ Easily bootstrap a secure Kubernetes cluster │
Expand Down Expand Up @@ -38,29 +37,8 @@ Example usage:

### Options

<table style="width: 100%; table-layout: fixed;">
<colgroup>
<col span="1" style="width: 10px;" />
<col span="1" />
</colgroup>
<tbody>

<tr>
<td colspan="2">-h, --help</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;">help for kubeadm</td>
</tr>

<tr>
<td colspan="2">--rootfs string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;">[EXPERIMENTAL] The path to the 'real' host root filesystem.</td>
</tr>

</tbody>
</table>


```
-h, --help help for kubeadm
--rootfs string [EXPERIMENTAL] The path to the 'real' host root filesystem.
```

Original file line number Diff line number Diff line change
Expand Up @@ -3,48 +3,17 @@ Kubeadm experimental sub-commands

### Synopsis


Kubeadm experimental sub-commands

### Options

<table style="width: 100%; table-layout: fixed;">
<colgroup>
<col span="1" style="width: 10px;" />
<col span="1" />
</colgroup>
<tbody>

<tr>
<td colspan="2">-h, --help</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;">help for alpha</td>
</tr>

</tbody>
</table>


```
-h, --help help for alpha
```

### Options inherited from parent commands

<table style="width: 100%; table-layout: fixed;">
<colgroup>
<col span="1" style="width: 10px;" />
<col span="1" />
</colgroup>
<tbody>

<tr>
<td colspan="2">--rootfs string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;">[EXPERIMENTAL] The path to the 'real' host root filesystem.</td>
</tr>

</tbody>
</table>


```
--rootfs string [EXPERIMENTAL] The path to the 'real' host root filesystem.
```

Original file line number Diff line number Diff line change
Expand Up @@ -3,48 +3,17 @@ Commands related to handling kubernetes certificates

### Synopsis


Commands related to handling kubernetes certificates

### Options

<table style="width: 100%; table-layout: fixed;">
<colgroup>
<col span="1" style="width: 10px;" />
<col span="1" />
</colgroup>
<tbody>

<tr>
<td colspan="2">-h, --help</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;">help for certs</td>
</tr>

</tbody>
</table>


```
-h, --help help for certs
```

### Options inherited from parent commands

<table style="width: 100%; table-layout: fixed;">
<colgroup>
<col span="1" style="width: 10px;" />
<col span="1" />
</colgroup>
<tbody>

<tr>
<td colspan="2">--rootfs string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;">[EXPERIMENTAL] The path to the 'real' host root filesystem.</td>
</tr>

</tbody>
</table>


```
--rootfs string [EXPERIMENTAL] The path to the 'real' host root filesystem.
```

Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@

Generate certificate keys

### Synopsis


This command will print out a secure randomly-generated certificate key that can be used with
the "init" command.

You can also use "kubeadm init --experimental-upload-certs" without specifying a certificate key and it will
generate and print one for you.


```
kubeadm alpha certs certificate-key [flags]
```

### Options

```
-h, --help help for certificate-key
```

### Options inherited from parent commands

```
--rootfs string [EXPERIMENTAL] The path to the 'real' host root filesystem.
```

Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@

Check certificates expiration for a Kubernetes cluster

### Synopsis

Checks expiration for the certificates in the local PKI managed by kubeadm.

```
kubeadm alpha certs check-expiration [flags]
```

### Options

```
--cert-dir string The path where to save the certificates (default "/etc/kubernetes/pki")
--config string Path to a kubeadm configuration file.
-h, --help help for check-expiration
```

### Options inherited from parent commands

```
--rootfs string [EXPERIMENTAL] The path to the 'real' host root filesystem.
```

Original file line number Diff line number Diff line change
@@ -1,9 +1,8 @@

Renews certificates for a Kubernetes cluster
Renew certificates for a Kubernetes cluster

### Synopsis


This command is not meant to be run on its own. See list of available subcommands.

```
Expand All @@ -12,43 +11,13 @@ kubeadm alpha certs renew [flags]

### Options

<table style="width: 100%; table-layout: fixed;">
<colgroup>
<col span="1" style="width: 10px;" />
<col span="1" />
</colgroup>
<tbody>

<tr>
<td colspan="2">-h, --help</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;">help for renew</td>
</tr>

</tbody>
</table>


```
-h, --help help for renew
```

### Options inherited from parent commands

<table style="width: 100%; table-layout: fixed;">
<colgroup>
<col span="1" style="width: 10px;" />
<col span="1" />
</colgroup>
<tbody>

<tr>
<td colspan="2">--rootfs string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;">[EXPERIMENTAL] The path to the 'real' host root filesystem.</td>
</tr>

</tbody>
</table>


```
--rootfs string [EXPERIMENTAL] The path to the 'real' host root filesystem.
```

Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@

Renew the certificate embedded in the kubeconfig file for the admin to use and for kubeadm itself

### Synopsis

Renew the certificate embedded in the kubeconfig file for the admin to use and for kubeadm itself.

Renewals run unconditionally, regardless of certificate expiration date; extra attributes such as SANs will be based on the existing file/certificates, there is no need to resupply them.

Renewal by default tries to use the certificate authority in the local PKI managed by kubeadm; as alternative it is possible to use K8s certificate API for certificate renewal, or as a last option, to generate a CSR request.

After renewal, in order to make changes effective, is is required to restart control-plane components and eventually re-distribute the renewed certificate in case the file is used elsewhere.

```
kubeadm alpha certs renew admin.conf [flags]
```

### Options

```
--cert-dir string The path where to save the certificates (default "/etc/kubernetes/pki")
--config string Path to a kubeadm configuration file.
--csr-dir string The path to output the CSRs and private keys to
--csr-only Create CSRs instead of generating certificates
-h, --help help for admin.conf
--kubeconfig string The kubeconfig file to use when talking to the cluster. If the flag is not set, a set of standard locations can be searched for an existing kubeconfig file. (default "/etc/kubernetes/admin.conf")
--use-api Use the Kubernetes certificate API to renew certificates
```

### Options inherited from parent commands

```
--rootfs string [EXPERIMENTAL] The path to the 'real' host root filesystem.
```

Loading

0 comments on commit 2a0f39f

Please sign in to comment.