Skip to content

Commit

Permalink
docs: Generate
Browse files Browse the repository at this point in the history
  • Loading branch information
@Baarsgaard
Baarsgaard committed Nov 18, 2024
1 parent d3f6da6 commit de69b0a
Show file tree
Hide file tree
Showing 14 changed files with 174 additions and 125 deletions.
10 changes: 7 additions & 3 deletions config/crd/bases/grafana.integreatly.org_grafanaalertrulegroups.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,8 @@ spec:
description: GrafanaAlertRuleGroupSpec defines the desired state of GrafanaAlertRuleGroup
properties:
allowCrossNamespaceImport:
description: Allow the Operator to match this resource with Grafanas
outside the current namespace
type: boolean
editable:
description: Whether to enable or disable editing of the alert rule
Expand All @@ -60,7 +62,7 @@ spec:
Overrides the FolderSelector
type: string
instanceSelector:
description: selects Grafanas for import
description: Selects Grafana instances for import
properties:
matchExpressions:
description: matchExpressions is a list of label selector requirements.
Expand Down Expand Up @@ -106,7 +108,7 @@ spec:
type: object
x-kubernetes-map-type: atomic
x-kubernetes-validations:
- message: Value is immutable
- message: spec.instanceSelector is immutable
rule: self == oldSelf
interval:
format: duration
Expand All @@ -117,7 +119,9 @@ spec:
name will be used.
type: string
resyncPeriod:
default: 10m
default: 10m0s
description: How often the resource is synced, defaults to 10m0s if
not set
format: duration
pattern: ^([0-9]+(\.[0-9]+)?(ns|us|µs|ms|s|m|h))+$
type: string
Expand Down
10 changes: 7 additions & 3 deletions config/crd/bases/grafana.integreatly.org_grafanacontactpoints.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -43,11 +43,13 @@ spec:
description: GrafanaContactPointSpec defines the desired state of GrafanaContactPoint
properties:
allowCrossNamespaceImport:
description: Allow the Operator to match this resource with Grafanas
outside the current namespace
type: boolean
disableResolveMessage:
type: boolean
instanceSelector:
description: selects Grafanas for import
description: Selects Grafana instances for import
properties:
matchExpressions:
description: matchExpressions is a list of label selector requirements.
Expand Down Expand Up @@ -93,12 +95,14 @@ spec:
type: object
x-kubernetes-map-type: atomic
x-kubernetes-validations:
- message: Value is immutable
- message: spec.instanceSelector is immutable
rule: self == oldSelf
name:
type: string
resyncPeriod:
default: 10m
default: 10m0s
description: How often the resource is synced, defaults to 10m0s if
not set
format: duration
pattern: ^([0-9]+(\.[0-9]+)?(ns|us|µs|ms|s|m|h))+$
type: string
Expand Down
14 changes: 7 additions & 7 deletions config/crd/bases/grafana.integreatly.org_grafanadashboards.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -53,8 +53,8 @@ spec:
description: GrafanaDashboardSpec defines the desired state of GrafanaDashboard
properties:
allowCrossNamespaceImport:
description: allow to import this resources from an operator in a
different namespace
description: Allow the Operator to match this resource with Grafanas
outside the current namespace
type: boolean
configMapRef:
description: dashboard from configmap
Expand Down Expand Up @@ -238,7 +238,7 @@ spec:
format: byte
type: string
instanceSelector:
description: selects Grafanas for import
description: Selects Grafana instances for import
properties:
matchExpressions:
description: matchExpressions is a list of label selector requirements.
Expand Down Expand Up @@ -284,7 +284,7 @@ spec:
type: object
x-kubernetes-map-type: atomic
x-kubernetes-validations:
- message: Value is immutable
- message: spec.instanceSelector is immutable
rule: self == oldSelf
json:
description: dashboard json
Expand Down Expand Up @@ -322,9 +322,9 @@ spec:
type: object
type: array
resyncPeriod:
default: 5m
description: how often the dashboard is refreshed, defaults to 5m
if not set
default: 10m0s
description: How often the resource is synced, defaults to 10m0s if
not set
format: duration
pattern: ^([0-9]+(\.[0-9]+)?(ns|us|µs|ms|s|m|h))+$
type: string
Expand Down
14 changes: 7 additions & 7 deletions config/crd/bases/grafana.integreatly.org_grafanadatasources.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -53,8 +53,8 @@ spec:
description: GrafanaDatasourceSpec defines the desired state of GrafanaDatasource
properties:
allowCrossNamespaceImport:
description: allow to import this resources from an operator in a
different namespace
description: Allow the Operator to match this resource with Grafanas
outside the current namespace
type: boolean
datasource:
properties:
Expand Down Expand Up @@ -95,7 +95,7 @@ spec:
type: string
type: object
instanceSelector:
description: selects Grafana instances for import
description: Selects Grafana instances for import
properties:
matchExpressions:
description: matchExpressions is a list of label selector requirements.
Expand Down Expand Up @@ -141,7 +141,7 @@ spec:
type: object
x-kubernetes-map-type: atomic
x-kubernetes-validations:
- message: Value is immutable
- message: spec.instanceSelector is immutable
rule: self == oldSelf
plugins:
description: plugins
Expand All @@ -157,9 +157,9 @@ spec:
type: object
type: array
resyncPeriod:
default: 5m
description: how often the datasource is refreshed, defaults to 5m
if not set
default: 10m0s
description: How often the resource is synced, defaults to 10m0s if
not set
format: duration
pattern: ^([0-9]+(\.[0-9]+)?(ns|us|µs|ms|s|m|h))+$
type: string
Expand Down
14 changes: 7 additions & 7 deletions config/crd/bases/grafana.integreatly.org_grafanafolders.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -49,11 +49,11 @@ spec:
description: GrafanaFolderSpec defines the desired state of GrafanaFolder
properties:
allowCrossNamespaceImport:
description: Enable matching Grafana instances outside the current
namespace
description: Allow the Operator to match this resource with Grafanas
outside the current namespace
type: boolean
instanceSelector:
description: Selects Grafanas for import
description: Selects Grafana instances for import
properties:
matchExpressions:
description: matchExpressions is a list of label selector requirements.
Expand Down Expand Up @@ -99,7 +99,7 @@ spec:
type: object
x-kubernetes-map-type: atomic
x-kubernetes-validations:
- message: Value is immutable
- message: spec.instanceSelector is immutable
rule: self == oldSelf
parentFolderRef:
description: Reference to an existing GrafanaFolder CR in the same
Expand All @@ -114,9 +114,9 @@ spec:
from Grafana
type: string
resyncPeriod:
default: 5m
description: How often the folder is synced, defaults to 5m if not
set
default: 10m0s
description: How often the resource is synced, defaults to 10m0s if
not set
format: duration
pattern: ^([0-9]+(\.[0-9]+)?(ns|us|µs|ms|s|m|h))+$
type: string
Expand Down
12 changes: 9 additions & 3 deletions config/crd/bases/grafana.integreatly.org_grafananotificationpolicies.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,10 @@ spec:
description: GrafanaNotificationPolicySpec defines the desired state of
GrafanaNotificationPolicy
properties:
allowCrossNamespaceImport:
description: Allow the Operator to match this resource with Grafanas
outside the current namespace
type: boolean
editable:
description: Whether to enable or disable editing of the notification
policy in Grafana UI
Expand All @@ -51,7 +55,7 @@ spec:
- message: Value is immutable
rule: self == oldSelf
instanceSelector:
description: selects Grafanas for import
description: Selects Grafana instances for import
properties:
matchExpressions:
description: matchExpressions is a list of label selector requirements.
Expand Down Expand Up @@ -97,10 +101,12 @@ spec:
type: object
x-kubernetes-map-type: atomic
x-kubernetes-validations:
- message: Value is immutable
- message: spec.instanceSelector is immutable
rule: self == oldSelf
resyncPeriod:
default: 10m
default: 10m0s
description: How often the resource is synced, defaults to 10m0s if
not set
format: duration
pattern: ^([0-9]+(\.[0-9]+)?(ns|us|µs|ms|s|m|h))+$
type: string
Expand Down
10 changes: 7 additions & 3 deletions deploy/helm/grafana-operator/crds/grafana.integreatly.org_grafanaalertrulegroups.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,8 @@ spec:
description: GrafanaAlertRuleGroupSpec defines the desired state of GrafanaAlertRuleGroup
properties:
allowCrossNamespaceImport:
description: Allow the Operator to match this resource with Grafanas
outside the current namespace
type: boolean
editable:
description: Whether to enable or disable editing of the alert rule
Expand All @@ -60,7 +62,7 @@ spec:
Overrides the FolderSelector
type: string
instanceSelector:
description: selects Grafanas for import
description: Selects Grafana instances for import
properties:
matchExpressions:
description: matchExpressions is a list of label selector requirements.
Expand Down Expand Up @@ -106,7 +108,7 @@ spec:
type: object
x-kubernetes-map-type: atomic
x-kubernetes-validations:
- message: Value is immutable
- message: spec.instanceSelector is immutable
rule: self == oldSelf
interval:
format: duration
Expand All @@ -117,7 +119,9 @@ spec:
name will be used.
type: string
resyncPeriod:
default: 10m
default: 10m0s
description: How often the resource is synced, defaults to 10m0s if
not set
format: duration
pattern: ^([0-9]+(\.[0-9]+)?(ns|us|µs|ms|s|m|h))+$
type: string
Expand Down
10 changes: 7 additions & 3 deletions deploy/helm/grafana-operator/crds/grafana.integreatly.org_grafanacontactpoints.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -43,11 +43,13 @@ spec:
description: GrafanaContactPointSpec defines the desired state of GrafanaContactPoint
properties:
allowCrossNamespaceImport:
description: Allow the Operator to match this resource with Grafanas
outside the current namespace
type: boolean
disableResolveMessage:
type: boolean
instanceSelector:
description: selects Grafanas for import
description: Selects Grafana instances for import
properties:
matchExpressions:
description: matchExpressions is a list of label selector requirements.
Expand Down Expand Up @@ -93,12 +95,14 @@ spec:
type: object
x-kubernetes-map-type: atomic
x-kubernetes-validations:
- message: Value is immutable
- message: spec.instanceSelector is immutable
rule: self == oldSelf
name:
type: string
resyncPeriod:
default: 10m
default: 10m0s
description: How often the resource is synced, defaults to 10m0s if
not set
format: duration
pattern: ^([0-9]+(\.[0-9]+)?(ns|us|µs|ms|s|m|h))+$
type: string
Expand Down
14 changes: 7 additions & 7 deletions deploy/helm/grafana-operator/crds/grafana.integreatly.org_grafanadashboards.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -53,8 +53,8 @@ spec:
description: GrafanaDashboardSpec defines the desired state of GrafanaDashboard
properties:
allowCrossNamespaceImport:
description: allow to import this resources from an operator in a
different namespace
description: Allow the Operator to match this resource with Grafanas
outside the current namespace
type: boolean
configMapRef:
description: dashboard from configmap
Expand Down Expand Up @@ -238,7 +238,7 @@ spec:
format: byte
type: string
instanceSelector:
description: selects Grafanas for import
description: Selects Grafana instances for import
properties:
matchExpressions:
description: matchExpressions is a list of label selector requirements.
Expand Down Expand Up @@ -284,7 +284,7 @@ spec:
type: object
x-kubernetes-map-type: atomic
x-kubernetes-validations:
- message: Value is immutable
- message: spec.instanceSelector is immutable
rule: self == oldSelf
json:
description: dashboard json
Expand Down Expand Up @@ -322,9 +322,9 @@ spec:
type: object
type: array
resyncPeriod:
default: 5m
description: how often the dashboard is refreshed, defaults to 5m
if not set
default: 10m0s
description: How often the resource is synced, defaults to 10m0s if
not set
format: duration
pattern: ^([0-9]+(\.[0-9]+)?(ns|us|µs|ms|s|m|h))+$
type: string
Expand Down
14 changes: 7 additions & 7 deletions deploy/helm/grafana-operator/crds/grafana.integreatly.org_grafanadatasources.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -53,8 +53,8 @@ spec:
description: GrafanaDatasourceSpec defines the desired state of GrafanaDatasource
properties:
allowCrossNamespaceImport:
description: allow to import this resources from an operator in a
different namespace
description: Allow the Operator to match this resource with Grafanas
outside the current namespace
type: boolean
datasource:
properties:
Expand Down Expand Up @@ -95,7 +95,7 @@ spec:
type: string
type: object
instanceSelector:
description: selects Grafana instances for import
description: Selects Grafana instances for import
properties:
matchExpressions:
description: matchExpressions is a list of label selector requirements.
Expand Down Expand Up @@ -141,7 +141,7 @@ spec:
type: object
x-kubernetes-map-type: atomic
x-kubernetes-validations:
- message: Value is immutable
- message: spec.instanceSelector is immutable
rule: self == oldSelf
plugins:
description: plugins
Expand All @@ -157,9 +157,9 @@ spec:
type: object
type: array
resyncPeriod:
default: 5m
description: how often the datasource is refreshed, defaults to 5m
if not set
default: 10m0s
description: How often the resource is synced, defaults to 10m0s if
not set
format: duration
pattern: ^([0-9]+(\.[0-9]+)?(ns|us|µs|ms|s|m|h))+$
type: string
Expand Down
Loading

0 comments on commit de69b0a

Please sign in to comment.