Terraform Provider for Grafana
We welcome contributions. See CONTRIBUTING.md for how to submit changes.
Requirements
Development
If you're new to provider development, a good place to start is the Extending
Terraform docs.
Set up your local environment by installing Go. Also
Docker can be used for running tests.
Local Development with Grafana
If you develop the provider and want to test locally with your Grafana provider
- Create a
.terraformrc file in your operating system user directory and paste the following
provider_installation {
dev_overrides {
"grafana/grafana" = "/path/to/your/terraform-provider-grafana" # this path is the directory where the binary is built
}
# For all other providers, install them directly from their origin provider
# registries as normal. If you omit this, Terraform will _only_ use
# the dev_overrides block, and so no other providers will be available.
direct {}
}
- Run
go build in this directory to get the binary, Terraform will use the binary you just built for every terraform plan/apply (it should print out a warning). No need to run terraform init.
Running Tests
Acceptance tests require a running instance of Grafana. You can either handle
running an instance of Grafana yourself or use Docker Compose.
There are Make targets provided for different test scenarios that will start Grafana in Docker Compose automatically.
This is the simplest option, but often not the quickest.
To run the OSS tests with Grafana running in Docker Compose:
make testacc-oss-docker
Alternatively, you can use the testacc target which will use your local go
installation:
# Assuming Grafana was run with:
# docker run --rm -p 3000:3000 grafana/grafana
GRAFANA_URL=http://localhost:3000 \
GRAFANA_AUTH=admin:admin \
make testacc
Running enterprise tests
To run tests for resources which are available only for Grafana Enterprise, running instance of Grafana Enterprise is required.
It is only possible to run tests for Grafana Enterprise using local environment.
To run the Enterprise tests with Grafana running in Docker Compose:
make testacc-enterprise-docker
Alternatively, you can use the testacc-enterprise target which will use your local go
installation:
# Assuming Grafana was run with:
# docker run --rm -p 3000:3000 grafana/grafana
GRAFANA_URL=http://localhost:3000 \
GRAFANA_AUTH=admin:admin \
make testacc-enterprise
Documentation
Documentation is generated with
tfplugindocs. Generated
files are in docs/ and should not be updated manually. They are derived from:
Use go generate ./... to update generated docs. This will be checked by CI on pull requests to ensure docs are in sync.
Releasing
See RELEASING.md for versioning policy, release process, pre-release
validation against the tfprovidertest appenv stack, and how the CI pipeline works.
