Skip to content

Commit 3ac4816

Browse files
authored
Merge pull request #318 from open-source-labs/KuberReadMe
Edit Kuber read me and npm readme
2 parents 5a68ea5 + cc327bb commit 3ac4816

File tree

2 files changed

+6
-5
lines changed

2 files changed

+6
-5
lines changed

chronos_npm_package/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -213,11 +213,11 @@ volumes:
213213
```
214214

215215
### Chronos Tracker for "Kubernetes" Mode
216-
Chronos can monitor an Kubernetes clusters by saving metric data from instant queries to a Prometheus server in your Kubernetes cluster.
216+
Chronos can monitor an Kubernetes clusters by saving metric data from instant queries to a Prometheus server in your Kubernetes cluster, and then display all metrics data through Grafana dashboards.
217217

218218
In `chronos-config.js`, set the `mode` to `kubernetes` and pass it both the name of the port the Prometheus server is listening on INSIDE the cluster, and the name of the Prometheus service so that its IP address can be resolved using KubeDNS.
219219

220-
Also add a `grafanaAPIKey` section, this API key will grant chronos access to create and update dashboards in Grafana.
220+
Also add a `grafanaAPIKey` section, this API key will grant chronos access to create and update dashboards in Grafana. Be sure to include `CHRONOS_GRAFANA_API_KEY` in your `.env` with `Bearer [the access token you get from Grafana]`. For more details, please check Kubernetes example.
221221

222222
```js
223223
// Excerpt from a chronos-config.js

examples/kubernetes/README.md

+4-3
Original file line numberDiff line numberDiff line change
@@ -27,15 +27,16 @@ This example has been developed and tested using the Kubernetes Engine packaged
2727

2828
**Note**: If you run into `Permission denied` error, try run this command: `chmod +x [the_file_name]` in the terminal and re-run `./setup.sh`.
2929

30-
2. In your browser, go to `localhost:32000`, which will be the login page of grafana. Use `admin` as both username and password to login. You can change the password after login.
30+
2. Open your web browser and navigate to `localhost:32000`. If you've correctly completed step 1 of the setup, you'll be directed to the Grafana login page. Use `admin` for both the username and password to log in. You can update the password after logging in if needed.
3131

32-
3. Navigate to `Home -> Administration -> Service accounts`, then click `Add service account` to create an service account. Be sure to choose `Admin` as the role. Then click `Add service account token`, hit `generate`, you are done! Remember this token, you will be using this token to access Grafana HTTP API programmatically.
32+
3. Go to `Home -> Administration -> Service accounts`, and select `Add service account` to establish a new service account. Make sure to designate `Admin` as the role. Then, click on `Add service account token`, press `generate`, and you're finished! Keep this token in mind as you'll utilize it for accessing Grafana HTTP API programmatically.
3333

3434
4. Add a `.env` file to the _server_ folder that contains the following key/value pairs:
3535

3636
```
3737
CHRONOS_GRAFANA_API_KEY = Bearer [the access token you created in step 3]
3838
```
39+
**Note**: If you are monitoring your own application, be sure to create a `.env` file as well.
3940

4041
## Build the Client
4142

@@ -104,7 +105,7 @@ kubectl apply -f frontend.yml
104105

105106
The second image is inside **k8s_node-backend_node-backend-d597768c-6zm5j_default_46da04f8-99c6-4522-9141-6c05f8d5141d_0** container, it may take a while to show up in Docker desktop based on the scraping interval.
106107

107-
Your microservice health metrics can now be viewed at the given `CHRONOS_URI` or, preferrably, in the Electron.js desktop application.
108+
Your microservice health metrics can now be viewed at the given `CHRONOS_URI` or, preferrably, in the `Chronos desktop app`.
108109

109110
## Teardown the Cluster
110111

0 commit comments

Comments
 (0)