diff --git a/docs/clmc-service.md b/docs/clmc-service.md index f39c92dc2841f7a02e736ad6ee45e3d99eeeae13..c75df3c2471b180ed3b078fd9f78deb47b0052ff 100644 --- a/docs/clmc-service.md +++ b/docs/clmc-service.md @@ -37,28 +37,28 @@ configuration data and Alerts API for creating and subscribing to alerts in Kapa configuration files of the service can be found in the **src/service** folder. #### Notes -* Interacting with *Chronograf* - use ***http://<clmc-host>/chronograf***. You will be asked to enter connection details. -The only input that you need to edit is the *Connection String* - set it to **http://<clmc-host>:8086** and click the +* Interacting with *Chronograf* - use `http://<clmc-host>/chronograf`. You will be asked to enter connection details. +The only input that you need to edit is the *Connection String* - set it to `http://<clmc-host>:8086` and click the **Add Source** button. * Interacting with *Kapacitor* - the Kapacitor HTTP API documentation can be found here: https://docs.influxdata.com/kapacitor/v1.4/working/api/ Notice that all of the URL paths provided by Kapacitor are already namespaced using base path ***/kapacitor/v1***. Therefore, no other prefix is required when interacting with the Kapacitor application running on the clmc container, e.g. -***http://<clmc-host>/kapacitor/v1/tasks*** +`http://<clmc-host>/kapacitor/v1/tasks` as described in the Kapacitor API reference. * Interacting with *InfluxDB* - the InfluxDB HTTP API documentation can be found here: https://docs.influxdata.com/influxdb/v1.5/tools/api/ In order to interact with the InfluxDB application running on the clmc container, prefix all URL paths in the documentation with **/influxdb**, e.g. -***http://<clmc-host>/influxdb/query*** +`http://<clmc-host>/influxdb/query` -* Interacting with *neo4j* - use ***http://localhost/neo4j/browser/***. This will open the neo4j browser, which lets you +* Interacting with *neo4j* - use `http://<clmc-host>/neo4j/browser/`. This will open the neo4j browser, which lets you interact with the graph using Cypher queries (if necessary). * Interacting with *clmc-serivce* - the API endpoints listed in the following sections relate to direct interactions with the clmc-service application server (listening on port 9080). If interacting with the clmc container, all of the listed below URIs must be prefixed with **/clmc-service** so that the nginx reverse proxy server (listening on port 80) can forward to requests to the correct application, e.g. -***http://<clmc-host>/clmc-service/alerts?sfc={service function chain id}&sfci={service function chain instance id}&policy={policy id}&trigger={trigger id}***. +`http://<clmc-host>/clmc-service/alerts?sfc={service function chain id}&sfci={service function chain instance id}&policy={policy id}&trigger={trigger id}`. ## Alerts API Endpoints