Skip to content

Latest commit

 

History

History
91 lines (60 loc) · 4.58 KB

deploy_grafana.md

File metadata and controls

91 lines (60 loc) · 4.58 KB
Raw

Deploying a Grafana instance

This document describes how to get up and running with a new Grafana instance no Kubernetes.

Deploying the operator

The first step is to install the Grafana operator to a namespace in your cluster.

To create a namespace named grafana run:

$ kubectl create namespace grafana

Create the operator roles:

$ kubectl create -f deploy/roles

If you want to scan for dashboards in other namespaces you also need the cluster roles:

$ kubectl create -f deploy/cluster_roles

To deploy the operator to that namespace you can use deploy/operator.yaml:

$ kubectl create -f deploy/operator.yaml -n grafana

Check the status of the operator pod:

$ kubectl get pods -n grafana
NAME                                READY     STATUS    RESTARTS   AGE
grafana-operator-78cfcbf8db-ssrgq   1/1       Running   0          17s

Operator flags

The operator accepts a number of flags that can be passed in the args section of the container in the deployment:

  • --grafana-image: overrides the Grafana image, defaults to quay.io/openshift/origin-grafana.
  • --grafana-image-tag: overrides the Grafana tag. See controller_config.go for default.
  • --grafana-plugins-init-container-image: overrides the Grafana Plugins Init Container image, defaults to quay.io/integreatly/grafana_plugins_init.
  • --grafana-plugins-init-container-tag: overrides the Grafana Plugins Init Container tag, defaults to 0.0.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.
  • --pod-label-value: override the value of the app label that gets attached to pods and other resources.

See deploy/operator.yaml for an example.

Deploying Grafana

Create a custom resource of type Grafana, or use the one in deploy/examples/Grafana.yaml.

The resource accepts the following properties in it's spec:

  • hostname: The host to be used for the ingress. Ignored when --openshift is set.
  • dashboardLabelSelector: A list of either matchLabels or matchExpressions to filter the dashboards before importing them.
  • containers: Extra containers to be added to the Grafana deployment. Can be used for example to add auth proxy side cars.
  • secrets: A list of secrets that are added as volumes to the deployment. Mostly useful in combination with extra containers.
  • config: The properties used to generate grafana.ini. All properties defined in the official documentation are supported although some of them are not allowed to be overridden (path configuration). See deploy/examples/Grafana.yaml for an example.
  • createRoute: Force the operator to create a Route instead of an Ingress even if the --openshift flag is not set.

The other accepted properties are logLevel, adminUser, adminPassword, basicAuth, disableLoginForm, disableSignoutMenu and anonymous. They are supported for legacy reasons, but new instances should use the config field. If a value is set in config then it will override the legacy field.

NOTE: setting hostname on Ingresses is not permitted on OpenShift. We recommend using the --openshift flag which will use a Route with an automatically assigned host instead. You can still use Ingress on OpenShift if you don't provide a hostname in the Grafana resource.

To create a new Grafana instance in the grafana namespace, run:

$ kubectl create -f deploy/examples/Grafana.yaml -n grafana

Get the URL of the instance and open it in a browser:

$ kubectl get ingress -n grafana
NAME              HOSTS                           ADDRESS   PORTS     AGE
grafana-ingress   grafana.apps.127.0.0.1.nip.io             80        28s

Config reconciliation

When the config object in the Grafana CR is modified, then grafana.ini will be automatically updated and Grafana will be restarted.

NOTE: there is a known issue when removing whole sections from the config object. The operator might not detect the update in such cases. As a workaround we recommend to leave the section header in place and only removing all the sections properties.