Skip to content

Commit c2bc2f3

Browse files
committed
Restore examples in DisabledDashboards doc
The DisabledDashboards field doc previously listed example dashboard names (openstack-cloud, openstack-node, openstack-vm). A later commit replaced them with generic wording. Restore the examples, which are more helpful, per review feedback. Regenerate the CRD manifests accordingly. Related-To: OSPRH-37817 Signed-off-by: Victoria Martinez de la Cruz <victoria@redhat.com> Assisted-By: Claude Opus 4.8 <noreply@anthropic.com>
1 parent b17f801 commit c2bc2f3

5 files changed

Lines changed: 10 additions & 10 deletions

‎api/bases/telemetry.openstack.org_metricstorages.yaml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1749,8 +1749,8 @@ spec:
17491749
description: |-
17501750
DisabledDashboards is a list of dashboard names that should not be
17511751
created even when DashboardsEnabled is true. Valid names match the
1752-
dashboards managed by the operator. Names that are not managed by the
1753-
operator are ignored.
1752+
dashboards managed by the operator (for example "openstack-cloud",
1753+
"openstack-node", "openstack-vm").
17541754
items:
17551755
type: string
17561756
type: array

‎api/bases/telemetry.openstack.org_telemetries.yaml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3151,8 +3151,8 @@ spec:
31513151
description: |-
31523152
DisabledDashboards is a list of dashboard names that should not be
31533153
created even when DashboardsEnabled is true. Valid names match the
3154-
dashboards managed by the operator. Names that are not managed by the
3155-
operator are ignored.
3154+
dashboards managed by the operator (for example "openstack-cloud",
3155+
"openstack-node", "openstack-vm").
31563156
items:
31573157
type: string
31583158
type: array

‎api/v1beta1/metricstorage_types.go‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -91,8 +91,8 @@ type MetricStorageSpec struct {
9191

9292
// DisabledDashboards is a list of dashboard names that should not be
9393
// created even when DashboardsEnabled is true. Valid names match the
94-
// dashboards managed by the operator. Names that are not managed by the
95-
// operator are ignored.
94+
// dashboards managed by the operator (for example "openstack-cloud",
95+
// "openstack-node", "openstack-vm").
9696
// +kubebuilder:validation:Optional
9797
// +listType=atomic
9898
DisabledDashboards []string `json:"disabledDashboards,omitempty"`

‎config/crd/bases/telemetry.openstack.org_metricstorages.yaml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1749,8 +1749,8 @@ spec:
17491749
description: |-
17501750
DisabledDashboards is a list of dashboard names that should not be
17511751
created even when DashboardsEnabled is true. Valid names match the
1752-
dashboards managed by the operator. Names that are not managed by the
1753-
operator are ignored.
1752+
dashboards managed by the operator (for example "openstack-cloud",
1753+
"openstack-node", "openstack-vm").
17541754
items:
17551755
type: string
17561756
type: array

‎config/crd/bases/telemetry.openstack.org_telemetries.yaml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3151,8 +3151,8 @@ spec:
31513151
description: |-
31523152
DisabledDashboards is a list of dashboard names that should not be
31533153
created even when DashboardsEnabled is true. Valid names match the
3154-
dashboards managed by the operator. Names that are not managed by the
3155-
operator are ignored.
3154+
dashboards managed by the operator (for example "openstack-cloud",
3155+
"openstack-node", "openstack-vm").
31563156
items:
31573157
type: string
31583158
type: array

0 commit comments

Comments
 (0)