.. This work is licensed under a Creative Commons Attribution 4.0 International License. .. http://creativecommons.org/licenses/by/4.0 .. Copyright 2017 Bell Canada & Amdocs Intellectual Property. All rights reserved. .. Links .. _release-notes-label: Release Notes ============= Version 2.0.0 Beijing Release ----------------------------- :Release Date: 2018-06-07 Epic **** * [`OOM-6 `_] - Automated platform deployment on Docker/Kubernetes * [`OOM-7 `_] - Platform monitoring and auto-healing * [`OOM-8 `_] - Automated platform scalability * [`OOM-9 `_] - Platform upgradability & rollbacks * [`OOM-10 `_] - Platform configuration management * [`OOM-46 `_] - Platform infrastructure deployment with TOSCA * [`OOM-109 `_] - Platform Centralized Logging * [`OOM-138 `_] - Using Optimization framework * [`OOM-346 `_] - Platform Resiliency (including Recoverability, High-Availability, Backup/Restore, Geo-Redundancy) * [`OOM-376 `_] - ONAP deployment options standardization * [`OOM-486 `_] - HELM upgrade from 2.3 to 2.8.0 * [`OOM-535 `_] - Upgrade Kubernetes from 1.8.6 to 1.9.2 * [`OOM-590 `_] - OOM Wiki documentation of deployment options Story ***** * [`OOM-11 `_] - Add AAF containers to ONAP Kubernetes * [`OOM-13 `_] - Add CLI containers to ONAP Kubernetes * [`OOM-15 `_] - Add DMAAP containers to ONAP Kubernetes * [`OOM-20 `_] - State Monitoring: MSO/mso * [`OOM-21 `_] - State Monitoring: A&AI/aai-service * [`OOM-22 `_] - State Monitoring: SDNC/sdc-be * [`OOM-24 `_] - State Monitoring: message-router * [`OOM-25 `_] - State Monitoring: MSB * [`OOM-29 `_] - State Monitoring: VID * [`OOM-31 `_] - State Monitoring: APPC/dbhost * [`OOM-32 `_] - State Monitoring: VFC * [`OOM-33 `_] - State Monitoring: Multi-VIM * [`OOM-34 `_] - Auto-Restart on failure: ... * [`OOM-35 `_] - State Monitoring: A&AI/hbase * [`OOM-36 `_] - State Monitoring: A&AI/model-loader-service * [`OOM-37 `_] - State Monitoring: APPC/dgbuilder * [`OOM-38 `_] - State Monitoring: APPC/sdnctldb01 * [`OOM-39 `_] - State Monitoring: APPC/sdnctldb02 * [`OOM-40 `_] - State Monitoring: APPC/sdnhost * [`OOM-41 `_] - State Monitoring: MSO/mariadb * [`OOM-42 `_] - State Monitoring: SDNC/dbhost * [`OOM-43 `_] - State Monitoring: SDNC/sdnc-dgbuilder * [`OOM-44 `_] - State Monitoring: SDNC/sdnc-portal * [`OOM-45 `_] - State Monitoring: SDNC/sdnctldb01 * [`OOM-51 `_] - OOM ONAP Configuration Management - Externalize hardwired values * [`OOM-52 `_] - OOM ONAP Configuration Management - Parameterization of docker images * [`OOM-53 `_] - OOM ONAP Configuration Management - Parameterization for Sizing * [`OOM-63 `_] - Kubernetes cluster created by TOSCA description * [`OOM-85 `_] - Test the code in the “Lab” project environment * [`OOM-86 `_] - Monitoring the health status of ONAP components * [`OOM-87 `_] - Configure TOSCA description via dashboard * [`OOM-88 `_] - Deploy Holmes on K8S cluster by TOSCA description * [`OOM-89 `_] - Deploy CLAMP on K8S cluster by TOSCA description * [`OOM-91 `_] - Deploy MSB on K8S cluster by TOSCA description * [`OOM-92 `_] - Deploy AAF on K8S cluster by TOSCA description * [`OOM-93 `_] - Deploy VF-C on K8S cluster by TOSCA description * [`OOM-94 `_] - Deploy Multi-VIM on K8S cluster by TOSCA description * [`OOM-95 `_] - Deploy DCAEGen2 on K8S cluster by TOSCA description * [`OOM-96 `_] - Deploy AAI on K8S cluster by TOSCA description * [`OOM-97 `_] - Deploy APPC on K8S cluster by TOSCA description * [`OOM-98 `_] - Deploy MSO on K8S cluster by TOSCA description * [`OOM-99 `_] - Deploy Policy on K8S cluster by TOSCA description * [`OOM-100 `_] - Deploy SDC on K8S cluster by TOSCA description * [`OOM-102 `_] - Deploy VID on K8S cluster by TOSCA description * [`OOM-110 `_] - OOM ONAP Logging - Elastic Stack components deployment * [`OOM-111 `_] - OOM ONAP Logging - FileBeat deployment aside ONAP components * [`OOM-112 `_] - OOM ONAP Logging - Configuration of all ONAP components to emit canonical logs * [`OOM-116 `_] - ignore intellj files * [`OOM-145 `_] - update directory path from dockerdata-nfs to configured directory name (make it configurable) * [`OOM-235 `_] - Service endpoint annotation for Usecase UI * [`OOM-242 `_] - Modify DCAE seed for Helm * [`OOM-262 `_] - Remove "oneclick" kubectl scripts. * [`OOM-265 `_] - Top level 
## **Quick Start Guide - ONAP on Kubernetes**


This is a quick start guide to help you get started on ONAP installation. Creating an ONAP deployment instance requires creating base configuration on the host node and then deploying the runtime containers.

Pre-requisites:

-  Your Kubernetes environment must be available. For more information see, [ONAP on Kubernetes](https://wiki.onap.org/display/DW/ONAP+on+Kubernetes).
-  Deployment artifacts are customized for your location.

Step 1

Review and optionally change configuration parameters:

Setup the [/oom/kubernetes/config/onap-parameters.yaml](https://gerrit.onap.org/r/gitweb?p=oom.git;a=blob;f=kubernetes/config/onap-parameters.yaml;h=7ddaf4d4c3dccf2fad515265f0da9c31ec0e64b1;hb=refs/heads/master) file with key-value pairs specific to your OpenStack environment.

OR

There is a [sample](https://gerrit.onap.org/r/gitweb?p=oom.git;a=blob;f=kubernetes/config/onap-parameters-sample.yaml;h=3a74beddbbf7f9f9ec8e5a6abaecb7cb238bd519;hb=refs/heads/master) that may help you out or even be usable directly if you don't intend to actually use OpenStack resources.


Step 2

In-order to be able to support multiple ONAP instances within a single kubernetes environment, a configuration set is required. To do this, execute the [createConfig.sh](https://gerrit.onap.org/r/gitweb?p=oom.git;a=blob;f=kubernetes/config/createConfig.sh;h=f226ccae47ca6de15c1da49be4b8b6de974895ed;hb=refs/heads/master) script:

> oom/kubernetes/config/createConfig.sh -n onap

Where:
'onap' refers to the name of the instance. This serves as the Namespace prefix for each deployed ONAP component (for example, onap-mso).

Step 3

The bash script [createAll.bash](https://gerrit.onap.org/r/gitweb?p=oom.git;a=blob;f=kubernetes/oneclick/createAll.bash;h=5e5f2dc76ea7739452e757282e750638b4e3e1de;hb=refs/heads/master) is used to create an ONAP deployment with kubernetes. It has two primary functions:

-  Creating the namespaces used to encapsulate the ONAP components, and
-  Creating the services, pods and containers within each of these namespaces that provide the core functionality of ONAP.

Before you execute the createAll.bash. script, pod config-init ([pod-config-init.yaml](https://gerrit.onap.org/r/gitweb?p=oom.git;a=blob;f=kubernetes/config/pod-config-init.yaml;h=b1285ce21d61815c082f6d6aa3c43d00561811c7;hb=refs/heads/master)) may need editing to match your environment and deployment into the default namespace.

To deploy the containers and create your ONAP system, execute the following command:

> oom/kubernetes/oneclick/createAll.bash -n onap

#### **Additional information on usage of createAll.bash**

Namespaces provide isolation between ONAP components as ONAP release 1.0 contains duplicate application (for example, mariadb) and port usage.

As such createAll.bash requires the user to enter a namespace prefix string that can be used to separate multiple deployments of onap. The result will be set of 10 namespaces (for example, onap-sdc, onap-aai, onap-mso, onap-message-router, onap-robot, onap-vid, onap-sdnc, onap-portal, onap-policy, onap-appc) being created within the kubernetes environment.


#### **Deploying multiple ONAP instances within the same Kubernetes cluster**

To deploy multiple ONAP instances, you must specify the number of Instances you would like to create in a Kubernetes cluster using createAllbash.

This is currently required due to the use of NodePort ranges. NodePorts allow external IP:Port access to containers that are running inside a Kubernetes cluster.

To create multiple instances of an ONAP deployment in the cluster, use the following commands:

> oom/kubernetes/config/createConfig.sh -n onap

> oom/kubernetes/oneclick/createAll.bash -n onap -i 2

Where:

-  'onap' refers to the name of the instance.

-  �i 2� refers to the number of instances of an ONAP deployment in the cluster.

#### **To delete a deployed instance**

To delete a deployed instance, use the following command:

> oom/kubernetes/oneclick/deleteAll.bash -n onap

**Note:** Deleting the runtime containers does not remove the configuration created in step 2.

For more information on OOM project documentation, refer to:

 -  [Quick Start Guide on Wiki](https://wiki.onap.org/display/DW/ONAP+Operations+Manager+Project#ONAPOperationsManagerProject-QuickStartGuide)
 -  [Quick Start Guide on readthedocs](http://onap.readthedocs.io/en/latest/submodules/oom.git/docs/OOM%20Project%20Description/oom_project_description.html#quick-start-guide)
auto installation * [`OOM-680 `_] - ONAP Failure install with kubernetes 1.8+ * [`OOM-687 `_] - Typo in README_HELM * [`OOM-724 `_] - License Update in TOSCA * [`OOM-767 `_] - data-router-logs and elasticsearch-data mapped to same folder * [`OOM-768 `_] - Hardcoded onap in config files * [`OOM-769 `_] - sdc-es data mapping in sdc-be and sdc-fe redundant * [`OOM-783 `_] - UUI health check is failing * [`OOM-784 `_] - make new so chart one namespace compatible * [`OOM-791 `_] - After OOM-722 merge - docker pulls are timing out - switch to pullPolicy IfNotPresent * [`OOM-794 `_] - demo-k8s.sh name not modified in the usage string * [`OOM-795 `_] - HEAT templates for robot instantiateVFW missing * [`OOM-796 `_] - robot asdc/sdngc interface in synch for Master * [`OOM-797 `_] - GLOBAL_INJECTED_SCRIPT_VERSION missing from vm_properties.py * [`OOM-804 `_] - VFC vfc-ztevnfmdriver container failure * [`OOM-815 `_] - OOM Robot container helm failure after OOM-728 35909 merge * [`OOM-829 `_] - Can not make multicloud helm chart * [`OOM-830 `_] - Fix OOM build dependencies * [`OOM-835 `_] - CLAMP mariadb pv is pointing to a wrong location * [`OOM-836 `_] - champ and gizmo yaml validation issue * [`OOM-845 `_] - Global repository should not be set by default * [`OOM-846 `_] - Add liveness enabled fix to helm starter * [`OOM-847 `_] - log-elasticsearch external ports are not externally accessible * [`OOM-848 `_] - log-logstash logstash pipeline fails to start after oom standard config changes * [`OOM-851 `_] - sdc chart validation error * [`OOM-856 `_] - appc mysql fails deployment * [`OOM-858 `_] - Fail to deploy onap chart due to config map size * [`OOM-870 `_] - Missing CLAMP configuration * [`OOM-871 `_] - log kibana container fails to start after oom standard config changes * [`OOM-872 `_] - APPC-helm Still need config pod * [`OOM-873 `_] - OOM doc typo * [`OOM-874 `_] - Inconsistent repository references in ONAP charts * [`OOM-875 `_] - Cannot retrieve robot logs * [`OOM-876 `_] - Some containers ignore the repository setting * [`OOM-878 `_] - MySQL slave nodes don't deploy when mysql.replicaCount > 1 * [`OOM-881 `_] - SDN-C Portal pod fails to come up * [`OOM-882 `_] - Some SDNC service names should be prefixed with the helm release name * [`OOM-884 `_] - VID-VID mariadb pv is pointing to a wrong location * [`OOM-885 `_] - Beijing oom component log messages missing in Elasticsearch * [`OOM-886 `_] - kube2msb not starting up * [`OOM-887 `_] - SDN-C db schema and sdnctl db user not reliably being created * [`OOM-888 `_] - aaf-cs mapping wrong * [`OOM-889 `_] - restore pv&pvc for mysql when NFS provisioner is disabled * [`OOM-898 `_] - Multicloud-framework config file is not volume-mounted * [`OOM-899 `_] - SDNC main pod does not come up * [`OOM-900 `_] - portal-cassandra missing pv and pvc * [`OOM-904 `_] - OOM problems bringing up components and passing healthchecks * [`OOM-905 `_] - Charts use nsPrefix instead of release namespace * [`OOM-906 `_] - Make all services independent of helm Release.Name * [`OOM-907 `_] - Make all persistent volume to be mapped to a location defined by helm Release.Name * [`OOM-908 `_] - Job portal-db-config fails due to missing image config * [`OOM-909 `_] - SO Health Check fails * [`OOM-910 `_] - VID Health Check fails * [`OOM-911 `_] - VFC Health Check fails for 9 components * [`OOM-912 `_] - Multicloud Health Check fails for 1 of its components * [`OOM-913 `_] - Consul agent pod is failing * [`OOM-916 `_] - Used to fix testing issues related to usability * [`OOM-918 `_] - Policy - incorrect configmap mount causes base.conf to disappear * [`OOM-920 `_] - Issue with CLAMP configuation * [`OOM-921 `_] - align onap/values.yaml and onap/resources/environments/dev.yaml - different /dockerdata-nfs * [`OOM-926 `_] - Disable clustering for APP-C out-of-the-box * [`OOM-927 `_] - Need a production grade configuration override file of ONAP deployment * [`OOM-928 `_] - Some charts use /dockerdata-nfs by default * [`OOM-929 `_] - DMaaP message router docker image fails to pull * [`OOM-930 `_] - New AAF Helm Charts required * [`OOM-931 `_] - Reintroduce VNC pod into OOM * [`OOM-932 `_] - Unblock integration testing * [`OOM-935 `_] - sdc-cassandra pod fails to delete using helm delete - forced kubectl delete * [`OOM-936 `_] - Readiness-check prob version is inconsistent across components * [`OOM-937 `_] - Portal Cassandra config map points to wrong directory * [`OOM-938 `_] - Can't install aai alone using helm * [`OOM-945 `_] - SDNC some bundles failing to start cleanly * [`OOM-948 `_] - make vfc got an error * [`OOM-951 `_] - Update APPC charts based on on changes for ccsdk and Nitrogen ODL * [`OOM-953 `_] - switch aai haproxy/hbase repo from hub.docker.com to nexus3 * [`OOM-958 `_] - SDC-be deployment missing environment paramter * [`OOM-964 `_] - SDC Healthcheck failure on sdc-be and sdc-kb containers down * [`OOM-968 `_] - warning on default deployment values.yaml * [`OOM-969 `_] - oomk8s images have no Dockerfile's * [`OOM-971 `_] - Common service name template should allow for chart name override * [`OOM-974 `_] - Cassandra bootstrap is done incorrectly * [`OOM-977 `_] - The esr-gui annotations should include a "path" param when register to MSB * [`OOM-985 `_] - DMAAP Redis fails to start * [`OOM-986 `_] - SDC BE and FE logs are missing * [`OOM-989 `_] - Sync ete-k8.sh and ete.sh for new log file numbering * [`OOM-990 `_] - AUTO.json in SDC has unreachable addresses * [`OOM-993 `_] - AAI model-loader.properties not in sync with project file * [`OOM-994 `_] - DCAE cloudify controller docker image 1.1.0 N/A - use 1.2.0/1.3.0 * [`OOM-1003 `_] - dcae-cloudify-manager chart references obsolete image version * [`OOM-1004 `_] - aai-resources constantly fails due to cassanda hostname * [`OOM-1005 `_] - AAI Widgets not loading due to duplicate volumes * [`OOM-1007 `_] - Update dcae robot health check config * [`OOM-1008 `_] - Set default consul server replica count to 1 * [`OOM-1010 `_] - Fix broken property names in DCAE input files * [`OOM-1011 `_] - Policy config correction after Service Name changes because of OOM-906 * [`OOM-1013 `_] - Update DCAE container versions * [`OOM-1014 `_] - Portal login not working due to inconsistent zookeeper naming * [`OOM-1015 `_] - Champ fails to start * [`OOM-1016 `_] - DOC-OPS Review: Helm install command is wrong on oom_user_guide - missing namespace * [`OOM-1017 `_] - DOC-OPS review: Docker/Kubernetes versions wrong for master in oom_cloud_setup_guide * [`OOM-1018 `_] - DOC-OPS review: global repo override does not match git in oom quick start guide * [`OOM-1019 `_] - DOC-OPS review: Add Ubuntu 16.04 reference to oom_user_guide to avoid 14/16 confusion * [`OOM-1021 `_] - Update APPC resources for Nitrogen ODL * [`OOM-1022 `_] - Fix SDC startup dependencies * [`OOM-1023 `_] - "spring.datasource.cldsdb.url" in clamp has wrong clampdb name * [`OOM-1024 `_] - Cassandra data not persisted * [`OOM-1033 `_] - helm error during deployment 20180501:1900 - all builds under 2.7.2 * [`OOM-1034 `_] - VID Ports incorrect in deployment.yaml * [`OOM-1037 `_] - Enable CLI health check * [`OOM-1039 `_] - Service distribution to SO fails * [`OOM-1041 `_] - aai-service was renamed, but old references remain * [`OOM-1042 `_] - portalapps service was renamed, but old references remain * [`OOM-1045 `_] - top level values.yaml missing entry for dmaap chart * [`OOM-1049 `_] - SDNC_UEB_LISTENER db * [`OOM-1050 `_] - Impossible to deploy consul using cache docker registry * [`OOM-1051 `_] - Fix aaf deployment * [`OOM-1052 `_] - SO cloud config file points to Rackspace cloud * [`OOM-1054 `_] - Portal LoadBalancer Ingress IP is on the wrong network * [`OOM-1060 `_] - Incorrect MR Kafka references prevent aai champ from starting * [`OOM-1061 `_] - ConfigMap size limit exceeded * [`OOM-1064 `_] - Improve docker registry secret management * [`OOM-1066 `_] - Updating TOSCA blueprint to sync up with helm configuration changes (add dmaap and oof/delete message-router) * [`OOM-1068 `_] - Update SO with new AAI cert * [`OOM-1076 `_] - some charts still using readiness check image from amsterdam 1.x * [`OOM-1077 `_] - AAI resources and traversal deployment failure on non-rancher envs * [`OOM-1079 `_] - Robot charts dont allow over ride of pub_key, dcae_collector_ip and dcae_collector_port * [`OOM-1081 `_] - Remove component 'mock' from TOSCA deployment * [`OOM-1082 `_] - Wrong pv location of dcae postgres * [`OOM-1085 `_] - appc hostname is incorrect in url * [`OOM-1086 `_] - clamp deployment changes /dockerdata-nfs/ReleaseName dir permissions * [`OOM-1088 `_] - APPC returns error for vCPE restart message from Policy * [`OOM-1089 `_] - DCAE pods are not getting purged * [`OOM-1093 `_] - Line wrapping issue in redis-cluster-config.sh script * [`OOM-1094 `_] - Fix postgres startup * [`OOM-1095 `_] - common makefile builds out of order * [`OOM-1096 `_] - node port conflict SDNC (Geo enabled) & other charts * [`OOM-1097 `_] - Nbi needs dep-nbi - crash on make all * [`OOM-1099 `_] - Add External Interface NBI project into OOM TOSCA * [`OOM-1102 `_] - Incorrect AAI services * [`OOM-1103 `_] - Cannot disable NBI * [`OOM-1104 `_] - Policy DROOLS configuration across container restarts * [`OOM-1110 `_] - Clamp issue when connecting Policy * [`OOM-1111 `_] - Please revert to using VNFSDK Postgres container * [`OOM-1114 `_] - APPC is broken in latest helm chart * [`OOM-1115 `_] - SDNC DGBuilder cant operate on DGs in database - need NodePort * [`OOM-1116 `_] - Correct values needed by NBI chart * [`OOM-1124 `_] - Update OOM APPC chart to enhance AAF support * [`OOM-1126 `_] - Incorrect Port mapping between CDT Application and APPC main application * [`OOM-1127 `_] - SO fails healthcheck * [`OOM-1128 `_] - AAF CS fails to start in OpenLab Sub-task ******** * [`OOM-304 `_] - Service endpoint annotation for Data Router * [`OOM-306 `_] - Handle mariadb secrets * [`OOM-510 `_] - Increase vm.max_map_count to 262144 when running Rancher 1.6.11+ via helm 2.6+ - for elasticsearch log mem failure * [`OOM-512 `_] - Push the reviewed and merged ReadMe content to RTD * [`OOM-641 `_] - Segregating of configuration for SDNC-UEB component * [`OOM-655 `_] - Create alternate prepull script which provides more user feedback and logging * [`OOM-753 `_] - Create Helm Sub-Chart for SO's embedded mariadb * [`OOM-754 `_] - Create Helm Chart for SO * [`OOM-774 `_] - Create Helm Sub-Chart for APPC's embedded mySQL database * [`OOM-775 `_] - Create Helm Chart for APPC * [`OOM-778 `_] - Replace NFS Provisioner with configurable PV storage solution * [`OOM-825 `_] - Apache 2 License updation for All sqls and .js file * [`OOM-849 `_] - Policy Nexus component needs persistent volume for /sonatype-work * [`OOM-991 `_] - Adjust SDC-BE init job timing from 10 to 30s to avoid restarts on single node systems * [`OOM-1036 `_] - update helm from 2.7.2 to 2.8.2 wiki/rtd * [`OOM-1063 `_] - Document Portal LoadBalancer Ingress IP Settings **Security Notes** OOM code has been formally scanned during build time using NexusIQ and no Critical vulnerability was found. Quick Links: - `OOM project page `_ - `Passing Badge information for OOM `_ Version: 1.1.0 -------------- :Release Date: 2017-11-16 **New Features** The Amsterdam release is the first release of the ONAP Operations Manager (OOM). The main goal of the Amsterdam release was to: - Support Flexible Platform Deployment via Kubernetes of fully containerized ONAP components - on any type of environment. - Support State Management of ONAP platform components. - Support full production ONAP deployment and any variation of component level deployment for development. - Platform Operations Orchestration / Control Loop Actions. - Platform centralized logging with ELK stack. **Bug Fixes** The full list of implemented user stories and epics is available on `JIRA `_ This is the first release of OOM, the defects fixed in this release were raised during the course of the release. Anything not closed is captured below under Known Issues. If you want to review the defects fixed in the Amsterdam release, refer to Jira link above. **Known Issues** - `OOM-6 `_ Automated platform deployment on Docker/Kubernetes VFC, AAF, MSB minor issues. Workaround: Manual configuration changes - however the reference vFirewall use case does not currently require these components. - `OOM-10 `_ Platform configuration management. OOM ONAP Configuration Management - Handling of Secrets. Workaround: Automated workaround to be able to pull from protected docker repositories. **Security Issues** N/A **Upgrade Notes** N/A **Deprecation Notes** N/A **Other** N/A End of Release Notes