[GENERAL] Use readiness container v3.0.1

[oom.git] / docs / oom_developer_guide.rst

diff --git a/docs/oom_developer_guide.rst b/docs/oom_developer_guide.rst
index c3fb603..fccf453 100644 (file)
--- a/docs/oom_developer_guide.rst
+++ b/docs/oom_developer_guide.rst
@@ -1,6 +1,7 @@
-.. 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/
 
 .. Links
 .. _Helm: https://docs.helm.sh/


@@ -164,7 +165,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`:
 


@@ -373,6 +375,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 +453,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 +639,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 +1012,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