aboutsummaryrefslogtreecommitdiffstats
path: root/docs/oom_project_description.rst
diff options
context:
space:
mode:
authorefiacor <fiachra.corcoran@est.tech>2022-10-28 15:29:26 +0100
committerefiacor <fiachra.corcoran@est.tech>2022-11-07 08:17:35 +0000
commit0fb3b8f4d48a066259b8a9ea2a18d68d7644f8e5 (patch)
tree336e001b0b148d2b37e6afb1e80a767e8ac8f850 /docs/oom_project_description.rst
parent66789f218b8464f28a08572ef0c30dbfe40b13c5 (diff)
[RDT] Refactoring RTD
Major refactor Moved some old docs etc to archived dir Added sub section for guides Added section for deployment options etc Signed-off-by: efiacor <fiachra.corcoran@est.tech> Change-Id: I5832c7a94d58c3110655f0c676a5f2a19172dc68 Issue-ID: OOM-3028
Diffstat (limited to 'docs/oom_project_description.rst')
-rw-r--r--docs/oom_project_description.rst100
1 files changed, 0 insertions, 100 deletions
diff --git a/docs/oom_project_description.rst b/docs/oom_project_description.rst
deleted file mode 100644
index b672c48bc0..0000000000
--- a/docs/oom_project_description.rst
+++ /dev/null
@@ -1,100 +0,0 @@
-.. This work is licensed under a Creative Commons Attribution 4.0
-.. International License.
-.. http://creativecommons.org/licenses/by/4.0
-.. Copyright 2018-2020 Amdocs, Bell Canada, Orange, Samsung
-.. _oom_project_description:
-
-ONAP Operations Manager Project
-###############################
-
-The ONAP Operations Manager (OOM) is responsible for life-cycle management of
-the ONAP platform itself; components such as SO, SDNC, etc. It is not
-responsible for the management of services, VNFs or infrastructure instantiated
-by ONAP or used by ONAP to host such services or VNFs. OOM uses the open-source
-Kubernetes container management system as a means to manage the Docker
-containers that compose ONAP where the containers are hosted either directly on
-bare-metal servers or on VMs hosted by a 3rd party management system. OOM
-ensures that ONAP is easily deployable and maintainable throughout its life
-cycle while using hardware resources efficiently.
-
-.. figure:: images/oom_logo/oomLogoV2-medium.png
- :align: right
-
-In summary OOM provides the following capabilities:
-
-- **Deploy** - with built-in component dependency management
-- **Configure** - unified configuration across all ONAP components
-- **Monitor** - real-time health monitoring feeding to a Consul UI and
- Kubernetes
-- **Heal**- failed ONAP containers are recreated automatically
-- **Scale** - cluster ONAP services to enable seamless scaling
-- **Upgrade** - change-out containers or configuration with little or no
- service impact
-- **Delete** - cleanup individual containers or entire deployments
-
-OOM supports a wide variety of Kubernetes private clouds - built with Rancher,
-Kubeadm or Cloudify - and public cloud infrastructures such as: Microsoft
-Azure, Amazon AWS, Google GCD, VMware VIO, and OpenStack.
-
-The OOM documentation is broken into four different areas each targeted at a
-different user:
-
-- :ref:`quick-start-label` - deploy ONAP on an existing cloud
-- :ref:`user-guide-label` - a guide for operators of an ONAP instance
-- :ref:`developer-guide-label` - a guide for developers of OOM and ONAP
-- :ref:`cloud-setup-guide-label` - a guide for those setting up cloud
- environments that ONAP will use
-- :ref:`hardcoded-certificates-label` - the list of all hardcoded certificates
- set in ONAP installation
-
-The :ref:`release_notes` for OOM describe the incremental features per release.
-
-Component Orchestration Overview
-================================
-Multiple technologies, templates, and extensible plug-in frameworks are used in
-ONAP to orchestrate platform instances of software component artifacts. A few
-standard configurations are provide that may be suitable for test, development,
-and some production deployments by substitution of local or platform wide
-parameters. Larger and more automated deployments may require integration the
-component technologies, templates, and frameworks with a higher level of
-automated orchestration and control software. Design guidelines are provided to
-insure the component level templates and frameworks can be easily integrated
-and maintained. The following diagram provides an overview of these with links
-to examples and templates for describing new ones.
-
-.. graphviz::
-
- digraph COO {
- rankdir="LR";
-
- {
- node [shape=folder]
- oValues [label="values"]
- cValues [label="values"]
- comValues [label="values"]
- sValues [label="values"]
- oCharts [label="charts"]
- cCharts [label="charts"]
- comCharts [label="charts"]
- sCharts [label="charts"]
- blueprint [label="TOSCA blueprint"]
- }
- {oom [label="ONAP Operations Manager"]}
- {hlo [label="High Level Orchestrator"]}
-
-
- hlo -> blueprint
- hlo -> oom
- oom -> oValues
- oom -> oCharts
- oom -> component
- oom -> common
- common -> comValues
- common -> comCharts
- component -> cValues
- component -> cCharts
- component -> subcomponent
- subcomponent -> sValues
- subcomponent -> sCharts
- blueprint -> component
- }