diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/oom_quickstart_guide.rst | 37 | ||||
| -rw-r--r-- | docs/release-notes.rst | 69 |
2 files changed, 90 insertions, 16 deletions
diff --git a/docs/oom_quickstart_guide.rst b/docs/oom_quickstart_guide.rst index 501deda7e4..a641fabf60 100644 --- a/docs/oom_quickstart_guide.rst +++ b/docs/oom_quickstart_guide.rst @@ -83,7 +83,8 @@ ROBOT uses in Dublin. OS_PASSWORD=XXXX_OS_CLEARTESTPASSWORD_XXXX git clone http://gerrit.onap.org/r/integration - cd integration/deployment/heat/onap-oom/scripts + + cd integration/deployment/heat/onap-rke/scripts javac Crypto.java java Crypto "$OS_PASSWORD" "$SO_ENCRYPTION_KEY" @@ -128,32 +129,42 @@ single command The --timeout 900 is currently required in Dublin to address long running initialization tasks for DMaaP and SO. Without this timeout value both applications may fail to deploy. - a. To deploy all ONAP applications use this command:: +To deploy all ONAP applications use this command:: > cd oom/kubernetes - > helm deploy dev local/onap --namespace onap -f onap/resources/overrides/onap-all.yaml -f onap/resources/overrides/openstack.yaml --timeout 900 + > helm deploy dev local/onap --namespace onap -f onap/resources/overrides/onap-all.yaml -f onap/resources/overrides/environment.yaml -f onap/resources/overrides/openstack.yaml --timeout 900 + +All override files may be customized (or replaced by other overrides) as per needs. + +onap-all.yaml - b. If you are using a custom override (e.g. integration-override.yaml) use this command:: + Enables the modules in the ONAP deployment. As ONAP is very modular, it is possible to customize ONAP and disable some components through this configuration file. - > helm deploy dev local/onap -f /root/integration-override.yaml --namespace onap --timeout 900 +environment.yaml + Includes configuration values specific to the deployment environment. - c. If you have a slower cloud environment you may want to use the public-cloud.yaml - which has longer delay intervals on database updates.:: + Example: adapt readiness and liveness timers to the level of performance of your infrastructure - > helm deploy dev local/onap -f /root/oom/kubernetes/onap/resources/environments/public-cloud.yaml -f /root/integration-override.yaml --namespace onap --timeout 900 +openstack.yaml + Includes all the Openstack related information for the default target tenant you want to use to deploy VNFs from ONAP and/or additional parameters for the embedded tests. -**Step 9.** Commands to interact with the OOM installation +**Step 9.** Verify ONAP installation -Use the following to monitor your deployment and determine when ONAP is -ready for use:: +Use the following to monitor your deployment and determine when ONAP is ready for use:: > kubectl get pods -n onap -o=wide -Undeploying onap can be done using the following command:: +.. note:: + While all pods may be in a Running state, it is not a guarantee that all components are running fine. + + Launch the healthcheck tests using Robot to verify that the components are healthy. + + > ~/oom/kubernetes/robot/ete-k8s.sh onap health - > helm undeploy dev --purge +**Step 10.** Undeploy ONAP +> helm undeploy dev --purge More examples of using the deploy and undeploy plugins can be found here: https://wiki.onap.org/display/DW/OOM+Helm+%28un%29Deploy+plugins diff --git a/docs/release-notes.rst b/docs/release-notes.rst index 82e4fb1c2f..dc10400dfb 100644 --- a/docs/release-notes.rst +++ b/docs/release-notes.rst @@ -7,8 +7,71 @@ .. Links .. _release-notes-label: -Release Notes -============= +ONAP Operations Manager Release Notes +===================================== + +Version 4.0.0 (Dublin Release) +------------------------------ + +:Release Date: 2019-06-26 + +Summary +------- + +**Platform Resiliency** + +* Documenation of a Highly-Available Kubernetes Cluster Deployment +* Availability of a Default Storage Class Provisioner for improved Persistent Storage resiliency +* Availability of a CNI reference integration for Multi-site support + + * applications can take advantage of multi-site by using POD and/or Node (anti)affinity, taints/tolerations, labels per application + +**Footprint Optimization** + +* Shared MariaDB-Galera Cluster - current clients in Dublin: SO, SDNC +* Shared Cassandra Cluster - current clients in Dublin: AAI, SDC +* Optional deployment of independent clusters (backward compatibility) + +**Platform Upgradability** + +* Introduction of an Upgrade Framework supporting: + + * Automated rolling upgrades for applications + * In-place schema and data migrations + * Blue-Green deployment environment migration (e.g. Pre-prod to Prod) + * Upgrades from embedded database instance into shared database instance + +* Release-to-release upgrade support delivered for the following projects + + * A&AI + * SDNC + * SO + +**Security Notes** + +*Fixed Security Issues* + +*Known 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>`_] +* Hard coded password used for all oom deployments [`OJSI-188 <https://jira.onap.org/browse/OJSI-188>`_] +* CVE-2019-12127 - OOM exposes unprotected API/UI on port 30270 [`OJSI-202 <https://jira.onap.org/browse/OJSI-202>`_] + +*Known Vulnerabilities in Used Modules* + +OOM code has been formally scanned during build time using NexusIQ and no +Critical vulnerability was found. + +Quick Links: + + - `OOM project page <https://wiki.onap.org/display/DW/ONAP+Operations+Manager+Project>`_ + + - `Passing Badge information for OOM <https://bestpractices.coreinfrastructure.org/en/projects/1631>`_ + + +**Known Issues** + + Version 3.0.0 Casablanca Release -------------------------------- @@ -16,7 +79,7 @@ Version 3.0.0 Casablanca Release :Release Date: 2018-11-30 Summary -======= +------- The focus of this release was on incremental improvements in the following areas: |