X-Git-Url: https://gerrit.onap.org/r/gitweb?a=blobdiff_plain;f=docs%2Foom_developer_guide.rst;h=8df8e74acd3e9e7f88d8a02dd8d1470f81ac5409;hb=1660a8c5518c45b8a424b15b8c63b71ae0b39c69;hp=3cced83f62e4a917a05615becbe7de70743533ec;hpb=33c2105e28a74b72dc10acee8997f51462f6be0f;p=oom.git diff --git a/docs/oom_developer_guide.rst b/docs/oom_developer_guide.rst index 3cced83f62..8df8e74acd 100644 --- a/docs/oom_developer_guide.rst +++ b/docs/oom_developer_guide.rst @@ -1,13 +1,14 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. This work is licensed under a Creative Commons Attribution 4.0 +.. International License. .. http://creativecommons.org/licenses/by/4.0 -.. Copyright 2018 Amdocs, Bell Canada +.. Copyright 2018-2020 Amdocs, Bell Canada, Orange, Samsung .. Links .. _Helm: https://docs.helm.sh/ .. _Helm Charts: https://github.com/kubernetes/charts .. _Kubernetes: https://Kubernetes.io/ .. _Docker: https://www.docker.com/ -.. _Nexus: https://nexus.onap.org/#welcome +.. _Nexus: https://nexus.onap.org/ .. _AWS Elastic Block Store: https://aws.amazon.com/ebs/ .. _Azure File: https://docs.microsoft.com/en-us/azure/storage/files/storage-files-introduction .. _GCE Persistent Disk: https://cloud.google.com/compute/docs/disks/ @@ -21,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 @@ -84,7 +85,6 @@ The top level of the ONAP charts is shown below: common ├── cassandra │   ├── Chart.yaml - │   ├── requirements.yaml │   ├── resources │   │   ├── config │   │   │   └── docker-entrypoint.sh @@ -120,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: @@ -135,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 @@ -164,7 +163,8 @@ components and in themselves can be quite complex. You can use either `charts` or `components` folder for your subcomponents. `charts` folder means that the subcomponent will always been deployed. -`components` folders means we can choose if we want to deploy the sub component. +`components` folders means we can choose if we want to deploy the +subcomponent. This choice is done in root `values.yaml`: @@ -179,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 @@ -451,10 +451,10 @@ It would render the following Service Resource (for a component named app.kubernetes.io/instance: my-deployment-name-of-my-component type: NodePort -In the deployment or statefulSet file, you needs to set the good labels in order -for the service to match the pods. +In the deployment or statefulSet file, you needs to set the good labels in +order for the service to match the pods. -here's an example to be sure it matchs (for a statefulSet): +here's an example to be sure it matches (for a statefulSet): .. code-block:: yaml @@ -637,7 +637,7 @@ SO deployment specification excerpt: spec: initContainers: - command: - - /root/ready.py + - /app/ready.py args: - --container-name - so-mariadb @@ -687,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. @@ -1010,7 +1010,7 @@ MSB service discovery. The following is a brief description of how this integration will be done: A registrator to push the service endpoint info to MSB service -discovery.  +discovery. - The needed service endpoint info is put into the kubernetes yaml file as annotation, including service name, Protocol,version, visual @@ -1074,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: @@ -1129,7 +1129,7 @@ access to watch the kubernetes events and get service annotation by Kubernetes APIs. The token can be found in the kubectl configuration file *~/.kube/config* -More details can be found here `MSB installation `__. +More details can be found here `MSB installation `_. .. MISC .. ====