Preliminary version. The functionality may change, but the basic features will be preserved. Compatibility with future versions is ensured, but may require additional migration actions.

The Deckhouse Kubernetes Platform installs CRDs but does not remove them when a module is disabled. If you no longer need the created CRDs, delete them.

ClusterMetric

Scope: Cluster
Version: v1alpha1

ClusterObservabilityDashboard

Scope: Cluster
Version: v1alpha1

Defines a cluster-level dashboard that is displayed in the Deckhouse Console. This resource is not bound to any specific namespace. Supported annotations: - metadata.deckhouse.io/category — sets the folder/category in the UI. - metadata.deckhouse.io/title — sets the visible dashboard title. If not set, the title from the dashboard JSON is used.
  • spec
    object
    • spec.definition
      string

      Required value

      The dashboard JSON manifest. The JSON definition should be provided as a raw JSON string compatible with the Grafana dashboard format.

ClusterObservabilityPropagatedDashboard

Scope: Cluster
Version: v1alpha1

Deckhouse internal system resource that lets you define a dashboard once and automatically make it available everywhere in the Deckhouse Console.

A dashboard defined as a ClusterObservabilityPropagatedDashboard is automatically visible: at the cluster level and in every namespace/project.

Supported annotations:

  • metadata.deckhouse.io/category — sets the folder/category in the UI.
  • metadata.deckhouse.io/title — sets the visible dashboard title. If not set, the title from the dashboard JSON is used.
  • spec
    object
    • spec.definition
      string

      Required value

      The dashboard JSON manifest. The JSON definition should be provided as a raw JSON string compatible with the Grafana dashboard format.

ObservabilityDashboard

Scope: Namespaced
Version: v1alpha1

Defines a dashboard that will be displayed in the Deckhouse Console. This resource is namespaced, allowing teams to create and manage their own dashboards independently within their namespaces. The following annotations are supported: - metadata.deckhouse.io/category — sets the folder/category in the UI. - metadata.deckhouse.io/title — sets the visible dashboard title. If not set, the title from the dashboard JSON is used.
  • spec
    object
    • spec.definition
      string

      Required value

      The dashboard’s JSON manifest. The JSON definition should be provided as a raw JSON string compatible with the Grafana dashboard format.