X-Git-Url: https://gerrit.onap.org/r/gitweb?a=blobdiff_plain;f=docs%2Foom_quickstart_guide.rst;h=a641fabf607e99cdd6cada65ea24a73a5caed700;hb=fe8c46d5556541c90600e4f2903e63ac783addf0;hp=501deda7e48ccff497694e55e3d57ece1facb697;hpb=47ad13899b9b91cc7266c93e1635ab97550a784e;p=oom.git diff --git a/docs/oom_quickstart_guide.rst b/docs/oom_quickstart_guide.rst index 501deda7e4..a641fabf60 100644 --- a/docs/oom_quickstart_guide.rst +++ b/docs/oom_quickstart_guide.rst @@ -83,7 +83,8 @@ ROBOT uses in Dublin. OS_PASSWORD=XXXX_OS_CLEARTESTPASSWORD_XXXX git clone http://gerrit.onap.org/r/integration - cd integration/deployment/heat/onap-oom/scripts + + cd integration/deployment/heat/onap-rke/scripts javac Crypto.java java Crypto "$OS_PASSWORD" "$SO_ENCRYPTION_KEY" @@ -128,32 +129,42 @@ single command The --timeout 900 is currently required in Dublin to address long running initialization tasks for DMaaP and SO. Without this timeout value both applications may fail to deploy. - a. To deploy all ONAP applications use this command:: +To deploy all ONAP applications use this command:: > cd oom/kubernetes - > helm deploy dev local/onap --namespace onap -f onap/resources/overrides/onap-all.yaml -f onap/resources/overrides/openstack.yaml --timeout 900 + > helm deploy dev local/onap --namespace onap -f onap/resources/overrides/onap-all.yaml -f onap/resources/overrides/environment.yaml -f onap/resources/overrides/openstack.yaml --timeout 900 + +All override files may be customized (or replaced by other overrides) as per needs. + +onap-all.yaml - b. If you are using a custom override (e.g. integration-override.yaml) use this command:: + Enables the modules in the ONAP deployment. As ONAP is very modular, it is possible to customize ONAP and disable some components through this configuration file. - > helm deploy dev local/onap -f /root/integration-override.yaml --namespace onap --timeout 900 +environment.yaml + Includes configuration values specific to the deployment environment. - c. If you have a slower cloud environment you may want to use the public-cloud.yaml - which has longer delay intervals on database updates.:: + Example: adapt readiness and liveness timers to the level of performance of your infrastructure - > helm deploy dev local/onap -f /root/oom/kubernetes/onap/resources/environments/public-cloud.yaml -f /root/integration-override.yaml --namespace onap --timeout 900 +openstack.yaml + Includes all the Openstack related information for the default target tenant you want to use to deploy VNFs from ONAP and/or additional parameters for the embedded tests. -**Step 9.** Commands to interact with the OOM installation +**Step 9.** Verify ONAP installation -Use the following to monitor your deployment and determine when ONAP is -ready for use:: +Use the following to monitor your deployment and determine when ONAP is ready for use:: > kubectl get pods -n onap -o=wide -Undeploying onap can be done using the following command:: +.. note:: + While all pods may be in a Running state, it is not a guarantee that all components are running fine. + + Launch the healthcheck tests using Robot to verify that the components are healthy. + + > ~/oom/kubernetes/robot/ete-k8s.sh onap health - > helm undeploy dev --purge +**Step 10.** Undeploy ONAP +> helm undeploy dev --purge More examples of using the deploy and undeploy plugins can be found here: https://wiki.onap.org/display/DW/OOM+Helm+%28un%29Deploy+plugins