Merge "Fix component startup"

6 files changed, 229 insertions, 44 deletions

diff --git a/nokiav2/docs/development.rst b/nokiav2/docs/development.rst
index f0bcc714..c16ed935 100644
--- a/nokiav2/docs/development.rst
+++ b/nokiav2/docs/development.rst
@@ -5,24 +5,41 @@ Developing the Nokia v2 SVNFM adapter
 Quality gate
 ------------
 
-99.9 % unit test converage
-near 0 sonar issues (with the exceptions of FIXME issues)
+- 99.9 % unit test coverage
 
-Usfull links
+- near 0 sonar issues (with the exceptions of FIXME issues)
+
+Useful links
 ------------
 
-Jenkins build bot: https://jenkins.onap.org/view/vfc/job/vfc-nfvo-driver-svnfm-nokiav2-master-drv-vnfm-nokiav2-verify-java/
-Jenkins sonar analyitcs: https://jenkins.onap.org/view/vfc/job/vfc-nfvo-driver-vnfm-svnfm-nokiav2-sonar/
-Jenkins CLM: https://jenkins.onap.org/view/vfc/job/vfc-nfvo-driver-svnfm-nokiav2-maven-clm-master/
-Jenkins daily release https://jenkins.onap.org/view/vfc/job/vfc-nfvo-driver-svnfm-nokiav2-master-drv-vnfm-nokiav2-release-version-java-daily/
-Sonar: https://sonar.onap.org/dashboard?id=org.onap.vfc.nfvo.driver.vnfm.svnfm.nokiav2%3Avfc-nfvo-driver-vnfm-svnfm-nokiav2
-Nexus IQ reports: https://nexus-iq.wl.linuxfoundation.org/assets/index.html#/management/view/application/vfc-nfvo-driver-svnfm-nokiav2
+- Jenkins build bot: https://jenkins.onap.org/view/vfc/job/vfc-nfvo-driver-svnfm-nokiav2-master-drv-vnfm-nokiav2-verify-java/
+
+- Jenkins sonar analyitcs: https://jenkins.onap.org/view/vfc/job/vfc-nfvo-driver-vnfm-svnfm-nokiav2-sonar/
+
+- Jenkins CLM: https://jenkins.onap.org/view/vfc/job/vfc-nfvo-driver-svnfm-nokiav2-maven-clm-master/
+
+- Jenkins daily release https://jenkins.onap.org/view/vfc/job/vfc-nfvo-driver-svnfm-nokiav2-master-drv-vnfm-nokiav2-release-version-java-daily/
+
+- Sonar: https://sonar.onap.org/dashboard?id=org.onap.vfc.nfvo.driver.vnfm.svnfm.nokiav2%3Avfc-nfvo-driver-vnfm-svnfm-nokiav2
+
+- Nexus IQ reports: https://nexus-iq.wl.linuxfoundation.org/assets/index.html#/management/view/application/vfc-nfvo-driver-svnfm-nokiav2
 
 Backlog
 -------
 
-- add driver to OOM based deployments
-- Solve remaining severe & moderate license issues
+- Support micro service auto configuration
+
+- Support logging configuration
+
 - Support for operation traces in logging https://wiki.onap.org/pages/viewpage.action?pageId=20087036
+
 - Add CSIT using SVNFM simulator
 
+Recently solved issues
+----------------------
+
+- add driver to OOM based deployments
+
+- Solve remaining severe & moderate license issues
+
+
diff --git a/nokiav2/docs/fix.rst b/nokiav2/docs/fix.rst
new file mode 100644
index 00000000..68f82534
--- /dev/null
+++ b/nokiav2/docs/fix.rst
@@ -0,0 +1,101 @@
+Fix ONAP installation
+=====================
+
+This document is intended to help to fix common problems in the ONAP released software. Since the ONAP software in some
+cases uses "snapshots" or "master" these steps may not be 100 percent accurate.
+
+Amsterdam release
+-----------------
+
+- Create SDC consumer in SDC (username = SDC  password=SDC )
+
+  - curl -X POST -i -H "Accept: application/json; charset=UTF-8" -H "Content-Type: application/json" -H "USER_ID: jh0003" http://sdc.api.simpledemo.onap.org:8080/sdc2/rest/v1/consumers/ -d '{"consumerName": "SDC", "consumerSalt": "00ae7619efccee9bf5b53d7f72c3cdf7","consumerPassword": "516e53e4b822601ef58d96abcc054709d15cb42179aa3b6302f48c6c7cf575a6"}'
+
+- Log into the multi-service node via SSH
+
+  - Fix VF-C
+
+    - docker exec -it `docker ps | grep nslcm | awk '{print $1}'` /bin/bash
+
+    - vim.tiny /service/vfc/nfvo/lcm/lcm/pub/config/config.py
+
+      - AAI_BASE_URL = "https://10.0.1.1:8443/aai/v11"
+
+      - SDC_BASE_URL = "https://10.0.3.1:8443/sdc/v1"
+
+    - vim.tiny /service/vfc/nfvo/lcm/lcm/ns/vnfs/grant_vnfs.py
+
+      - Fix according to: https://gerrit.onap.org/r/#/c/27941/3/lcm/ns/vnfs/grant_vnfs.py
+
+    - vim.tiny /service/vfc/nfvo/lcm/lcm/ns/vnfs/notify_lcm.py
+
+      - Fix according to: https://gerrit.onap.org/r/#/c/25447/1/lcm/ns/vnfs/notify_lcm.py
+
+    - vim.tiny /service/vfc/nfvo/lcm/lcm/ns/ns_delete.py
+
+      - Fix according to: https://gerrit.onap.org/r/#/c/25373/
+
+    - exit
+
+  - Fix catalog
+
+    - docker exec -it `docker ps | grep catalog | awk '{print $1}'` /bin/bash
+
+      - vim.tiny /service/vfc/nfvo/catalog/catalog/pub/config/config.py
+
+        - SDC_BASE_URL = "https://10.0.3.1:8443"
+
+      - vim.tiny /service/vfc/nfvo/catalog/catalog/pub/utils/toscaparser/vnfdmodel.py
+
+        - Fix according to: https://gerrit.onap.org/r/#/c/27937/1/catalog/pub/utils/toscaparser/vnfdmodel.py
+
+      - vim.tiny /service/vfc/nfvo/catalog/catalog/pub/utils/toscaparser/basemodel.py
+
+        - Fix according to: https://gerrit.onap.org/r/#/c/25157/1/catalog/pub/utils/toscaparser/basemodel.py
+
+      - exit
+
+  - Fix multi cloud (required if cloud endpoint is over HTTPS)
+
+    - docker exec -it `docker ps | grep ocata | awk '{print $1}'` /bin/bash
+
+      - apt-get install vim
+
+      - vim /opt/ocata/lib/newton/newton/requests/views/util.py
+
+      - Change from return session.Session(auth=auth) to: session.Session(auth=auth, verify=False)
+
+      - exit
+
+- Specify quotas for the tenant (VF-C resource managed does not handle unlimited quotas)
+
+Beijing release
+---------------
+
+- create SDC user (SDC:SDC)
+
+  - curl -X POST -i -H "Accept: application/json; charset=UTF-8" -H "Content-Type: application/json" -H "USER_ID: jh0003" http://sdc.api.simpledemo.onap.org:8080/sdc2/rest/v1/consumers/ -d '{"consumerName": "SDC", "consumerSalt": "00ae7619efccee9bf5b53d7f72c3cdf7","consumerPassword": "516e53e4b822601ef58d96abcc054709d15cb42179aa3b6302f48c6c7cf575a6"}'
+
+- Log into the multi-service node via SSH
+
+  - Fix catalog
+
+    - docker exec -it `docker ps | grep catalog | awk '{print $1}'` /bin/bash
+
+      - vim.tiny /service/vfc/nfvo/catalog/catalog/pub/config/config.py
+
+        - SDC_BASE_URL = "https://10.0.3.1:8443"
+
+  - Fix VF-C
+
+    - docker exec -it `docker ps | grep nslcm | awk '{print $1}'` /bin/bash
+
+    - vim.tiny /service/vfc/nfvo/lcm/lcm/pub/config/config.py
+
+      - AAI_BASE_URL = "https://10.0.1.1:8443/aai/v11"
+
+      - SDC_BASE_URL = "https://10.0.3.1:8443/sdc/v1"
+
+
+
+https://gerrit.onap.org/r/#/c/44203/
diff --git a/nokiav2/docs/index.rst b/nokiav2/docs/index.rst
index b9a98466..fabd0d6a 100644
--- a/nokiav2/docs/index.rst
+++ b/nokiav2/docs/index.rst
@@ -10,6 +10,7 @@ Welcome to Nokia SVNFM documentation!
    :caption: Contents:
 
    integration.rst
+   fix.rst
    samplevnf.rst
    vnfintegration.rst
    onboarding.rst
diff --git a/nokiav2/docs/integration.rst b/nokiav2/docs/integration.rst
index 4a0fb36f..2ce93e80 100644
--- a/nokiav2/docs/integration.rst
+++ b/nokiav2/docs/integration.rst
@@ -1,14 +1,14 @@
 Integrate ONAP with Nokia VNFM
 ==============================
 
-The following section describes how to integrate the Nokia Virtualized Network Function Manager (VNFM) into ONAP. The integration is easier if the
-VNFM is installed before ONAP.
+The following section describes how to integrate the Nokia Virtualized Network Function Manager (VNFM) into ONAP.
 
 Prepare the VNFM
 ----------------
 
 * Start the VNFM.
- The VNFM must be able to communicate with the ONAP VF-C interface, the virtualized infrastructure manager (VIM) and the virtualized network function (VNF), so the VNFM must
+
+ - The VNFM must be able to communicate with the ONAP VF-C interface, the virtualized infrastructure manager (VIM) and the virtualized network function (VNF), so the VNFM must
  have the correct network setup. The VNFM uses lifecycle notifications (LCNs) to notify the VF-C about the executed changes, therefore, the LCN zone of the
  VNFM must be configured so that the VNFM is able to reach the VF-C LCN interface.
 
@@ -17,7 +17,7 @@ Prepare the VNFM
  - Using SSH, log in to the CloudBand Application Manager (CBAM) virtual machine as cbam user and determine the Keycloak
   auto-generated admin password with the following command: ectl get /cbam/cluster/components/keycloak/admin_credentials/password
 
-  - Copy the printout of the command.
+ - Copy the printout of the command.
 
  - Access the Keycloak login page with the following URL: https://<cbamIp>/auth/admin where <cbamIp> is the FQDN or IP
  address assigned to CBAM node during instantiation. Optionally, it may contain a port, for example, cbam.mycompany.com:port or 1.2.3.4:port.
@@ -196,12 +196,20 @@ Add the VNFM driver to ONAP
 
 - Register the VNFM as an external system:
 
-  - Note: - Repeat this step for all VIMs planned to be used.
-
  - Access the following URL: http://msb.api.simpledemo.onap.org/iui/aai-esr-gui/extsys/vnfm/vnfmView.html
 
    - Result: The ONAP platform opens
 
+ - The VNFM has four end points. These end points must be configured in the external system configuration of the VNFM.
+
+  - Authentication endpoint: https://$CBAM_IP:443/auth/
+
+  - Life-cycle management endpoint: https://<cbamIp>:443/vnfm/lcm/v3/
+
+  - Life-cycle change notification endpoint: https://<cbamIp>:443/vnfm/lcn/v3/
+
+  - Catalog endpoint: https://<cbamIp>:443/api/catalog/adapter/
+
  - On the platform, click Register.
 
    - Result: The registration form opens.
@@ -210,27 +218,27 @@ Add the VNFM driver to ONAP
 
    - Note: Cloud credentials are supplied by the VNF integrator.
 
-+-----------------+-----------------------------------+
-| key             | Value                             |
-+-----------------+-----------------------------------+
-| Name            | CbamVnfm                          |
-+-----------------+-----------------------------------+
-| type            | NokiaSVNFM                        |
-+-----------------+-----------------------------------+
-| Vendor          | Nokia                             |
-+-----------------+-----------------------------------+
-| version         | v1                                |
-+-----------------+-----------------------------------+
-| URL             | https://<cbamIp>:443/vnfm/lcm/v3/ |
-+-----------------+-----------------------------------+
-| VIM             | <cloudOwner>_<cloudRegionId>      |
-+-----------------+-----------------------------------+
-| certificate URL |                                   |
-+-----------------+-----------------------------------+
-| Username        | <clientId>                        |
-+-----------------+-----------------------------------+
-| Password        | <clientSecret>                    |
-+-----------------+-----------------------------------+
++-----------------+------------------------------------------+
+| key             | Value                                    |
++-----------------+------------------------------------------+
+| Name            | CbamVnfm                                 |
++-----------------+------------------------------------------+
+| type            | NokiaSVNFM                               |
++-----------------+------------------------------------------+
+| Vendor          | Nokia                                    |
++-----------------+------------------------------------------+
+| version         | v1                                       |
++-----------------+------------------------------------------+
+| URL             | <authUrl>_<lcmUrl>_<lcnUrl>_<catalogUrl> |
++-----------------+------------------------------------------+
+| VIM             | any                                      |
++-----------------+------------------------------------------+
+| certificate URL |                                          |
++-----------------+------------------------------------------+
+| Username        | <onapUsername>_<clientId>                |
++-----------------+------------------------------------------+
+| Password        | <onapPassword>_<clientSecret>            |
++-----------------+------------------------------------------+
 
  - Click Save.
 
@@ -238,7 +246,6 @@ Add the VNFM driver to ONAP
 
  - Determine the UUID of the VNFM:
 
-   - Note: If the VNFM was registered multiple times, select one of them at random
    - Access the following URL: http://msb.api.simpledemo.onap.org:9518/api/aai-esr-server/v1/vnfms
    - Look for the previously registered VNFM and note the value of <vnfmId>.
 
@@ -260,13 +267,10 @@ Configure the SVNFM driver (generic)
 
 .. code-block:: console
 
-   export CBAM_IP=<cbamIp>
    export MULTI_NODE_IP=<multiNodeIp>
    export VNFM_ID=<vnfmId>
    export IMAGE_ID=<imageId>
-   export CBAM_PASSWORD=<onapPassword>
-   export CBAM_USERNAME=<onapUsername>
-   docker run --name vfc_nokia -p 8089:8089 -e "MSB_IP=$MULTI_NODE_IP" -e "CONFIGURE=kuku" -e "EXTERNAL_IP=$MULTI_NODE_IP" -e "CBAM_CATALOG_URL=https://$CBAM_IP:443/api/catalog/adapter/" -e "CBAM_LCN_URL=https://$CBAM_IP:443/vnfm/lcn/v3/" -e "CBAM_KEYCLOAK_URL=https://$CBAM_IP:443/auth/" -e "CBAM_USERNAME=$CBAM_USERNAME" -e "CBAM_PASSWORD=$CBAM_PASSWORD" -e "VNFM_ID=$VNFM_ID" -d --stop-timeout 300 $IMAGE_ID
+   docker run --name vfc_nokia -p 8089:8089 -e "MSB_IP=$MULTI_NODE_IP" -e "CONFIGURE=kuku" -e "EXTERNAL_IP=$MULTI_NODE_IP" -e "VNFM_ID=$VNFM_ID" -d --stop-timeout 300 $IMAGE_ID
 
 - Determine the identifier of the container:
 
@@ -295,6 +299,11 @@ This step is executed instead of the "Configure the SVNFM driver (generic)" in c
 - Configure the already running instance:
 
  - Execute the following command: docker exec -it `docker ps | grep nokiav2 | awk '{print $1}'` /bin/bash
+
  - Edit /service/application.properties:
 
-   - In this file, change the default values of the following keys to the correct values: cbamCatalogUrl, cbamLcnUrl, cbamKeyCloakBaseUrl, cbamUsername, cbamPassword, vnfmId
+   - In this file, change the default values of the following keys to the correct values: vnfmId
+
+ - Restart the VNFM service
+
+   - Execute the following command: ps -ef | grep java |
\ No newline at end of file
diff --git a/nokiav2/docs/intro.rst b/nokiav2/docs/intro.rst
new file mode 100644
index 00000000..fb7678f9
--- /dev/null
+++ b/nokiav2/docs/intro.rst
@@ -0,0 +1,45 @@
+Introduction to ONAP with Nokia VNFM
+====================================
+
+Supported features
+------------------
+
+ - Use VF-C LCM as data source for VIM & VNFM information
+
+ - Use VF-C catalog as data source for VNF template artifacts
+
+ - Integrate with multiple VNFM instances
+
+ - VNF instantiation with VF-C API
+
+ - VNF termination with VF-C API
+
+ - VNF scaling with VF-C API
+
+ - VNF healing with VF-C API
+
+ - VNF on-boarding to VNFM (part of instantiation)
+
+ - Send LCN to VF-C of the following elements:
+
+   - VNFC
+
+   - virtual link (internal)
+
+   - connection point (internal & external)
+
+ - Use SDC as data source for VNF template artifacts
+
+ - Use AAI as data source for VIM & VNFM information
+
+ - Directly manipulate the following resource in  A&AI
+
+   - generic VNF (may also be created previously)
+
+   - VNFC
+
+   - virtual server
+
+   - L3 networks
+
+   - logical interfaces
\ No newline at end of file
diff --git a/nokiav2/docs/sample/aai.create.cloud.region.request.json b/nokiav2/docs/sample/aai.create.cloud.region.request.json
new file mode 100644
index 00000000..9aa5a06c
--- /dev/null
+++ b/nokiav2/docs/sample/aai.create.cloud.region.request.json
@@ -0,0 +1,12 @@
+{
+  "cloud-owner": "Nokia",
+  "cloud-region-id": "RegionOne",
+  "cloud-type": "openstack",
+  "owner-defined-type": "Nokia",
+  "cloud-region-version": "ocata",
+  "identity-url": "https://10.41.49.22:5000/v3",
+  "cloud-zone": "any",
+  "complex-name": "any",
+  "sriov-automation": false,
+  "cloud-extra-info": ""
+}
\ No newline at end of file