Grafana Operator

A Kubernetes Operator based on the Operator SDK for creating and managing Grafana instances.

Current status

The Operator is functional and can deploy and manage a Grafana instance on Kubernetes and OpenShift. The following features are supported:

The operator supports the following flags on startup:

--grafana-image: overrides the Grafana image, defaults to docker.io/grafana/grafana.
--grafana-image-tag: overrides the Grafana tag, defaults to 5.4.2.
--scan-all: watch for dashboards in all namespaces. This requires the the operator service account to have cluster wide permissions to get, list, update and watch dashboards. See deploy/cluster_roles.
--openshift: force the operator to use a route instead of an ingress. Note that routes are only supported on OpenShift.

Flags can be passed as args to the container.

The following Grafana resources are supported:

all custom resources use the api group integreatly.org and version v1alpha1.

Represents a Grafana instance. See the documentation for a description of properties supported in the spec.

Represents a Grafana dashboard and allows to specify required plugins. See the documentation for a description of properties supported in the spec.

Represents a Grafana datasource. See the documentation for a description of properties supported in the spec.

You can run the Operator locally against a remote namespace using the operator-sdk:

Prerequisites:

operator-sdk installed
kubectl pointing to the local context. minikube automatically sets the context to the local VM. If not you can use kubectl config use <context> or (if using the OpenShift CLI) oc login -u <user> <url>

$ operator-sdk up local --namespace=<namespace> --operator-flags="<flags to pass>"