From 5d044fdab03ee28309925a52af1c6964dbc73345 Mon Sep 17 00:00:00 2001 From: Marina Lipnitskaya Date: Wed, 31 Oct 2018 13:49:13 +0300 Subject: [PATCH] Update README.md --- README.md | 77 +++++++++++++++++++++++++++++++++++-------------------- 1 file changed, 49 insertions(+), 28 deletions(-) diff --git a/README.md b/README.md index 828089b9a..1f4b885eb 100644 --- a/README.md +++ b/README.md @@ -457,8 +457,11 @@ $ iofog-controller catalog <*command*> <*options*>
remove -- Delete a microservice.
list -- List all microservices.
info -- Get microservice settings.
- route -- Add/Remove microservice route.
- port-mapping -- Create/Delete/List microservice port mapping.
+ route-create -- Create microservice route.
+ route-remove -- Remove microservice route.
+ port-mapping-create -- Create microservice port mapping.
+ port-mapping-remove -- Remove microservice port mapping.
+ port-mapping-list -- List microservice port mapping.
*add -u* <*user-id*> @@ -500,17 +503,25 @@ $ iofog-controller catalog <*command*> <*options*>
-i, --microservice-id string (Microservice ID)
-*route*
+*route-create*
- -a, --add string (Add new route(s))
- -m, --remove string (Delete existing route(s))
+ -T, --route string (Microservice route (receiving microservices))
-*port-mapping*
+*route-remove*
- -i, --microservice-id string (Microservice ID)
- -b, --create (Add new port mapping(s))
- -B, --delete (Delete existing port mapping(s))
- -G, --list (List port mappings)
+ -T, --route string (Microservice route (receiving microservices))
+ +*port-mapping-create*
+ + -i, --microservice-id string (Microservice ID)
+ -P, --mapping string (Container port mapping)
+ +*port-mapping-remove*
+ + -i, --microservice-id string (Microservice ID)
+ -b, --internal-port string (Internal port)
+ +*port-mapping-list* **JSON ADD File Schema**
@@ -560,25 +571,35 @@ $ iofog-controller catalog <*command*> <*options*>
}
**Examples**
- 1. Single mapping ($ iofog-controller microservice add - [other required options] --volumes - /host_src:/container_src) - 2. Multiple mappings ($ iofog-controller microservice add - [other required options] --volumes - /host_src:/container_src - /host_bin:/container_bin) - 3. Port mapping ($ iofog-controller microservice add - (internal:external:publicMode) [other required options] --ports - 80:8080:false 443:5443:false) - 4. Add routes ($ iofog-controller microservice route - --add ABC:DEF) - 5. Delete route ($ iofog-controller microservice route - --remove ABC:DEF) - 6. Create port mapping ($ iofog-controller microservice port- - mapping --create 80:8080:false -i ABC) - 7. Delete port mapping ($ iofog-controller microservice port- - mapping --delete 80 -i ABC) + 1. Single mapping
+ $ iofog-controller microservice add [other required options] --volumes
+ /host_src:/container_src
+ + 2. Multiple mappings
+ $ iofog-controller microservice add [other required options] --volumes
+ /host_src:/container_src
+ /host_bin:/container_bin
+ + 3. Port mapping (80:8080:false - internal port : external port : public mode)
+ $ iofog-controller microservice add [other required options] --ports
+ 80:8080:false 443:5443:false
+ + 4. Add routes (ABC:DEF - source microservice id : dest microservice id)
+ $ iofog-controller microservice add [other required options] --routes
+ ABC:DEF RFG:HJK
+ + 5. Add route (ABC:DEF - source microservice id : dest microservice id)
+ $ iofog-controller microservice route-create --route ABC:DEF
+ + 6. Delete route (ABC:DEF - source microservice id : dest microservice id)
+ $ iofog-controller microservice route-remove --route ABC:DEF
+ + 7. Create port mapping (80:8080:false - internal port : external port : public mode, ABC - microservice)
+ $ iofog-controller microservice port-mapping-create --mapping 80:8080:false -i ABC
+ + 8. Delete port mapping (80 - internal port, ABC - microservice id)
+ $ iofog-controller microservice port-mapping-remove --internal-port 80 -i ABC