diff options
| author |   Mike Elliott <mike.elliott@amdocs.com> | 2019-07-09 10:47:08 -0400 |
|---|---|---|
| committer | Mike Elliott <mike.elliott@amdocs.com> | 2019-07-09 12:28:45 -0400 |
| commit | 895ddcb8ab14660cea542b4312c90b18e0170b05 (patch) | |
| tree | 62956b102b19621a571693ae8c6def2ca6066cf0 | |
| parent | 737a17a3900d85d63fa34ea195d7c4bd4b45220b (diff) | |
Update quickstart guide
It has been determined that, in certain environments, readiness and liveness probe values need to be increased.
This improves reliability on the initial deployment of ONAP.
Addressed documentation feedback.
Issue-ID: OOM-1959
Signed-off-by: Mike Elliott <mike.elliott@amdocs.com>
Change-Id: I8cfb30b52e4bdbd6bab7756ec247c9574efcb503
| -rw-r--r-- | docs/oom_quickstart_guide.rst | 32 |
1 files changed, 25 insertions, 7 deletions
diff --git a/docs/oom_quickstart_guide.rst b/docs/oom_quickstart_guide.rst index ed71c97f10..a641fabf60 100644 --- a/docs/oom_quickstart_guide.rst +++ b/docs/oom_quickstart_guide.rst @@ -129,24 +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. - 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/environment.yaml -f onap/resources/overrides/openstack.yaml --timeout 900 - All override files may be customized (or replaced by other overrides) as per needs. +All override files may be customized (or replaced by other overrides) as per needs. +onap-all.yaml -**Step 9.** Commands to interact with the OOM installation + 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. -Use the following to monitor your deployment and determine when ONAP is -ready for use:: +environment.yaml + + Includes configuration values specific to the deployment environment. + + Example: adapt readiness and liveness timers to the level of performance of your infrastructure + +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.** Verify ONAP installation + +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 |