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 root dir files, including license, pom, tox, start/stop scripts, log configuration, etc
  19    ./docker     nslcm docker related scripts
  20    ./docs       nslcm project documents
  21    ./lcm        NS life cycle management
  22        ./jobs      nslcm related job
  23        ./ns        NS life cycle API&logic
  24              ./               API url, const, enum files
  25              ./biz            NS LCM management busyness logic files
  26              ./data           NS LCM workflow plans
  27              ./serializers    API related request and response definitions.
  28              ./tests          Test cases
  29              ./views          API related NS views
  30        ./ns_pnfs   PNF related API&logic in NS layer
  31        ./ns_sfcs   SFC related API&logic in NS layer
  32        ./ns_vls    VL related API&logic in NS layer
  33        ./ns_vnfs   VNF related API&logic in NS layer
  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
  37        ./workflows workflow related logic
  38    ./logs       nslcm log file
  39    ./resources  nslcm resources, including database scripts