Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Added a section on proxying to the contributor docs #40

Merged
merged 3 commits into from
Dec 1, 2023
Merged

Added a section on proxying to the contributor docs #40

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
9fcd2fc
Added a section on proxying to the contibutor docs
kyle-sammons Nov 21, 2023
21d6035
Changed wording
kyle-sammons Nov 21, 2023
17e0b57
Merge branch 'master' into ksammons-add-proxy-docs
kyle-sammons Nov 30, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions .github/CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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. 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
KalDB datasource 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:
Expand Down
Loading