GrafanaDashboard is the Schema for the grafanadashboards API
Last changed in Grafana Operator v5.25.0
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
GrafanaDashboardSpec defines the desired state of GrafanaDashboard
Allow the Operator to match this resource with Grafanas outside the current namespace
model from configmap
The key to select.
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
Specify whether the ConfigMap or its key must be defined
Cache duration for models fetched from URLs
maps required data sources to existing ones
environments variables from secrets or config maps
Selects a key of a ConfigMap.
The key to select.
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
Specify whether the ConfigMap or its key must be defined
Selects a key of a Secret.
The key of the secret to select from. Must be a valid secret key.
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
Specify whether the Secret or its key must be defined
environments variables as a map
Inline env value
Reference on value source, might be the reference on a secret or config map
Selects a key of a ConfigMap.
The key to select.
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
Specify whether the ConfigMap or its key must be defined
Selects a key of a Secret.
The key of the secret to select from. Must be a valid secret key.
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
Specify whether the Secret or its key must be defined
folder assignment for dashboard
Name of a `GrafanaFolder` resource in the same namespace
UID of the target folder for this dashboard
grafana.com/dashboards
GzipJson the model's JSON compressed with Gzip. Base64-encoded when in YAML.
Selects Grafana instances for import
matchExpressions is a list of label selector requirements. The requirements are ANDed.
key is the label key that the selector applies to.
operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.
matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.
model json
Jsonnet
Jsonnet project build
model from an OCI artifact (e.g. ghcr.io/team/dashboards:v1)
InsecurePlainHTTP switches the registry connection to plain HTTP (non-TLS) instead of HTTPS. Intended for in-cluster or test registries; HTTPS registries with self-signed certificates are not supported. Default false.
Path is the path of the file to extract from the artifact.
PullSecretRef references a kubernetes.io/dockerconfigjson Secret in the same namespace as the CR. If omitted, anonymous pull is attempted.
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
Reference is the full OCI artifact reference including a tag or digest, e.g. "ghcr.io/team/dashboards:v1.4.7" or "ghcr.io/team/dashboards@sha256:abc123...". Prefer a digest for reproducible deployments.
plugins
Allows configuration of sharing the dashboard publicly
Optional. Unique access token. If empty it will generate a new access token per instance.
Optional. When set to true, shows annotations. The default value is false.
Optional. Set to false to disable sharing, the public dashboard is still created. The default value is true.
Optional. when set to true, the time picker is enabled in the shared dashboard. The default value is false.
How often the resource is synced, defaults to 10m0s if not set
Suspend pauses synchronizing attempts and tells the operator to ignore changes
Manually specify the uid, overwrites uids already present in the json model. Can be any string consisting of alphanumeric characters, - and _ with a maximum length of 40.
model url
authorization options for model from url
SecretKeySelector selects a key of a Secret.
The key of the secret to select from. Must be a valid secret key.
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
Specify whether the Secret or its key must be defined
SecretKeySelector selects a key of a Secret.
The key of the secret to select from. Must be a valid secret key.
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
Specify whether the Secret or its key must be defined
overrides the default (current) value of named template variables in the dashboard model. Variables that are not present in the model are ignored.
Name of the template variable to override, matching templating.list[].name in the model.
Value is the new default value. For datasource variables this is the datasource UID or name; for query, custom, constant and textbox variables it is the selected value. Multi-value (multi-select) variables are collapsed to this single value.
GrafanaDashboardStatus defines the observed state of GrafanaDashboard
The dashboard instanceSelector can't find matching grafana instances
Results when synchronizing resource with Grafana instances
lastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.
message is a human readable message indicating details about the transition. This may be an empty string.
observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance.
reason contains a programmatic identifier indicating the reason for the condition's last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty.
status of the condition, one of True, False, Unknown.
type of condition in CamelCase or in foo.example.com/CamelCase.
Last time the resource was synchronized with Grafana instances
The resulting path where a public sharing config is available
Source: grafana.integreatly.org_grafanadashboards.yaml
Changes to GrafanaDashboard (grafana.integreatly.org/v1beta1) in each Grafana Operator version, compared to the version before it.
3 properties have been added
Released · View GrafanaDashboard in v5.25.0
1 property has been added
Released · View GrafanaDashboard in v5.24.0
1 property has changed the description
Released · View GrafanaDashboard in v5.21.4
GrafanaDashboard was already present in this version of Grafana Operator, the oldest one on kubespec.dev
Released · View GrafanaDashboard in v5.20.0
No examples of GrafanaDashboard yet. Contribute one on GitHub.
kubespec.dev