From 4805d69be8300fbb3cd46145b81ef429ff97e381 Mon Sep 17 00:00:00 2001 From: kelseiv <47797004+kelseiv@users.noreply.github.com> Date: Fri, 5 Feb 2021 08:23:34 -0800 Subject: [PATCH] add example for subscription-path (#2041) * docs: added bigpanda.md event handler documentation * docs: fixing typos * docs: fixing typos * docs: updated bigpanda.md, added primary, secondary property * Update config.yml * add example for subscription-path * fix formatting * resolve conflicts Co-authored-by: Robert Hajek Co-authored-by: Scott Anderson --- .../kapacitor/v1.5/administration/security.md | 19 ++++++++++++++++--- .../kapacitor/v1.5/event_handlers/bigpanda.md | 2 +- 2 files changed, 17 insertions(+), 4 deletions(-) diff --git a/content/kapacitor/v1.5/administration/security.md b/content/kapacitor/v1.5/administration/security.md index 90053f759..245ebcdeb 100644 --- a/content/kapacitor/v1.5/administration/security.md +++ b/content/kapacitor/v1.5/administration/security.md @@ -160,6 +160,7 @@ This results in the following file: "startup-timeout": "5m0s", "subscription-mode": "cluster", "subscription-protocol": "https", + "subscription-path": "", "subscriptions": {}, "subscriptions-sync-interval": "1m0s", "timeout": "0s", @@ -205,15 +206,27 @@ Similar commands: * To change the URLS: -`curl -kv -d '{ "set": { "urls": [ "https://lenovo-TP02:8086" ]} }' https://localhost:9092/kapacitor/v1/config/influxdb/` +```sh +curl -kv -d '{ "set": { "urls": [ "https://lenovo-TP02:8086" ]} }' https://localhost:9092/kapacitor/v1/config/influxdb/ +``` * To set the `subscription-protocol`: -`curl -kv -d '{ "set": { "subscription-protocol": "https" } }' https://localhost:9092/kapacitor/v1/config/influxdb/` +```sh +curl -kv -d '{ "set": { "subscription-protocol": "https" } }' https://localhost:9092/kapacitor/v1/config/influxdb/ +``` + +* If Kapacitor is behind a reverse proxy, set the `subscription-path` to append to the InfluxDB subscription URL: + +```sh +curl -kv -d '{ "set": { "subscription-path": "/path/behind/reverse-proxy" } }' https://localhost:9092/kapacitor/v1/config/influxdb/ +``` * To set the path to the CA Certificate: -`curl -kv -d '{ "set": { "ssl-ca": "/etc/ssl/influxdata-selfsigned-incl-pub-key.pem" } }' https://localhost:9092/kapacitor/v1/config/influxdb/` +```sh +curl -kv -d '{ "set": { "ssl-ca": "/etc/ssl/influxdata-selfsigned-incl-pub-key.pem" } }' https://localhost:9092/kapacitor/v1/config/influxdb/ +``` Other properties can be set in a similar fashion. diff --git a/content/kapacitor/v1.5/event_handlers/bigpanda.md b/content/kapacitor/v1.5/event_handlers/bigpanda.md index 21ba182a5..7fa009dd1 100644 --- a/content/kapacitor/v1.5/event_handlers/bigpanda.md +++ b/content/kapacitor/v1.5/event_handlers/bigpanda.md @@ -39,7 +39,7 @@ Authorization Bearer token for BigPanda REST API. BigPanda integration App Key. To get your App Key, log in to your BigPanda account and select **Integrations** in the header toolbar, and then click **New Integration**. Select **Alerts REST API**, click **Integrate**, and then **Create an App Key**. - + #### `url` BigPanda Alert API url.