Skip to content

Commit c4f7ab9

Browse files
committed
edited README files for gRPC, kubernetes, and npm package - removed repeated or unclear instructions
1 parent b1fdfe8 commit c4f7ab9

File tree

3 files changed

+16
-18
lines changed

3 files changed

+16
-18
lines changed

chronos_npm_package/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@ _See mode-specific configuration descriptions in the "Chronos Tracker for Micros
8989

9090
The `microservice` property takes in a string. This should be a descriptive name for your microservice.
9191

92-
- <img src="assets/important.png" alt="Important" title="Important" align="center" height="20" /> For **Dockerized** microservices, this field **must** match the _container_name_ of the corresponding Docker container.
92+
- <img src="../assets/important.png" alt="Important" title="Important" align="center" height="20" /> For **Dockerized** microservices, this field **must** match the _container_name_ of the corresponding Docker container.
9393

9494
The `interval` property is optional and takes in an integer. This controls the Chronos monitoring frequency. If this is omitted, Chronos will default to recording server health every 60000 ms or 60 seconds.
9595

@@ -279,7 +279,7 @@ When viewing your information in the Chronos Electron application the data will
279279

280280
### Chronos Tracker for gRPC
281281

282-
To monitory your gRPC server, setup `chronos-config.js` as if it was a standard microservices example, but be sure to set the `connection` type to `gRPC`.
282+
To monitor your gRPC server, setup `chronos-config.js` as if it was a standard microservices example, but be sure to set the `connection` type to `gRPC`.
283283

284284
```js
285285
module.exports = {

examples/gRPC/README.md

Lines changed: 12 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
![Chronos logo](https://raw.githubusercontent.com/Chronos2-0/Chronos/master/app/assets/logo2.png)
2-
31
## Microservices Architecture
42
Microservices architecture for testing [Chronos](https://github.com/open-source-labs/Chronos), a microservice communication and health visualizer.
53

@@ -13,11 +11,12 @@ Each microservice has its own server, which receives requests from both the clie
1311

1412
## Getting Started w/ gRPC Example Microservices
1513

16-
Follow **'main'** branch README steps: Pre-Installation, Install Dependencies before start.
14+
Follow **'main'** branch [README](../../README.md) steps: Pre-Installation, Install Dependencies before start.
15+
16+
We have already initialized Chronos within this example. To track gRPCs within your own application, please review the [README for the Chronos microtracker npm package](../../chronos_npm_package/README.md) for more information.
1717

18-
On each microservice in example/microservices, perform the following steps
19-
- **NOTE: Do this for microservices: books, orders, & reverse proxy**
20-
- Create a .env file under each microservice folder and input your own Mongodb Atlas URI for Microservice_URI, CHRONOS_URI and ORDER_URI, see example below:
18+
On **each** microservice in ```example/microservices```, perform the following steps:
19+
- Create a .env file under the microservice's folder and input your own Mongodb Atlas URI for Microservice_URI, CHRONOS_URI and ORDER_URI (example below):
2120

2221
```
2322
BOOK_URI = mongodb+srv://<username>:<password>@cluster0.o2hx5.mongodb.net/<dbname>?retryWrites=true&w=majority
@@ -26,34 +25,32 @@ CHRONOS_URI = mongodb+srv://<username>:<password>@cluster0.o2hx5.mongodb.net/<db
2625
2726
ORDER_URI = mongodb+srv://<username>:<password>@cluster0.o2hx5.mongodb.net/<dbname>?retryWrites=true&w=majority
2827
```
29-
- In each Microservices *chronos-config.js* file, verify that `"mode"` property has a value of `"microservices"`
3028

29+
- In each Microservices *chronos-config.js* file, verify that `"mode"` property has a value of `"microservices"`
3130

32-
- ** Note: The Initialize Chronos step is already taken care of for you.
3331
- Inside each microservice directory, install all dependencies using the `npm install`
3432
- Run `npm run start` in each folder directory
35-
- Head over to localhost:3000 to view reverse proxy acting as the frontend of this microservice example
33+
- Head over to localhost:3000 to view reverse proxy acting as the front end of this microservice example
3634

3735
<p align="center">
3836
<img alt="gRPC reverse proxy front end" src="../../assets/gRPC_example_reverseProxy.png">
3937
</p>
4038

4139
- Start adding data!
42-
- Run `npm run both` to start Electron app
40+
- Run `npm run dev:app` and `npm run dev:electron` **in separate terminals** to start Electron app
4341
- Add a new application in Chronos app dashboard.
4442
- The URI should be your CHRONOS_URI
4543

4644

47-
**To test the functionality of Chronos using this sample microservices architecture, you must have the [Chronos node module](https://www.npmjs.com/package/chronos-microservice-debugger3) within each microservice.**
48-
49-
This is already included as a dependency therefore there should be no need to install it manually. But if it is missing from the dependency list, the installation instructions for both the Chronos node module and the Chronos desktop visualizer are below:
45+
**To test the functionality of Chronos using this sample microservices architecture, you must have the [Chronos microservice tracker](https://www.npmjs.com/package/@chronosmicro/tracker) within each microservice.**
5046

47+
This is already included as a dependency, therefore there should be no need to install it manually. But if it is missing from the dependency list, the installation instructions for both the Chronos node module and the Chronos desktop visualizer are below:
5148

5249
#### Electron desktop application
5350

5451
After installing the node module in each microservice, download the Electron desktop application from the public [Chronos](https://github.com/oslabs-beta/Chronos) repo.
5552

56-
Inside the downloaded directory, install all dependencies using the `npm install` command followed by the `npm run both` command to start the Electron desktop application.
53+
Inside the downloaded directory, install all dependencies using the `npm install` command, followed by the `npm run both` command to start the Electron desktop application.
5754

5855
## Contributing
5956

@@ -67,3 +64,4 @@ Chronos hopes to inspire an active community of both users and developers. For q
6764
[npm-url]: https://www.npmjs.com/package/chronos-microservice-debugger3
6865
[downloads-image]: https://img.shields.io/npm/dm/chronos-microservice-debugger3.svg
6966
[downloads-url]: https://npmjs.org/package/chronos-microservice-debugger3
67+

examples/kubernetes/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,13 @@ This example demonstrates how `Chronos` can be used to track health metrics of a
77
- *scripts*: Scripts to automate some of the steps involved in running the example
88

99
## Install Docker Desktop
10-
This example has been developed and tested using the Kubernetes Engine packaged in the Docker Desktop application. Follow instructions online to download/install Docker Desktop and to enable the Kubernetes Engine.
10+
This example has been developed and tested using the Kubernetes Engine packaged in the Docker Desktop application.
1111

12+
Follow instructions online to download/install Docker Desktop and to **enable the Kubernetes Engine**. The examples will not work without the Kubernetes Engine enabled.
1213
## Build the Client
1314
`cd` into the *client* folder and run the following command:
1415
```
1516
docker build -t frontend:1.0 .
16-
1717
```
1818
**Mac Users:** Alternatively running the above command, `cd` into the scripts folder and run the `buildClient.sh` script
1919

0 commit comments

Comments
 (0)