summaryrefslogtreecommitdiffstats
path: root/lcm
diff options
context:
space:
mode:
authormaopengzhang <zhang.maopeng1@zte.com.cn>2018-08-06 19:49:43 +0800
committermaopengzhang <zhang.maopeng1@zte.com.cn>2018-08-06 19:49:43 +0800
commita241c7043b2496004c8f2ea18a6f4376de91a61e (patch)
tree238a79a5d75f909cd50e912fe10773ecf5b926de /lcm
parent5856d335c0ed0f256fa186373af7165cecb879a6 (diff)
SOL003 API Align code guide
SOL003 API ALign -VNFLCM code guide Change-Id: I1f32479b1f77553f215f643f1ce6a8ca8ef553f4 Issue-ID: VFC-635 Signed-off-by: maopengzhang <zhang.maopeng1@zte.com.cn>
Diffstat (limited to 'lcm')
-rw-r--r--lcm/README.md18
1 files changed, 18 insertions, 0 deletions
diff --git a/lcm/README.md b/lcm/README.md
index 65717d61..159c1036 100644
--- a/lcm/README.md
+++ b/lcm/README.md
@@ -13,3 +13,21 @@ See the License for the specific language governing permissions and
limitations under the License.
Micro service of vnf life cycle management.
+
+1. Code structure guide
+ ./ vnflcm project files
+ ./docker vnflcm docker related scripts
+ ./logs vnflcm log file
+ ./lcm vnf life cycle management
+ ./nf vnf life cycle API& logic
+ ./ API url and const
+ ./views API related VNF views, each operation is a view
+ ./serializers API related request and response parametes.
+ Suggest related to sol003, each datatype is a file.
+ Common datatypes are put into the common file
+ ./biz VNF LCM mangement busyness logic files
+ ./tests all the test case. At least each API should have a test case
+ ./jobs vnf lcm related job
+ ./pub common class, including database, external micro service API, utils, and config parameters.
+ ./samples vnflcm micro service health check
+ ./swagger auto-generate vnflcm swagger