README.md

   1 # Copyright 2016 ZTE Corporation.
   2 #
   3 # Licensed under the Apache License, Version 2.0 (the "License");
   4 # you may not use this file except in compliance with the License.
   5 # You may obtain a copy of the License at
   6 #
   7 #         http://www.apache.org/licenses/LICENSE-2.0
   8 #
   9 # Unless required by applicable law or agreed to in writing, software
  10 # distributed under the License is distributed on an "AS IS" BASIS,
  11 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12 # See the License for the specific language governing permissions and
  13 # limitations under the License.
  14
  15 # Micro service of network service life cycle management.
  16
  17 1. Code structure guide
  18    ./         nslcm project files
  19    ./docker   nslcm docker related scripts
  20    ./logs     nslcm log file
  21    ./lcm      NS life cycle management
  22        ./ns      NS life cycle API& logic
  23              ./               API url and const
  24              ./views          API related NS views, each operation is a view
  25              ./serializers    API related request and response parametes.
  26                               Suggest related to sol003/sol005, each datatype is a file.
  27                               Common datatypes are put into the common file
  28              ./biz            NS LCM mangement busyness logic files
  29              ./tests          all the test case. At least each API should have a test case
  30         ./ns_sfcs  SFC of NS API & logic
  31         ./ns_vls   vl in NS API & logic
  32         ./ns_vnfs  vnf in NS API & logic, which is used to integrate with VNFM drivers.
  33        ./jobs      nslcm related job
  34        ./pub       common class, including database model, external micro service API, utils, and config parameters.
  35        ./samples   project micro service health check
  36        ./swagger   auto-generate nslcm swagger