Implement spec.uid for GrafanaFolder

[Baarsgaard]

Disclaimer: I'm not a Go developer in any capacity, feel free to address any issues as I will gladly modify the PR to suit the project.

I took a stab at #1636 and limited it to the GrafanaFolder resource for now, I'm planning a separate PR for both GrafanaNotificationPolicy and GrafanaContactPoint with almost identical changes once the design in this PR has been approved.

The Makefile changes were mainly due to me trying to figure out how to work with the Operator locally and I found a lot of discrepancies with the make help target.

I struggled a fair bit with testing and validating as I'm unfamiliar with the project, hence I spent a lot of time in the Makefile.
For now, I have yet to find an existing way to easily deploy the most recently built ko-image into my local kind cluster, specifically due to the default imagePullPolicy: Always that is default in the config/manager/manager.yaml

Local procedure for testing

make start-kind
make install
make ko-build-kind
IMG=ko.local/grafana/grafana-operator make deploy
# Change imagePullPolicy
kubectl patch deploy -n grafana-operator-system grafana-operator-controller-manager-v5  --type='json' -p='[{"op": "replace", "path": "/spec/template/spec/containers/0/imagePullPolicy", "value":"IfNotPresent"}]'

# Test resources
kubectl apply -f https://raw.githubusercontent.com/grafana-operator/grafana-operator/master/examples/basic/resources.yaml
kubectl apply -f ../test-folders.yaml

../test-folders.yaml

apiVersion: grafana.integreatly.org/v1beta1
kind: GrafanaFolder
metadata:
  name: test-folder
spec:
  instanceSelector:
    matchLabels:
      dashboards: grafana
  title: Folder
---
apiVersion: grafana.integreatly.org/v1beta1
kind: GrafanaFolder
metadata:
  name: test-folder2
spec:
  instanceSelector:
    matchLabels:
      dashboards: grafana
  # uid: custom-uid # I repeatedly changed this to ensure immutability rules worked as expected
  title: Folder2

• Changing the uid: The GrafanaFolder "test-folder2" is invalid: spec.uid: Invalid value: "string": Value is immutable
• Adding/Removing uid: The GrafanaFolder "test-folder2" is invalid: spec: Invalid value: "object": uid is immutable

Old vs new make help

Usage:
  make <target>

General
  help             Display this help.
<  yq               Download yq locally if necessary.

Development
  manifests        Generate WebhookConfiguration, ClusterRole and CustomResourceDefinition objects.
  generate         Generate code containing DeepCopy, DeepCopyInto, and DeepCopyObject method implementations.
  vet              Run go vet against code.
  test             Run tests.

Build
  build            Build manager binary.
  run              Run a controller from your host.

Deployment
  install          Install CRDs into the K8s cluster specified in ~/.kube/config.
  uninstall        Uninstall CRDs from the K8s cluster specified in ~/.kube/config. Call with ignore-not-found=true to ignore resource not found errors during deletion.
  deploy           Deploy controller to the K8s cluster specified in ~/.kube/config.
  deploy-chainsaw  Deploy controller to the K8s cluster specified in ~/.kube/config.
  undeploy         Undeploy controller from the K8s cluster specified in ~/.kube/config. Call with ignore-not-found=true to ignore resource not found errors during deletion.
>  start-kind       Start kind cluster locally

Build Dependencies
  kustomize        Download kustomize locally if necessary.
  controller-gen   Download controller-gen locally if necessary.
  envtest          Download envtest-setup locally if necessary.
  operator-sdk     Download operator-sdk locally if necessary.
>  yq               Download yq locally if necessary.
>  kind             Download kind locally if necessary.
  bundle           Generate bundle manifests and metadata, then validate generated files.
  e2e              Run e2e tests using chainsaw.
>  ko-build-local   Build Docker image with KO
>  ko-build-kind    Build and Load Docker image into kind cluster
  bundle-build     Build the bundle image.
  bundle-push      Push the bundle image.
  opm              Download opm locally if necessary.
  catalog-build    Build a catalog image.
  catalog-push     Push a catalog image.

[aboulay-numspot]

Hello @Baarsgaard,

I have played the following scenarios on my local cluster. I work pretty well!

Here is the list of played scenarios:
✅ create folder without uid
✅ create folder with uid
✅ create folder in a parent folder with uid
✅ update the parent folder of the folder with uid
✅ update the uid of the resource with already an uid (should fail)
✅ remove the uid of the resource (should fail)
✅ add an uid to an existing folder without uid (should fail)

I have try to work myself on it and I was blocking into the two last point. Well done!

[Rohlik]

Getting an error while I am trying to use spec.uid within GrafanaFolder:

GrafanaFolder test-folder is invalid: problem validating schema. Check JSON formatting: jsonschema: '/spec' does not validate with https://raw.githubusercontent.com/datreeio/CRDs-catalog/main/grafana.integreatly.org/grafanafolder_v1beta1.json#/properties/spec/additionalProperties: additionalProperties 'uid' not allowed

[theSuess]

We do not control the CRDs-catalog. You'll have to create an issue or PR there to update the CRDs based on our latest github release