Create a minimal environment file

[oom.git] / docs / oom_user_guide.rst

diff --git a/docs/oom_user_guide.rst b/docs/oom_user_guide.rst
index bb8ff0b..db410a6 100644 (file)
--- a/docs/oom_user_guide.rst
+++ b/docs/oom_user_guide.rst
@@ -63,7 +63,7 @@ Enter the following to install kubectl (on Ubuntu, there are slight differences
   > sudo mv ./kubectl /usr/local/bin/kubectl
   > mkdir ~/.kube
 
-Paste kubectl config from Rancher (see the :ref:`cloud-setup-guide-label` for alternative Kubenetes environment setups) into the `~/.kube/config` file.
+Paste kubectl config from Rancher (see the :ref:`cloud-setup-guide-label` for alternative Kubernetes environment setups) into the `~/.kube/config` file.
 
 Verify that the Kubernetes config is correct::
 
@@ -75,8 +75,8 @@ Install Helm
 ~~~~~~~~~~~~
 Helm is used by OOM for package and configuration management. To install Helm, enter the following::
 
-  > wget http://storage.googleapis.com/kubernetes-helm/helm-v2.7.2-linux-amd64.tar.gz
-  > tar -zxvf helm-v2.7.2-linux-amd64.tar.gz
+  > wget http://storage.googleapis.com/kubernetes-helm/helm-v2.9.1-linux-amd64.tar.gz
+  > tar -zxvf helm-v2.9.1-linux-amd64.tar.gz
   > sudo mv linux-amd64/helm /usr/local/bin/helm
 
 Verify the Helm version with::
@@ -108,7 +108,7 @@ stable which should be removed to avoid confusion::
 
 To prepare your system for an installation of ONAP, you'll need to::
 
-  > git clone http://gerrit.onap.org/r/oom
+  > git clone -b beijing http://gerrit.onap.org/r/oom
   > cd oom/kubernetes
 
 
@@ -196,7 +196,7 @@ Many technologies are used across the projects resulting in significant
 operational complexity and an inability to apply global parameters across the
 entire ONAP deployment. OOM solves this problem by introducing a common
 configuration technology, Helm charts, that provide a hierarchical
-configuration configuration with the ability to override values with higher
+configuration with the ability to override values with higher
 level charts or command line options.
 
 The structure of the configuration of ONAP is shown in the following diagram.
@@ -391,16 +391,28 @@ Ensure you've disabled any proxy settings the browser you are using to access
 the portal and then simply access the familiar URL:
 http://portal.api.simpledemo.onap.org:8989/ONAPPORTAL/login.htm
 
-.. note:: Alternatives Considered.
 
-  Kubernetes port forwarding was considered but discarded as it would require
-  the end user to run a script that opens up port forwarding tunnels to each of
-  the pods that provides a portal application widget.
+.. note::     
 
-  Reverting to a VNC server similar to what was deployed in the Amsterdam
-  release was also considered but there were many issues with resolution, lack
-  of volume mount, /etc/hosts dynamic update, file upload that were a tall order
-  to solve in time for the Beijing release.
+   | Alternatives Considered:
+
+   -  Kubernetes port forwarding was considered but discarded as it would require
+      the end user to run a script that opens up port forwarding tunnels to each of
+      the pods that provides a portal application widget.
+
+   -  Reverting to a VNC server similar to what was deployed in the Amsterdam
+      release was also considered but there were many issues with resolution, lack
+      of volume mount, /etc/hosts dynamic update, file upload that were a tall order
+      to solve in time for the Beijing release.
+
+   Observations:
+
+   -  If you are not using floating IPs in your Kubernetes deployment and directly attaching
+      a public IP address (i.e. by using your public provider network) to your K8S Node
+      VMs' network interface, then the output of 'kubectl -n onap get services | grep "portal-app"'
+      will show your public IP instead of the private network's IP. Therefore,
+      you can grab this public IP directly (as compared to trying to find the floating
+      IP first) and map this IP in /etc/hosts.
 
 .. figure:: oomLogoV2-Monitor.png
    :align: right
@@ -411,7 +423,7 @@ Monitor
 All highly available systems include at least one facility to monitor the
 health of components within the system.  Such health monitors are often used as
 inputs to distributed coordination systems (such as etcd, zookeeper, or consul)
-and monitoring systems (such as nagios or zabbix). OOM provides two mechanims
+and monitoring systems (such as nagios or zabbix). OOM provides two mechanisms
 to monitor the real-time health of an ONAP deployment:
 
 - a Consul GUI for a human operator or downstream monitoring systems and
@@ -420,10 +432,10 @@ to monitor the real-time health of an ONAP deployment:
 - a set of liveness probes which feed into the Kubernetes manager which
   are described in the Heal section.
 
-Within ONAP Consul is the monitoring system of choice and deployed by OOM in two parts:
+Within ONAP, Consul is the monitoring system of choice and deployed by OOM in two parts:
 
 - a three-way, centralized Consul server cluster is deployed as a highly
-  available monitor of all of the ONAP components,and
+  available monitor of all of the ONAP components, and
 - a number of Consul agents.
 
 The Consul server provides a user interface that allows a user to graphically
@@ -675,4 +687,4 @@ deployment enter::
 
 will remove `so` as the configuration indicates it's no longer part of the
 deployment. This might be useful if a one wanted to replace just `so` by
-installing a custom version.
+installing a custom version.