lcm/README.md

   1 Copyright 2017 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 vnf life cycle management.
  16
  17 1. Code structure guide
  18    ./         vnflcm project files
  19    ./docker   vnflcm docker related scripts
  20    ./logs     vnflcm log file
  21    ./lcm      vnf life cycle management
  22        ./nf      vnf life cycle API& logic
  23              ./               API url and const
  24              ./views          API related VNF views, each operation is a view
  25              ./serializers    API related request and response parametes.
  26                               Suggest related to sol003, each datatype is a file.
  27                               Common datatypes are put into the common file
  28              ./biz            VNF LCM mangement busyness logic files
  29              ./tests          all the test case. At least each API should have a test case
  30        ./jobs      vnf lcm related job
  31        ./pub       common class, including database, external micro service API, utils, and config parameters.
  32        ./samples   vnflcm micro service health check
  33        ./swagger   auto-generate vnflcm swagger