From 9fcd2fc4cb21710b1fd14cb561bfe17bd07fcd4d Mon Sep 17 00:00:00 2001 From: Kyle Sammons Date: Tue, 21 Nov 2023 11:39:04 -0800 Subject: [PATCH 1/2] Added a section on proxying to the contibutor docs --- .github/CONTRIBUTING.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index ef12074..050c2b5 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -65,6 +65,8 @@ There are more details about processes and workflow in the [Maintainer's Guide]( ### Frontend +#### Starting the frontend + 1. Install dependencies ```bash @@ -89,6 +91,19 @@ There are more details about processes and workflow in the [Maintainer's Guide]( yarn build ``` +#### Proxying +Depending on your setup, it may be advantageous for you to setup a proxy from your +local machine to a KalDB query node running in a cloud environment and +point your local Grafana to that node. An example command to do something +like that would be: +``` +ssh -N -L $LOCALHOST_PORT:localhost:$REMOTE_PORT $NODE_NAME +``` + +You would then be able to use `host.docker.internal:$LOCALHOST_PORT` as the +URL inside your Grafana instance. + + ### Backend 1. Update [Grafana plugin SDK for Go](https://grafana.com/docs/grafana/latest/developers/plugins/backend/grafana-plugin-sdk-for-go/) dependency to the latest minor version: From 21d6035539bd3c654c847f68f985d53762e9ef42 Mon Sep 17 00:00:00 2001 From: Kyle Sammons Date: Tue, 21 Nov 2023 11:45:35 -0800 Subject: [PATCH 2/2] Changed wording --- .github/CONTRIBUTING.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 050c2b5..af26e20 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -93,15 +93,15 @@ There are more details about processes and workflow in the [Maintainer's Guide]( #### Proxying Depending on your setup, it may be advantageous for you to setup a proxy from your -local machine to a KalDB query node running in a cloud environment and -point your local Grafana to that node. An example command to do something -like that would be: +local machine to a KalDB query node running in a cloud environment. Below is +an example command to do that (NOTE: this may or may not work depending on +your setup): ``` ssh -N -L $LOCALHOST_PORT:localhost:$REMOTE_PORT $NODE_NAME ``` You would then be able to use `host.docker.internal:$LOCALHOST_PORT` as the -URL inside your Grafana instance. +KalDB datasource URL inside your Grafana instance. ### Backend