crossplane-provider-grafana

packaged by Chainguard

Chainguard Container for crossplane-provider-grafana

This Crossplane provider manages Grafana and Grafana Cloud resources such as folders, dashboards, data sources, and alerting rules as Crossplane managed resources.

Chainguard Containers are regularly-updated, secure-by-default container images.

Download this Container Image

For those with access, this container image is available on cgr.dev:

docker pull cgr.dev/ORGANIZATION/crossplane-provider-grafana:latest

Be sure to replace the ORGANIZATION placeholder with the name used for your organization's private repository within the Chainguard Registry.

Compatibility Notes

The Chainguard crossplane-provider-grafana container image is a drop-in replacement for the upstream crossplane-provider-grafana Crossplane package published at xpkg.upbound.io/grafana/provider-grafana. The image ships the provider binary together with the Crossplane package metadata and CRDs in /package.yaml, so you can reference it directly in a Provider resource. Like the upstream image, it uses /usr/local/bin/provider as the entrypoint and runs as the nonroot user with UID 65532. The Grafana Terraform provider is compiled into the provider binary, so the image does not need a Terraform CLI or a separate plugin download at runtime.

Prerequisites

You need a Kubernetes cluster with Crossplane v2.0 or later installed, and a Grafana instance that the provider can reach. If Crossplane is not installed yet, install it with Helm:

helm repo add crossplane-stable https://charts.crossplane.io/stable
helm repo update
helm install crossplane --namespace crossplane-system --create-namespace crossplane-stable/crossplane

Getting Started

Create a Provider that points at the Chainguard image:

cat > provider.yaml <<EOF
apiVersion: pkg.crossplane.io/v1
kind: Provider
metadata:
  name: provider-grafana
spec:
  package: cgr.dev/ORGANIZATION/crossplane-provider-grafana:latest
EOF
kubectl apply -f provider.yaml

Wait for Crossplane to install the provider and report it as healthy:

kubectl wait --for=condition=Healthy provider.pkg.crossplane.io/provider-grafana --timeout=600s

The provider reads its connection settings from a JSON document stored in a Secret. Replace GRAFANA_URL with the address of your Grafana instance and GRAFANA_AUTH with either username:password or a service account token, then create the Secret and a ProviderConfig that references it:

kubectl create secret generic grafana-creds -n crossplane-system \
  --from-literal=credentials='{"url":"GRAFANA_URL","auth":"GRAFANA_AUTH"}'

cat > providerconfig.yaml <<EOF
apiVersion: grafana.crossplane.io/v1beta1
kind: ProviderConfig
metadata:
  name: default
spec:
  credentials:
    source: Secret
    secretRef:
      name: grafana-creds
      namespace: crossplane-system
      key: credentials
EOF
kubectl apply -f providerconfig.yaml

Create a folder and a dashboard inside it. The folderRef field resolves the folder's Grafana identifier for you:

cat > dashboard.yaml <<EOF
apiVersion: oss.grafana.crossplane.io/v1alpha1
kind: Folder
metadata:
  name: platform
spec:
  forProvider:
    title: Platform
---
apiVersion: oss.grafana.crossplane.io/v1alpha1
kind: Dashboard
metadata:
  name: platform-overview
spec:
  forProvider:
    folderRef:
      name: platform
    configJson: |
      {
        "title": "Platform Overview",
        "uid": "platform-overview"
      }
EOF
kubectl apply -f dashboard.yaml

Wait for both resources to become ready:

kubectl wait --for=condition=Ready folder.oss.grafana.crossplane.io/platform dashboard.oss.grafana.crossplane.io/platform-overview --timeout=300s

The dashboard now appears in Grafana under the Platform folder. Deleting either resource removes it from Grafana.

Configuration

For anything beyond a quick test, authenticate with a Grafana service account token rather than a username and password. A token can be scoped to the permissions the provider needs and rotated without touching a user account.

Settings that are not secret can live in the ProviderConfig instead of the Secret, and values set there take precedence over the Secret. The following configuration keeps only the token in the Secret, sets the Grafana address and organization in the ProviderConfig, and uses a separate ProviderConfig name so that resources opt into it explicitly:

kubectl create secret generic grafana-token -n crossplane-system \
  --from-literal=credentials='{"auth":"GRAFANA_SERVICE_ACCOUNT_TOKEN"}'

cat > providerconfig-org.yaml <<EOF
apiVersion: grafana.crossplane.io/v1beta1
kind: ProviderConfig
metadata:
  name: platform-org
spec:
  url: GRAFANA_URL
  orgId: 2
  credentials:
    source: Secret
    secretRef:
      name: grafana-token
      namespace: crossplane-system
      key: credentials
EOF
kubectl apply -f providerconfig-org.yaml

Resources then select it with spec.providerConfigRef.name: platform-org. The full list of credential fields, including the Grafana Cloud, OnCall, and Synthetic Monitoring settings, is documented in the upstream ProviderConfig secret fields reference.

Documentation and Resources

• crossplane-provider-grafana on GitHub
• crossplane-provider-grafana examples
• Grafana Terraform provider documentation
• Crossplane providers

What are Chainguard Containers?

Chainguard's free tier of Starter container images are built with Wolfi, our minimal Linux undistro.

All other Chainguard Containers are built with Chainguard OS, Chainguard's minimal Linux operating system designed to produce container images that meet the requirements of a more secure software supply chain.

The main features of Chainguard Containers include:

• Minimal design, without unnecessary software bloat
• Daily builds to ensure container images are up-to-date with available security patches
• High quality build-time SBOMs attesting to the provenance of all artifacts within the image
• Verifiable signatures provided by Sigstore
• Reproducible builds with Cosign and apko (read more about reproducibility)

For cases where you need container images with shells and package managers to build or debug, most Chainguard Containers come paired with a development, or -dev, variant.

In all other cases, including Chainguard Containers tagged as :latest or with a specific version number, the container images include only an open-source application and its runtime dependencies. These minimal container images typically do not contain a shell or package manager.

Although the -dev container image variants have similar security features as their more minimal versions, they include additional software that is typically not necessary in production environments. We recommend using multi-stage builds to copy artifacts from the -dev variant into a more minimal production image.

Need additional packages?

To improve security, Chainguard Containers include only essential dependencies. Need more packages? Chainguard customers can use Custom Assembly to add packages, either through the Console, chainctl, or API.

To use Custom Assembly in the Chainguard Console: navigate to the image you'd like to customize in your Organization's list of images, and click on the Customize image button at the top of the page.

Learn More

Refer to our Chainguard Containers documentation on Chainguard Academy. Chainguard also offers VMs and Libraries — contact us for access.

Trademarks

This software listing is packaged by Chainguard. The trademarks set forth in this offering are owned by their respective companies, and use of them does not imply any affiliation, sponsorship, or endorsement by such companies.