You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@griffin.apache.org by gu...@apache.org on 2018/09/14 02:39:28 UTC
incubator-griffin git commit: Improve document quality
Repository: incubator-griffin
Updated Branches:
refs/heads/master d5f337e5d -> a459a0dae
Improve document quality
Revise docker guide document and append more descriptions.
Author: Eugene <li...@apache.org>
Closes #411 from toyboxman/doc/docker.
Project: http://git-wip-us.apache.org/repos/asf/incubator-griffin/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-griffin/commit/a459a0da
Tree: http://git-wip-us.apache.org/repos/asf/incubator-griffin/tree/a459a0da
Diff: http://git-wip-us.apache.org/repos/asf/incubator-griffin/diff/a459a0da
Branch: refs/heads/master
Commit: a459a0dae6213a1caf7fe8ee129b1701b3376c04
Parents: d5f337e
Author: Eugene <li...@apache.org>
Authored: Fri Sep 14 10:39:20 2018 +0800
Committer: William Guo <gu...@apache.org>
Committed: Fri Sep 14 10:39:20 2018 +0800
----------------------------------------------------------------------
griffin-doc/docker/griffin-docker-guide.md | 25 +++++++++++++------
griffin-doc/img/devguide/call_postman.png | Bin 0 -> 186495 bytes
.../img/devguide/import_postman_conf.png | Bin 0 -> 142743 bytes
griffin-doc/img/devguide/revise_postman_env.png | Bin 0 -> 129575 bytes
4 files changed, 18 insertions(+), 7 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-griffin/blob/a459a0da/griffin-doc/docker/griffin-docker-guide.md
----------------------------------------------------------------------
diff --git a/griffin-doc/docker/griffin-docker-guide.md b/griffin-doc/docker/griffin-docker-guide.md
index 6ac3775..83a3543 100644
--- a/griffin-doc/docker/griffin-docker-guide.md
+++ b/griffin-doc/docker/griffin-docker-guide.md
@@ -55,13 +55,24 @@ Griffin docker images are pre-built on docker hub, users can pull them to try gr
### How to use griffin docker images in batch mode
1. Copy [docker-compose-batch.yml](compose/docker-compose-batch.yml) to your work path.
-2. In your work path, start docker containers by using docker compose, wait for about one minutes, then griffin service is ready.
- ```
- docker-compose -f docker-compose-batch.yml up -d
- ```
-3. Now you can try griffin APIs by using postman after importing the [json files](../service/postman).
- In which you need to modify the environment `BASE_PATH` value to `<your local IP address>:38080`.
-4. You can try the api `Basic -> Get griffin version`, to make sure griffin service has started up.
+2. In your work path, start docker containers by using docker compose, wait for about one minute, then griffin service is ready.
+ ```bash
+ $ docker-compose -f docker-compose-batch.yml up -d
+ ```
+ After approximate one minute, you can check result. If result looks like below, it means startup is successful.
+ ```bash
+ $ docker container ls
+ CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
+ bfec3192096d apachegriffin/griffin_spark2:0.3.0 "/etc/bootstrap-al..." 5 hours ago Up 5 hours 6066/tcp, 8030-8033/tcp, 8040/tcp, 9000/tcp, 10020/tcp, 19888/tcp, 27017/tcp, 49707/tcp, 50010/tcp, 50020/tcp, 50070/tcp, 50075/tcp, 50090/tcp, 0.0.0.0:32122->2122/tcp, 0.0.0.0:33306->3306/tcp, 0.0.0.0:35432->5432/tcp, 0.0.0.0:38042->8042/tcp, 0.0.0.0:38080->8080/tcp, 0.0.0.0:38088->8088/tcp, 0.0.0.0:38998->8998/tcp, 0.0.0.0:39083->9083/tcp griffin
+ fb9d04285070 apachegriffin/elasticsearch "/docker-entrypoin..." 5 hours ago Up 5 hours 0.0.0.0:39200->9200/tcp, 0.0.0.0:39300->9300/tcp es
+ ```
+3. Now you can try griffin APIs by using any http client, here we use [postman](https://github.com/postmanlabs/postman-app-support) as example.
+We have prepared two postman configuration files, you can download them from [json files](../service/postman).<br><br>For sake of usage, you need to import two files into postman firstly.<br><br>
+<br><br>
+And change the initial environment `BASE_PATH` value to `<your local IP address>:38080`.<br><br>
+<br><br>
+4. You can try the api `Basic -> Get griffin version`, to make sure griffin service has started up.<br><br>
+<br><br>
5. Add an accuracy measure through api `Measures -> Add measure`, to create a measure in griffin.
6. Add a job to through api `jobs -> Add job`, to schedule a job to execute the measure. In the example, the schedule interval is 5 minutes.
7. After some minutes, you can get the metrics from elasticsearch.
http://git-wip-us.apache.org/repos/asf/incubator-griffin/blob/a459a0da/griffin-doc/img/devguide/call_postman.png
----------------------------------------------------------------------
diff --git a/griffin-doc/img/devguide/call_postman.png b/griffin-doc/img/devguide/call_postman.png
new file mode 100644
index 0000000..4bb8533
Binary files /dev/null and b/griffin-doc/img/devguide/call_postman.png differ
http://git-wip-us.apache.org/repos/asf/incubator-griffin/blob/a459a0da/griffin-doc/img/devguide/import_postman_conf.png
----------------------------------------------------------------------
diff --git a/griffin-doc/img/devguide/import_postman_conf.png b/griffin-doc/img/devguide/import_postman_conf.png
new file mode 100644
index 0000000..77b86c0
Binary files /dev/null and b/griffin-doc/img/devguide/import_postman_conf.png differ
http://git-wip-us.apache.org/repos/asf/incubator-griffin/blob/a459a0da/griffin-doc/img/devguide/revise_postman_env.png
----------------------------------------------------------------------
diff --git a/griffin-doc/img/devguide/revise_postman_env.png b/griffin-doc/img/devguide/revise_postman_env.png
new file mode 100644
index 0000000..3b64ef4
Binary files /dev/null and b/griffin-doc/img/devguide/revise_postman_env.png differ