feat: support hiding Astarte Dashboard sidebar via annotation

PR astarte-platform/astarte-dashboard#521 introduced the ability to hide 
the Astarte Dashboard sidebar by tweaking its configuration. This allows 
the dashboard to be more easily used as an embedded component.

This commit adds an annotation to the Astarte Custom Resource (CR) that 
acts as a feature flag to enable or disable the sidebar display. 

This annotation is a temporary solution to support the feature until it 
is officially added to the Astarte CR specification under the Dashboard 
component section. If the annotation is not set, it defaults to false 
(the sidebar remains visible). No defaulting webhook has been configured 
to automatically populate this annotation on the Astarte CR.

To hide the Dashboard sidebar, set the following on the Astarte CR:
```yaml
annotations:
  api.astarte-platform.org/hide-dashboard-sidebar: "true"
```


Signed-off-by: Luca Marchiori <luca.marchiori@secomind.com>

Author: lucamarchiori

CHANGELOG.md

@@ -21,6 +21,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
   endpoints, pods and services.
 - Add experimental support for FIDO Device Onboard (FDO) in Astarte Pairing. The feature
   can be enabled and configured through the `features.fdo` field in the Astarte CR.
+- Add experimental support to hidden sidebar feature in the Astarte Dashboard.
 
 ### Changed
 - Forward port changes from release-24.5

api/api/v2alpha1/astarte_types.go

@@ -27,6 +27,14 @@ import (
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 )
 
+// Supported custom annotations in Astarte CR.
+const (
+	// AnnotationHideDashboardSidebar allows to hide the Dashboard sidebar.
+	// It is propagated to the Astarte Dashboard configmap
+	// Value: "true" or "false"
+	AnnotationHideDashboardSidebar = "api.astarte-platform.org/hide-dashboard-sidebar"
+)
+
 // AstarteSpec defines the desired state of Astarte
 type AstarteSpec struct {
 	// The Astarte Version for this Resource

docs/documentation/pages/crds/001-intro_crds.md

@@ -3,3 +3,12 @@
 The Astarte Operator extends the Kubernetes API through the definition of Custom Resources.
 
 To browse the CRD documentation, [follow this link](./crds/index.html).
+
+## Custom Annotations
+Astarte and ADI CRs support a set of custom annotations that can be used to toggle custom behaviors that are not directly supported by the CRD schema. This is often the case for features that are still experimental, or that are not expected to be widely used, and that would therefore add unnecessary complexity to the CRD schema.
+
+### Astarte CR
+
+**Enable or disable the Astarte Dashboard sidebar**
+- Annotation: `api.astarte-platform.org/hide-dashboard-sidebar`
+- Values: `"true"` or `"false"`

internal/reconcile/astarte_dashboard.go

@@ -174,6 +174,7 @@ func getAstarteDashboardPodSpec(cr *apiv2alpha1.Astarte, dashboard apiv2alpha1.A
 
 func getAstarteDashboardConfigMapData(cr *apiv2alpha1.Astarte, dashboard apiv2alpha1.AstarteDashboardSpec) map[string]string {
 	dashboardConfig := make(map[string]interface{})
+	dashboardConfigUi := make(map[string]interface{})
 
 	dashboardConfig["astarte_api_url"] = getBaseAstarteAPIURL(cr)
 	dashboardConfig["enable_flow_preview"] = misc.IsAstarteComponentDeployed(cr, apiv2alpha1.FlowComponent)
@@ -210,6 +211,12 @@ func getAstarteDashboardConfigMapData(cr *apiv2alpha1.Astarte, dashboard apiv2al
 		dashboardConfig["auth"] = []apiv2alpha1.AstarteDashboardConfigAuthSpec{{Type: "token"}}
 	}
 
+	dashboardConfigUi["hideSidebar"] = false
+	if b, ok := cr.GetAnnotations()[apiv2alpha1.AnnotationHideDashboardSidebar]; ok && b == "true" { // nolint:goconst
+		dashboardConfigUi["hideSidebar"] = true
+	}
+	dashboardConfig["ui"] = dashboardConfigUi
+
 	configJSON, _ := json.Marshal(dashboardConfig)
 
 	return map[string]string{