summaryrefslogtreecommitdiffstats
path: root/docs/guides/onap-operator/platformoperations.rst
blob: edde9aed84c2f756167ebb7401542187c91314e6 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
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>