You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
You should be good to go! The last step, Step #5, is **only applicable** if you need to configure <imgsrc="./app/assets/docker-logo-color.png"alt="Docker"title="Docker"align="center"height="20" /> for your application.
159
156
157
+
### 5. Docker Configuration
160
158
159
+
Again, this step is **only applicable** if you are currently using <imgsrc="./app/assets/docker-logo-color.png"alt="Docker"title="Docker"align="center"height="20" /> containers for your microservices.
160
+
161
+
<imgsrc="./app/assets/important.png"alt="Important"title="Important"align="center"height="20" /> Give your containers the same names you pass as arguments for microservice names.
162
+
163
+
<imgsrc="./app/assets/important.png"alt="Important"title="Important"align="center"height="20" /> In order to have container stats saved to your database, along with other health info, bind volumes to this path when starting up the containers:
164
+
```
165
+
/var/run/docker.sock
166
+
```
167
+
168
+
For example, you can type the following when starting up a container:
169
+
```
170
+
docker run -v /var/run/docker.sock:/var/run/docker.sock [your-image-tag]
171
+
```
172
+
173
+
If you're using `docker-compose` to start up multiple containers, you can add a `volumes` key for each of your services in the `docker-compose.yml` file:
174
+
175
+
```
176
+
volumes:
177
+
- "/var/run/docker.sock:/var/run/docker.sock"
178
+
```
161
179
#
162
180
###### Return to [Top](#Chronos)
163
181
<br>
@@ -222,7 +240,8 @@ notifications: [
222
240
223
241
## Branches
224
242
225
-
### Master
243
+
### Master Branch
244
+
#
226
245
227
246
The **'master'** branch of this repository is where the <imgsrc="./app/assets/electron-logo-color.png"alt="Electron"title="Electron"align="center"height="20" /> application for Chronos is deployed. The Chronos monitoring tool includes two database examples, one PostgresQL and one MongoDB, with sample data sets.
228
247
@@ -231,46 +250,31 @@ The **'master'** branch of this repository is where the <img src="./app/assets/e
231
250
root directory -> electron -> user -> settings.json
232
251
```
233
252
234
-
#### Examples
253
+
### Examples
254
+
#
235
255
236
-
We provide two working example microservice applications in the `master` branch for you to test out Chronos.
256
+
We provide two working example microservice applications in the `master` branch for you to test out Chronos: `microservices` and `docker`.
237
257
238
258
#### Microservices
259
+
#
239
260
240
-
The **'dummy-microservice'** branch is where we provide a test suite of sample microservices application that successfully utilizes Chronos to apply all the powerful, built-in features of our monitoring tool. You can then visualize the data with the <imgsrc="./app/assets/electron-logo-color.png"alt="Electron"title="Electron"align="center"height="20" /> app.
241
-
242
-
The microservices include individual <imgsrc="./app/assets/docker-logo-color.png"alt="Docker"title="Docker"align="center"height="20" />files in their respective directories. A docker-compose.yml is in the root directory in case you'd like to deploy all services together.
261
+
In the `microservices` folder, we provide a sample microservice application that successfully utilizes Chronos to apply all the powerful, built-in features of our monitoring tool. You can then visualize the data with the <imgsrc="./app/assets/electron-logo-color.png"alt="Electron"title="Electron"align="center"height="20" /> app.
243
262
244
-
Refer to the [README](https://github.com/oslabs-beta/Chronos/tree/docker/microservice) of that branch for more details.
245
-
<br>
246
263
<br>
247
264
248
265
#### Docker
266
+
#
249
267
250
-
The '<imgsrc="./app/assets/docker-logo-color.png"alt="Docker"title="Docker"align="center"height="20" /> **/microservice'** branch is where we provide a sample _dockerized_ microservices application to test out Chronos and to apply distributed tracing across different containers for your testing convenience..
251
-
252
-
<imgsrc="./app/assets/important.png"alt="Important"title="Important"align="center"height="20" /> Give your containers the same names you use for arguments for microservice names. Read more about it under the INSTALLATION section below.
268
+
In the <imgsrc="./app/assets/docker-logo-color.png"alt="Docker"title="Docker"align="center"height="20" /> folder within the `master` branch, we provide a sample _dockerized_ microservices application to test out Chronos and to apply distributed tracing across different containers for your testing convenience.
253
269
254
-
<imgsrc="./app/assets/important.png"alt="Important"title="Important"align="center"height="20" /> In order to have container stats saved to your database along with other health info, when starting up the containers, bind volumes to this path:
255
-
```
256
-
/var/run/docker.sock
257
-
```
258
-
259
-
For example, you can type the following when starting up a container:
260
-
```
261
-
docker run -v /var/run/docker.sock:/var/run/docker.sock [your-image-tag]
262
-
```
270
+
The `docker` folder includes individual <imgsrc="./app/assets/docker-logo-color.png"alt="Docker"title="Docker"align="center"height="20" /> files in their respective directories. A docker-compose.yml is in the root directory in case you'd like to deploy all services together.
263
271
264
-
If you're using docker-compose to start up multiple containers at once, you can add a `volumes` key for each of your services in the YAML file:
272
+
Refer to the [README](link) in the `docker` folder for more details.
265
273
266
-
```
267
-
volumes:
268
-
- "/var/run/docker.sock:/var/run/docker.sock"
269
-
```
270
274
<br>
271
275
272
-
### Middleware
273
-
276
+
### Middleware Branch
277
+
#
274
278
The **'middleware'** branch is the current codebase for the <imgsrc="./app/assets/npm-logo-color.png"alt="NPM"title="NPM"align="center"height="20" /> package, which is what you will install in your own application in order to use Chronos.
0 commit comments