X-Git-Url: https://gerrit.onap.org/r/gitweb?a=blobdiff_plain;f=docs%2Foom_user_guide.rst;h=0835a93c75eff48faa192caf07080ff74d1e825f;hb=1660a8c5518c45b8a424b15b8c63b71ae0b39c69;hp=019d84363f9e8a17436786b07544541b47e4147f;hpb=7ffea7fdc885fe74a4884f94ee1a2baa1b29b74d;p=oom.git diff --git a/docs/oom_user_guide.rst b/docs/oom_user_guide.rst index 019d84363f..0835a93c75 100644 --- a/docs/oom_user_guide.rst +++ b/docs/oom_user_guide.rst @@ -27,7 +27,7 @@ This guide provides many examples of Helm command line operations. For a complete description of these commands please refer to the `Helm Documentation`_. -.. figure:: oomLogoV2-medium.png +.. figure:: images/oom_logo/oomLogoV2-medium.png :align: right The following sections describe the life-cycle operations: @@ -41,7 +41,7 @@ The following sections describe the life-cycle operations: impact - Delete_ - cleanup individual containers or entire deployments -.. figure:: oomLogoV2-Deploy.png +.. figure:: images/oom_logo/oomLogoV2-Deploy.png :align: right Deploy @@ -55,7 +55,7 @@ ONAP with a few simple commands. Pre-requisites -------------- -Your environment must have the Kubernetes `kubectl` with Cert-Manager +Your environment must have the Kubernetes `kubectl` with Strimzi Apache Kafka, Cert-Manager and Helm setup as a one time activity. Install Kubectl @@ -78,11 +78,6 @@ Verify that the Kubernetes config is correct:: At this point you should see Kubernetes pods running. -Install Cert-Manager -~~~~~~~~~~~~~~~~~~~~ -Details on how to install Cert-Manager can be found -:doc:`here `. - Install Helm ~~~~~~~~~~~~ Helm is used by OOM for package and configuration management. To install Helm, @@ -96,6 +91,16 @@ Verify the Helm version with:: > helm version +Install Strimzi Apache Kafka Operator +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Details on how to install Strimzi Apache Kafka can be found +:doc:`here `. + +Install Cert-Manager +~~~~~~~~~~~~~~~~~~~~ +Details on how to install Cert-Manager can be found +:doc:`here `. + Install the Helm Repo --------------------- Once kubectl and Helm are setup, one needs to setup a local Helm server to @@ -216,7 +221,7 @@ To display details of a specific resource or group of resources type:: where the pod identifier refers to the auto-generated pod identifier. -.. figure:: oomLogoV2-Configure.png +.. figure:: images/oom_logo/oomLogoV2-Configure.png :align: right Configure @@ -316,7 +321,7 @@ To deploy ONAP with this environment file, enter:: > helm deploy local/onap -n onap -f onap/resources/environments/onap-production.yaml --set global.masterPassword=password -.. include:: environments_onap_demo.yaml +.. include:: yaml/environments_onap_demo.yaml :code: yaml When deploying all of ONAP, the dependencies section of the Chart.yaml file @@ -459,7 +464,7 @@ the portal and then simply access now the new ssl-encrypted URL: 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 +.. figure:: images/oom_logo/oomLogoV2-Monitor.png :align: right Monitor @@ -488,7 +493,7 @@ The Consul server provides a user interface that allows a user to graphically view the current health status of all of the ONAP components for which agents have been created - a sample from the ONAP Integration labs follows: -.. figure:: consulHealth.png +.. figure:: images/consul/consulHealth.png :align: center To see the real-time health of a deployment go to: ``http://:30270/ui/`` @@ -498,7 +503,7 @@ where a GUI much like the following will be found: If Consul GUI is not accessible, you can refer this `kubectl port-forward `_ method to access an application -.. figure:: oomLogoV2-Heal.png +.. figure:: images/oom_logo/oomLogoV2-Heal.png :align: right Heal @@ -527,7 +532,7 @@ creation of a replacement pod:: > kubectl get pods --all-namespaces -o=wide -.. figure:: oomLogoV2-Scale.png +.. figure:: images/oom_logo/oomLogoV2-Scale.png :align: right Scale @@ -621,7 +626,7 @@ even if the pods are physically distributed across multiple nodes. An example of how these capabilities can be used is described in the Running Consul on Kubernetes tutorial. -.. figure:: oomLogoV2-Upgrade.png +.. figure:: images/oom_logo/oomLogoV2-Upgrade.png :align: right Upgrade @@ -751,7 +756,7 @@ release v1.1.2: The previous so pod will be terminated and a new so pod with an updated so container will be created. -.. figure:: oomLogoV2-Delete.png +.. figure:: images/oom_logo/oomLogoV2-Delete.png :align: right Delete