[GLOBAL] Migrate to helm v3

[oom.git] / docs / oom_developer_guide.rst

diff --git a/docs/oom_developer_guide.rst b/docs/oom_developer_guide.rst
index c3fb603..05cdca1 100644 (file)
--- 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
 .. 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/
 
 .. 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/
 .. _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/


@@ -84,7 +85,6 @@ The top level of the ONAP charts is shown below:
   common
   ├── cassandra
   │   ├── Chart.yaml
   common
   ├── cassandra
   │   ├── Chart.yaml

-  │   ├── requirements.yaml

   │   ├── resources
   │   │   ├── config
   │   │   │   └── docker-entrypoint.sh
   │   ├── resources
   │   │   ├── config
   │   │   │   └── docker-entrypoint.sh


@@ -120,14 +120,14 @@ The top level of the ONAP charts is shown below:
   ├── ...
   └── postgres-legacy
       ├── Chart.yaml
   ├── ...
   └── postgres-legacy
       ├── Chart.yaml

-      ├── requirements.yaml

       ├── charts
       └── configs
 
 The common section of charts consists of a set of templates that assist with
       ├── 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:
 
 
 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
 
   name-of-my-component
   ├── Chart.yaml

-  ├── requirements.yaml

   ├── component
   │   └── subcomponent-folder
   ├── charts
   ├── 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.
 
 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`:
 
 
 This choice is done in root `values.yaml`:
 


@@ -179,7 +179,7 @@ This choice is done in root `values.yaml`:
   component2:
     enabled: true
 
   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
 
 
 .. code-block:: yaml
 


@@ -373,6 +373,9 @@ Templates are provided in order to create Kubernetes resources (Secrets,
 Ingress, Services, ...) or part of Kubernetes resources (names, labels,
 resources requests and limits, ...).
 
 Ingress, Services, ...) or part of Kubernetes resources (names, labels,
 resources requests and limits, ...).
 

+a full list and simple description is done in
+`kubernetes/common/common/documentation.rst`.
+

 Service template
 ----------------
 
 Service template
 ----------------
 


@@ -448,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
 
       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
 
 
 .. code-block:: yaml
 


@@ -634,7 +637,7 @@ SO deployment specification excerpt:
       spec:
         initContainers:
         - command:
       spec:
         initContainers:
         - command:

-          - /root/ready.py
+          - /app/ready.py

           args:
           - --container-name
           - so-mariadb
           args:
           - --container-name
           - so-mariadb


@@ -1007,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
 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
 
 -  The needed service endpoint info is put into the kubernetes yaml file
    as annotation, including service name, Protocol,version, visual


@@ -1126,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*
 
 Kubernetes APIs. The token can be found in the kubectl configuration file
 *~/.kube/config*
 

-More details can be found here `MSB installation <http://onap.readthedocs.io/en/latest/submodules/msb/apigateway.git/docs/platform/installation.html>`__.
+More details can be found here `MSB installation <https://docs.onap.org/projects/onap-msb-apigateway/en/latest/platform/installation.html>`_.

 
 .. MISC
 .. ====
 
 .. MISC
 .. ====