feat: Add parentFolderUID in GrafanaFolder CRD

Author: aboulay-numspot

api/v1beta1/grafanafolder_types.go

@@ -44,6 +44,10 @@ type GrafanaFolderSpec struct {
 	// +optional
 	AllowCrossNamespaceImport *bool `json:"allowCrossNamespaceImport,omitempty"`
 
+	// find parent folder where the folder will be created with it UID value
+	// +optional
+	ParentFolderUID string `json:"parentFolderUID,omitempty"`
+
 	// how often the folder is synced, defaults to 5m if not set
 	// +optional
 	// +kubebuilder:validation:Type=string
@@ -145,3 +149,7 @@ func (in *GrafanaFolder) ResyncPeriodHasElapsed() bool {
 	deadline := in.Status.LastResync.Add(in.GetResyncPeriod())
 	return time.Now().After(deadline)
 }
+
+func (in *GrafanaFolder) HasAParentFolder() bool {
+	return in.Spec.ParentFolderUID != ""
+}

config/crd-for-docs-generation/grafana.integreatly.org_grafanafolders.yaml

@@ -99,6 +99,10 @@ spec:
                 x-kubernetes-validations:
                 - message: Value is immutable
                   rule: self == oldSelf
+              parentFolderUID:
+                description: find parent folder where the folder will be created with
+                  it UID value
+                type: string
               permissions:
                 description: raw json with folder permissions
                 type: string

config/crd/bases/grafana.integreatly.org_grafanafolders.yaml

@@ -64,6 +64,8 @@ spec:
                 x-kubernetes-validations:
                 - message: Value is immutable
                   rule: self == oldSelf
+              parentFolderUID:
+                type: string
               permissions:
                 type: string
               resyncPeriod:

controllers/grafanafolder_controller.go

@@ -328,10 +328,14 @@ func (r *GrafanaFolderReconciler) onFolderCreated(ctx context.Context, grafana *
 			}
 		}
 	} else {
-		folderResp, err := grafanaClient.Folders.CreateFolder(&models.CreateFolderCommand{
+		body := &models.CreateFolderCommand{
 			Title: title,
 			UID:   uid,
-		})
+		}
+		if cr.HasAParentFolder() {
+			body.ParentUID = cr.Spec.ParentFolderUID
+		}
+		folderResp, err := grafanaClient.Folders.CreateFolder(body)
 		if err != nil {
 			return err
 		}
@@ -373,6 +377,9 @@ func (r *GrafanaFolderReconciler) Exists(client *genapi.GrafanaHTTPAPI, cr *graf
 	limit := int64(10000)
 	for {
 		params := folders.NewGetFoldersParams().WithPage(&page).WithLimit(&limit)
+		if cr.HasAParentFolder() {
+			params.WithParentUID(&cr.Spec.ParentFolderUID)
+		}
 		foldersResp, err := client.Folders.GetFolders(params)
 		if err != nil {
 			return false, "", err

deploy/helm/grafana-operator/crds/grafana.integreatly.org_grafanafolders.yaml

@@ -64,6 +64,8 @@ spec:
                 x-kubernetes-validations:
                 - message: Value is immutable
                   rule: self == oldSelf
+              parentFolderUID:
+                type: string
               permissions:
                 type: string
               resyncPeriod:

deploy/kustomize/base/crds.yaml

@@ -861,6 +861,8 @@ spec:
                 x-kubernetes-validations:
                 - message: Value is immutable
                   rule: self == oldSelf
+              parentFolderUID:
+                type: string
               permissions:
                 type: string
               resyncPeriod:

docs/docs/api.md

@@ -2472,6 +2472,13 @@ GrafanaFolderSpec defines the desired state of GrafanaFolder
           allow to import this resources from an operator in a different namespace<br/>
         </td>
         <td>false</td>
+      </tr><tr>
+        <td><b>parentFolderUID</b></td>
+        <td>string</td>
+        <td>
+          find parent folder where the folder will be created with it UID value<br/>
+        </td>
+        <td>false</td>
       </tr><tr>
         <td><b>permissions</b></td>
         <td>string</td>