Skip to content

Commit

Permalink
Re-add kubefed to setup tools reference (#8422)
Browse files Browse the repository at this point in the history
* Add kubefed files

* Add kubeadm files

* Add weights
  • Loading branch information
zacharysarah authored and k8s-ci-robot committed May 8, 2018
1 parent b39a726 commit e73a73a
Show file tree
Hide file tree
Showing 19 changed files with 641 additions and 117 deletions.
5 changes: 5 additions & 0 deletions content/en/docs/reference/setup-tools/_index.md
@@ -0,0 +1,5 @@
---
title: Setup tools reference
weight: 50
toc-hide: true
---
2 changes: 1 addition & 1 deletion content/en/docs/reference/setup-tools/kubeadm/_index.md
@@ -1,5 +1,5 @@
--- ---
title: "Kubeadm" title: "Kubeadm"
weight: 10 weight: 10
toc-hide: true
--- ---

Large diffs are not rendered by default.

Expand Up @@ -4,6 +4,7 @@ approvers:
- luxas - luxas
- jbeda - jbeda
title: kubeadm alpha title: kubeadm alpha
weight: 90
--- ---
{{< caution >}} {{< caution >}}
`kubeadm alpha` provides a preview of a set of features made available for gathering feedback `kubeadm alpha` provides a preview of a set of features made available for gathering feedback
Expand All @@ -12,7 +13,7 @@ title: kubeadm alpha


In v1.8.0, kubeadm introduced the `kubeadm alpha phase` command with the aim of making kubeadm more modular. This modularity enables you to invoke atomic sub-steps of the bootstrap process; you can let kubeadm do some parts and fill in yourself where you need customizations. In v1.8.0, kubeadm introduced the `kubeadm alpha phase` command with the aim of making kubeadm more modular. This modularity enables you to invoke atomic sub-steps of the bootstrap process; you can let kubeadm do some parts and fill in yourself where you need customizations.


`kubeadm alpha phase` is consistent with [kubeadm init workflow](kubeadm-init.md#init-workflow), `kubeadm alpha phase` is consistent with [kubeadm init workflow](kubeadm-init.md#init-workflow),
and behind the scene both use the same code. and behind the scene both use the same code.


* [kubeadm alpha phase preflight](#cmd-phase-preflight) * [kubeadm alpha phase preflight](#cmd-phase-preflight)
Expand Down Expand Up @@ -69,7 +70,7 @@ Additionally, the `user` subcommand supports the creation of kubeconfig files fo


## kubeadm alpha phase controlplane {#cmd-phase-controlplane} ## kubeadm alpha phase controlplane {#cmd-phase-controlplane}


You can create all required static Pod files for the control plane components with the `all` subcommand, You can create all required static Pod files for the control plane components with the `all` subcommand,
or selectively create the files. or selectively create the files.


{{< tabs name="tab-controlplane" >}} {{< tabs name="tab-controlplane" >}}
Expand Down Expand Up @@ -101,7 +102,7 @@ Use the following command to label and taint the node with the `node-role.kubern
## kubeadm alpha phase bootstrap-token {#cmd-phase-bootstrap-token} ## kubeadm alpha phase bootstrap-token {#cmd-phase-bootstrap-token}


Use the following actions to fully configure bootstrap tokens. Use the following actions to fully configure bootstrap tokens.
You can fully configure bootstrap tokens with the `all` subcommand, You can fully configure bootstrap tokens with the `all` subcommand,
or selectively configure single elements. or selectively configure single elements.


{{< tabs name="tab-bootstrap-token" >}} {{< tabs name="tab-bootstrap-token" >}}
Expand All @@ -125,7 +126,7 @@ Alternatively, you can use [kubeadm config](kubeadm-config.md).


## kubeadm alpha phase addon {#cmd-phase-addon} ## kubeadm alpha phase addon {#cmd-phase-addon}


You can install all the available addons with the `all` subcommand, or You can install all the available addons with the `all` subcommand, or
install them selectively. install them selectively.


Please note that if kubeadm is invoked with `--feature-gates=CoreDNS=true`, [CoreDNS](https://coredns.io/) is installed instead of `kube-dns`. Please note that if kubeadm is invoked with `--feature-gates=CoreDNS=true`, [CoreDNS](https://coredns.io/) is installed instead of `kube-dns`.
Expand Down
Expand Up @@ -5,9 +5,10 @@ approvers:
- jbeda - jbeda
title: kubeadm config title: kubeadm config
content_template: templates/concept content_template: templates/concept
weight: 50
--- ---
{{% capture overview %}} {{% capture overview %}}
Beginning with v1.8.0, kubeadm uploads the configuration of your cluster to a ConfigMap called Beginning with v1.8.0, kubeadm uploads the configuration of your cluster to a ConfigMap called
`kubeadm-config` in the `kube-system` namespace, and later reads the ConfigMap when upgrading. `kubeadm-config` in the `kube-system` namespace, and later reads the ConfigMap when upgrading.
This enables correct configuration of system components, and provides a seamless user experience. This enables correct configuration of system components, and provides a seamless user experience.


Expand All @@ -31,4 +32,3 @@ may use `kubeadm upgrade`.
{{% capture whatsnext %}} {{% capture whatsnext %}}
* [kubeadm upgrade](kubeadm-upgrade.md) to upgrade a Kubernetes cluster to a newer version * [kubeadm upgrade](kubeadm-upgrade.md) to upgrade a Kubernetes cluster to a newer version
{{% /capture %}} {{% /capture %}}

5 changes: 2 additions & 3 deletions content/en/docs/reference/setup-tools/kubeadm/kubeadm-init.md
Expand Up @@ -5,6 +5,7 @@ approvers:
- jbeda - jbeda
title: kubeadm init title: kubeadm init
content_template: templates/concept content_template: templates/concept
weight: 20
--- ---
{{% capture overview %}} {{% capture overview %}}
This command initializes a Kubernetes master node. This command initializes a Kubernetes master node.
Expand Down Expand Up @@ -37,7 +38,7 @@ following steps:
1. If kubeadm is invoked with `--feature-gates=DynamicKubeletConfig` enabled, 1. If kubeadm is invoked with `--feature-gates=DynamicKubeletConfig` enabled,
it writes the kubelet init configuration into the `/var/lib/kubelet/config/init/kubelet` file. it writes the kubelet init configuration into the `/var/lib/kubelet/config/init/kubelet` file.
See [Set Kubelet parameters via a config file](/docs/tasks/administer-cluster/kubelet-config-file/) See [Set Kubelet parameters via a config file](/docs/tasks/administer-cluster/kubelet-config-file/)
and [Reconfigure a Node's Kubelet in a Live Cluster](/docs/tasks/administer-cluster/reconfigure-kubelet/) and [Reconfigure a Node's Kubelet in a Live Cluster](/docs/tasks/administer-cluster/reconfigure-kubelet/)
for more information about Dynamic Kubelet Configuration. for more information about Dynamic Kubelet Configuration.
This functionality is now by default disabled as it is behind a feature gate, but is expected to be a default in future versions. This functionality is now by default disabled as it is behind a feature gate, but is expected to be a default in future versions.


Expand Down Expand Up @@ -458,5 +459,3 @@ provisioned). For details, see the [kubeadm join](kubeadm-join.md).
* [kubeadm upgrade](kubeadm-upgrade.md) to upgrade a Kubernetes cluster to a newer version * [kubeadm upgrade](kubeadm-upgrade.md) to upgrade a Kubernetes cluster to a newer version
* [kubeadm reset](kubeadm-reset.md) to revert any changes made to this host by `kubeadm init` or `kubeadm join` * [kubeadm reset](kubeadm-reset.md) to revert any changes made to this host by `kubeadm init` or `kubeadm join`
{{% /capture %}} {{% /capture %}}


7 changes: 3 additions & 4 deletions content/en/docs/reference/setup-tools/kubeadm/kubeadm-join.md
Expand Up @@ -5,9 +5,10 @@ approvers:
- jbeda - jbeda
title: kubeadm join title: kubeadm join
content_template: templates/concept content_template: templates/concept
weight: 30
--- ---
{{% capture overview %}} {{% capture overview %}}
This command initializes a Kubernetes worker node and joins it to the cluster. This command initializes a Kubernetes worker node and joins it to the cluster.
{{% /capture %}} {{% /capture %}}


{{% capture body %}} {{% capture body %}}
Expand All @@ -27,7 +28,7 @@ This action consists of the following steps:
it first retrieves the kubelet init configuration from the master and writes it to it first retrieves the kubelet init configuration from the master and writes it to
the disk. When kubelet starts up, kubeadm updates the node `Node.spec.configSource` property of the node. the disk. When kubelet starts up, kubeadm updates the node `Node.spec.configSource` property of the node.
See [Set Kubelet parameters via a config file](/docs/tasks/administer-cluster/kubelet-config-file/) See [Set Kubelet parameters via a config file](/docs/tasks/administer-cluster/kubelet-config-file/)
and [Reconfigure a Node's Kubelet in a Live Cluster](/docs/tasks/administer-cluster/reconfigure-kubelet/) and [Reconfigure a Node's Kubelet in a Live Cluster](/docs/tasks/administer-cluster/reconfigure-kubelet/)
for more information about Dynamic Kubelet Configuration. for more information about Dynamic Kubelet Configuration.


1. Once the cluster information is known, kubelet can start the TLS bootstrapping 1. Once the cluster information is known, kubelet can start the TLS bootstrapping
Expand Down Expand Up @@ -235,5 +236,3 @@ discoveryTokenUnsafeSkipCAVerification: <bool>
* [kubeadm token](kubeadm-token.md) to manage tokens for `kubeadm join` * [kubeadm token](kubeadm-token.md) to manage tokens for `kubeadm join`
* [kubeadm reset](kubeadm-reset.md) to revert any changes made to this host by `kubeadm init` or `kubeadm join` * [kubeadm reset](kubeadm-reset.md) to revert any changes made to this host by `kubeadm init` or `kubeadm join`
{{% /capture %}} {{% /capture %}}


Expand Up @@ -3,8 +3,9 @@ approvers:
- mikedanese - mikedanese
- luxas - luxas
- jbeda - jbeda
title: kubeadm reset title: kubeadm reset
content_template: templates/concept content_template: templates/concept
weight: 60
--- ---
{{% capture overview %}} {{% capture overview %}}
This command reverts any changes made by `kubeadm init` or `kubeadm join`. This command reverts any changes made by `kubeadm init` or `kubeadm join`.
Expand All @@ -15,7 +16,7 @@ This command reverts any changes made by `kubeadm init` or `kubeadm join`.


### External etcd clean up! ### External etcd clean up!


`kubeadm reset` will not delete any etcd data if external etcd is used. This means that if you run `kubeadm init` again using the same etcd endpoints, you will see state from previous clusters. `kubeadm reset` will not delete any etcd data if external etcd is used. This means that if you run `kubeadm init` again using the same etcd endpoints, you will see state from previous clusters.


To wipe etcd data it is recommended you use a client like etcdctl, such as: To wipe etcd data it is recommended you use a client like etcdctl, such as:


Expand All @@ -30,4 +31,3 @@ See the [etcd documentation](https://github.com/coreos/etcd/tree/master/etcdctl)
* [kubeadm init](kubeadm-init.md) to bootstrap a Kubernetes master node * [kubeadm init](kubeadm-init.md) to bootstrap a Kubernetes master node
* [kubeadm join](kubeadm-join.md) to bootstrap a Kubernetes worker node and join it to the cluster * [kubeadm join](kubeadm-join.md) to bootstrap a Kubernetes worker node and join it to the cluster
{{% /capture %}} {{% /capture %}}

Expand Up @@ -5,13 +5,14 @@ approvers:
- jbeda - jbeda
title: kubeadm token title: kubeadm token
content_template: templates/concept content_template: templates/concept
weight: 70
--- ---
{{% capture overview %}} {{% capture overview %}}


Bootstrap tokens are used for establishing bidirectional trust between a node joining Bootstrap tokens are used for establishing bidirectional trust between a node joining
the cluster and a master node, as described in [authenticating with bootstrap tokens](/docs/admin/bootstrap-tokens/). the cluster and a master node, as described in [authenticating with bootstrap tokens](/docs/admin/bootstrap-tokens/).


`kubeadm init` creates an initial token with a 24-hour TTL. The following commands allow you to manage `kubeadm init` creates an initial token with a 24-hour TTL. The following commands allow you to manage
such a token and also to create and manage new ones. such a token and also to create and manage new ones.


{{% /capture %}} {{% /capture %}}
Expand All @@ -33,5 +34,3 @@ such a token and also to create and manage new ones.
{{% capture whatsnext %}} {{% capture whatsnext %}}
* [kubeadm join](kubeadm-join.md) to bootstrap a Kubernetes worker node and join it to the cluster * [kubeadm join](kubeadm-join.md) to bootstrap a Kubernetes worker node and join it to the cluster
{{% /capture %}} {{% /capture %}}


Expand Up @@ -5,6 +5,7 @@ approvers:
- jbeda - jbeda
title: kubeadm upgrade title: kubeadm upgrade
content_template: templates/concept content_template: templates/concept
weight: 40
--- ---
{{% capture overview %}} {{% capture overview %}}
`kubeadm upgrade` is a user-friendly command that wraps complex upgrading logic behind one command, with support `kubeadm upgrade` is a user-friendly command that wraps complex upgrading logic behind one command, with support
Expand Down Expand Up @@ -37,5 +38,3 @@ Please check these documents out for more detailed how-to-upgrade guidance:
{{% capture whatsnext %}} {{% capture whatsnext %}}
* [kubeadm config](kubeadm-config.md) if you initialized your cluster using kubeadm v1.7.x or lower, to configure your cluster for `kubeadm upgrade` * [kubeadm config](kubeadm-config.md) if you initialized your cluster using kubeadm v1.7.x or lower, to configure your cluster for `kubeadm upgrade`
{{% /capture %}} {{% /capture %}}


Expand Up @@ -3,8 +3,9 @@ approvers:
- mikedanese - mikedanese
- luxas - luxas
- jbeda - jbeda
title: kubeadm version title: kubeadm version
content_template: templates/concept content_template: templates/concept
weight: 80
--- ---
{{% capture overview %}} {{% capture overview %}}
This command prints the verison of kubeadm. This command prints the verison of kubeadm.
Expand All @@ -13,5 +14,3 @@ This command prints the verison of kubeadm.
{{% capture body %}} {{% capture body %}}
{{< include "generated/kubeadm_version.md" >}} {{< include "generated/kubeadm_version.md" >}}
{{% /capture %}} {{% /capture %}}


3 changes: 2 additions & 1 deletion content/en/docs/reference/setup-tools/kubeadm/kubeadm.md
Expand Up @@ -4,8 +4,9 @@ approvers:
- luxas - luxas
- jbeda - jbeda
title: Overview of kubeadm title: Overview of kubeadm
weight: 10
--- ---
<img src="https://raw.githubusercontent.com/cncf/artwork/master/kubernetes/certified-kubernetes/versionless/color/certified-kubernetes-color.png" align="right" width="150px">Kubeadm is a tool built to provide `kubeadm init` and `kubeadm join` as best-practice “fast paths” for creating Kubernetes clusters. <img src="https://raw.githubusercontent.com/cncf/artwork/master/kubernetes/certified-kubernetes/versionless/color/certified-kubernetes-color.png" align="right" width="150px">Kubeadm is a tool built to provide `kubeadm init` and `kubeadm join` as best-practice “fast paths” for creating Kubernetes clusters.


kubeadm performs the actions necessary to get a minimum viable cluster up and running. By design, it cares only about bootstrapping, not about provisioning machines. Likewise, installing various nice-to-have addons, like the Kubernetes Dashboard, monitoring solutions, and cloud-specific addons, is not in scope. kubeadm performs the actions necessary to get a minimum viable cluster up and running. By design, it cares only about bootstrapping, not about provisioning machines. Likewise, installing various nice-to-have addons, like the Kubernetes Dashboard, monitoring solutions, and cloud-specific addons, is not in scope.


Expand Down
5 changes: 5 additions & 0 deletions content/en/docs/reference/setup-tools/kubefed/_index.md
@@ -0,0 +1,5 @@
---
title: kubefed
weight: 20
toc-hide: true
---
105 changes: 105 additions & 0 deletions content/en/docs/reference/setup-tools/kubefed/kubefed-init.md
@@ -0,0 +1,105 @@
---
title: kubefed init
notitle: true
weight: 30
---
## kubefed init

Initialize a federation control plane

### Synopsis


Init initializes a federation control plane.

Federation control plane is hosted inside a Kubernetes
cluster. The host cluster must be specified using the
--host-cluster-context flag.

```
kubefed init FEDERATION_NAME --host-cluster-context=HOST_CONTEXT [flags]
```

### Examples

```
# Initialize federation control plane for a federation
# named foo in the host cluster whose local kubeconfig
# context is bar.
kubefed init foo --host-cluster-context=bar
```

### Options

```
--api-server-advertise-address string Preferred address to advertise api server nodeport service. Valid only if 'api-server-service-type=NodePort'.
--api-server-port int32 Preferred port to use for api server nodeport service (0 for random port assignment). Valid only if 'api-server-service-type=NodePort'.
--api-server-service-type string The type of service to create for federation API server. Options: 'LoadBalancer' (default), 'NodePort'. (default "LoadBalancer")
--apiserver-arg-overrides string comma separated list of federation-apiserver arguments to override: Example "--arg1=value1,--arg2=value2..."
--apiserver-enable-basic-auth Enables HTTP Basic authentication for the federation-apiserver. Defaults to false.
--apiserver-enable-token-auth Enables token authentication for the federation-apiserver. Defaults to false.
--controllermanager-arg-overrides string comma separated list of federation-controller-manager arguments to override: Example "--arg1=value1,--arg2=value2..."
--dns-provider string Dns provider to be used for this deployment.
--dns-provider-config string Config file path on local file system for configuring DNS provider.
--dns-zone-name string DNS suffix for this federation. Federated Service DNS names are published with this suffix.
--dry-run dry run without sending commands to server.
--etcd-image string Image to use for etcd server. (default "gcr.io/google_containers/etcd:3.1.10")
--etcd-persistent-storage Use persistent volume for etcd. Defaults to 'true'. (default true)
--etcd-pv-capacity string Size of persistent volume claim to be used for etcd. (default "10Gi")
--etcd-pv-storage-class string The storage class of the persistent volume claim used for etcd. Must be provided if a default storage class is not enabled for the host cluster.
--etcd-servers string External pre-deployed etcd server to be used to store federation state.
--federation-system-namespace string Namespace in the host cluster where the federation system components are installed (default "federation-system")
-h, --help help for init
--host-cluster-context string Host cluster context
--image string Image to use for federation API server and controller manager binaries. (default "gcr.io/k8s-jkns-e2e-gce-federation/fcp-amd64:v0.0.0-master_$Format:%h$")
--image-pull-policy string PullPolicy describes a policy for if/when to pull a container image. The default pull policy is IfNotPresent which will not pull an image if it already exists. (default "IfNotPresent")
--image-pull-secrets string Provide secrets that can access the private registry.
--node-selector string comma separated list of nodeSelector arguments: Example "arg1=value1,arg2=value2..."
```

### Options inherited from parent commands

```
--alsologtostderr log to standard error as well as files
--as string Username to impersonate for the operation
--as-group stringArray Group to impersonate for the operation, this flag can be repeated to specify multiple groups.
--cache-dir string Default HTTP cache directory (default "/Users/jrondeau/.kube/http-cache")
--certificate-authority string Path to a cert file for the certificate authority
--client-certificate string Path to a client certificate file for TLS
--client-key string Path to a client key file for TLS
--cloud-provider-gce-lb-src-cidrs cidrs CIDRs opened in GCE firewall for LB traffic proxy & health checks (default 130.211.0.0/22,209.85.152.0/22,209.85.204.0/22,35.191.0.0/16)
--cluster string The name of the kubeconfig cluster to use
--context string The name of the kubeconfig context to use
--default-not-ready-toleration-seconds int Indicates the tolerationSeconds of the toleration for notReady:NoExecute that is added by default to every pod that does not already have such a toleration. (default 300)
--default-unreachable-toleration-seconds int Indicates the tolerationSeconds of the toleration for unreachable:NoExecute that is added by default to every pod that does not already have such a toleration. (default 300)
--insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
--ir-data-source string Data source used by InitialResources. Supported options: influxdb, gcm. (default "influxdb")
--ir-dbname string InfluxDB database name which contains metrics required by InitialResources (default "k8s")
--ir-hawkular string Hawkular configuration URL
--ir-influxdb-host string Address of InfluxDB which contains metrics required by InitialResources (default "localhost:8080/api/v1/namespaces/kube-system/services/monitoring-influxdb:api/proxy")
--ir-namespace-only Whether the estimation should be made only based on data from the same namespace.
--ir-password string Password used for connecting to InfluxDB (default "root")
--ir-percentile int Which percentile of samples should InitialResources use when estimating resources. For experiment purposes. (default 90)
--ir-user string User used for connecting to InfluxDB (default "root")
--kubeconfig string Path to the kubeconfig file to use for CLI requests.
--log-backtrace-at traceLocation when logging hits line file:N, emit a stack trace (default :0)
--log-dir string If non-empty, write log files in this directory
--log-flush-frequency duration Maximum number of seconds between log flushes (default 5s)
--logtostderr log to standard error instead of files (default true)
--match-server-version Require server version to match client version
-n, --namespace string If present, the namespace scope for this CLI request
--password string Password for basic authentication to the API server
--request-timeout string The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests. (default "0")
-s, --server string The address and port of the Kubernetes API server
--stderrthreshold severity logs at or above this threshold go to stderr (default 2)
--token string Bearer token for authentication to the API server
--user string The name of the kubeconfig user to use
--username string Username for basic authentication to the API server
-v, --v Level log level for V logs
--vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
```

### SEE ALSO
* [kubefed](kubefed.md) - kubefed controls a Kubernetes Cluster Federation

###### Auto generated by spf13/cobra on 25-Mar-2018

0 comments on commit e73a73a

Please sign in to comment.