diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/helm-search.txt | 81 | ||||
| -rw-r--r-- | docs/oom_cloud_setup_guide.rst | 25 | ||||
| -rw-r--r-- | docs/oom_quickstart_guide.rst | 7 | ||||
| -rw-r--r-- | docs/oom_user_guide.rst | 12 | ||||
| -rw-r--r-- | docs/release-notes-frankfurt.rst | 164 | ||||
| -rw-r--r-- | docs/release-notes.rst | 50 |
6 files changed, 248 insertions, 91 deletions
diff --git a/docs/helm-search.txt b/docs/helm-search.txt index c7c4a7fe97..4ec41fd6cd 100644 --- a/docs/helm-search.txt +++ b/docs/helm-search.txt @@ -1,42 +1,41 @@ NAME CHART VERSION APP VERSION DESCRIPTION -local/onap 6.0.0 Frankfurt Open Network Automation Platform (ONAP) -local/aaf 6.0.0 ONAP Application Authorization Framework -local/aai 6.0.0 ONAP Active and Available Inventory -local/appc 6.0.0 Application Controller -local/cassandra 6.0.0 ONAP cassandra -local/cds 6.0.0 ONAP Controller Design Studio (CDS) -local/clamp 6.0.0 ONAP Clamp -local/cli 6.0.0 ONAP Command Line Interface -local/common 6.0.0 Common templates for inclusion in other charts -local/consul 6.0.0 ONAP Consul Agent -local/contrib 6.0.0 ONAP optional tools -local/dcaegen2 6.0.0 ONAP DCAE Gen2 -local/dgbuilder 6.0.0 D.G. Builder application -local/dmaap 6.0.0 ONAP DMaaP components -local/esr 6.0.0 ONAP External System Register -local/log 6.0.0 ONAP Logging ElasticStack -local/mariadb-galera 6.0.0 Chart for MariaDB Galera cluster -local/mongo 6.0.0 MongoDB Server -local/msb 6.0.0 ONAP MicroServices Bus -local/multicloud 6.0.0 ONAP multicloud broker -local/music 6.0.0 MUSIC - Multi-site State Coordination Service -local/mysql 6.0.0 MySQL Server -local/nbi 6.0.0 ONAP Northbound Interface -local/network-name-gen 6.0.0 Name Generation Micro Service -local/nfs-provisioner 6.0.0 NFS provisioner -local/oof 6.0.0 ONAP Optimization Framework -local/pnda 6.0.0 ONAP DCAE PNDA -local/policy 6.0.0 ONAP Policy Administration Point -local/pomba 6.0.0 ONAP Post Orchestration Model Based Audit -local/portal 6.0.0 ONAP Web Portal -local/postgres 6.0.0 ONAP Postgres Server -local/robot 6.0.0 A helm Chart for kubernetes-ONAP Robot -local/sdc 6.0.0 Service Design and Creation Umbrella Helm charts -local/sdnc 6.0.0 SDN Controller -local/sdnc-prom 6.0.0 ONAP SDNC Policy Driven Ownership Management -local/sniro-emulator 6.0.0 ONAP Mock Sniro Emulator -local/so 6.0.0 ONAP Service Orchestrator -local/uui 6.0.0 ONAP uui -local/vfc 6.0.0 ONAP Virtual Function Controller (VF-C) -local/vid 6.0.0 ONAP Virtual Infrastructure Deployment -local/vnfsdk 6.0.0 ONAP VNF SDK +local/onap 7.0.0 Frankfurt Open Network Automation Platform (ONAP) +local/aaf 7.0.0 ONAP Application Authorization Framework +local/aai 7.0.0 ONAP Active and Available Inventory +local/appc 7.0.0 Application Controller +local/cassandra 7.0.0 ONAP cassandra +local/cds 7.0.0 ONAP Controller Design Studio (CDS) +local/clamp 7.0.0 ONAP Clamp +local/cli 7.0.0 ONAP Command Line Interface +local/common 7.0.0 Common templates for inclusion in other charts +local/consul 7.0.0 ONAP Consul Agent +local/contrib 7.0.0 ONAP optional tools +local/dcaegen2 7.0.0 ONAP DCAE Gen2 +local/dgbuilder 7.0.0 D.G. Builder application +local/dmaap 7.0.0 ONAP DMaaP components +local/esr 7.0.0 ONAP External System Register +local/log 7.0.0 ONAP Logging ElasticStack +local/mariadb-galera 7.0.0 Chart for MariaDB Galera cluster +local/mongo 7.0.0 MongoDB Server +local/msb 7.0.0 ONAP MicroServices Bus +local/multicloud 7.0.0 ONAP multicloud broker +local/music 7.0.0 MUSIC - Multi-site State Coordination Service +local/mysql 7.0.0 MySQL Server +local/nbi 7.0.0 ONAP Northbound Interface +local/network-name-gen 7.0.0 Name Generation Micro Service +local/nfs-provisioner 7.0.0 NFS provisioner +local/oof 7.0.0 ONAP Optimization Framework +local/policy 7.0.0 ONAP Policy Administration Point +local/pomba 7.0.0 ONAP Post Orchestration Model Based Audit +local/portal 7.0.0 ONAP Web Portal +local/postgres 7.0.0 ONAP Postgres Server +local/robot 7.0.0 A helm Chart for kubernetes-ONAP Robot +local/sdc 7.0.0 Service Design and Creation Umbrella Helm charts +local/sdnc 7.0.0 SDN Controller +local/sdnc-prom 7.0.0 ONAP SDNC Policy Driven Ownership Management +local/sniro-emulator 7.0.0 ONAP Mock Sniro Emulator +local/so 7.0.0 ONAP Service Orchestrator +local/uui 7.0.0 ONAP uui +local/vfc 7.0.0 ONAP Virtual Function Controller (VF-C) +local/vid 7.0.0 ONAP Virtual Infrastructure Deployment +local/vnfsdk 7.0.0 ONAP VNF SDK diff --git a/docs/oom_cloud_setup_guide.rst b/docs/oom_cloud_setup_guide.rst index 9a34036727..e54992e852 100644 --- a/docs/oom_cloud_setup_guide.rst +++ b/docs/oom_cloud_setup_guide.rst @@ -46,16 +46,21 @@ The versions of Kubernetes that are supported by OOM are as follows: .. table:: OOM Software Requirements - ============== =========== ====== ======== ======== - Release Kubernetes Helm kubectl Docker - ============== =========== ====== ======== ======== - amsterdam 1.7.x 2.3.x 1.7.x 1.12.x - beijing 1.8.10 2.8.2 1.8.10 17.03.x - casablanca 1.11.5 2.9.1 1.11.5 17.03.x - dublin 1.13.5 2.12.3 1.13.5 18.09.5 - 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 - ============== =========== ====== ======== ======== + ============== =========== ======= ======== ======== + Release Kubernetes Helm kubectl Docker + ============== =========== ======= ======== ======== + amsterdam 1.7.x 2.3.x 1.7.x 1.12.x + beijing 1.8.10 2.8.2 1.8.10 17.03.x + casablanca 1.11.5 2.9.1 1.11.5 17.03.x + dublin 1.13.5 2.12.3 1.13.5 18.09.5 + 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 + ============== =========== ======= ======== ======== + +.. note:: + Guilin version also supports Kubernetes up to version 1.19.x and should work + with Helm with version up to 3.3.x but has not been thoroughly tested. Minimum Hardware Configuration ============================== diff --git a/docs/oom_quickstart_guide.rst b/docs/oom_quickstart_guide.rst index 5c0d5127bd..28d3597923 100644 --- a/docs/oom_quickstart_guide.rst +++ b/docs/oom_quickstart_guide.rst @@ -25,6 +25,7 @@ where <BRANCH> can be an official release tag, such as * 4.0.0-ONAP for Dublin * 5.0.1-ONAP for El Alto * 6.0.0 for Frankfurt +* 7.0.0 for Guilin **Step 2.** Install Helm Plugins required to deploy ONAP:: @@ -178,7 +179,7 @@ follows:: single command .. note:: - The ``--timeout 900`` is currently required in Dublin and up to address long + The ``--timeout 900`` is currently required in Guilin and up to address long running initialization tasks for DMaaP and SO. Without this timeout value both applications may fail to deploy. @@ -235,6 +236,10 @@ for use:: > ~/oom/kubernetes/robot/ete-k8s.sh onap health + Launch Robot distribute health checks to verify whether ONAP runtime components are healthy:: + + > ~/oom/kubernetes/robot/ete-k8s.sh onap healthdist + **Step 10.** Undeploy ONAP :: diff --git a/docs/oom_user_guide.rst b/docs/oom_user_guide.rst index 74f24dab62..70f19df7b6 100644 --- a/docs/oom_user_guide.rst +++ b/docs/oom_user_guide.rst @@ -150,12 +150,12 @@ system, and looks for matches:: > helm search -l 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 7.0.0 Application Controller + local/clamp 7.0.0 ONAP Clamp + local/common 7.0.0 Common templates for inclusion in other charts + local/onap 7.0.0 Open Network Automation Platform (ONAP) + local/robot 7.0.0 A helm Chart for kubernetes-ONAP Robot + local/so 7.0.0 ONAP Service Orchestrator In any case, setup of the Helm repository is a one time activity. diff --git a/docs/release-notes-frankfurt.rst b/docs/release-notes-frankfurt.rst new file mode 100644 index 0000000000..da3ae2a956 --- /dev/null +++ b/docs/release-notes-frankfurt.rst @@ -0,0 +1,164 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 + International License. +.. http://creativecommons.org/licenses/by/4.0 +.. (c) ONAP Project and its contributors +.. _release_notes_frankfurt: + +************************************* +ONAP Operations Manager Release Notes +************************************* + +Previous Release Notes +====================== + +- :ref:`El Alto <release_notes_elalto>` +- :ref:`Dublin <release_notes_dublin>` +- :ref:`Casablanca <release_notes_casablanca>` +- :ref:`Beijing <release_notes_beijing>` +- :ref:`Amsterdam <release_notes_amsterdam>` + +Abstract +======== + +This document provides the release notes for the Frankfurt release. + +Summary +======= + +The focus of this release is to strengthen the foundation of OOM installer. + +Release Data +============ + ++--------------------------------------+--------------------------------------+ +| **Project** | OOM | +| | | ++--------------------------------------+--------------------------------------+ +| **Docker images** | N/A | +| | | ++--------------------------------------+--------------------------------------+ +| **Release designation** | Frankfurt | +| | | ++--------------------------------------+--------------------------------------+ +| **Release date** | 2020/06/15 | +| | | ++--------------------------------------+--------------------------------------+ + +New features +------------ + +* Ingress deployment is getting more and more usable +* Use of dynamic Persistent Volume is available + +**Bug fixes** + +A list of issues resolved in this release can be found here: +https://jira.onap.org/projects/OOM/versions/10826 + +**Known Issues** + +- `OOM-1237 <https://jira.onap.org/browse/OOM-1237>`_ Source Helm Charts from + ONAP Repo. Having helm charts repo is not possible for Frankfurt release. +- `OOM-1720 <https://jira.onap.org/browse/OOM-1237>`_ galera container is + outdated. containers used for mariadb are outdated and not supported anymore. +- `OOM-1817 <https://jira.onap.org/browse/OOM-1817>`_ Use of global.repository + inconsistent across Helm Charts. it's then may be hard to retrieve some + containers when deploying in constrained environment. +- `OOM-2075 <https://jira.onap.org/browse/OOM-2075>`_ Invalid MTU for Canal CNI + interfaces +- `OOM-2227 <https://jira.onap.org/browse/OOM-2227>`_ Cassandra Backup Mechanism + works only on "static PV" mode. +- `OOM-2230 <https://jira.onap.org/browse/OOM-2230>`_ Missing requests/limits + for some PODS. This can lead to "memory bombing" so cautious monitoring of + Kubernetes resources usage must be set up. +- `OOM-2279 <https://jira.onap.org/browse/OOM-2279>`_ OOM El Alto and master + clamp mariadb resources doesn't match chart. +- `OOM-2285 <https://jira.onap.org/browse/OOM-2285>`_ deploy.sh does not work + for mariadb-galera. deploy script doesn't behave well with "-" in the + component name. +- `OOM-2369 <https://jira.onap.org/browse/OOM-2369>`_ DMAAP Helm install takes + too long and often fails. +- `OOM-2418 <https://jira.onap.org/browse/OOM-2418>`_ Readiness-check 2.0.2 not + working properly for stateful set. +- `OOM-2421 <https://jira.onap.org/browse/OOM-2421>`_ OOM NBI chart deployment + error. In some case, NBI deployment fails. +- `OOM-2422 <https://jira.onap.org/browse/OOM-2422>`_ Portal App is unreachable + when deploying without HTTPs + + +Deliverables +------------ + +Software Deliverables +~~~~~~~~~~~~~~~~~~~~~ + +OOM provides `Helm charts <https://git.onap.org/oom/>`_ that needs to be +"compiled" into Helm package. see step 6 in +:doc:`quickstart guide <oom_quickstart_guide>`. + +Documentation Deliverables +~~~~~~~~~~~~~~~~~~~~~~~~~~ + +- :doc:`Project Description <oom_project_description>` +- :doc:`Cloud Setup Guide <oom_cloud_setup_guide>` +- :doc:`Quick Start Guide <oom_quickstart_guide>` +- :doc:`Setup Ingress Controller <oom_setup_ingress_controller>` +- :doc:`Developer Guide <oom_developer_guide>` +- :doc:`Hardcoded Certificates <oom_hardcoded_certificates>` + +Known Limitations, Issues and Workarounds +========================================= + +Known Vulnerabilities +--------------------- + +- Hard coded password used for all OOM deployments + [`OJSI-188 <https://jira.onap.org/browse/OJSI-188>`_] +- :doc:`Hard coded certificates <oom_hardcoded_certificates>` in Helm packages + +Workarounds +----------- + +- `OOM-1237 <https://jira.onap.org/browse/OOM-1237>`_ Workaround is to generate + them as explained in documentation. +- `OOM-1817 <https://jira.onap.org/browse/OOM-1817>`_ Workaround is to use + offline installer if needed. +- `OOM-2227 <https://jira.onap.org/browse/OOM-2227>`_ Workaround is to stick to + "static PV" (so, not using storage class) if backup is needed. +- `OOM-2285 <https://jira.onap.org/browse/OOM-2285>`_ Workaround is to use + directly helm upgrade if needed. +- `OOM-2369 <https://jira.onap.org/browse/OOM-2369>`_ Workaround is to play + postinstall jobs by hand. +- `OOM-2418 <https://jira.onap.org/browse/OOM-2418>`_ Workaround is to use + version 2.2.2 in global part of override file if the new check is needed. +- `OOM-2421 <https://jira.onap.org/browse/OOM-2421>`_ Workaround is to + undeploy/redeploy NBI. +- `OOM-2422 <https://jira.onap.org/browse/OOM-2422>`_ Workaround is to create + first portal app service with service type Cluster IP then changing it to + NodePort or LoadBalancer so all the port are available. + +Security Notes +-------------- + +**Fixed Security Issues** + +- In default deployment OOM (consul-server-ui) exposes HTTP port 30270 outside + of cluster. [`OJSI-134 <https://jira.onap.org/browse/OJSI-134>`_] +- CVE-2019-12127 - OOM exposes unprotected API/UI on port 30270 + [`OJSI-202 <https://jira.onap.org/browse/OJSI-202>`_] + +References +========== + +For more information on the ONAP Frankfurt release, please see: + +#. `ONAP Home Page`_ +#. `ONAP Documentation`_ +#. `ONAP Release Downloads`_ +#. `ONAP Wiki Page`_ + + +.. _`ONAP Home Page`: https://www.onap.org +.. _`ONAP Wiki Page`: https://wiki.onap.org +.. _`ONAP Documentation`: https://docs.onap.org +.. _`ONAP Release Downloads`: https://git.onap.org diff --git a/docs/release-notes.rst b/docs/release-notes.rst index 382b49961d..30f4353ba4 100644 --- a/docs/release-notes.rst +++ b/docs/release-notes.rst @@ -11,6 +11,7 @@ ONAP Operations Manager Release Notes Previous Release Notes ====================== +- :ref:`Frankfurt <release_notes_frankfurt>` - :ref:`El Alto <release_notes_elalto>` - :ref:`Dublin <release_notes_dublin>` - :ref:`Casablanca <release_notes_casablanca>` @@ -37,18 +38,19 @@ Release Data | **Docker images** | N/A | | | | +--------------------------------------+--------------------------------------+ -| **Release designation** | Frankfurt | +| **Release designation** | Guilin | | | | +--------------------------------------+--------------------------------------+ -| **Release date** | 2020/06/15 | +| **Release date** | 2020/12/03 | | | | +--------------------------------------+--------------------------------------+ New features ------------ -* Ingress deployment is getting more and more usable -* Use of dynamic Persistent Volume is available +* Kubernetes support for version up to 1.19 +* Helm (experimental) support for version up to 3.3 +* Limits are set for most of the components **Bug fixes** @@ -64,26 +66,20 @@ https://jira.onap.org/projects/OOM/versions/10826 - `OOM-1817 <https://jira.onap.org/browse/OOM-1817>`_ Use of global.repository inconsistent across Helm Charts. it's then may be hard to retrieve some containers when deploying in constrained environment. -- `OOM-2075 <https://jira.onap.org/browse/OOM-2075>`_ Invalid MTU for Canal CNI - interfaces - `OOM-2227 <https://jira.onap.org/browse/OOM-2227>`_ Cassandra Backup Mechanism works only on "static PV" mode. -- `OOM-2230 <https://jira.onap.org/browse/OOM-2230>`_ Missing requests/limits - for some PODS. This can lead to "memory bombing" so cautious monitoring of - Kubernetes resources usage must be set up. -- `OOM-2279 <https://jira.onap.org/browse/OOM-2279>`_ OOM El Alto and master - clamp mariadb resources doesn't match chart. - `OOM-2285 <https://jira.onap.org/browse/OOM-2285>`_ deploy.sh does not work for mariadb-galera. deploy script doesn't behave well with "-" in the component name. -- `OOM-2369 <https://jira.onap.org/browse/OOM-2369>`_ DMAAP Helm install takes - too long and often fails. -- `OOM-2418 <https://jira.onap.org/browse/OOM-2418>`_ Readiness-check 2.0.2 not - working properly for stateful set. -- `OOM-2421 <https://jira.onap.org/browse/OOM-2421>`_ OOM NBI chart deployment - error. In some case, NBI deployment fails. -- `OOM-2422 <https://jira.onap.org/browse/OOM-2422>`_ Portal App is unreachable - when deploying without HTTPs +- `OOM-2421 <https://jira.onap.org/browse/OOM-2421>`_ OOM nbi chart deployment + error +- `OOM-2534 <https://jira.onap.org/browse/OOM-2534>`_ Cert-Service leverages + runtime external dependency +- `OOM-2554 <https://jira.onap.org/browse/OOM-2554>`_ Common pods have java 8 +- `OOM-2588 <https://jira.onap.org/browse/OOM-2588>`_ Various subcharts not + installing due to helm size issues +- `OOM-2629 <https://jira.onap.org/browse/OOM-2629>`_ NetBox demo entry setup + not complete Deliverables @@ -127,26 +123,14 @@ Workarounds "static PV" (so, not using storage class) if backup is needed. - `OOM-2285 <https://jira.onap.org/browse/OOM-2285>`_ Workaround is to use directly helm upgrade if needed. -- `OOM-2369 <https://jira.onap.org/browse/OOM-2369>`_ Workaround is to play - postinstall jobs by hand. -- `OOM-2418 <https://jira.onap.org/browse/OOM-2418>`_ Workaround is to use - version 2.2.2 in global part of override file if the new check is needed. -- `OOM-2421 <https://jira.onap.org/browse/OOM-2421>`_ Workaround is to - undeploy/redeploy NBI. -- `OOM-2422 <https://jira.onap.org/browse/OOM-2422>`_ Workaround is to create - first portal app service with service type Cluster IP then changing it to - NodePort or LoadBalancer so all the port are available. +- `OOM-2534 <https://jira.onap.org/browse/OOM-2534>`_ Workaround is to download + in advance docker.io/openjdk:11-jre-slim where you will generate the charts Security Notes -------------- **Fixed Security Issues** -- In default deployment OOM (consul-server-ui) exposes HTTP port 30270 outside - of cluster. [`OJSI-134 <https://jira.onap.org/browse/OJSI-134>`_] -- CVE-2019-12127 - OOM exposes unprotected API/UI on port 30270 - [`OJSI-202 <https://jira.onap.org/browse/OJSI-202>`_] - References ========== |