Update readme

JIRA: MODELS-2

Change-Id: Ibf8512ee96202aa32029ab5ef29f72e08d635440
Signed-off-by: Bryan Sullivan <bryan.sullivan@att.com>

diff --git a/tools/kubernetes/README.md b/tools/kubernetes/README.md
index b8c81f2..fa6ca5c 100644 (file)
--- a/tools/kubernetes/README.md
+++ b/tools/kubernetes/README.md
@@ -1,17 +1,7 @@
-This folder contains scripts etc to setup a kubernetes cluster with the following type of environment and components:
-* hardware
-  * 2 or more bare metal servers
-  * two connected networks (public and private): may work if just a single network
-  * one or more disks on each server: ceph-osd can be setup on an unused disk, or a folder (/ceph) on the host OS disk
-* kubernetes
-  * single master (admin) node
-  * other cluster nodes
-* ceph: ceph-mon on admin, ceph-osd on other nodes
-* helm on admin node
-* demo helm charts, cloned from https://github.com/kubernetes/charts and modified/tested to work on this cluster
-
-See comments in [setup script](k8s-cluster.sh) for more info.
-
-This is a work in progress!
-
-![Resulting Cluster](/docs/images/models-k8s.png?raw=true "Resulting Cluster")
+This folder contains scripts etc to setup a kubernetes cluster with the following type of environment and components:\r
+* hardware\r
+  * 2 or more bare metal servers\r  * two connected networks (public and private): may work if just a single network\r  * one or more disks on each server: ceph-osd can be setup on an unused disk, or a folder (/ceph) on the host OS disk\r* Kubernetes\r  * single k8s master (admin) node\r  * other cluster (k8s worker) nodes\r* Ceph: backend for persistent volume claims (PVCs) for the k8s cluster, deployed using Helm charts from https://github.com/att/netarbiter\r* Helm on k8s master (used for initial cluster deployment only)\r  * demo helm charts for Helm install verification etc, cloned from https://github.com/kubernetes/charts and modified/tested to work on this cluster\r* Prometheus: server on the k8s master, exporters on the k8s workers\r* Cloudify CLI and Cloudify Manager with Kubernetes plugin (https://github.com/cloudify-incubator/cloudify-kubernetes-plugin)\r* OPNFV VES Collector and Agent\r* OPNFV Barometer collectd plugin with libvirt and kafka support\r* As many components as possible above will be deployed using k8s charts, managed either through Helm or Cloudify\r\r
+A larger goal of this work is to demonstrate hybrid cloud deployment as indicated by the presence of OpenStack nodes in the diagram below.\r\r
+See comments in [setup script](k8s-cluster.sh) and other scripts in the for more info.\r\r
+This is a work in progress!\r\r
+![Resulting Cluster](/docs/images/models-k8s.png?raw=true "Resulting Cluster")\r\r