README
¶
pdc-agent
The Grafana Private Datasource Connect Agent allows connecting private datasources with your grafana cloud instance.
Installation
Follow installation and running instructions in the Grafana Labs Documentation
Setting the ssh log level
Use the -log.level flag. Run the agent with the -help flag to see the possible values.
| go log level | ssh log level |
|---|---|
error |
0 (-v not set) |
warn |
0 (-v not set) |
info |
0 (-v not set) |
debug |
3 (-vvv) |
DEV flags
Flags prefixed with -dev are used for local development and can be removed at any time.
Developer guide
Dependencies
You will need the following dependencies to test and build the pdc-agent:
- git
- go (see
go.modfor minimum required version) - golangci-lint
- gh, the GitHub cli (for releasing only)
Build and test
Run unit tests, lint and build with:
make
Releasing
Snapshot/testing release
If you want to test a release before publishing, you can create a snapshot release and publish to docker by pushing your change to a branch and going to https://github.com/grafana/pdc-agent/actions/workflows/testing-release.yml and clicking "run workflow" and then selecting your branch. A docker image will then be built against that branch.
Versioned release
Create public releases with:
make release
The release script reads the latest release from GitHub, increments it one patch version, and then runs gh release create vX.X.X --generate-notes with the bumped version. To print the next version without releasing, run:
go run ./scripts/release.go -next
Releases are managed using goreleaser. Use the following command to build binaries on your local machine.
goreleaser build --snapshot --clean
If you want the docker image locally, you can run
goreleaser release --snapshot --clean
Directories