From ea507b5bd5ac4bb84d839769908f5ebe3e36a4e4 Mon Sep 17 00:00:00 2001 From: rvyas Date: Mon, 25 Sep 2017 14:29:47 -0400 Subject: Adding seed document in OOM Fixed doc8 errors. All 3 rst files now pass validation. [OOM-313] Seed Documentation Change-Id: Id9952197a357f55f91326e828825f04b7d4e283c Signed-off-by: rvyas Signed-off-by: Mike Elliott --- .../oom_project_description.rst | 91 ++++++++++++++++++++++ 1 file changed, 91 insertions(+) create mode 100644 docs/OOM Project Description/oom_project_description.rst (limited to 'docs/OOM Project Description') diff --git a/docs/OOM Project Description/oom_project_description.rst b/docs/OOM Project Description/oom_project_description.rst new file mode 100644 index 0000000000..ba80769793 --- /dev/null +++ b/docs/OOM Project Description/oom_project_description.rst @@ -0,0 +1,91 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. + +ONAP Operations Manager Project +############################### + +Introduction +============ + +The ONAP Operations Manager (OOM) is responsible for life-cycle +management of the ONAP platform itself; components such as MSO, 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.  + +Quick Start Guide +================= + +Once a kubernetes environment is available (check out `ONAP on Kubernetes `__ if you're +getting started) and the deployment artifacts have been customized for your location, ONAP is ready to be installed.  + +The first step is to setup +the \ `/oom/kubernetes/config/onap-parameters.yaml `__ +file with key-value pairs specific to your OpenStack environment.  There is a +`sample `__ +that may help you out or even be usable directly if you don't intend to actually use OpenStack resources. + +In-order to be able to support multiple ONAP instances within a single kubernetes environment a configuration set is required. + The `createConfig.sh `__ script +is used to do this.:: + + > ./createConfig.sh -n onapTrial + +The bash script  +\ `createAll.bash `__ is +used to create an ONAP deployment with kubernetes. It has two primary +functions: + +- Creating the namespaces used to encapsulate the ONAP components, and + +- Creating the services, pods and containers within each of these + namespaces that provide the core functionality of ONAP. + +To deploy the containers and create your ONAP system enter:: + + > ./createAll.bash -n onapTrial + +Namespaces provide isolation between ONAP components as ONAP release 1.0 +contains duplicate application (e.g. mariadb) and port usage. As +such createAll.bash requires the user to enter a namespace prefix string +that can be used to separate multiple deployments of onap. The result +will be set of 10 namespaces (e.g. onapTrial-sdc, onapTrial-aai, +onapTrial-mso, onapTrial-message-router, onapTrial-robot, onapTrial-vid, +onapTrial-sdnc, onapTrial-portal, onapTrial-policy, onapTrial-appc) +being created within the kubernetes environment.  A prerequisite pod +config-init (\ `pod-config-init.yaml `__) +may need editing to match your environment and deployment into the +default namespace before running createAll.bash. + +Demo Video +---------- + +If you'd like to see the installation of ONAP by OOM take a look at this +short video demonstration by Mike Elliott:  + +.. raw:: html + + + + +OOM Architecture and Technical Details +====================================== + +OOM uses the \ `Kubernetes  `__\ container +management system to orchestrate the life cycle of the ONAP +infrastructure components.  If you'd like to learn more about how this +works or develop the deployment specifications for a project not already +managed by OOM look here: \ `OOM User +Guide `__. + + +Links to Further Information +============================ + +- Configuration data for all of the ONAP sub-projects is distributed by + OOM.  For more information on how this is done see: \ `OOM + Configuration Management `__. -- cgit 1.2.3-korg