diff options
author | Eric Debeau <eric.debeau@orange.com> | 2020-08-19 15:30:00 +0200 |
---|---|---|
committer | Eric Debeau <eric.debeau@orange.com> | 2020-08-19 15:36:00 +0200 |
commit | 993b77b8108e25787a1425f109f76a0bc61ffb7d (patch) | |
tree | 81eea035914df31bffeea49fc23800f80daf726b /docs/oom_developer_guide.rst | |
parent | fda0e908856c5c48720f011771fa3195f86dfc6d (diff) |
[DOC] Correct RST files
Correct different RST files to remove warnings generated by Doc8
- long lines
- yaml code bad formated
- tabulation
Add a new file to store the hardcoded certificates
(easier to manage with a CSV file than a RST table)
Correct some minor editorial errors
Issue-ID: OOM-2542
Signed-off-by: Eric Debeau <eric.debeau@orange.com>
Change-Id: I89bfea619fbeda581dc04ca2abea80adfe1a8a02
Diffstat (limited to 'docs/oom_developer_guide.rst')
-rw-r--r-- | docs/oom_developer_guide.rst | 16 |
1 files changed, 9 insertions, 7 deletions
diff --git a/docs/oom_developer_guide.rst b/docs/oom_developer_guide.rst index 3cced83f62..d76bd35b39 100644 --- 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 -.. Copyright 2018 Amdocs, Bell Canada +.. Copyright 2018-2020 Amdocs, Bell Canada, Orange, Samsung .. 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. -`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`: @@ -451,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 -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 @@ -1010,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 -discovery. +discovery. - The needed service endpoint info is put into the kubernetes yaml file as annotation, including service name, Protocol,version, visual |