Update and refactor the kubeadm documentation + add HypriotOS instructions as well by luxas · Pull Request #1420 · kubernetes/website

luxas · 2016-10-10T16:42:49Z

@errordeveloper @lukemarsden @mikedanese

PTAL

This change is

lukemarsden

Hey @luxas! I think the ARM/rpi stuff should be moved into a separate document and linked to from here. It's really cool that kubeadm supports ARM, but having it all inline here "if ARM, do this, otherwise, do that" makes it much harder to follow for the 80% case which is users installing Kubernetes on x86-64.

Please have a go at splitting it out into a separate doc and then resubmit for review. Thanks!

errordeveloper · 2016-10-12T16:11:27Z

      EOF
      # apt-get update
-      # apt-get install -y docker.io kubelet kubeadm kubectl kubernetes-cni
+      # # Install docker if you don't have it already. Version 1.11.2 is recommended, but 1.10.3 and 1.12.1 are known to work as well.


Not sure if this helps the user here, may be we can have these extra version number in footnotes?

errordeveloper · 2016-10-12T16:11:45Z

 ## Prerequisites

-1. One or more machines running Ubuntu 16.04 or CentOS 7
+1. One or more machines running Ubuntu 16.04, CentOS 7 or HypriotOS


Any version of HypriotOS?

errordeveloper · 2016-10-12T16:12:39Z

 The master is the machine where the "control plane" components run, including `etcd` (the cluster database) and the API server (which the `kubectl` CLI communicates with).
 All of these components run in pods started by `kubelet`.

+Before you run this, make sure nothing is listening on `2379`, `2380`, `8080`, `443` or `10250` and kubelet and docker is running (check with `systemctl status kubelet`).


443 is subject to change, I have some WIP... just FYI :)

errordeveloper · 2016-10-12T16:13:22Z

 This will remove the "dedicated" taint from any nodes that have it, including the master node, meaning that the scheduler will then be able to schedule pods everywhere.

-### (3/4) Joining your nodes
+### (3/4) Installing a pod network


So the purpose of moving this here is that people don't forget to do it, right?

errordeveloper · 2016-10-12T16:15:30Z

-  ip link set cni0 down; ip link del cni0;
-  systemctl start kubelet</code></pre>
-  </details> <!-- *syntax-highlighting-hack -->
+    systemctl stop kubelet;


You will need to rebase this part after my PR gets merged...

errordeveloper · 2016-10-12T16:15:45Z

+    rm -rf /var/lib/kubelet /etc/kubernetes /var/lib/etcd /etc/cni;
+    ip link set cni0 down; ip link del cni0;
+    systemctl start kubelet
+    <!-- *syntax-highlighting-hack -->


Any ideas what this tag really means? I am not sure I can see any highlighting on this code, and generally shell syntax is just to ambiguous for highlighters...

it's to stop vim highlighting the rest of the document as bold

errordeveloper · 2016-10-12T16:17:27Z

 1. `kubectl logs` is broken with `kubeadm` clusters due to [#22770](https://github.com/kubernetes/kubernetes/issues/22770).

   Workaround: use `docker logs` on the nodes where the containers are running as a workaround.
-1. There is not yet an easy way to generate a `kubeconfig` file which can be used to authenticate to the cluster remotely with `kubectl` on, for example, your workstation.


Thanks for promoting this to the main section.

luxas · 2016-10-13T20:59:30Z

PTAL @errordeveloper @lukemarsden

errordeveloper · 2016-10-14T07:24:47Z

+
+If you want to use flannel, run this:
+
+    # ARCH=amd64 curl -sSL https://raw.githubusercontent.com/luxas/flannel/update-daemonset/Documentation/kube-flannel.yml | sed "s/amd64/${ARCH}/g" | kubectl create -f -


I understand what you are trying to do, but it's a bit confusing as it stand - sed expression has no effect...

It has, since an arm user will understand to swap ARCH=amd64 to ARCH=arm
Should I point that out explicitely?

lukemarsden · 2016-10-14T13:46:20Z

Hey @luxas! I think the ARM/rpi stuff should be moved into a separate document and linked to from here. It's really cool that kubeadm supports ARM, but having it all inline here "if ARM, do this, otherwise, do that" makes it much harder to follow for the 80% case which is users installing Kubernetes on x86-64.

Please have a go at splitting it out into a separate doc and then resubmit for review. Thanks!

I don't think you addressed this, @luxas?

chrislovecnm

Update looks good. Have comments throughout.

I am not saying something negative about the tool,
but I would like to have a comment added calling out that this tool does not create a production grade or HA install yet.

This tool is still alpha, and it is listed on the site as the primary install tool, by website organization. I am concerned about optics, and people having a challenging experience with this tool.

How can we lead them better?

chrislovecnm · 2016-10-17T20:07:14Z

-### (3/4) Joining your nodes
+### (3/4) Installing a pod network
+
+You must install a pod network add-on so that your pods can communicate with each other.


Kubenet does not work?

Not yet at least. cc @mikedanese

chrislovecnm · 2016-10-17T20:07:41Z

+If you prefer [Calico](https://github.com/projectcalico/calico-containers/tree/master/docs/cni/kubernetes/manifests/kubeadm) or [Canal](https://github.com/tigera/canal/tree/master/k8s-install/kubeadm), please refer to their respective installation guides.
+You can install _only one_ pod network per cluster.
+
+Once a pod network has been installed, you can confirm that it is working by checking that the `kube-dns` pod is `Running` in the output of `kubectl get pods --all-namespaces`.


Should we give an example output?

chrislovecnm · 2016-10-17T20:08:57Z

@@ -149,28 +183,12 @@ For example:

 A few seconds later, you should notice that running `kubectl get nodes` on the master shows a cluster with as many machines as you created.


Also, should the user validate the number of running nodes and cluster-info with kubectl?

chrislovecnm · 2016-10-17T20:09:35Z


-If you prefer [Calico](https://github.com/projectcalico/calico-containers/tree/master/docs/cni/kubernetes/manifests/kubeadm) or [Canal](https://github.com/tigera/canal/tree/master/k8s-install/kubeadm), please refer to their respective installation guides.
-You should only install one pod network per cluster.
+In order to get a kubectl on your laptop for example to talk to your cluster, you need to copy the `KubeConfig` file from your master to your laptop like this:


kubeadmin does not export the cluster kubeconf for the user?

It does create a admin.json kubeconfig file that can be used for accessing the cluster, but not tied to a specific user with permissions

chrislovecnm · 2016-10-17T20:10:52Z

-
-
-## Cleanup
+## Turndown


Don't think you mean Turndown.

noun: turndown; plural noun: turndowns; noun: turn-down; plural noun: turn-downs

a rejection or refusal.

a decline in something; a downturn

Tear down?

Tear down was the word I was searching for, thanks

chrislovecnm · 2016-10-17T20:15:09Z

This needs a rebase.

luxas · 2016-10-17T20:43:53Z

Rebased and updated.

PTAL @mikedanese @lukemarsden @errordeveloper

lukemarsden · 2016-10-17T20:56:49Z

I'll take a look tomorrow...

errordeveloper · 2016-10-24T15:44:08Z

 **Note:** this will autodetect the network interface to advertise the master on as the interface with the default gateway.
 If you want to use a different interface, specify `--api-advertise-addresses=<ip-address>` argument to `kubeadm init`.

+If you want to use [flannel](https://github.com/coreos/flannel) as the pod network; specify `--pod-network-cidr=10.244.0.0/16` if you're using the daemonset manifest below.


I am not entirely sure about this flag, have you tested this and it's required 100%? From what I know, this flag is entirely incompatible with any CNI plugin.

Yes, it's unfortunately required

Ok, may be we should make it more explicit by adding: "However, this is not required for any other networks, including Weave, which is recommended."

errordeveloper · 2016-10-25T08:40:38Z

 * Mailing List: [kubernetes-sig-cluster-lifecycle](https://groups.google.com/forum/#!forum/kubernetes-sig-cluster-lifecycle)
 * [GitHub Issues](https://github.com/kubernetes/kubernetes/issues): please tag `kubeadm` issues with `@kubernetes/sig-cluster-lifecycle`

+## kubeadm is multi-platform


This is better here, thank you.

…tions as well

errordeveloper

LGTM

luxas · 2016-10-25T21:18:58Z

Thanks a lot!

* Added Self Healing Italian localization Signed-off-by: Paolo <ugho16@users.noreply.github.com> * Update content/it/self-healing.md Co-authored-by: Francesco Sbaraglia <23255586+fsbaraglia@users.noreply.github.com> Signed-off-by: Paolo <81316809+ugho16@users.noreply.github.com> Signed-off-by: Paolo <ugho16@users.noreply.github.com> Signed-off-by: Paolo <81316809+ugho16@users.noreply.github.com> Co-authored-by: Paolo <ugho16@users.noreply.github.com> Co-authored-by: Francesco Sbaraglia <23255586+fsbaraglia@users.noreply.github.com>

googlebot added the cla: yes label Oct 10, 2016

k8s-github-robot assigned errordeveloper Oct 10, 2016

lukemarsden suggested changes Oct 12, 2016

View reviewed changes

errordeveloper reviewed Oct 12, 2016

View reviewed changes

luxas force-pushed the update_kubeadm_arm branch from 11612ed to c709021 Compare October 13, 2016 20:58

luxas force-pushed the update_kubeadm_arm branch from c709021 to f9aa4a1 Compare October 13, 2016 21:04

errordeveloper reviewed Oct 14, 2016

View reviewed changes

luxas mentioned this pull request Oct 14, 2016

will it be convenient when upgrade to next release? luxas/kubernetes-on-arm#133

Closed

chrislovecnm suggested changes Oct 17, 2016

View reviewed changes

luxas force-pushed the update_kubeadm_arm branch from f9aa4a1 to 1aaab3e Compare October 17, 2016 20:33

devin-donnelly added the Tech Review: Open Issues label Oct 17, 2016

luxas force-pushed the update_kubeadm_arm branch from 1aaab3e to c723f7b Compare October 18, 2016 05:22

errordeveloper reviewed Oct 25, 2016

View reviewed changes

Update and refactor the kubeadm documentation + add HypriotOS instruc…

519ceca

…tions as well

luxas force-pushed the update_kubeadm_arm branch from c723f7b to 519ceca Compare October 25, 2016 19:56

luxas removed the Tech Review: Open Issues label Oct 25, 2016

errordeveloper approved these changes Oct 25, 2016

View reviewed changes

luxas added Docs LGTM labels Oct 25, 2016

luxas merged commit 50f4c84 into kubernetes:master Oct 25, 2016

foxish mentioned this pull request Nov 2, 2016

Issue with /docs/getting-started-guides/kubeadm/ #1602

Closed

2 tasks


		If you want to use flannel, run this:

		# ARCH=amd64 curl -sSL https://raw.githubusercontent.com/luxas/flannel/update-daemonset/Documentation/kube-flannel.yml \| sed "s/amd64/${ARCH}/g" \| kubectl create -f -

		@@ -149,28 +183,12 @@ For example:

		A few seconds later, you should notice that running `kubectl get nodes` on the master shows a cluster with as many machines as you created.

Conversation

luxas commented Oct 10, 2016 • edited by zmerlynn Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

lukemarsden left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

errordeveloper Oct 12, 2016 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

luxas commented Oct 13, 2016

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

lukemarsden commented Oct 14, 2016 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

chrislovecnm left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

chrislovecnm commented Oct 17, 2016

Uh oh!

luxas commented Oct 17, 2016

Uh oh!

lukemarsden commented Oct 17, 2016

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

errordeveloper Oct 25, 2016 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

errordeveloper left a comment

Choose a reason for hiding this comment

Uh oh!

luxas commented Oct 25, 2016

Uh oh!

Reviewers

Assignees

Labels

luxas commented Oct 10, 2016 •

edited by zmerlynn

Loading

errordeveloper Oct 12, 2016 •

edited

Loading

lukemarsden commented Oct 14, 2016 •

edited

Loading

chrislovecnm left a comment •

edited

Loading

errordeveloper Oct 25, 2016 •

edited

Loading