README.md

   1 [comment]: # (# Copyright 2018 Huawei Technologies Co., Ltd.)
   2 [comment]: # (# )
   3 [comment]: # (Licensed under the Apache License, Version 2.0 (the "License")
   4 [comment]: # (# you may not use this file except in compliance with the License.)
   5 [comment]: # (# You may obtain a copy of the License at)
   6 [comment]: # (#)
   7 [comment]: # (#     http://www.apache.org/licenses/LICENSE-2.0)
   8 [comment]: # (#)
   9 [comment]: # (# Unless required by applicable law or agreed to in writing, software)
  10 [comment]: # (# distributed under the License is distributed on an "AS IS" BASIS,)
  11 [comment]: # (# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.)
  12 [comment]: # (# See the License for the specific language governing permissions and)
  13 [comment]: # (# limitations under the License.)
  14
  15 VNFSDK Marketplace
  16 ==================
  17
  18 VNFSDK marketplace provides
  19
  20  1. Marketplace portal - operator uses this for managing the VNF packages
  21  2. VNF package repository - Backend repo for persisting the VNF packages
  22  3. VNF testing platform - Platform for testing VNF for a given ONAP environment.
  23
  24 VNF Test Platform (VTP)
  25 =======================
  26 A platform to automate and manage different kind of VNF test cases for given VNF package(s) and provides unified accessibility over CLI, REST API and  UI portal for operating the test cases. Also it facilitate to write test cases in different languages like java,  shell scripts, python, etc.
  27
  28 - LFN/ONAP wants test platform where VNF packages could be certified using ONAP requirements to drive industry adoption
  29 - Provide an platform where vendor/operator can develop, deploy, run test cases and query the results
  30 - Test cases, test results and VNF should be manageable .i,e with authorization, so only user with given roles is allowed to perform operation like VNF package upload/download, run compliance verification tests, allow only specific VIM for specific users, etc.
  31 - Test results should be persisted and should be available for human analysis later via LFN infrastructure.
  32 - Provides test flow where author make flow across different test cases for a given program like compliance verification and  VNFREQS/SOL0004.
  33 - Provide integration with OPNFV dovetail to run test cases across dovetail and ONAP VNFSDK.
  34 - Uses Open CLI Platform (OCLIP) for developing, testing, deploying and executing test cases
  35 - Available as docker container.
  36 - More details at <https://onap.readthedocs.io/en/latest/submodules/vnfsdk/model.git/docs/index.html>`
  37
  38 Docker image building
  39 =====================
  40 ```
  41     mvn clean package -Pdocker -Dpush.docker.image=false
  42 ```
  43
  44 Run refrepo locally
  45 ======================
  46 ```
  47     docker run --name refrepo -p 8702:8702 nexus3.onap.org:10003/onap/vnfsdk/refrepo:latest
  48 ```
  49
  50 Refrepo container - important folders
  51 =====================================
  52 To browse folder you must enter to the refrepo container, so first run docker container locally (see above section) then execute
  53 ```
  54     docker exec -it refrepo bash
  55 ```
  56
  57 In the running container you will find a few important folders:
  58 - /service/logs - it contains vnfmarket application logs
  59 - /opt/vtp/logs - it contains oclip logs
  60 - /opt/vtp/lib - it contains oclip dependencies, such as: validation-csar-XXX.jar file
  61
  62 Verify validation logic
  63 =============================
  64 If you want to verify validation logic (validation-csar project), first you need to build validation-csar project,
  65 next remove existing validation-csar.jar from /opt/vpt/lib folder in the container
  66 and then copy the new validation-csar jar file into the /opt/vpt/lib folder in the container and restart this container.
  67
  68 ```
  69     1. docker exec -it refrepo bash
  70     2. Inside the container: rm /opt/vtp/lib/ validation-csar-XXX.jar
  71     3. docker cp validation-csar.jar refrepo:/opt/vtp/lib
  72     4. docker restart refrepo
  73 ```
  74
  75 VNF Marketplace UI
  76 ==================
  77 VNF Marketplace UI is available at <http://127.0.0.1:8702/onapui/vnfmarket>