summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/helm-search.txt80
-rw-r--r--docs/oom_cloud_setup_guide.rst4
-rw-r--r--docs/oom_quickstart_guide.rst9
-rw-r--r--docs/oom_setup_paas.rst13
-rw-r--r--docs/oom_user_guide.rst26
-rw-r--r--docs/requirements-docs.txt9
6 files changed, 70 insertions, 71 deletions
diff --git a/docs/helm-search.txt b/docs/helm-search.txt
index 66fddcf869..c17cd25207 100644
--- a/docs/helm-search.txt
+++ b/docs/helm-search.txt
@@ -1,41 +1,41 @@
NAME CHART VERSION APP VERSION DESCRIPTION
-local/onap 8.0.0 Honolulu Open Network Automation Platform (ONAP)
-local/aaf 8.0.0 ONAP Application Authorization Framework
-local/aai 8.0.0 ONAP Active and Available Inventory
-local/appc 8.0.0 Application Controller
-local/cassandra 8.0.0 ONAP cassandra
-local/cds 8.0.0 ONAP Controller Design Studio (CDS)
-local/clamp 8.0.0 ONAP Clamp
-local/cli 8.0.0 ONAP Command Line Interface
-local/common 8.0.0 Common templates for inclusion in other charts
-local/consul 8.0.0 ONAP Consul Agent
-local/contrib 8.0.0 ONAP optional tools
-local/cps 8.0.0 ONAP Configuration Persistene Service (CPS)
-local/dcaegen2 8.0.0 ONAP DCAE Gen2
-local/dgbuilder 8.0.0 D.G. Builder application
-local/dmaap 8.0.0 ONAP DMaaP components
-local/log 8.0.0 ONAP Logging ElasticStack
-local/mariadb-galera 8.0.0 Chart for MariaDB Galera cluster
-local/mongo 8.0.0 MongoDB Server
-local/msb 8.0.0 ONAP MicroServices Bus
-local/multicloud 8.0.0 ONAP multicloud broker
-local/music 8.0.0 MUSIC - Multi-site State Coordination Service
-local/mysql 8.0.0 MySQL Server
-local/nbi 8.0.0 ONAP Northbound Interface
-local/network-name-gen 8.0.0 Name Generation Micro Service
-local/nfs-provisioner 8.0.0 NFS provisioner
-local/oof 8.0.0 ONAP Optimization Framework
-local/policy 8.0.0 ONAP Policy Administration Point
-local/pomba 8.0.0 ONAP Post Orchestration Model Based Audit
-local/portal 8.0.0 ONAP Web Portal
-local/postgres 8.0.0 ONAP Postgres Server
-local/robot 8.0.0 A helm Chart for kubernetes-ONAP Robot
-local/sdc 8.0.0 Service Design and Creation Umbrella Helm charts
-local/sdnc 8.0.0 SDN Controller
-local/sdnc-prom 8.0.0 ONAP SDNC Policy Driven Ownership Management
-local/sniro-emulator 8.0.0 ONAP Mock Sniro Emulator
-local/so 8.0.0 ONAP Service Orchestrator
-local/uui 8.0.0 ONAP uui
-local/vfc 8.0.0 ONAP Virtual Function Controller (VF-C)
-local/vid 8.0.0 ONAP Virtual Infrastructure Deployment
-local/vnfsdk 8.0.0 ONAP VNF SDK
+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
diff --git a/docs/oom_cloud_setup_guide.rst b/docs/oom_cloud_setup_guide.rst
index adebcba487..70f5190e8a 100644
--- a/docs/oom_cloud_setup_guide.rst
+++ b/docs/oom_cloud_setup_guide.rst
@@ -56,8 +56,8 @@ The versions of Kubernetes that are supported by OOM are as follows:
el alto 1.15.2 2.14.2 1.15.2 18.09.x
frankfurt 1.15.9 2.16.6 1.15.11 18.09.x
guilin 1.15.11 2.16.10 1.15.11 18.09.x
- Honolulu 1.19.9 3.5.2 1.19.9 19.03.x
- Istanbul 1.2.0
+ honolulu 1.19.9 3.5.2 1.19.9 19.03.x 1.2.0
+ Istanbul 1.19.11 3.6.3 1.19.11 19.03.x 1.5.4
============== =========== ======= ======== ======== ============
.. note::
diff --git a/docs/oom_quickstart_guide.rst b/docs/oom_quickstart_guide.rst
index 67b5794b83..6b91b2ca42 100644
--- a/docs/oom_quickstart_guide.rst
+++ b/docs/oom_quickstart_guide.rst
@@ -27,11 +27,18 @@ where <BRANCH> can be an official release tag, such as
* 6.0.0 for Frankfurt
* 7.0.0 for Guilin
* 8.0.0 for Honolulu
+* 9.0.0 for Istanbul
**Step 2.** Install Helm Plugins required to deploy ONAP::
> cp -R ~/oom/kubernetes/helm/plugins/ ~/.local/share/helm/plugins
- > helm plugin install https://github.com/chartmuseum/helm-push.git
+ > helm plugin install https://github.com/chartmuseum/helm-push.git \
+ --version 0.9.0
+
+.. note::
+ The ``--version 0.9.0`` is required as new version of helm (3.7.0 and up) is
+ now using ``push`` directly and helm-push is using ``cm-push`` starting
+ version ``0.10.0`` and up.
**Step 3.** Install Chartmuseum::
diff --git a/docs/oom_setup_paas.rst b/docs/oom_setup_paas.rst
index 6b7b9c3bab..ed632dac36 100644
--- a/docs/oom_setup_paas.rst
+++ b/docs/oom_setup_paas.rst
@@ -24,6 +24,7 @@ The versions of PaaS components that are supported by OOM are as follows:
Release Cert-Manager Prometheus Stack
============== ============= =================
honolulu 1.2.0 13.x
+ istanbul 1.5.4 19.x
============== ============= =================
This guide provides instructions on how to install the PaaS
@@ -46,7 +47,7 @@ date, and attempt to renew certificates at a configured time before expiry.
Installation steps
------------------
-The recommended version of Cert-Manager for Kubernetes 1.19 is v1.2.0.
+The recommended version of Cert-Manager for Kubernetes 1.19 is v1.5.4.
Cert-Manager is deployed using regular YAML manifests which include all
the needed resources (the CustomResourceDefinitions, cert-manager,
namespace, and the webhook component).
@@ -61,7 +62,7 @@ steps, please refer to `Cert-Manager kubectl plugin documentation`_.
Installation can be as simple as::
- > kubectl apply -f https://github.com/jetstack/cert-manager/releases/download/v1.2.0/cert-manager.yaml
+ > kubectl apply -f https://github.com/jetstack/cert-manager/releases/download/v1.5.4/cert-manager.yaml
Prometheus Stack (optional)
===========================
@@ -79,8 +80,8 @@ Installation steps
------------------
The recommended version of kube-prometheus-stack chart for
-Kubernetes 1.19 is 13.x (which is currently the latest major chart version),
-for example 13.3.1.
+Kubernetes 1.19 is 19.x (which is currently the latest major chart version),
+for example 19.0.2.
In order to install Prometheus Stack, you must follow these steps:
@@ -100,6 +101,6 @@ In order to install Prometheus Stack, you must follow these steps:
> helm install prometheus prometheus-community/kube-prometheus-stack --namespace=prometheus
- To install the kube-prometheus-stack Helm chart in specific version, for example 13.3.1::
+ To install the kube-prometheus-stack Helm chart in specific version, for example 19.0.2::
- > helm install prometheus prometheus-community/kube-prometheus-stack --namespace=prometheus --version=13.3.1
+ > helm install prometheus prometheus-community/kube-prometheus-stack --namespace=prometheus --version=19.0.2
diff --git a/docs/oom_user_guide.rst b/docs/oom_user_guide.rst
index 3212fd319d..2059251928 100644
--- a/docs/oom_user_guide.rst
+++ b/docs/oom_user_guide.rst
@@ -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 8.0.0 --set global.masterPassword=password --set global.flavor=unlimited --namespace onap
+ > helm deploy so onap/so --version 9.0.0 --set global.masterPassword=password --set global.flavor=unlimited --namespace onap
.. note::
The dependent components should be installed for component being installed
@@ -332,7 +332,7 @@ file:
dependencies:
<...>
- name: so
- version: ~8.0.0
+ version: ~9.0.0
repository: '@local'
condition: so.enabled
<...>
@@ -562,10 +562,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-8.0.0 Honolulu onap
- dev-cassandra 5 Thu Oct 15 14:45:34 2020 DEPLOYED cassandra-8.0.0 onap
- dev-contrib 1 Wed Oct 14 13:52:53 2020 DEPLOYED contrib-8.0.0 onap
- dev-mariadb-galera 1 Wed Oct 14 13:55:56 2020 DEPLOYED mariadb-galera-8.0.0 onap
+ 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
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 +579,10 @@ Below is the example for the same::
> helm search cassandra
NAME CHART VERSION APP VERSION DESCRIPTION
- local/cassandra 8.0.0 ONAP cassandra
- local/portal-cassandra 8.0.0 Portal cassandra
- local/aaf-cass 8.0.0 ONAP AAF cassandra
- local/sdc-cs 8.0.0 ONAP Service Design and Creation Cassandra
+ 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
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 +644,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-8.0.0 onap
+ so 1 Mon Feb 5 10:05:22 2020 DEPLOYED so-9.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
@@ -681,7 +681,7 @@ 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-8.0.1 Upgrade complete
+ 2 Mon Feb 5 10:10:55 2020 DEPLOYED so-9.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
@@ -704,7 +704,7 @@ 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-8.0.1 Upgrade 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
.. note::
diff --git a/docs/requirements-docs.txt b/docs/requirements-docs.txt
deleted file mode 100644
index edffc4b5d7..0000000000
--- a/docs/requirements-docs.txt
+++ /dev/null
@@ -1,9 +0,0 @@
-lfdocs-conf~=0.7.5
-funcparserlib~=1.0.0a0
-sphinxcontrib.blockdiag~=2.0.0
-sphinxcontrib-needs<0.6.0
-sphinxcontrib.plantuml~=0.21
-sphinxcontrib.nwdiag~=2.0.0
-sphinxcontrib-seqdiag~=2.0.0
-sphinxcontrib-swaggerdoc~=0.1.7
-sphinx-rtd-theme~=1.0.0