provider-grafana is a Crossplane provider that is built using Upjet code generation tools and exposes XRM-conformant managed resources for the Grafana API.

This tool is experimental

The code in this repository should be considered experimental. Documentation is only available alongside the code. It comes without support, but we are keen to receive feedback on the product and suggestions on how to improve it, though we cannot commit to resolution of any particular issue. No SLAs are available. It is not meant to be used in production environments, and the risks are unknown/high.

Additional information can be found in Release life cycle for Grafana Labs.

Install the provider by using the following command after changing the image tag to the latest release:

up ctp provider install xpkg.upbound.io/grafana/provider-grafana:v0.24.0

Alternatively, you can use declarative installation:

cat <<EOF | kubectl apply -f -
apiVersion: pkg.crossplane.io/v1
kind: Provider
metadata:
  name: provider-grafana
spec:
  package: xpkg.upbound.io/grafana/provider-grafana:v0.24.0
EOF

Notice that in this example Provider resource is referencing ControllerConfig with debug enabled.

You can see the API reference here.

make submodules

Run code-generation pipeline:

make generate

Run against a Kubernetes cluster:

make run

Build, push, and install:

make all

Build binary:

make build

1. Ensure Crossplane is installed on your local cluster (instructions here)

2. Run the following:

   kubectl config use-context <name-of-your-local-k8s-context>
   kubectl apply -f ./package/crossplane.yaml
   kubectl apply -f ./package/crds

Below are some issues that have been encountered and may be helpful in the future to others.

❯ make generate
14:35:30 [ .. ] generating provider schema for grafana/grafana 2.19.1
make[1]: *** [config/schema.json] Error 1
make: *** [generate] Error 2

Solution: ensure that you do not have a .terraformrc defined somewhere. For example ~/.terraformrc:

❯ cat ~/.terraformrc
provider_installation {
    dev_overrides {
        "grafana/grafana" = "/Users/joeyorlando/coding/grafana/terraform-provider-grafana"
    }
}

Solution 2: delete generated .cache, .work and _output folders and try again.

Additionally, you can check the terraform logs via:

❯ cat ./.work/terraform/terraform-logs.txt
...

Lastly, make sure that you have the following defined in your .bashrc (or .zshrc):

export PATH="$PATH:$HOME/go/bin"

Steps to update resources from the latest Terraform provider version:

1. Update terraform provider version in go.mod file.
2. Add your resource in the GroupMap in groups.go file.
3. Generate the resources with go generate.
   • Output will show you missing resources to map if any.
4. Create a PR with the result.

For filing bugs, suggesting improvements, or requesting new features, please open an issue.