From a37273b42254779273183c6fab256a5d4fbd01fd Mon Sep 17 00:00:00 2001
From: Smaine Kahlouch <smaine.kahlouch@arkena.com>
Date: Sun, 4 Oct 2015 21:25:09 +0200
Subject: [PATCH] README.md v 2

---
 README.md | 90 +++++++++++++++++++++++++++++++++++++++++++++++--------
 1 file changed, 78 insertions(+), 12 deletions(-)

diff --git a/README.md b/README.md
index f4d5e88e9..db4468161 100644
--- a/README.md
+++ b/README.md
@@ -11,24 +11,25 @@ The target servers must have access to the Internet in order to pull docker imaq
 Ansible v1.9.x
 
 ### Components
-* [kubernetes]('https://github.com/kubernetes/kubernetes/releases') v1.0.6
-* [etcd]('https://github.com/coreos/etcd/releases') v2.2.0
-* [calicoctl]('https://github.com/projectcalico/calico-docker/releases') v0.5.1
-* [flanneld]('https://github.com/coreos/flannel/releases') v0.5.3
-* [docker-gc]('https://github.com/spotify/docker-gc')
+* [kubernetes](https://github.com/kubernetes/kubernetes/releases) v1.0.6
+* [etcd](https://github.com/coreos/etcd/releases) v2.2.0
+* [calicoctl](https://github.com/projectcalico/calico-docker/releases) v0.5.1
+* [flanneld](https://github.com/coreos/flannel/releases) v0.5.3
+* [docker-gc](https://github.com/spotify/docker-gc)
 
 
 Ansible
 -------------------------
 ### Download binaries
 A role allows to download required binaries which will be stored in a directory defined by the variable
-'local_release_dir' (by default /tmp).
-Please ensure that you have enough disk space there (about 1G).
+**'local_release_dir'** (by default /tmp).
+Please ensure that you have enough disk space there (about **1G**).
 
-Note: Whenever you'll need to change the version of a software, you'll have to erase the content of this directory.
+**Note**: Whenever you'll need to change the version of a software, you'll have to erase the content of this directory.
 
 
 ### Variables
+The main variables to change are located in the directory ```environments/[env_name]/group_vars/k8s-cluster.yml```.
 
 ### Playbook
 ```
@@ -64,12 +65,13 @@ ansible-playbook -i environments/dev/inventory cluster.yml
 
 Kubernetes
 -------------------------
-### Check cluster status
 
 ### Network Overlay
 You can choose between 2 network overlays. Only one must be chosen.
-flannel: gre/vxlan (layer 2) networking
-calico: bgp (layer 3) networking.
+**flannel**: gre/vxlan (layer 2) networking
+**calico**: bgp (layer 3) networking.
+
+The choice is defined with the variable '**overlay_network_plugin**'
 
 ### Expose a service
 There are several loadbalancing solution.
@@ -82,13 +84,77 @@ Then Haproxy can be configured to request kubernetes's api in order to loadbalan
 
 Please refer to the proper kubernetes documentation on [Services]('https://github.com/kubernetes/kubernetes/blob/release-1.0/docs/user-guide/services.md')
 
+### Check cluster status
+
+#### Kubernetes components
+
+#### Calico networking
+Check if the calico-node container is running
+```
+docker ps | grep calico
+```
+
+The **calicoctl** command allows to check the status of the network workloads.
+* Check the status of Calico nodes
+```
+calicoctl status
+```
+
+* Show the configured network subnet for containers
+```
+calicoctl pool show
+```
+
+* Show the workloads (ip addresses of containers and where they're located)
+```
+calicoctl endpoint show --detail
+```
+#### Flannel networking
+
+#### Test dns server
+* Create a file 'busybox.yaml' with the following content
+```
+apiVersion: v1
+kind: Pod
+metadata:
+  name: busybox
+  namespace: default
+spec:
+  containers:
+  - image: busybox
+    command:
+      - sleep
+      - "3600"
+    imagePullPolicy: IfNotPresent
+    name: busybox
+  restartPolicy: Always
+```
+
+* Create the pod
+```
+kubectl create -f busybox.yaml
+```
+
+* When the pod is ready, execute the following command
+```
+kubectl exec busybox -- nslookup kubernetes.default
+```
+You should get an answer from the configured dns server
+
 Known issues
 -------------
 ### Node reboot and Calico
+There is a major issur with calico-kubernetes version 0.5.1 and kubernetes prior to 1.1 :
+After host reboot, the pods networking are not configured again, they are started without any network configuration.
+This issue will be fixed when kubernetes 1.1 will be released as described in this [issue]('https://github.com/projectcalico/calico-kubernetes/issues/34')
 
 ### Monitoring addon
+Until now i didn't managed to get the monitoring addon working.
 
-### Etcd failover
+### Listen on secure port only
+Currently the api-server listens on both secure and insecure ports.
+The insecure port is mainly used for calico.
+Will be fixed soon.
 
 Author Information
 ------------------