X-Git-Url: https://gerrit.onap.org/r/gitweb?a=blobdiff_plain;ds=sidebyside;f=docs%2Foom_user_guide.rst;h=3743f5b7d783e5e21f7323c33098bb13102d5452;hb=refs%2Fchanges%2F58%2F117858%2F3;hp=8a7ebfcb253620783f921896ee81e511da563b58;hpb=182aa9ea882d44202439f6cd1c9f8b5b1fd4583b;p=oom.git diff --git a/docs/oom_user_guide.rst b/docs/oom_user_guide.rst index 8a7ebfcb25..3743f5b7d7 100644 --- a/docs/oom_user_guide.rst +++ b/docs/oom_user_guide.rst @@ -12,7 +12,8 @@ .. _Helm Documentation: https://docs.helm.sh/helm/ .. _Helm: https://docs.helm.sh/ .. _Kubernetes: https://Kubernetes.io/ -.. _Kubernetes LoadBalancer: https://kubernetes.io/docs/concepts/services-networking/service/#type-loadbalancer +.. _Kubernetes LoadBalancer: https://kubernetes.io/docs/concepts/services-networking/service/#loadbalancer +.. _`Docker installation guide`: https://docs.docker.com/engine/install/ .. _user-guide-label: OOM User Guide @@ -55,8 +56,12 @@ ONAP with a few simple commands. Pre-requisites -------------- -Your environment must have both the Kubernetes `kubectl` and Helm setup as a -one time activity. +Your environment must have Docker installed as well as both the Kubernetes +`kubectl` and Helm setup as a one time activity. + +Install Docker +~~~~~~~~~~~~~~ +Follow official `Docker installation guide`_. Install Kubectl ~~~~~~~~~~~~~~~ @@ -139,19 +144,24 @@ To get a list of all of the available Helm chart repositories:: Then build your local Helm repository:: - > make SKIP_LINT=TRUE all + > make SKIP_LINT=TRUE [HELM_BIN=] all + +`HELM_BIN` + Sets the helm binary to be used. The default value use helm from PATH. + Allow the user to have multiple version of helm in operating system and + choose which one to use. The Helm search command reads through all of the repositories configured on the system, and looks for matches:: > helm search -l NAME VERSION DESCRIPTION - local/appc 2.0.0 Application Controller - local/clamp 2.0.0 ONAP Clamp - local/common 2.0.0 Common templates for inclusion in other charts - local/onap 2.0.0 Open Network Automation Platform (ONAP) - local/robot 2.0.0 A helm Chart for kubernetes-ONAP Robot - local/so 2.0.0 ONAP Service Orchestrator + local/appc 7.0.0 Application Controller + local/clamp 7.0.0 ONAP Clamp + local/common 7.0.0 Common templates for inclusion in other charts + local/onap 7.0.0 Open Network Automation Platform (ONAP) + local/robot 7.0.0 A helm Chart for kubernetes-ONAP Robot + local/so 7.0.0 ONAP Service Orchestrator In any case, setup of the Helm repository is a one time activity. @@ -410,7 +420,7 @@ below:: Ensure you've disabled any proxy settings the browser you are using to access the portal and then simply access now the new ssl-encrypted URL: -https://portal.api.simpledemo.onap.org:30225/ONAPPORTAL/login.htm +``https://portal.api.simpledemo.onap.org:30225/ONAPPORTAL/login.htm`` .. note:: Using the HTTPS based Portal URL the Browser needs to be configured to accept @@ -477,7 +487,7 @@ have been created - a sample from the ONAP Integration labs follows: .. figure:: consulHealth.png :align: center -To see the real-time health of a deployment go to: http://:30270/ui/ +To see the real-time health of a deployment go to: ``http://:30270/ui/`` where a GUI much like the following will be found: