Skip to content

Commit

Permalink
Newly generated kubeadm includes. (kubernetes#7882)
Browse files Browse the repository at this point in the history
* Newly generated kubeadm includes.

* Add new includes to skip_toc and skip_title.
  • Loading branch information
steveperry-53 authored and k8s-ci-robot committed Mar 28, 2018
1 parent 98b2170 commit 5c06a8b
Show file tree
Hide file tree
Showing 68 changed files with 480 additions and 241 deletions.
7 changes: 6 additions & 1 deletion docs/reference/setup-tools/kubeadm/generated/kubeadm.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@ kubeadm: easily bootstrap a secure Kubernetes cluster
### Synopsis



kubeadm: easily bootstrap a secure Kubernetes cluster.

┌──────────────────────────────────────────────────────────┐
Expand Down Expand Up @@ -37,3 +36,9 @@ Example usage:



### Options

```
-h, --help help for kubeadm
```

Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,11 @@ Experimental sub-commands not yet fully functional.

### Synopsis


Experimental sub-commands not yet fully functional.

### Options

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

Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,11 @@ Invoke subsets of kubeadm functions separately for a manual install.

### Synopsis


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

### Options

```
-h, --help help for phase
```

Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,11 @@ Installs required addons for passing Conformance tests

### Synopsis


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

### Options

```
-h, --help help for addon
```

Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,13 @@ Installs all addons to a Kubernetes cluster

### Synopsis


Installs the kube-dns and the kube-proxys addons components via the API server.
Please note that although the DNS server is deployed, it will not be scheduled until CNI is installed.

Alpha Disclaimer: this command is currently alpha.

```
kubeadm alpha phase addon all
kubeadm alpha phase addon all [flags]
```

### Examples
Expand All @@ -29,15 +28,15 @@ kubeadm alpha phase addon all
--apiserver-bind-port int32 The port the API server is accessible on (default 6443)
--config string Path to a kubeadm config file. WARNING: Usage of a configuration file is experimental!
--feature-gates string A set of key=value pairs that describe feature gates for various features.Options are:
CoreDNS=true|false (ALPHA - default=false)
Auditing=true|false (ALPHA - default=false)
CoreDNS=true|false (BETA - default=false)
DynamicKubeletConfig=true|false (ALPHA - default=false)
HighAvailability=true|false (ALPHA - default=false)
SelfHosting=true|false (BETA - default=false)
SelfHosting=true|false (ALPHA - default=false)
StoreCertsInSecrets=true|false (ALPHA - default=false)
SupportIPVSProxyMode=true|false (ALPHA - default=false)
-h, --help help for all
--image-repository string Choose a container registry to pull control plane images from (default "k8s.gcr.io")
--kubeconfig string The KubeConfig file to use when talking to the cluster (default "/etc/kubernetes/admin.conf")
--kubernetes-version string Choose a specific Kubernetes version for the control plane (default "stable-1.8")
--kubernetes-version string Choose a specific Kubernetes version for the control plane (default "stable-1.10")
--pod-network-cidr string The range of IP addresses used for the Pod network
--service-cidr string The range of IP address used for service VIPs (default "10.96.0.0/12")
--service-dns-domain string Alternative domain for services (default "cluster.local")
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,30 +3,29 @@ Installs the kube-dns addon to a Kubernetes cluster

### Synopsis


Installs the kube-dns addon components via the API server.
Please note that although the DNS server is deployed, it will not be scheduled until CNI is installed.

Alpha Disclaimer: this command is currently alpha.

```
kubeadm alpha phase addon kube-dns
kubeadm alpha phase addon kube-dns [flags]
```

### Options

```
--config string Path to a kubeadm config file. WARNING: Usage of a configuration file is experimental!
--feature-gates string A set of key=value pairs that describe feature gates for various features.Options are:
CoreDNS=true|false (ALPHA - default=false)
Auditing=true|false (ALPHA - default=false)
CoreDNS=true|false (BETA - default=false)
DynamicKubeletConfig=true|false (ALPHA - default=false)
HighAvailability=true|false (ALPHA - default=false)
SelfHosting=true|false (BETA - default=false)
SelfHosting=true|false (ALPHA - default=false)
StoreCertsInSecrets=true|false (ALPHA - default=false)
SupportIPVSProxyMode=true|false (ALPHA - default=false)
-h, --help help for kube-dns
--image-repository string Choose a container registry to pull control plane images from (default "k8s.gcr.io")
--kubeconfig string The KubeConfig file to use when talking to the cluster (default "/etc/kubernetes/admin.conf")
--kubernetes-version string Choose a specific Kubernetes version for the control plane (default "stable-1.8")
--kubernetes-version string Choose a specific Kubernetes version for the control plane (default "stable-1.10")
--service-cidr string The range of IP address used for service VIPs (default "10.96.0.0/12")
--service-dns-domain string Alternative domain for services (default "cluster.local")
```
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,12 @@ Installs the kube-proxy addon to a Kubernetes cluster

### Synopsis


Installs the kube-proxy addon components via the API server.

Alpha Disclaimer: this command is currently alpha.

```
kubeadm alpha phase addon kube-proxy
kubeadm alpha phase addon kube-proxy [flags]
```

### Options
Expand All @@ -18,9 +17,10 @@ kubeadm alpha phase addon kube-proxy
--apiserver-advertise-address string The IP address or DNS name the API server is accessible on
--apiserver-bind-port int32 The port the API server is accessible on (default 6443)
--config string Path to a kubeadm config file. WARNING: Usage of a configuration file is experimental!
-h, --help help for kube-proxy
--image-repository string Choose a container registry to pull control plane images from (default "k8s.gcr.io")
--kubeconfig string The KubeConfig file to use when talking to the cluster (default "/etc/kubernetes/admin.conf")
--kubernetes-version string Choose a specific Kubernetes version for the control plane (default "stable-1.8")
--kubernetes-version string Choose a specific Kubernetes version for the control plane (default "stable-1.10")
--pod-network-cidr string The range of IP addresses used for the Pod network
```

Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,12 @@ Manage kubeadm-specific bootstrap token functions

### Synopsis


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

### Options

```
-h, --help help for bootstrap-token
--kubeconfig string The KubeConfig file to use when talking to the cluster (default "/etc/kubernetes/admin.conf")
```

Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,14 @@ Makes all the bootstrap token configurations and creates an initial token

### Synopsis


Bootstrap tokens are used for establishing bidirectional trust between a node joining the cluster and a the master node.

This command makes all the configurations required to make bootstrap tokens works and then creates an initial token.

Alpha Disclaimer: this command is currently alpha.

```
kubeadm alpha phase bootstrap-token all
kubeadm alpha phase bootstrap-token all [flags]
```

### Examples
Expand All @@ -25,14 +24,14 @@ kubeadm alpha phase bootstrap-token all
### Options

```
--cert-dir string The path where certificates are stored (default "/etc/kubernetes/pki")
--config string Path to kubeadm config file (WARNING: Usage of a configuration file is experimental)
--description string A human friendly description of how this token is used. (default "The default bootstrap token generated by 'kubeadm init'.")
--groups stringSlice Extra groups that this token will authenticate as when used for authentication. Must match "system:bootstrappers:[a-z0-9:-]{0,255}[a-z0-9]" (default [system:bootstrappers:kubeadm:default-node-token])
--groups strings Extra groups that this token will authenticate as when used for authentication. Must match "system:bootstrappers:[a-z0-9:-]{0,255}[a-z0-9]" (default [system:bootstrappers:kubeadm:default-node-token])
-h, --help help for all
--skip-token-print Skip printing of the bootstrap token
--token string The token to use for establishing bidirectional trust between nodes and masters
--ttl duration The duration before the token is automatically deleted (e.g. 1s, 2m, 3h). If set to '0', the token will never expire (default 24h0m0s)
--usages stringSlice Describes the ways in which this token can be used. You can pass --usages multiple times or provide a comma separated list of options. Valid options: [signing,authentication] (default [signing,authentication])
--usages strings Describes the ways in which this token can be used. You can pass --usages multiple times or provide a comma separated list of options. Valid options: [signing,authentication] (default [signing,authentication])
```

### Options inherited from parent commands
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,20 @@ Uploads the cluster-info ConfigMap from the given kubeconfig file

### Synopsis


Uploads the "cluster-info" ConfigMap in the "kube-public" namespace, populating it with cluster information extracted from the given kubeconfig file. The ConfigMap is used for the node bootstrap process in its initial phases, before the client trusts the API server.

See online documentation about Authenticating with Bootstrap Tokens for more details.

Alpha Disclaimer: this command is currently alpha.

```
kubeadm alpha phase bootstrap-token cluster-info
kubeadm alpha phase bootstrap-token cluster-info [flags]
```

### Options

```
-h, --help help for cluster-info
```

### Options inherited from parent commands
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,28 +3,27 @@ Creates a bootstrap token to be used for node joining

### Synopsis


Creates a bootstrap token. If no token value is given, kubeadm will generate a random token instead.

Alternatively, you can use kubeadm token.

Alpha Disclaimer: this command is currently alpha.

```
kubeadm alpha phase bootstrap-token create
kubeadm alpha phase bootstrap-token create [flags]
```

### Options

```
--cert-dir string The path where certificates are stored (default "/etc/kubernetes/pki")
--config string Path to kubeadm config file (WARNING: Usage of a configuration file is experimental)
--description string A human friendly description of how this token is used. (default "The default bootstrap token generated by 'kubeadm init'.")
--groups stringSlice Extra groups that this token will authenticate as when used for authentication. Must match "system:bootstrappers:[a-z0-9:-]{0,255}[a-z0-9]" (default [system:bootstrappers:kubeadm:default-node-token])
--groups strings Extra groups that this token will authenticate as when used for authentication. Must match "system:bootstrappers:[a-z0-9:-]{0,255}[a-z0-9]" (default [system:bootstrappers:kubeadm:default-node-token])
-h, --help help for create
--skip-token-print Skip printing of the bootstrap token
--token string The token to use for establishing bidirectional trust between nodes and masters
--ttl duration The duration before the token is automatically deleted (e.g. 1s, 2m, 3h). If set to '0', the token will never expire (default 24h0m0s)
--usages stringSlice Describes the ways in which this token can be used. You can pass --usages multiple times or provide a comma separated list of options. Valid options: [signing,authentication] (default [signing,authentication])
--usages strings Describes the ways in which this token can be used. You can pass --usages multiple times or provide a comma separated list of options. Valid options: [signing,authentication] (default [signing,authentication])
```

### Options inherited from parent commands
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,14 @@ Configures the node bootstrap process

### Synopsis


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

### Options

```
-h, --help help for node
```

### Options inherited from parent commands

```
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,20 @@ Configures RBAC rules to allow the csrapprover controller automatically approve

### Synopsis


Configures RBAC rules to allow the csrapprover controller to automatically approve certificate signing requests generated by nodes joining the cluster. It configures also RBAC rules for certificates rotation (with auto approval of new certificates).

See online documentation about TLS bootstrapping for more details.

Alpha Disclaimer: this command is currently alpha.

```
kubeadm alpha phase bootstrap-token node allow-auto-approve
kubeadm alpha phase bootstrap-token node allow-auto-approve [flags]
```

### Options

```
-h, --help help for allow-auto-approve
```

### Options inherited from parent commands
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,20 @@ Configures RBAC to allow node bootstrap tokens to post CSRs in order for nodes t

### Synopsis


Configures RBAC rules to allow node bootstrap tokens to post a certificate signing request, thus enabling nodes joining the cluster to request long term certificate credentials.

See online documentation about TLS bootstrapping for more details.

Alpha Disclaimer: this command is currently alpha.

```
kubeadm alpha phase bootstrap-token node allow-post-csrs
kubeadm alpha phase bootstrap-token node allow-post-csrs [flags]
```

### Options

```
-h, --help help for allow-post-csrs
```

### Options inherited from parent commands
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,11 @@ Generates certificates for a Kubernetes cluster

### Synopsis


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

### Options

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

Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@ Generates all PKI assets necessary to establish the control plane

### Synopsis


Generates a self-signed CA to provision identities for each component in the cluster (including nodes) and client certificates to be used by various components.

If a given certificate and private key pair both exist, kubeadm skips the generation step and
Expand All @@ -12,14 +11,14 @@ existing files will be used.
Alpha Disclaimer: this command is currently alpha.

```
kubeadm alpha phase certs all
kubeadm alpha phase certs all [flags]
```

### Examples

```
# Creates all PKI assets necessary to establish the control plane,
# functionally equivalent to what generated by kubeadm init.
# functionally equivalent to what generated by kubeadm init.
kubeadm alpha phase certs all
# Creates all PKI assets using options read from a configuration file.
Expand All @@ -29,11 +28,12 @@ kubeadm alpha phase certs all
### Options

```
--apiserver-advertise-address string The IP address the API server is accessible on, to use for the API server serving cert
--apiserver-cert-extra-sans stringSlice Optional extra altnames to use for the API server serving cert. Can be both IP addresses and dns names
--cert-dir string The path where to save the certificates (default "/etc/kubernetes/pki")
--config string Path to kubeadm config file (WARNING: Usage of a configuration file is experimental)
--service-cidr string Alternative range of IP address for service VIPs, from which derives the internal API server VIP that will be added to the API Server serving cert (default "10.96.0.0/12")
--service-dns-domain string Alternative domain for services, to use for the API server serving cert (default "cluster.local")
--apiserver-advertise-address string The IP address the API server is accessible on, to use for the API server serving cert
--apiserver-cert-extra-sans strings Optional extra altnames to use for the API server serving cert. Can be both IP addresses and dns names
--cert-dir string The path where to save the certificates (default "/etc/kubernetes/pki")
--config string Path to kubeadm config file (WARNING: Usage of a configuration file is experimental)
-h, --help help for all
--service-cidr string Alternative range of IP address for service VIPs, from which derives the internal API server VIP that will be added to the API Server serving cert (default "10.96.0.0/12")
--service-dns-domain string Alternative domain for services, to use for the API server serving cert (default "cluster.local")
```

Loading

0 comments on commit 5c06a8b

Please sign in to comment.