Skip to content

Commit

Permalink
Update docs (#45)
Browse files Browse the repository at this point in the history
* Update QL docs link

* Change martel to smartsdk dockerhub domain

* Fix typo
  • Loading branch information
taliaga committed Aug 6, 2018
1 parent f4e5136 commit 6169f9f
Show file tree
Hide file tree
Showing 11 changed files with 27 additions and 29 deletions.
8 changes: 4 additions & 4 deletions recipes.ja/data-management/context-broker/ha/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ $ docker stack deploy -c docker-compose.yml orion
$ docker service ls
ID NAME MODE REPLICAS IMAGE
nrxbm6k0a2yn mongo-rs_mongo global 3/3 mongo:3.2
rgws8vumqye2 mongo-rs_mongo-controller replicated 1/1 martel/mongo-replica-ctrl:latest
rgws8vumqye2 mongo-rs_mongo-controller replicated 1/1 smartsdk/mongo-replica-ctrl:latest
zk7nu592vsde orion_orion replicated 3/3 fiware/orion:1.3.0
```

Expand Down Expand Up @@ -226,7 +226,7 @@ Docker は、コンテナがダウンした場合のサービスの調整を担
$ docker ps
CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
abc5e37037f0 fiware/orion@sha256:734c034d078d22f4479e8d08f75b0486ad5a05bfb36b2a1f1ba90ecdba2040a9 "/usr/bin/contextB..." 2 minutes ago Up 2 minutes 1026/tcp orion_orion.1.o9ebbardwvzn1gr11pmf61er8
1d79dca4ff28 martel/mongo-replica-ctrl@sha256:f53d1ebe53624dcf7220fe02b3d764f1b0a34f75cb9fff309574a8be0625553a "python /src/repli..." About an hour ago Up About an hour mongo-rs_mongo-controller.1.xomw6zf1o0wq0wbut9t5jx99j
1d79dca4ff28 smartsdk/mongo-replica-ctrl@sha256:f53d1ebe53624dcf7220fe02b3d764f1b0a34f75cb9fff309574a8be0625553a "python /src/repli..." About an hour ago Up About an hour mongo-rs_mongo-controller.1.xomw6zf1o0wq0wbut9t5jx99j
8ea3b24bee1c mongo@sha256:0d4453308cc7f0fff863df2ecb7aae226ee7fe0c5257f857fd892edf6d2d9057 "/usr/bin/mongod -..." About an hour ago Up About an hour 27017/tcp mongo-rs_mongo.ta8olaeg1u1wobs3a2fprwhm6.3akgzz28zp81beovcqx182nkz
```

Expand All @@ -241,13 +241,13 @@ $ docker rm -f abc5e37037f0
```
$ docker ps
CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
1d79dca4ff28 martel/mongo-replica-ctrl@sha256:f53d1ebe53624dcf7220fe02b3d764f1b0a34f75cb9fff309574a8be0625553a "python /src/repli..." About an hour ago Up About an hour mongo-rs_mongo-controller.1.xomw6zf1o0wq0wbut9t5jx99j
1d79dca4ff28 smartsdk/mongo-replica-ctrl@sha256:f53d1ebe53624dcf7220fe02b3d764f1b0a34f75cb9fff309574a8be0625553a "python /src/repli..." About an hour ago Up About an hour mongo-rs_mongo-controller.1.xomw6zf1o0wq0wbut9t5jx99j
8ea3b24bee1c mongo@sha256:0d4453308cc7f0fff863df2ecb7aae226ee7fe0c5257f857fd892edf6d2d9057 "/usr/bin/mongod -..." About an hour ago Up About an hour 27017/tcp mongo-rs_mongo.ta8olaeg1u1wobs3a2fprwhm6.3akgzz28zp81beovcqx182nkz
$ docker ps
CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
60ba3f431d9d fiware/orion@sha256:734c034d078d22f4479e8d08f75b0486ad5a05bfb36b2a1f1ba90ecdba2040a9 "/usr/bin/contextB..." 6 seconds ago Up Less than a second 1026/tcp orion_orion.1.uj1gghehb2s1gnoestup2ugs5
1d79dca4ff28 martel/mongo-replica-ctrl@sha256:f53d1ebe53624dcf7220fe02b3d764f1b0a34f75cb9fff309574a8be0625553a "python /src/repli..." About an hour ago Up About an hour mongo-rs_mongo-controller.1.xomw6zf1o0wq0wbut9t5jx99j
1d79dca4ff28 smartsdk/mongo-replica-ctrl@sha256:f53d1ebe53624dcf7220fe02b3d764f1b0a34f75cb9fff309574a8be0625553a "python /src/repli..." About an hour ago Up About an hour mongo-rs_mongo-controller.1.xomw6zf1o0wq0wbut9t5jx99j
8ea3b24bee1c mongo@sha256:0d4453308cc7f0fff863df2ecb7aae226ee7fe0c5257f857fd892edf6d2d9057 "/usr/bin/mongod -..." About an hour ago Up About an hour 27017/tcp mongo-rs_mongo.ta8olaeg1u1wobs3a2fprwhm6.3akgzz28zp81beovcqx182nkz
```

Expand Down
7 changes: 3 additions & 4 deletions recipes.ja/data-management/quantumleap/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

ここでは、QuantumLeap のさまざまな用途を目的としたレシピを見つけることが
できます。すでにあなたが QuantumLeapに精通していることを前提としています。
そうでなければ、[公式ドキュメント](https://smartsdk.github.io/ngsi-timeseries-api/)
そうでなければ、[公式ドキュメント](https://quantumleap.readthedocs.io)
を参照してください。

これらのレシピをテストするための環境の準備方法については、
Expand Down Expand Up @@ -188,11 +188,10 @@ $ sh insert.sh IP_OF_ANY_SWARM_NODE 8668

典型的なシナリオでは、ペイロードを `/notify` エンドポイントに直接送信するのでは
なく、通知 (notifications) の形式で、*Orion Context Broker* に送信することになり
ます。詳細は[公式ドキュメント](https://smartsdk.github.io/ngsi-timeseries-api/)
を参照してください。
ます。

これらのすべてのクエリについては、[ツール・セクション](../../tools/readme.md)
で利用可能な、postman コレクションを使用できます。

詳細については、[QuantumLeap のユーザ・マニュアル](https://smartsdk.github.io/ngsi-timeseries-api/)
詳細については、[QuantumLeap のユーザ・マニュアル](https://quantumleap.readthedocs.io)
を参照してください。
6 changes: 3 additions & 3 deletions recipes.ja/security/api-umbrella/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,7 @@ ID NAME IMAGE
mxxrlexvj0r9 mongo-rs_mongo.z69rvapjce827l69b6zehceal mongo:3.2 ms-worker1 Running Starting 9 seconds ago
d74orl0f0q7a mongo-rs_mongo.fw2ajm8zw4f12ut3sgffgdwsl mongo:3.2 ms-worker0 Running Starting 15 seconds ago
a2wddzw2g2fg mongo-rs_mongo.w697ke0djs3cfdf3bgbrcblam mongo:3.2 ms-manager0 Running Starting 6 seconds ago
nero0vahaa8h mongo-rs_controller.1 martel/mongo-replica-ctrl:latest ms-manager0 Running Running 5 seconds ago
nero0vahaa8h mongo-rs_controller.1 smartsdk/mongo-replica-ctrl:latest ms-manager0 Running Running 5 seconds ago
```

Swarm Cluster の IPs に基づいて mongo の接続 URL を設定するか、`frontend.env` ファイルを編集します :
Expand Down Expand Up @@ -148,8 +148,8 @@ Creating service api_api-umbrella
$ docker service ls

ID NAME MODE REPLICAS IMAGE PORTS
ca11lmx40tu5 api_api-umbrella replicated 2/2 martel/api-umbrella:0.14.4-1-fiware *:80->80/tcp,*:443->443/tcp
te1i0vhwtmnw mongo-rs_controller replicated 1/1 martel/mongo-replica-ctrl:latest
ca11lmx40tu5 api_api-umbrella replicated 2/2 smartsdk/api-umbrella:0.14.4-1-fiware *:80->80/tcp,*:443->443/tcp
te1i0vhwtmnw mongo-rs_controller replicated 1/1 smartsdk/mongo-replica-ctrl:latest
rbo2oe2y0d72 mongo-rs_mongo global 3/3 mongo:3.2
```

Expand Down
4 changes: 2 additions & 2 deletions recipes.ja/utils/mongo-replicaset/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ $ docker stack deploy -c docker-compose.yml mongo-rs
$ docker service ls
ID NAME MODE REPLICAS IMAGE
fjxof1n5ce58 mongo-rs_mongo global 3/3 mongo:latest
yzsur7rb4mg1 mongo-rs_mongo-controller replicated 1/1 martel/mongo-replica-ctrl:latest
yzsur7rb4mg1 mongo-rs_mongo-controller replicated 1/1 smartsdk/mongo-replica-ctrl:latest
```

## ウォークスルー
Expand Down Expand Up @@ -125,7 +125,7 @@ docker@ms-worker2:~$ exit
$ docker service ls
ID NAME MODE REPLICAS IMAGE
fjxof1n5ce58 mongo-rs_mongo global 4/4 mongo:latest
yzsur7rb4mg1 mongo_mongo-controller replicated 1/1 martel/mongo-replica-ctrl:latest
yzsur7rb4mg1 mongo_mongo-controller replicated 1/1 smartsdk/mongo-replica-ctrl:latest
$ docker logs $(docker ps -f "name=mongo_mongo-controller" -q)
...
Expand Down
8 changes: 4 additions & 4 deletions recipes/data-management/context-broker/ha/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ At some point, your deployment should look like this...
$ docker service ls
ID NAME MODE REPLICAS IMAGE
nrxbm6k0a2yn mongo-rs_mongo global 3/3 mongo:3.2
rgws8vumqye2 mongo-rs_mongo-controller replicated 1/1 martel/mongo-replica-ctrl:latest
rgws8vumqye2 mongo-rs_mongo-controller replicated 1/1 smartsdk/mongo-rs-controller-swarm:latest
zk7nu592vsde orion_orion replicated 3/3 fiware/orion:1.3.0
```

Expand Down Expand Up @@ -231,7 +231,7 @@ node):
$ docker ps
CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
abc5e37037f0 fiware/orion@sha256:734c034d078d22f4479e8d08f75b0486ad5a05bfb36b2a1f1ba90ecdba2040a9 "/usr/bin/contextB..." 2 minutes ago Up 2 minutes 1026/tcp orion_orion.1.o9ebbardwvzn1gr11pmf61er8
1d79dca4ff28 martel/mongo-replica-ctrl@sha256:f53d1ebe53624dcf7220fe02b3d764f1b0a34f75cb9fff309574a8be0625553a "python /src/repli..." About an hour ago Up About an hour mongo-rs_mongo-controller.1.xomw6zf1o0wq0wbut9t5jx99j
1d79dca4ff28 smartsdk/mongo-rs-controller-swarm@sha256:f53d1ebe53624dcf7220fe02b3d764f1b0a34f75cb9fff309574a8be0625553a "python /src/repli..." About an hour ago Up About an hour mongo-rs_mongo-controller.1.xomw6zf1o0wq0wbut9t5jx99j
8ea3b24bee1c mongo@sha256:0d4453308cc7f0fff863df2ecb7aae226ee7fe0c5257f857fd892edf6d2d9057 "/usr/bin/mongod -..." About an hour ago Up About an hour 27017/tcp mongo-rs_mongo.ta8olaeg1u1wobs3a2fprwhm6.3akgzz28zp81beovcqx182nkz
```

Expand All @@ -246,13 +246,13 @@ You will see it gone, but after a while it will automatically come back.
```
$ docker ps
CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
1d79dca4ff28 martel/mongo-replica-ctrl@sha256:f53d1ebe53624dcf7220fe02b3d764f1b0a34f75cb9fff309574a8be0625553a "python /src/repli..." About an hour ago Up About an hour mongo-rs_mongo-controller.1.xomw6zf1o0wq0wbut9t5jx99j
1d79dca4ff28 smartsdk/mongo-rs-controller-swarm@sha256:f53d1ebe53624dcf7220fe02b3d764f1b0a34f75cb9fff309574a8be0625553a "python /src/repli..." About an hour ago Up About an hour mongo-rs_mongo-controller.1.xomw6zf1o0wq0wbut9t5jx99j
8ea3b24bee1c mongo@sha256:0d4453308cc7f0fff863df2ecb7aae226ee7fe0c5257f857fd892edf6d2d9057 "/usr/bin/mongod -..." About an hour ago Up About an hour 27017/tcp mongo-rs_mongo.ta8olaeg1u1wobs3a2fprwhm6.3akgzz28zp81beovcqx182nkz
$ docker ps
CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
60ba3f431d9d fiware/orion@sha256:734c034d078d22f4479e8d08f75b0486ad5a05bfb36b2a1f1ba90ecdba2040a9 "/usr/bin/contextB..." 6 seconds ago Up Less than a second 1026/tcp orion_orion.1.uj1gghehb2s1gnoestup2ugs5
1d79dca4ff28 martel/mongo-replica-ctrl@sha256:f53d1ebe53624dcf7220fe02b3d764f1b0a34f75cb9fff309574a8be0625553a "python /src/repli..." About an hour ago Up About an hour mongo-rs_mongo-controller.1.xomw6zf1o0wq0wbut9t5jx99j
1d79dca4ff28 smartsdk/mongo-rs-controller-swarm@sha256:f53d1ebe53624dcf7220fe02b3d764f1b0a34f75cb9fff309574a8be0625553a "python /src/repli..." About an hour ago Up About an hour mongo-rs_mongo-controller.1.xomw6zf1o0wq0wbut9t5jx99j
8ea3b24bee1c mongo@sha256:0d4453308cc7f0fff863df2ecb7aae226ee7fe0c5257f857fd892edf6d2d9057 "/usr/bin/mongod -..." About an hour ago Up About an hour 27017/tcp mongo-rs_mongo.ta8olaeg1u1wobs3a2fprwhm6.3akgzz28zp81beovcqx182nkz
```

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
stackfile: recipes/data-management/quantumleap/docker-compose.yml
env:
- name: QL_VERSION
label: QuantumLeap Verions
label: QuantumLeap Version
- name: CRATE_HOST
label: CRATE Host
- name: CRATE_VERSION
Expand Down
7 changes: 3 additions & 4 deletions recipes/data-management/quantumleap/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

Here you can find recipes aimed at different usages of QuantumLeap. We assume
you are already familiar with it, otherwise refer to the
[official documentation](https://smartsdk.github.io/ngsi-timeseries-api/).
[official documentation](https://quantumleap.readthedocs.io/en/latest/).

Instructions on how to prepare your environment to test these recipes are given
in the [installation section](../../installation.md).
Expand Down Expand Up @@ -195,11 +195,10 @@ Dashboard.

Remember in the typical scenario, it is not the client that will be sending
payloads directly to the `/notify` endpoint, but rather *Orion Context Broker*
in the form of notifications. More info in the
[official documentation](https://smartsdk.github.io/ngsi-timeseries-api/).
in the form of notifications.

For all these queries, you can use the postman collection available in the
[tools section](../../tools/readme.md).

For further information, please refer to the
[QuantumLeap's User Manual](https://smartsdk.github.io/ngsi-timeseries-api/).
[QuantumLeap's User Manual](https://quantumleap.readthedocs.io/en/latest/user/).
2 changes: 1 addition & 1 deletion recipes/security/api-umbrella/docker-compose.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ version: '3.3'
services:

api-umbrella:
image: martel/api-umbrella:${API_UMBRELLA_VERSION:-0.14.4-1-fiware}
image: smartsdk/api-umbrella:${API_UMBRELLA_VERSION:-0.14.4-1-fiware}
ports:
- "80:80"
- "443:443"
Expand Down
6 changes: 3 additions & 3 deletions recipes/security/api-umbrella/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@ ID NAME IMAGE
mxxrlexvj0r9 mongo-rs_mongo.z69rvapjce827l69b6zehceal mongo:3.2 ms-worker1 Running Starting 9 seconds ago
d74orl0f0q7a mongo-rs_mongo.fw2ajm8zw4f12ut3sgffgdwsl mongo:3.2 ms-worker0 Running Starting 15 seconds ago
a2wddzw2g2fg mongo-rs_mongo.w697ke0djs3cfdf3bgbrcblam mongo:3.2 ms-manager0 Running Starting 6 seconds ago
nero0vahaa8h mongo-rs_controller.1 martel/mongo-replica-ctrl:latest ms-manager0 Running Running 5 seconds ago
nero0vahaa8h mongo-rs_controller.1 smartsdk/mongo-rs-controller-swarm:latest ms-manager0 Running Running 5 seconds ago
```

Set the connection url for mongo based on the IPs of your Swarm Cluster
Expand Down Expand Up @@ -155,8 +155,8 @@ will look like this:
$ docker service ls

ID NAME MODE REPLICAS IMAGE PORTS
ca11lmx40tu5 api_api-umbrella replicated 2/2 martel/api-umbrella:0.14.4-1-fiware *:80->80/tcp,*:443->443/tcp
te1i0vhwtmnw mongo-rs_controller replicated 1/1 martel/mongo-replica-ctrl:latest
ca11lmx40tu5 api_api-umbrella replicated 2/2 smartsdk/api-umbrella:0.14.4-1-fiware *:80->80/tcp,*:443->443/tcp
te1i0vhwtmnw mongo-rs_controller replicated 1/1 smartsdk/mongo-rs-controller-swarm:latest
rbo2oe2y0d72 mongo-rs_mongo global 3/3 mongo:3.2
```

Expand Down
2 changes: 1 addition & 1 deletion recipes/utils/mongo-replicaset/docker-compose.yml
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ services:
delay: 1m30s

controller:
image: martel/mongo-replica-ctrl:latest
image: smartsdk/mongo-rs-controller-swarm:latest
volumes:
# TODO: Avoid exposing the docker socket (security issue)
- /var/run/docker.sock:/var/run/docker.sock
Expand Down
4 changes: 2 additions & 2 deletions recipes/utils/mongo-replicaset/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ running...
$ docker service ls
ID NAME MODE REPLICAS IMAGE
fjxof1n5ce58 mongo-rs_mongo global 3/3 mongo:latest
yzsur7rb4mg1 mongo-rs_mongo-controller replicated 1/1 martel/mongo-replica-ctrl:latest
yzsur7rb4mg1 mongo-rs_mongo-controller replicated 1/1 smartsdk/mongo-rs-controller-swarm:latest
```

## A Walkthrough
Expand Down Expand Up @@ -134,7 +134,7 @@ Back to the host, some minutes later...
$ docker service ls
ID NAME MODE REPLICAS IMAGE
fjxof1n5ce58 mongo-rs_mongo global 4/4 mongo:latest
yzsur7rb4mg1 mongo_mongo-controller replicated 1/1 martel/mongo-replica-ctrl:latest
yzsur7rb4mg1 mongo_mongo-controller replicated 1/1 smartsdk/mongo-rs-controller-swarm:latest
$ docker logs $(docker ps -f "name=mongo_mongo-controller" -q)
...
Expand Down

0 comments on commit 6169f9f

Please sign in to comment.