diff options
Diffstat (limited to 'docs')
-rw-r--r-- | docs/helm-search.txt | 80 | ||||
-rw-r--r-- | docs/oom_developer_guide.rst | 5 | ||||
-rw-r--r-- | docs/oom_quickstart_guide.rst | 1 | ||||
-rw-r--r-- | docs/oom_user_guide.rst | 66 |
4 files changed, 73 insertions, 79 deletions
diff --git a/docs/helm-search.txt b/docs/helm-search.txt index c17cd25207..035b9a6b91 100644 --- a/docs/helm-search.txt +++ b/docs/helm-search.txt @@ -1,41 +1,41 @@ NAME CHART VERSION APP VERSION DESCRIPTION -local/onap 9.0.0 Istanbul Open Network Automation Platform (ONAP) -local/aaf 9.0.0 ONAP Application Authorization Framework -local/aai 9.0.0 ONAP Active and Available Inventory -local/appc 9.0.0 Application Controller -local/cassandra 9.0.0 ONAP cassandra -local/cds 9.0.0 ONAP Controller Design Studio (CDS) -local/clamp 9.0.0 ONAP Clamp -local/cli 9.0.0 ONAP Command Line Interface -local/common 9.0.0 Common templates for inclusion in other charts -local/consul 9.0.0 ONAP Consul Agent -local/contrib 9.0.0 ONAP optional tools -local/cps 9.0.0 ONAP Configuration Persistene Service (CPS) -local/dcaegen2 9.0.0 ONAP DCAE Gen2 -local/dgbuilder 9.0.0 D.G. Builder application -local/dmaap 9.0.0 ONAP DMaaP components -local/log 9.0.0 ONAP Logging ElasticStack -local/mariadb-galera 9.0.0 Chart for MariaDB Galera cluster -local/mongo 9.0.0 MongoDB Server -local/msb 9.0.0 ONAP MicroServices Bus -local/multicloud 9.0.0 ONAP multicloud broker -local/music 9.0.0 MUSIC - Multi-site State Coordination Service -local/mysql 9.0.0 MySQL Server -local/nbi 9.0.0 ONAP Northbound Interface -local/network-name-gen 9.0.0 Name Generation Micro Service -local/nfs-provisioner 9.0.0 NFS provisioner -local/oof 9.0.0 ONAP Optimization Framework -local/policy 9.0.0 ONAP Policy Administration Point -local/pomba 9.0.0 ONAP Post Orchestration Model Based Audit -local/portal 9.0.0 ONAP Web Portal -local/postgres 9.0.0 ONAP Postgres Server -local/robot 9.0.0 A helm Chart for kubernetes-ONAP Robot -local/sdc 9.0.0 Service Design and Creation Umbrella Helm charts -local/sdnc 9.0.0 SDN Controller -local/sdnc-prom 9.0.0 ONAP SDNC Policy Driven Ownership Management -local/sniro-emulator 9.0.0 ONAP Mock Sniro Emulator -local/so 9.0.0 ONAP Service Orchestrator -local/uui 9.0.0 ONAP uui -local/vfc 9.0.0 ONAP Virtual Function Controller (VF-C) -local/vid 9.0.0 ONAP Virtual Infrastructure Deployment -local/vnfsdk 9.0.0 ONAP VNF SDK +local/onap 10.0.0 Jakarta Open Network Automation Platform (ONAP) +local/aaf 10.0.0 ONAP Application Authorization Framework +local/aai 10.0.0 ONAP Active and Available Inventory +local/appc 10.0.0 Application Controller +local/cassandra 10.0.0 ONAP cassandra +local/cds 10.0.0 ONAP Controller Design Studio (CDS) +local/clamp 10.0.0 ONAP Clamp +local/cli 10.0.0 ONAP Command Line Interface +local/common 10.0.0 Common templates for inclusion in other charts +local/consul 10.0.0 ONAP Consul Agent +local/contrib 10.0.0 ONAP optional tools +local/cps 10.0.0 ONAP Configuration Persistene Service (CPS) +local/dcaegen2 10.0.0 ONAP DCAE Gen2 +local/dgbuilder 10.0.0 D.G. Builder application +local/dmaap 10.0.0 ONAP DMaaP components +local/log 10.0.0 ONAP Logging ElasticStack +local/mariadb-galera 10.0.0 Chart for MariaDB Galera cluster +local/mongo 10.0.0 MongoDB Server +local/msb 10.0.0 ONAP MicroServices Bus +local/multicloud 10.0.0 ONAP multicloud broker +local/music 10.0.0 MUSIC - Multi-site State Coordination Service +local/mysql 10.0.0 MySQL Server +local/nbi 10.0.0 ONAP Northbound Interface +local/network-name-gen 10.0.0 Name Generation Micro Service +local/nfs-provisioner 10.0.0 NFS provisioner +local/oof 10.0.0 ONAP Optimization Framework +local/policy 10.0.0 ONAP Policy Administration Point +local/pomba 10.0.0 ONAP Post Orchestration Model Based Audit +local/portal 10.0.0 ONAP Web Portal +local/postgres 10.0.0 ONAP Postgres Server +local/robot 10.0.0 A helm Chart for kubernetes-ONAP Robot +local/sdc 10.0.0 Service Design and Creation Umbrella Helm charts +local/sdnc 10.0.0 SDN Controller +local/sdnc-prom 10.0.0 ONAP SDNC Policy Driven Ownership Management +local/sniro-emulator 10.0.0 ONAP Mock Sniro Emulator +local/so 10.0.0 ONAP Service Orchestrator +local/uui 10.0.0 ONAP uui +local/vfc 10.0.0 ONAP Virtual Function Controller (VF-C) +local/vid 10.0.0 ONAP Virtual Infrastructure Deployment +local/vnfsdk 10.0.0 ONAP VNF SDK diff --git a/docs/oom_developer_guide.rst b/docs/oom_developer_guide.rst index 552aea25a7..05cdca1c46 100644 --- a/docs/oom_developer_guide.rst +++ b/docs/oom_developer_guide.rst @@ -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,7 +120,6 @@ The top level of the ONAP charts is shown below: ├── ... └── postgres-legacy ├── Chart.yaml - ├── requirements.yaml ├── charts └── configs @@ -137,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 @@ -182,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 diff --git a/docs/oom_quickstart_guide.rst b/docs/oom_quickstart_guide.rst index 6b91b2ca42..79a30567fb 100644 --- a/docs/oom_quickstart_guide.rst +++ b/docs/oom_quickstart_guide.rst @@ -28,6 +28,7 @@ where <BRANCH> can be an official release tag, such as * 7.0.0 for Guilin * 8.0.0 for Honolulu * 9.0.0 for Istanbul +* 10.0.0 for Jakarta **Step 2.** Install Helm Plugins required to deploy ONAP:: diff --git a/docs/oom_user_guide.rst b/docs/oom_user_guide.rst index 74f8c57f6e..019d84363f 100644 --- a/docs/oom_user_guide.rst +++ b/docs/oom_user_guide.rst @@ -1,7 +1,7 @@ .. This work is licensed under a Creative Commons Attribution 4.0 .. International License. .. http://creativecommons.org/licenses/by/4.0 -.. Copyright 2018-2020 Amdocs, Bell Canada, Orange, Samsung +.. Copyright 2018-2021 Amdocs, Bell Canada, Orange, Samsung, Nordix Foundation .. _oom_user_guide: .. Links @@ -118,7 +118,7 @@ stable which should be removed to avoid confusion:: To prepare your system for an installation of ONAP, you'll need to:: - > git clone -b guilin --recurse-submodules -j2 http://gerrit.onap.org/r/oom + > git clone -b jakarta --recurse-submodules -j2 http://gerrit.onap.org/r/oom > cd oom/kubernetes @@ -156,12 +156,12 @@ system, and looks for matches:: > helm search repo local NAME VERSION DESCRIPTION - local/appc 2.0.0 Application Controller - local/clamp 2.0.0 ONAP Clamp - local/common 2.0.0 Common templates for inclusion in other charts - local/onap 2.0.0 Open Network Automation Platform (ONAP) - local/robot 2.0.0 A helm Chart for kubernetes-ONAP Robot - local/so 2.0.0 ONAP Service Orchestrator + local/appc 10.0.0 Application Controller + local/clamp 10.0.0 ONAP Clamp + local/common 10.0.0 Common templates for inclusion in other charts + local/onap 10.0.0 Open Network Automation Platform (ONAP) + local/robot 10.0.0 A helm Chart for kubernetes-ONAP Robot + local/so 10.0.0 ONAP Service Orchestrator In any case, setup of the Helm repository is a one time activity. @@ -204,7 +204,7 @@ deployment:: To install a specific version of a single ONAP component (`so` in this example) with the given release name enter:: - > helm deploy so onap/so --version 9.0.0 --set global.masterPassword=password --set global.flavor=unlimited --namespace onap + > helm deploy so onap/so --version 10.0.0 --set global.masterPassword=password --set global.flavor=unlimited --namespace onap .. note:: The dependent components should be installed for component being installed @@ -244,9 +244,9 @@ precedence of all. oValues [label="values.yaml"] demo [label="onap-demo.yaml"] prod [label="onap-production.yaml"] - oReq [label="requirements.yaml"] + oReq [label="Chart.yaml"] soValues [label="values.yaml"] - soReq [label="requirements.yaml"] + soReq [label="Chart.yaml"] mdValues [label="values.yaml"] } { @@ -319,27 +319,23 @@ To deploy ONAP with this environment file, enter:: .. include:: environments_onap_demo.yaml :code: yaml -When deploying all of ONAP a requirements.yaml file control which and what -version of the ONAP components are included. Here is an excerpt of this -file: +When deploying all of ONAP, the dependencies section of the Chart.yaml file +controls which and what version of the ONAP components are included. +Here is an excerpt of this file: .. code-block:: yaml - # Referencing a named repo called 'local'. - # Can add this repo by running commands like: - # > helm serve - # > helm repo add local http://127.0.0.1:8879 dependencies: <...> - name: so - version: ~9.0.0 + version: ~10.0.0 repository: '@local' condition: so.enabled <...> -The ~ operator in the `so` version value indicates that the latest "8.X.X" +The ~ operator in the `so` version value indicates that the latest "10.X.X" version of `so` shall be used thus allowing the chart to allow for minor -upgrades that don't impact the so API; hence, version 8.0.1 will be installed +upgrades that don't impact the so API; hence, version 10.0.1 will be installed in this case. The onap/resources/environment/dev.yaml (see the excerpt below) enables @@ -562,10 +558,10 @@ Below is the example for the same:: > helm list NAME REVISION UPDATED STATUS CHART APP VERSION NAMESPACE - dev 1 Wed Oct 14 13:49:52 2020 DEPLOYED onap-9.0.0 Istanbul onap - dev-cassandra 5 Thu Oct 15 14:45:34 2020 DEPLOYED cassandra-9.0.0 onap - dev-contrib 1 Wed Oct 14 13:52:53 2020 DEPLOYED contrib-9.0.0 onap - dev-mariadb-galera 1 Wed Oct 14 13:55:56 2020 DEPLOYED mariadb-galera-9.0.0 onap + dev 1 Wed Oct 14 13:49:52 2020 DEPLOYED onap-10.0.0 Jakarta onap + dev-cassandra 5 Thu Oct 15 14:45:34 2020 DEPLOYED cassandra-10.0.0 onap + dev-contrib 1 Wed Oct 14 13:52:53 2020 DEPLOYED contrib-10.0.0 onap + dev-mariadb-galera 1 Wed Oct 14 13:55:56 2020 DEPLOYED mariadb-galera-10.0.0 onap Here the Name column shows the RELEASE NAME, In our case we want to try the scale operation on cassandra, thus the RELEASE NAME would be dev-cassandra. @@ -579,10 +575,10 @@ Below is the example for the same:: > helm search cassandra NAME CHART VERSION APP VERSION DESCRIPTION - local/cassandra 9.0.0 ONAP cassandra - local/portal-cassandra 9.0.0 Portal cassandra - local/aaf-cass 9.0.0 ONAP AAF cassandra - local/sdc-cs 9.0.0 ONAP Service Design and Creation Cassandra + local/cassandra 10.0.0 ONAP cassandra + local/portal-cassandra 10.0.0 Portal cassandra + local/aaf-cass 10.0.0 ONAP AAF cassandra + local/sdc-cs 10.0.0 ONAP Service Design and Creation Cassandra Here the Name column shows the chart name. As we want to try the scale operation for cassandra, thus the corresponding chart name is local/cassandra @@ -644,7 +640,7 @@ Prior to doing an upgrade, determine of the status of the deployed charts:: > helm list NAME REVISION UPDATED STATUS CHART NAMESPACE - so 1 Mon Feb 5 10:05:22 2020 DEPLOYED so-9.0.0 onap + so 1 Mon Feb 5 10:05:22 2020 DEPLOYED so-10.0.0 onap When upgrading a cluster a parameter controls the minimum size of the cluster during the upgrade while another parameter controls the maximum number of nodes @@ -680,8 +676,8 @@ To fetch release history enter:: > helm history so REVISION UPDATED STATUS CHART DESCRIPTION - 1 Mon Feb 5 10:05:22 2020 SUPERSEDED so-8.0.0 Install complete - 2 Mon Feb 5 10:10:55 2020 DEPLOYED so-9.0.0 Upgrade complete + 1 Mon Feb 5 10:05:22 2020 SUPERSEDED so-9.0.0 Install complete + 2 Mon Feb 5 10:10:55 2020 DEPLOYED so-10.0.0 Upgrade complete Unfortunately, not all upgrades are successful. In recognition of this the lineup of pods within an ONAP deployment is tagged such that an administrator @@ -703,9 +699,9 @@ For example, to roll-back back to previous system revision enter:: > helm history so REVISION UPDATED STATUS CHART DESCRIPTION - 1 Mon Feb 5 10:05:22 2020 SUPERSEDED so-8.0.0 Install complete - 2 Mon Feb 5 10:10:55 2020 SUPERSEDED so-9.0.0 Upgrade complete - 3 Mon Feb 5 10:14:32 2020 DEPLOYED so-8.0.0 Rollback to 1 + 1 Mon Feb 5 10:05:22 2020 SUPERSEDED so-9.0.0 Install complete + 2 Mon Feb 5 10:10:55 2020 SUPERSEDED so-10.0.0 Upgrade complete + 3 Mon Feb 5 10:14:32 2020 DEPLOYED so-9.0.0 Rollback to 1 .. note:: |