Grafanadashboard v1beta1 — grafana.integreatly.org

apiVersion string

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 string

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

metadata object

spec object required

GrafanaDashboardSpec defines the desired state of GrafanaDashboard

allowCrossNamespaceImport boolean

Allow the Operator to match this resource with Grafanas outside the current namespace

configMapRef object

model from configmap

key string required

The key to select.

name string

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

optional boolean

Specify whether the ConfigMap or its key must be defined

contentCacheDuration string

Cache duration for models fetched from URLs

datasources []object

maps required data sources to existing ones

datasourceName string required

inputName string required

envFrom []object

environments variables from secrets or config maps

configMapKeyRef object

Selects a key of a ConfigMap.

key string required

The key to select.

name string

optional boolean

Specify whether the ConfigMap or its key must be defined

secretKeyRef object

Selects a key of a Secret.

key string required

The key of the secret to select from. Must be a valid secret key.

name string

optional boolean

Specify whether the Secret or its key must be defined

envs []object

environments variables as a map

name string required

value string

Inline env value

valueFrom object

Reference on value source, might be the reference on a secret or config map

configMapKeyRef object

Selects a key of a ConfigMap.

key string required

The key to select.

name string

optional boolean

Specify whether the ConfigMap or its key must be defined

secretKeyRef object

Selects a key of a Secret.

key string required

The key of the secret to select from. Must be a valid secret key.

name string

optional boolean

Specify whether the Secret or its key must be defined

folder string

folder assignment for dashboard

folderRef string

Name of a `GrafanaFolder` resource in the same namespace

folderUID string

UID of the target folder for this dashboard

grafanaCom object

grafana.com/dashboards

id integer required

revision integer

gzipJson string

GzipJson the model's JSON compressed with Gzip. Base64-encoded when in YAML.

format: byte

instanceSelector object required

Selects Grafana instances for import

matchExpressions []object

matchExpressions is a list of label selector requirements. The requirements are ANDed.

key string required

key is the label key that the selector applies to.

operator string required

operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.

values []string

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 object

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.

json string

model json

jsonnet string

Jsonnet

jsonnetLib object

Jsonnet project build

fileName string required

gzipJsonnetProject string required

format: byte

jPath []string

plugins []object

plugins

name string required

minLength: 1

version string required

pattern: ^((0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?|latest)$

resyncPeriod string

How often the resource is synced, defaults to 10m0s if not set

pattern: ^([0-9]+(\.[0-9]+)?(ns|us|µs|ms|s|m|h))+$

suspend boolean

Suspend pauses synchronizing attempts and tells the operator to ignore changes

uid string

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.

pattern: ^[a-zA-Z0-9-_]+$

maxLength: 40

url string

model url

pattern: ^https?://.+$

urlAuthorization object

authorization options for model from url

basicAuth object

password object

SecretKeySelector selects a key of a Secret.

key string required

The key of the secret to select from. Must be a valid secret key.

name string

optional boolean

Specify whether the Secret or its key must be defined

username object

SecretKeySelector selects a key of a Secret.

key string required

The key of the secret to select from. Must be a valid secret key.

name string

optional boolean

Specify whether the Secret or its key must be defined

status object

GrafanaDashboardStatus defines the observed state of GrafanaDashboard

NoMatchingInstances boolean

The dashboard instanceSelector can't find matching grafana instances

conditions []object

Results when synchronizing resource with Grafana instances

lastTransitionTime string required

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.

format: date-time

message string required

message is a human readable message indicating details about the transition. This may be an empty string.

maxLength: 32768

observedGeneration integer

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.

format: int64

minimum: 0

reason string required

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.

pattern: ^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$

minLength: 1

maxLength: 1024

status string required

status of the condition, one of True, False, Unknown.

enum: True, False, Unknown

type string required

type of condition in CamelCase or in foo.example.com/CamelCase.

pattern: ^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$

maxLength: 316

contentCache string

format: byte

contentTimestamp string

format: date-time

contentUrl string

hash string

lastResync string

Last time the resource was synchronized with Grafana instances

format: date-time

uid string