X-Git-Url: https://gerrit.onap.org/r/gitweb?a=blobdiff_plain;f=docs%2Foom_developer_guide.rst;h=05cdca1c469fe8660015f2aaef1c8b816cb6a2ea;hb=370c6dc33e55bfee7b3b79bcc21481b02a3f1e24;hp=fccf453925dd45ca0aa40c046a9caf45899e00c1;hpb=d92618a67e411c4e0568c7a71a7d7b3307a56807;p=oom.git diff --git a/docs/oom_developer_guide.rst b/docs/oom_developer_guide.rst index fccf453925..05cdca1c46 100644 --- a/docs/oom_developer_guide.rst +++ b/docs/oom_developer_guide.rst @@ -8,7 +8,7 @@ .. _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/ @@ -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 @@ -1131,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 .. ====