X-Git-Url: https://gerrit.onap.org/r/gitweb?a=blobdiff_plain;f=docs%2Foom_developer_guide.rst;h=8df8e74acd3e9e7f88d8a02dd8d1470f81ac5409;hb=1660a8c5518c45b8a424b15b8c63b71ae0b39c69;hp=3d8cdb11288eebfb086c131fb0ac1855cb11ad4c;hpb=c4e405f6f408d7a61baa8a8d9563e598dddbb7bc;p=oom.git diff --git a/docs/oom_developer_guide.rst b/docs/oom_developer_guide.rst index 3d8cdb1128..8df8e74acd 100644 --- a/docs/oom_developer_guide.rst +++ b/docs/oom_developer_guide.rst @@ -22,7 +22,7 @@ OOM Developer Guide ################### -.. figure:: oomLogoV2-medium.png +.. figure:: images/oom_logo/oomLogoV2-medium.png :align: right ONAP consists of a large number of components, each of which are substantial @@ -85,7 +85,6 @@ The top level of the ONAP charts is shown below: common ├── cassandra │   ├── Chart.yaml - │   ├── requirements.yaml │   ├── resources │   │   ├── config │   │   │   └── docker-entrypoint.sh @@ -121,14 +120,14 @@ The top level of the ONAP charts is shown below: ├── ... └── postgres-legacy    ├── Chart.yaml -   ├── requirements.yaml ├── charts └── configs The common section of charts consists of a set of templates that assist with -parameter substitution (`_name.tpl`, `_namespace.tpl` and others) and a set of charts -for components used throughout ONAP. When the common components are used by other charts they -are instantiated each time or we can deploy a shared instances for several components. +parameter substitution (`_name.tpl`, `_namespace.tpl` and others) and a set of +charts for components used throughout ONAP. When the common components are used +by other charts they are instantiated each time or we can deploy a shared +instances for several components. All of the ONAP components have charts that follow the pattern shown below: @@ -136,7 +135,6 @@ All of the ONAP components have charts that follow the pattern shown below: name-of-my-component ├── Chart.yaml - ├── requirements.yaml ├── component │   └── subcomponent-folder ├── charts @@ -181,7 +179,7 @@ This choice is done in root `values.yaml`: component2: enabled: true -Then in `requirements.yaml`, you'll use these values: +Then in `Chart.yaml` dependencies section, you'll use these values: .. code-block:: yaml @@ -689,7 +687,7 @@ The relationship between these objects is shown in the following figure: .. database PV .. @enduml -.. figure:: kubernetes_objects.png +.. figure:: images/k8s/kubernetes_objects.png OOM uses these Kubernetes objects as described in the following sections. @@ -1076,7 +1074,7 @@ MSB Integration with OOM ------------------------ A preliminary view of the OOM-MSB integration is as follows: -.. figure:: MSB-OOM-Diagram.png +.. figure:: images/msb/MSB-OOM-Diagram.png A message sequence chart of the registration process: