Documentation: PVC and Volumes example about grafana-operator

[armagankaratosun]

Hello all

I was struggling with the same problem and I honestly think an example (https://github.com/grafana/grafana-operator/tree/master/examples) will improve the user/dev experience, at least, this is where I first look when I want to deploy resources with any operator.

If no one objects, I can provide examples based on my configuration for persistence storage and OpenID Connect (keycloak) integration as PR once I am finished tuning my setup. You can even assign this issue to me if you like.

Cheers!

[HubertStefanski]

Hi @aidapsibr, We generally try to avoid adding examples like this, because they're mostly just K8s, rather than operator-specific settings. The Grafana CR for example has all the fields from the deployment.spec resource embedded within it. I.e. you should be able to look at k8s documentation on how to configure a deployment with persistent volumes (e.g. through persistentVolumeClaimTemplates)
For example: https://github.com/grafana/grafana-operator/blob/master/examples/grafana_deployment/resources.yaml#L19C7-L28C36 the template section is directly built from the DeploymentSpec Struct (that we import from the k8s lib), as such you can add any configuration available in the Deployment CR, and the operator will respect your settings, and even reconcile them as you specified. We thought this was a more robust means of supporting a wider range of settings that users requested, without having to specifically extend the Grafana CR with any further wrappers (and thus, confusion).

However, if you think this would improve user/dev experience, then we've got no issue with accepting pull requests with those. (Unfortunately, the core maintainer group is quite busy atm, our daily-jobs are focused on different areas right now).

I hope this helps, or at least gives some more relevant guidance (I found this from one of our users in the Grafana-Operator channel in the k8s slack)

apiVersion: grafana.integreatly.org/v1beta1
kind: Grafana
metadata:
  name: grafana
  labels:
    dashboards: "grafana"
spec:
  persistentVolumeClaim:    
    spec:
      accessModes:
        - ReadWriteOnce
      resources:
        requests:
          storage: 10Gi
      storageClassName: standard-v1
      volumeMode: Filesystem
  config:
    log:
      mode: console
    # disable any means of authentication
    auth.anonymous:
      enabled: "True"
      org_role: Admin
    auth:
      disable_login_form: "False"
      disable_signout_menu: "True"
    auth.basic:
      enabled: "False"
    users:
      allow_sign_up: "False"
  deployment:
    spec:
      strategy: 
        type: Recreate
      template:
        spec:
          securityContext:
            runAsUser: 10001
            runAsGroup: 10001
            fsGroup: 10001
          volumes:
            - name: grafana-data
              persistentVolumeClaim:
                claimName: grafana-pvc

[HubertStefanski]

Thank you @armagankaratosun !

@aidapsibr Let us know if those examples are helpful to you!

[HubertStefanski]

@armagankaratosun That would be awesome! Thanks for offering your help! Looking forward to seeing your PR 😅 ping any of the maintainers on it, and we'll try to review and merge ASAP.

Thanks!

[armagankaratosun]

hello again @HubertStefanski

I submitted my PR #1397

hope it helps!

cheers!

[spimmer]

@HubertStefanski

I just figured out that this section is incorrect indented:

grafana-operator/examples/persistent_volume/resources.yaml

Lines 37 to 40 in 3c8cca1

	volumes:
	- name: grafana-data
	persistentVolumeClaim:
	claimName: grafana-pvc

According to API reference volumes[index] has to be under node Grafana.spec.deployment.spec.template.spec and not under Grafana.spec.deployment.spec.template