diff options
| -rw-r--r-- | docs/guides/onap-developer/architecture/index.rst | 4 | ||||
| -rw-r--r-- | docs/guides/onap-operator/cloud_site/aws/index.rst (renamed from docs/guides/onap-user/cloud_site/aws/index.rst) | 0 | ||||
| -rw-r--r-- | docs/guides/onap-operator/cloud_site/azure/index.rst (renamed from docs/guides/onap-user/cloud_site/azure/index.rst) | 0 | ||||
| -rw-r--r-- | docs/guides/onap-operator/cloud_site/index.rst (renamed from docs/guides/onap-user/cloud_site/index.rst) | 0 | ||||
| -rw-r--r-- | docs/guides/onap-operator/cloud_site/k8s/index.rst (renamed from docs/guides/onap-user/cloud_site/k8s/index.rst) | 0 | ||||
| -rw-r--r-- | docs/guides/onap-operator/cloud_site/openstack/index.rst (renamed from docs/guides/onap-user/cloud_site/openstack/index.rst) | 0 | ||||
| -rw-r--r-- | docs/guides/onap-operator/cloud_site/vmware/index.rst (renamed from docs/guides/onap-user/cloud_site/vmware/index.rst) | 0 | ||||
| -rw-r--r-- | docs/guides/onap-operator/index.rst | 18 | ||||
| -rw-r--r-- | docs/guides/onap-operator/platformoperations.rst | 94 | ||||
| -rw-r--r-- | docs/guides/onap-operator/settingup/index.rst (renamed from docs/guides/onap-developer/settingup/index.rst) | 0 | ||||
| -rw-r--r-- | docs/guides/onap-operator/settingup/nodeports.csv (renamed from docs/guides/onap-developer/settingup/nodeports.csv) | 0 | ||||
| -rw-r--r-- | docs/guides/onap-user/index.rst | 2 | ||||
| -rw-r--r-- | docs/guides/onap-user/platformoperations.rst | 17 | ||||
| -rw-r--r-- | docs/index.rst | 18 |
14 files changed, 121 insertions, 32 deletions
diff --git a/docs/guides/onap-developer/architecture/index.rst b/docs/guides/onap-developer/architecture/index.rst index d4f38d9cf..34e0bb356 100644 --- a/docs/guides/onap-developer/architecture/index.rst +++ b/docs/guides/onap-developer/architecture/index.rst @@ -7,8 +7,8 @@ .. _doc-architecture: -Architecture -============ +ONAP Architecture +================= .. toctree:: :maxdepth: 2 diff --git a/docs/guides/onap-user/cloud_site/aws/index.rst b/docs/guides/onap-operator/cloud_site/aws/index.rst index c04886396..c04886396 100644 --- a/docs/guides/onap-user/cloud_site/aws/index.rst +++ b/docs/guides/onap-operator/cloud_site/aws/index.rst diff --git a/docs/guides/onap-user/cloud_site/azure/index.rst b/docs/guides/onap-operator/cloud_site/azure/index.rst index 17cfa59da..17cfa59da 100644 --- a/docs/guides/onap-user/cloud_site/azure/index.rst +++ b/docs/guides/onap-operator/cloud_site/azure/index.rst diff --git a/docs/guides/onap-user/cloud_site/index.rst b/docs/guides/onap-operator/cloud_site/index.rst index 89f730055..89f730055 100644 --- a/docs/guides/onap-user/cloud_site/index.rst +++ b/docs/guides/onap-operator/cloud_site/index.rst diff --git a/docs/guides/onap-user/cloud_site/k8s/index.rst b/docs/guides/onap-operator/cloud_site/k8s/index.rst index ee8fd3da6..ee8fd3da6 100644 --- a/docs/guides/onap-user/cloud_site/k8s/index.rst +++ b/docs/guides/onap-operator/cloud_site/k8s/index.rst diff --git a/docs/guides/onap-user/cloud_site/openstack/index.rst b/docs/guides/onap-operator/cloud_site/openstack/index.rst index 8688ff396..8688ff396 100644 --- a/docs/guides/onap-user/cloud_site/openstack/index.rst +++ b/docs/guides/onap-operator/cloud_site/openstack/index.rst diff --git a/docs/guides/onap-user/cloud_site/vmware/index.rst b/docs/guides/onap-operator/cloud_site/vmware/index.rst index ba7f9619e..ba7f9619e 100644 --- a/docs/guides/onap-user/cloud_site/vmware/index.rst +++ b/docs/guides/onap-operator/cloud_site/vmware/index.rst diff --git a/docs/guides/onap-operator/index.rst b/docs/guides/onap-operator/index.rst new file mode 100644 index 000000000..e464c2407 --- /dev/null +++ b/docs/guides/onap-operator/index.rst @@ -0,0 +1,18 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 +.. International License. http://creativecommons.org/licenses/by/4.0 +.. Copyright 2017 AT&T Intellectual Property. All rights reserved. + +.. _operation_guides: + +Operations and Administration Guides +==================================== +The following guides are provided to describe tasks that an adminitrator and +operator of ONAP need to perform when installing, monitoring and operating +an instance of ONAP. + +.. toctree:: + :maxdepth: 1 + + settingup/index.rst + platformoperations.rst + cloud_site/index.rst diff --git a/docs/guides/onap-operator/platformoperations.rst b/docs/guides/onap-operator/platformoperations.rst new file mode 100644 index 000000000..edde9aed8 --- /dev/null +++ b/docs/guides/onap-operator/platformoperations.rst @@ -0,0 +1,94 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. Copyright 2017 AT&T Intellectual Property. All rights reserved. + + +Platform Operations +=================== + +.. toctree:: + :maxdepth: 1 + :titlesonly: + +ONAP Operations +--------------- + +Configuring, scaling and upgrading ONAP is supported by OOM and can +be found in: + +.. toctree:: + :maxdepth: 2 + :titlesonly: + + ../../submodules/oom.git/docs/oom_user_guide.rst + +ONAP Testing and Monitoring +--------------------------- + +Monitoring of ONAP depends on the deployment scenario. +Generally the infrastructure monitoring (Openstack, K8S) depends on the +platform ONAP is installed on. + +Additionally ONAP supports the following additional tools to monitor ONAP +functions + +**Basic Healthcheck of ONAP is supported by:** + +.. toctree:: + :maxdepth: 2 + :titlesonly: + + RobotFramework <../../submodules/integration.git/docs/docs_robot.rst> + +**Interface Health can be checked via Consul:** + + 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 Kubernetes liveness probes that enable automatic healing of + failed containers, and + * a set of liveness probes which feed into the Kubernetes manager + + 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 a number + of Consul agents. + + 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 + + The Consul GUI can be accessed via: + + http://<kubernetes IP>:30270/ui/ + +**ONAP Log collection is provided by the Logging and Analytics Module:** + +.. toctree:: + :maxdepth: 2 + :titlesonly: + + Logging&Analytics <../../submodules/logging-analytics.git/docs/index.rst> + +ONAP Backup and Restore +----------------------- + +To Backup ONAP a solution is described in Wiki (Migration to RTD->TBD): + +`Backup and Restore Solution <https://wiki.onap.org/display/DW/Backup+and+Restore+Solution%3A+ONAP-OOM>`_ + +ONAP Multisite Deployment +------------------------- + +ONAP Multisite deployment, coordination and management is supported by +the MUSIC component: + +.. toctree:: + :maxdepth: 2 + :titlesonly: + + Multi-Site State Coordination <../../submodules/music.git/docs/index.rst> + diff --git a/docs/guides/onap-developer/settingup/index.rst b/docs/guides/onap-operator/settingup/index.rst index f96388891..f96388891 100644 --- a/docs/guides/onap-developer/settingup/index.rst +++ b/docs/guides/onap-operator/settingup/index.rst diff --git a/docs/guides/onap-developer/settingup/nodeports.csv b/docs/guides/onap-operator/settingup/nodeports.csv index 2fb6a2c24..2fb6a2c24 100644 --- a/docs/guides/onap-developer/settingup/nodeports.csv +++ b/docs/guides/onap-operator/settingup/nodeports.csv diff --git a/docs/guides/onap-user/index.rst b/docs/guides/onap-user/index.rst index 5e90a1ee8..c431b3190 100644 --- a/docs/guides/onap-user/index.rst +++ b/docs/guides/onap-user/index.rst @@ -14,8 +14,6 @@ an instance of ONAP. :maxdepth: 1 onapportal.rst - platformoperations.rst - cloud_site/index.rst design/index.rst instantiate/index.rst configure/index.rst diff --git a/docs/guides/onap-user/platformoperations.rst b/docs/guides/onap-user/platformoperations.rst deleted file mode 100644 index e7cf55ed7..000000000 --- a/docs/guides/onap-user/platformoperations.rst +++ /dev/null @@ -1,17 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 -.. Copyright 2017 AT&T Intellectual Property. All rights reserved. - - -Platform Operations -=================== - -.. toctree:: - :maxdepth: 1 - :titlesonly: - - ../../../submodules/oom.git/docs/oom_cloud_setup_guide.rst - ../../../submodules/oom.git/docs/oom_quickstart_guide.rst - ../../../submodules/oom.git/docs/oom_user_guide.rst - - Testing ONAP with RobotFramework <../../submodules/integration.git/docs/docs_robot.rst> diff --git a/docs/index.rst b/docs/index.rst index 4b6262350..64ff88783 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -39,20 +39,16 @@ Please find some guidance here on the content of ONAP documentation: | | We can learn what functionalities ONAP provides and how the certain components in ONAP | | | operate together. | +---------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ - | :ref:`Setting Up ONAP <installing-onap>` | Installation guidelines and requirements help the very first set up of an | - | | ONAP environment. The ONAP Operations Manager Cloud setup Guide and the | - | | ONAP Operations Manager Quick Start Guide support the deployment and installation activities. | + | :ref:`Operations and Adminstration Guides <operation_guides>` | ONAP Platform operation and adminstration cover the configuration and installation of ONAP, | + | | its management, monitoring and other operational tasks (integration, user management,...) | + +---------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ + | :ref:`User Guides <user-guides>` | The User Guides focus on tasks to administer Services using ONAP, covering Service Design, | + | | instantiation and their management using control loops | +---------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ | :ref:`Developer Guides <ONAP_developer_guides>` | Developers contributing to the ONAP development can find crucial information | | | in the Developer Guides. The reader can search among the developers’ topics | | | in alphabetical order. | +---------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ - | :ref:`User Guides <user-guides>` | The User Guides provide details on the ONAP portal, which portal integrates | - | | numerous different ONAP applications at one place. Platform operations are | - | | supported with ONAP Operations Quick Start Guide and with an ONAP Operations | - | | User Guide. The instantiation and the management of resources and the services | - | | are supported with a Service Design Guide and with guidelines on Service Deployment. | - +---------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ | :ref:`VNF/PNF Requirements and Guidelines <vnf_pnf_reqs>` | Harmonized VNF and PNF requirements and reduced customization of onboarding VNFs | | | and PNFs can accelerate the optimal usage of this ONAP environment. The guidelines | | | on VNF/PNF requirements facilitates synchronized and aligned activities for all participants. | @@ -69,7 +65,7 @@ Please find some guidance here on the content of ONAP documentation: guides/overview/index guides/onap-developer/architecture/index guides/onap-developer/developing/index - guides/onap-developer/settingup/index - guides/onap-developer/index + guides/onap-operator/index guides/onap-user/index + guides/onap-developer/index guides/onap-provider/index |