summaryrefslogtreecommitdiffstats
path: root/lcm/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'lcm/README.md')
-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