docs/sections/oom_project_description.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0
   2 .. International License.
   3 .. http://creativecommons.org/licenses/by/4.0
   4 .. Copyright 2018-2020 Amdocs, Bell Canada, Orange, Samsung
   5 .. Modification copyright (C) 2022 Nordix Foundation
   6
   7 .. _oom_project_description:
   8
   9 ONAP Operations Manager Project
  10 ###############################
  11
  12 .. warning::
  13
  14     THIS PAGE PROB NEEDS A REWRITE AS IT IS OUTDATED
  15
  16 The ONAP Operations Manager (OOM) is responsible for life-cycle management of
  17 the ONAP platform itself; components such as SO, SDNC, etc. It is not
  18 responsible for the management of services, VNFs or infrastructure instantiated
  19 by ONAP or used by ONAP to host such services or VNFs. OOM uses the open-source
  20 Kubernetes container management system as a means to manage the Docker
  21 containers that compose ONAP where the containers are hosted either directly on
  22 bare-metal servers or on VMs hosted by a 3rd party management system. OOM
  23 ensures that ONAP is easily deployable and maintainable throughout its life
  24 cycle while using hardware resources efficiently.
  25
  26 .. figure:: resources/images/oom_logo/oomLogoV2-medium.png
  27    :align: right
  28
  29 In summary OOM provides the following capabilities:
  30
  31 - **Deploy** - with built-in component dependency management
  32 - **Configure** - unified configuration across all ONAP components
  33 - **Monitor** - real-time health monitoring feeding to a Consul UI and
  34   Kubernetes
  35 - **Heal**- failed ONAP containers are recreated automatically
  36 - **Scale** - cluster ONAP services to enable seamless scaling
  37 - **Upgrade** - change-out containers or configuration with little or no
  38   service impact
  39 - **Delete** - cleanup individual containers or entire deployments
  40
  41 OOM supports a wide variety of Kubernetes private clouds - built with ClusterAPI,
  42 Kubespray - and public cloud infrastructures such as: Microsoft
  43 Azure, Amazon AWS, Google GCD, VMware VIO, and OpenStack.
  44
  45 The OOM documentation is broken into four different areas each targeted at a
  46 different user:
  47
  48 - :ref:`oom_dev_guide` - a guide for developers of OOM
  49 - :ref:`oom_infra_guide` - a guide for those setting up the environments that OOM will use
  50 - :ref:`oom_deploy_guide` - a guide for those deploying OOM on an existing cloud
  51 - :ref:`oom_user_guide` - a guide for operators of an OOM instance
  52 - :ref:`oom_access_info_guide` - a guide for operators who require access to OOM applications
  53
  54 The :ref:`release_notes` for OOM describe the incremental features per release.
  55
  56 Component Orchestration Overview
  57 ================================
  58 Multiple technologies, templates, and extensible plug-in frameworks are used in
  59 ONAP to orchestrate platform instances of software component artifacts. A few
  60 standard configurations are provide that may be suitable for test, development,
  61 and some production deployments by substitution of local or platform wide
  62 parameters. Larger and more automated deployments may require integration the
  63 component technologies, templates, and frameworks with a higher level of
  64 automated orchestration and control software. Design guidelines are provided to
  65 insure the component level templates and frameworks can be easily integrated
  66 and maintained. The following diagram provides an overview of these with links
  67 to examples and templates for describing new ones.
  68
  69 .. graphviz::
  70
  71    digraph COO {
  72       rankdir="LR";
  73
  74       {
  75          node      [shape=folder]
  76          oValues   [label="values"]
  77          cValues   [label="values"]
  78          comValues [label="values"]
  79          sValues   [label="values"]
  80          oCharts   [label="charts"]
  81          cCharts   [label="charts"]
  82          comCharts [label="charts"]
  83          sCharts   [label="charts"]
  84          blueprint [label="TOSCA blueprint"]
  85       }
  86       {oom [label="ONAP Operations Manager"]}
  87       {hlo [label="High Level Orchestrator"]}
  88
  89
  90       hlo -> blueprint
  91       hlo -> oom
  92       oom -> oValues
  93       oom -> oCharts
  94       oom -> component
  95       oom -> common
  96       common -> comValues
  97       common -> comCharts
  98       component -> cValues
  99       component -> cCharts
 100       component -> subcomponent
 101       subcomponent -> sValues
 102       subcomponent -> sCharts
 103       blueprint -> component
 104    }