Update git submodules
[doc.git] / docs / guides / onap-operator / platformoperations.rst
1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
2 .. http://creativecommons.org/licenses/by/4.0
3 .. Copyright 2017 AT&T Intellectual Property.  All rights reserved.
4
5
6 Platform Operations
7 ===================
8
9 .. toctree::
10    :maxdepth: 1
11    :titlesonly:
12
13 ONAP Operations
14 ---------------
15
16 Configuring, scaling and upgrading ONAP is supported by OOM and can
17 be found in:
18
19 .. toctree::
20    :maxdepth: 2
21    :titlesonly:
22
23    ../../submodules/oom.git/docs/oom_user_guide.rst
24
25 ONAP Testing and Monitoring
26 ---------------------------
27
28 Monitoring of ONAP depends on the deployment scenario.
29 Generally the infrastructure monitoring (Openstack, K8S) depends on the
30 platform ONAP is installed on.
31
32 Additionally ONAP supports the following additional tools to monitor ONAP
33 functions
34
35 **Basic Healthcheck of ONAP is supported by:**
36
37 .. toctree::
38    :maxdepth: 2
39    :titlesonly:
40
41    RobotFramework <../../submodules/integration.git/docs/docs_robot.rst>
42
43 **Interface Health can be checked via Consul:**
44
45    OOM provides two mechanisms to monitor the real-time health of an ONAP
46    deployment
47
48     * a Consul GUI for a human operator or downstream monitoring systems
49       and Kubernetes liveness probes that enable automatic healing of
50       failed containers, and
51     * a set of liveness probes which feed into the Kubernetes manager
52
53    Within ONAP, Consul is the monitoring system of choice and deployed
54    by OOM in two parts:
55
56     * a three-way, centralized Consul server cluster is deployed as a
57       highly available monitor of all of the ONAP components, and a number
58       of Consul agents.
59
60    The Consul server provides a user interface that allows a user to
61    graphically view the current health status of all of the ONAP components
62    for which agents have been created
63
64    The Consul GUI can be accessed via:
65
66    http://<kubernetes IP>:30270/ui/
67
68 **ONAP Log collection is provided by the Logging and Analytics Module:**
69
70 .. toctree::
71    :maxdepth: 2
72    :titlesonly:
73
74    Logging&Analytics <../../submodules/logging-analytics.git/docs/index.rst>
75
76 ONAP Backup and Restore
77 -----------------------
78
79 To Backup ONAP a solution is described in Wiki (Migration to RTD->TBD):
80
81 `Backup and Restore Solution <https://wiki.onap.org/display/DW/Backup+and+Restore+Solution%3A+ONAP-OOM>`_
82
83 ONAP Multisite Deployment
84 -------------------------
85
86 ONAP Multisite deployment, coordination and management is supported by
87 the MUSIC component:
88
89 .. toctree::
90    :maxdepth: 2
91    :titlesonly:
92
93    Multi-Site State Coordination <../../submodules/music.git/docs/index.rst>
94