summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md21
1 files changed, 21 insertions, 0 deletions
diff --git a/README.md b/README.md
index 7b59118f..75e5e502 100644
--- a/README.md
+++ b/README.md
@@ -13,3 +13,24 @@
# limitations under the License.
# Micro service of network service life cycle management.
+
+1. Code structure guide
+ ./ nslcm project files
+ ./docker nslcm docker related scripts
+ ./logs nslcm log file
+ ./lcm NS life cycle management
+ ./ns NS life cycle API& logic
+ ./ API url and const
+ ./views API related NS views, each operation is a view
+ ./serializers API related request and response parametes.
+ Suggest related to sol003/sol005, each datatype is a file.
+ Common datatypes are put into the common file
+ ./biz NS LCM mangement busyness logic files
+ ./tests all the test case. At least each API should have a test case
+ ./ns_sfcs SFC of NS API & logic
+ ./ns_vls vl in NS API & logic
+ ./ns_vnfs vnf in NS API & logic, which is used to integrate with VNFM drivers.
+ ./jobs nslcm related job
+ ./pub common class, including database model, external micro service API, utils, and config parameters.
+ ./samples project micro service health check
+ ./swagger auto-generate nslcm swagger