Skip to content
This repository was archived by the owner on Nov 21, 2022. It is now read-only.

Commit 224408c

Browse files
author
Archit Sharma
committed
update lib/*/README.md
1 parent 2e0854d commit 224408c

File tree

5 files changed

+24
-43
lines changed

5 files changed

+24
-43
lines changed

lib/backend/README.md

Lines changed: 5 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,10 @@
11
#DEPLOYMENT INSTRUCTIONS
22

3-
NOTE: Before building, ensure that you have set the correct URLs of
4-
ElasticSearch and Grafana instances under backend/conf/sar-index.cfg
5-
6-
- To build the image, refer:
3+
1. Configure ../../conf/sarjitsu.conf. Refer to project's main README.md
74

8-
```
9-
docker build -t sarjitsu_backend .
10-
```
5+
2. Make sure no previous running/stopped instance of this container ID exists.
6+
Container id for this could be configured from ../../conf/sarjitsu.conf
7+
8+
3. Run: `$ ./launch_backend`
119

12-
- To run using the container, refer the following command:
1310

14-
```
15-
docker run --privileged -it -d -v /sys/fs/cgroup:/sys/fs/cgroup:ro sarjitsu_backend
16-
```

lib/datasource/README.md

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,9 @@
11
#DEPLOYMENT INSTRUCTIONS
22

3-
- To build the image, refer:
3+
1. Configure ../../conf/sarjitsu.conf. Refer to project's main README.md
44

5-
```
6-
docker build -t sarjitsu_elasticsearch .
7-
```
5+
2. Make sure no previous running/stopped instance of this container ID exists.
6+
Container id for this could be configured from ../../conf/sarjitsu.conf
87

9-
- To run using the container, refer the following command:
8+
3. Run: `$ ./launch_elastic`
109

11-
```
12-
docker run --privileged -it -d -v /sys/fs/cgroup:/sys/fs/cgroup:ro sarjitsu_elasticsearch
13-
```

lib/frontend/README.md

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,9 @@
11
#DEPLOYMENT INSTRUCTIONS
22

3-
- To build the image, refer:
3+
1. Configure ../../conf/sarjitsu.conf. Refer to project's main README.md
44

5-
```
6-
docker build -t sarjitsu_grafana .
7-
```
5+
2. Make sure no previous running/stopped instance of this container ID exists.
6+
Container id for this could be configured from ../../conf/sarjitsu.conf
87

9-
- To run using the container, refer the following command:
8+
3. Run: `$ ./launch_grafana`
109

11-
```
12-
docker run --privileged -it -d -v /sys/fs/cgroup:/sys/fs/cgroup:ro sarjitsu_grafana
13-
```

lib/metricstore/README.md

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,9 @@
11
#DEPLOYMENT INSTRUCTIONS
22

3-
- To run using the container, refer the following command:
4-
```
5-
docker run --name <postgres_jistu> \
6-
-e POSTGRES_PASSWORD=<psql_password> \
7-
-e POSTGRES_USER=<psql_username> \
8-
-e POSTGRES_DB=<psql_db_name> \
9-
-d postgres
10-
```
3+
1. Configure ../../conf/sarjitsu.conf. Refer to project's main README.md
4+
5+
2. Make sure no previous running/stopped instance of this container ID exists.
6+
Container id for this could be configured from ../../conf/sarjitsu.conf
7+
8+
3. Run: `$ ./launch_postgres`
9+

lib/middleware/README.md

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,9 @@
11
#DEPLOYMENT INSTRUCTIONS
22

3-
- To build the image, refer:
3+
1. Configure ../../conf/sarjitsu.conf. Refer to project's main README.md
44

5-
```
6-
docker build -t sarjitsu_grafana .
7-
```
5+
2. Make sure no previous running/stopped instance of this container ID exists.
6+
Container id for this could be configured from ../../conf/sarjitsu.conf
87

9-
- To run using the container, refer the following command:
8+
3. Run: `$ ./launch_api_server`
109

11-
```
12-
docker run --privileged -it -d -v /sys/fs/cgroup:/sys/fs/cgroup:ro sarjitsu_grafana
13-
```

0 commit comments

Comments
 (0)