From 0ee3235676b2e684d00ace3e1b9569cefc2f99c1 Mon Sep 17 00:00:00 2001 From: Andrew Chen Date: Thu, 20 Apr 2017 13:59:02 -0700 Subject: [PATCH] Chenopis 3436 patch (#3480) * Remove the docker-multinode getting started guide * add entries to skip_toc_check.txt --- _data/setup.yml | 1 - .../docker-multinode.md | 120 +----------------- docs/getting-started-guides/docker.md | 2 +- docs/setup/pick-right-solution.md | 3 - skip_title_check.txt | 1 + skip_toc_check.txt | 2 + 6 files changed, 5 insertions(+), 124 deletions(-) diff --git a/_data/setup.yml b/_data/setup.yml index deb2b4b1fde..4b195972750 100644 --- a/_data/setup.yml +++ b/_data/setup.yml @@ -96,7 +96,6 @@ toc: - docs/admin/node-conformance.md - docs/admin/salt.md -- docs/getting-started-guides/docker-multinode.md - docs/admin/cluster-large.md - docs/admin/multiple-zones.md - docs/admin/high-availability/index.md diff --git a/docs/getting-started-guides/docker-multinode.md b/docs/getting-started-guides/docker-multinode.md index 44835622828..2516513b7e4 100644 --- a/docs/getting-started-guides/docker-multinode.md +++ b/docs/getting-started-guides/docker-multinode.md @@ -1,119 +1 @@ ---- -title: Portable Multi-Node Cluster ---- - -* TOC -{:toc} - - -## Prerequisites - -The only thing you need is a linux machine with **Docker 1.10.0 or higher** - -## Overview - -This guide will set up a 2-node Kubernetes cluster, consisting of a _master_ node which hosts the API server and orchestrates work -and a _worker_ node which receives work from the master. You can repeat the process of adding worker nodes an arbitrary number of -times to create larger clusters. - -Here's a diagram of what the final result will look like: -![Kubernetes on Docker](/images/docs/k8s-docker.png) - -### Bootstrap Docker - -This guide uses a pattern of running two instances of the Docker daemon: - 1) A _bootstrap_ Docker instance which is used to start `etcd` and `flanneld`, on which the Kubernetes components depend - 2) A _main_ Docker instance which is used for the Kubernetes infrastructure and user's scheduled containers - -This pattern is necessary because the `flannel` daemon is responsible for setting up and managing the network that interconnects -all of the Docker containers created by Kubernetes. To achieve this, it must run outside of the _main_ Docker daemon. However, -it is still useful to use containers for deployment and management, so we create a simpler _bootstrap_ daemon to achieve this. - -### Versions supported - -v1.2.x and v1.3.x are supported versions for this deployment. -v1.3.0 alphas and betas might work, but be sure you know what you're doing if you're trying them out. - -### Multi-arch solution - -Yeah, it's true. You may run this deployment setup seamlessly on `amd64`, `arm`, `arm64` and `ppc64le` hosts. -See this tracking issue for more details: https://github.com/kubernetes/kubernetes/issues/17981 - -v1.3.0 ships with support for amd64, arm and arm64. ppc64le isn't supported, due to a bug in the Go runtime, `hyperkube` (only!) isn't built for the stable v1.3.0 release, and therefore this guide can't run it. But you may still run Kubernetes on ppc64le via custom deployments. - -hyperkube was pushed for ppc64le at versions `v1.3.0-alpha.3` and `v1.3.0-alpha.4`, feel free to try them out, but there might be some unexpected bugs. - -### Options/configuration - -The scripts will output something like this when starting: - -```shell -+++ [0611 12:50:12] K8S_VERSION is set to: v1.3.0 -+++ [0611 12:50:12] ETCD_VERSION is set to: 2.2.5 -+++ [0611 12:50:12] FLANNEL_VERSION is set to: 0.5.5 -+++ [0611 12:50:12] FLANNEL_IPMASQ is set to: true -+++ [0611 12:50:12] FLANNEL_NETWORK is set to: 10.1.0.0/16 -+++ [0611 12:50:12] FLANNEL_BACKEND is set to: udp -+++ [0611 12:50:12] RESTART_POLICY is set to: unless-stopped -+++ [0611 12:50:12] MASTER_IP is set to: 192.168.1.50 -+++ [0611 12:50:12] ARCH is set to: amd64 -+++ [0611 12:50:12] NET_INTERFACE is set to: eth0 -``` - -Each of these options are overridable by `export`ing the values before running the script. - -## Setup the master node - -The first step in the process is to initialize the master node. - -Clone the `kube-deploy` repo, and run `master.sh` on the master machine _with root_: - -```shell -$ git clone https://github.com/kubernetes/kube-deploy -$ cd kube-deploy/docker-multinode -$ ./master.sh -``` - -First, the `bootstrap` docker daemon is started, then `etcd` and `flannel` are started as containers in the bootstrap daemon. -Then, the main docker daemon is restarted, and this is an OS/distro-specific tasks, so if it doesn't work for your distro, feel free to contribute! - -Lastly, it launches `kubelet` in the main docker daemon, and the `kubelet` in turn launches the control plane (apiserver, controller-manager and scheduler) as static pods. - -## Adding a worker node - -Once your master is up and running you can add one or more workers on different machines. - -Clone the `kube-deploy` repo, and run `worker.sh` on the worker machine _with root_: - -```shell -$ git clone https://github.com/kubernetes/kube-deploy -$ cd kube-deploy/docker-multinode -$ export MASTER_IP=${SOME_IP} -$ ./worker.sh -``` - -First, the `bootstrap` docker daemon is started, then `flannel` is started as a container in the bootstrap daemon, in order to set up the overlay network. -Then, the main docker daemon is restarted and lastly `kubelet` is launched as a container in the main docker daemon. - -## Addons - -kube-dns and the dashboard are deployed automatically with v1.3.0 - -### Deploy DNS manually for v1.2.x - -Just specify the architecture, and deploy via these commands: - -```shell -# Possible options: amd64, arm, arm64 and ppc64le -$ export ARCH=amd64 - -# If the kube-system namespace isn't already created, create it -$ kubectl get ns -$ kubectl create namespace kube-system - -$ sed -e "s/ARCH/${ARCH}/g;" skydns.yaml | kubectl create -f - -``` - -### Test if DNS works - -Follow [this link](https://releases.k8s.io/release-1.2/cluster/addons/dns#how-do-i-test-if-it-is-working) to check it out. +# Stop. This guide has been superseded by [kubeadm](../kubeadm/). This page is only present for historical purposes. diff --git a/docs/getting-started-guides/docker.md b/docs/getting-started-guides/docker.md index c61c628398f..663ec985a94 100644 --- a/docs/getting-started-guides/docker.md +++ b/docs/getting-started-guides/docker.md @@ -1,3 +1,3 @@ -# Stop. This guide has been superseded by [Minikube](../minikube/). The link below is present only for historical purposes +# Stop. This guide has been superseded by [Minikube](../minikube/). The link below is present only for historical purposes The document has been moved to [here](https://github.com/kubernetes/kubernetes/blob/master/docs/devel/local-cluster/docker.md) diff --git a/docs/setup/pick-right-solution.md b/docs/setup/pick-right-solution.md index ed703cfc2bd..55aa4dfc2d6 100644 --- a/docs/setup/pick-right-solution.md +++ b/docs/setup/pick-right-solution.md @@ -120,7 +120,6 @@ These solutions are combinations of cloud provider and OS not covered by the abo - [Centos](/docs/getting-started-guides/centos/centos_manual_config) - [Bare Metal with Ubuntu](/docs/getting-started-guides/ubuntu/) - [Ubuntu Manual](/docs/getting-started-guides/ubuntu/manual) -- [Docker Multi Node](/docs/getting-started-guides/docker-multinode) - [CoreOS](/docs/getting-started-guides/coreos) #### Integrations @@ -149,8 +148,6 @@ Platform9 | | multi-support | multi-support | [docs](https:/ GCE | Saltstack | Debian | GCE | [docs](/docs/getting-started-guides/gce) | Project Azure Container Service | | Ubuntu | Azure | [docs](https://azure.microsoft.com/en-us/services/container-service/) | Commercial Azure (IaaS) | | Ubuntu | Azure | [docs](/docs/getting-started-guides/azure) | [Community (Microsoft)](https://github.com/Azure/acs-engine) -Docker Single Node | custom | N/A | local | [docs](/docs/getting-started-guides/docker) | Project ([@brendandburns](https://github.com/brendandburns)) -Docker Multi Node | custom | N/A | flannel | [docs](/docs/getting-started-guides/docker-multinode) | Project ([@brendandburns](https://github.com/brendandburns)) Bare-metal | Ansible | Fedora | flannel | [docs](/docs/getting-started-guides/fedora/fedora_ansible_config) | Project Bare-metal | custom | Fedora | _none_ | [docs](/docs/getting-started-guides/fedora/fedora_manual_config) | Project Bare-metal | custom | Fedora | flannel | [docs](/docs/getting-started-guides/fedora/flannel_multi_node_cluster) | Community ([@aveshagarwal](https://github.com/aveshagarwal)) diff --git a/skip_title_check.txt b/skip_title_check.txt index 2d43e9bf593..7f1de8578ce 100644 --- a/skip_title_check.txt +++ b/skip_title_check.txt @@ -1,6 +1,7 @@ # Put files you want to skip "title:" check here: docs/sitemap.md docs/getting-started-guides/docker.md +docs/getting-started-guides/docker-multinode.md docs/user-guide/configmap/README.md docs/user-guide/downward-api/README.md docs/api-reference/extensions/v1beta1/definitions.md diff --git a/skip_toc_check.txt b/skip_toc_check.txt index 59639ead565..f5c51c6df7e 100644 --- a/skip_toc_check.txt +++ b/skip_toc_check.txt @@ -37,6 +37,8 @@ docs/contribute/style-guide.md docs/contribute/write-new-topic.md docs/deprecation-policy.md docs/federation/api-reference/index.md +docs/getting-started-guides/docker.md +docs/getting-started-guides/docker-multinode.md docs/getting-started-guides/kubectl.md docs/home/deprecation-policy.md docs/home/security.md