eagle-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From h..@apache.org
Subject [16/20] incubator-eagle git commit: Update README.md
Date Mon, 30 Nov 2015 10:11:58 GMT
Update README.md

Project: http://git-wip-us.apache.org/repos/asf/incubator-eagle/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-eagle/commit/aee5d6fa
Tree: http://git-wip-us.apache.org/repos/asf/incubator-eagle/tree/aee5d6fa
Diff: http://git-wip-us.apache.org/repos/asf/incubator-eagle/diff/aee5d6fa

Branch: refs/heads/master
Commit: aee5d6fa2e919e6eff2f21f4c047256cf4e86775
Parents: 8509591
Author: Hao Chen <haoch@users.noreply.github.com>
Authored: Mon Nov 30 16:02:39 2015 +0800
Committer: Hao Chen <haoch@users.noreply.github.com>
Committed: Mon Nov 30 16:02:39 2015 +0800

----------------------------------------------------------------------
 eagle-external/eagle-docker/README.md | 23 ++++++++++++++++++++++-
 1 file changed, 22 insertions(+), 1 deletion(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/incubator-eagle/blob/aee5d6fa/eagle-external/eagle-docker/README.md
----------------------------------------------------------------------
diff --git a/eagle-external/eagle-docker/README.md b/eagle-external/eagle-docker/README.md
index e272856..e3d35dc 100644
--- a/eagle-external/eagle-docker/README.md
+++ b/eagle-external/eagle-docker/README.md
@@ -8,7 +8,28 @@ And this project is to build apache/eagle images and provide eagle-functions
to
 ## Prerequisite
 * Docker environment (see [https://www.docker.com](https://www.docker.com/)) 
 
-## Installation & Usage
+## CLI Usage ##
+Basic usage of the entry script of eagle-docker: [bin/eagle-docker.sh](bin/eagle-docker.sh)
+ 
+    Usage: ./eagle-docker [options] [command]
+    
+    Apache Eagle Docker Image : apacheeagle/sandbox:latest
+    
+    Commands:
+      build           Build eagle docker image
+      deploy          Deploy eagle docker image
+      start           Start eagle docker instance
+      stop            Stop eagle docker instance
+      status          List eagle docker image and instance status
+      clean           Clean docker image and instance
+      shell           Execute docker instance bash, default: eagle-sandbox
+      boot            Simply bootstrap eagle docker by building then deploying
+    
+    Options:
+      --node [num]    Docker instances node number, default is 1
+      --help          Display eagle docker image usage information
+
+## Advanced Commands
 1. **Build Image**: Go to the root directory where the [Dockerfile](Dockerfile) is in, build
image with following command:
  
         docker built -t apache/eagle:0.1.0 . 


Mime
View raw message