docs/OOM Project Description/oom_project_description.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
   2
   3 .. _onap-operations-manager-project:
   4
   5 ONAP Operations Manager Project
   6 ###############################
   7
   8 Introduction
   9 ============
  10
  11 The ONAP Operations Manager (OOM) is responsible for life-cycle
  12 management of the ONAP platform itself; components such as MSO, SDNC,
  13 etc. It is not responsible for the management of services, VNFs or
  14 infrastructure instantiated by ONAP or used by ONAP to host such
  15 services or VNFs. OOM uses the open-source Kubernetes container
  16 management system as a means to manage the Docker containers that
  17 compose ONAP where the containers are hosted either directly on
  18 bare-metal servers or on VMs hosted by a 3rd party management system.
  19 OOM ensures that ONAP is easily deployable and maintainable throughout
  20 its life cycle while using hardware resources efficiently.
  21
  22 Quick Start Guide
  23 =================
  24
  25 Once a kubernetes environment is available (check out `ONAP on Kubernetes <https://wiki.onap.org/display/DW/ONAP+on+Kubernetes>`__ if you're
  26 getting started) and the deployment artifacts have been customized for your location, ONAP is ready to be installed.
  27
  28 The first step is to setup
  29 the \ `/oom/kubernetes/config/onap-parameters.yaml <https://gerrit.onap.org/r/gitweb?p=oom.git;a=blob;f=kubernetes/config/onap-parameters.yaml;h=7ddaf4d4c3dccf2fad515265f0da9c31ec0e64b1;hb=refs/heads/master>`__
  30 file with key-value pairs specific to your OpenStack environment.  There is a
  31 `sample <https://gerrit.onap.org/r/gitweb?p=oom.git;a=blob;f=kubernetes/config/onap-parameters-sample.yaml;h=3a74beddbbf7f9f9ec8e5a6abaecb7cb238bd519;hb=refs/heads/master>`__
  32 that may help you out or even be usable directly if you don't intend to actually use OpenStack resources.
  33
  34 In-order to be able to support multiple ONAP instances within a single kubernetes environment a configuration set is required.
  35  The `createConfig.sh <https://gerrit.onap.org/r/gitweb?p=oom.git;a=blob;f=kubernetes/config/createConfig.sh;h=f226ccae47ca6de15c1da49be4b8b6de974895ed;hb=refs/heads/master>`__ script
  36 is used to do this.::
  37
  38   > ./createConfig.sh -n onapTrial
  39
  40 The bash script
  41 \ `createAll.bash <https://gerrit.onap.org/r/gitweb?p=oom.git;a=blob;f=kubernetes/oneclick/createAll.bash;h=5e5f2dc76ea7739452e757282e750638b4e3e1de;hb=refs/heads/master>`__ is
  42 used to create an ONAP deployment with kubernetes. It has two primary
  43 functions:
  44
  45 -  Creating the namespaces used to encapsulate the ONAP components, and
  46
  47 -  Creating the services, pods and containers within each of these
  48    namespaces that provide the core functionality of ONAP.
  49
  50 To deploy the containers and create your ONAP system enter::
  51
  52   > ./createAll.bash -n onapTrial
  53
  54 Namespaces provide isolation between ONAP components as ONAP release 1.0
  55 contains duplicate application (e.g. mariadb) and port usage. As
  56 such createAll.bash requires the user to enter a namespace prefix string
  57 that can be used to separate multiple deployments of onap. The result
  58 will be set of 10 namespaces (e.g. onapTrial-sdc, onapTrial-aai,
  59 onapTrial-mso, onapTrial-message-router, onapTrial-robot, onapTrial-vid,
  60 onapTrial-sdnc, onapTrial-portal, onapTrial-policy, onapTrial-appc)
  61 being created within the kubernetes environment.  A prerequisite pod
  62 config-init (\ `pod-config-init.yaml <https://gerrit.onap.org/r/gitweb?p=oom.git;a=blob;f=kubernetes/config/pod-config-init.yaml;h=b1285ce21d61815c082f6d6aa3c43d00561811c7;hb=refs/heads/master>`__)
  63 may need editing to match your environment and deployment into the
  64 default namespace before running createAll.bash.
  65
  66 Demo Video
  67 ----------
  68
  69 If you'd like to see the installation of ONAP by OOM take a look at this
  70 short video demonstration by Mike Elliott:
  71
  72 .. raw:: html
  73
  74    <video controls src="_static/OOM_Demo.mp4"></video>
  75
  76
  77 OOM Architecture and Technical Details
  78 ======================================
  79
  80 OOM uses the \ `Kubernetes  <http://kubernetes.io/>`__\ container
  81 management system to orchestrate the life cycle of the ONAP
  82 infrastructure components.  If you'd like to learn more about how this
  83 works or develop the deployment specifications for a project not already
  84 managed by OOM look here: \ `OOM User
  85 Guide <http://onap.readthedocs.io/en/latest/submodules/oom.git/docs/OOM%20User%20Guide/oom_user_guide.html>`__.
  86
  87
  88 Links to Further Information
  89 ============================
  90
  91 -  Configuration data for all of the ONAP sub-projects is distributed by
  92    OOM.  For more information on how this is done see: \ `OOM
  93    Configuration Management <https://wiki.onap.org/display/DW/OOM+Configuration+Management>`__.