Skip to content

Grafana Schema

Note

This is auto-generated documentation from a JSON schema that is under construction, this will improve over time.

Return to the root config schema

https://raw.githubusercontent.com/elastisys/compliantkubernetes-apps/v0.41.0/config/schemas/config.yaml#/properties/grafana/properties/user

Configure Grafana.

Abstract Extensible Status Identifiable Custom Properties Additional Properties Access Restrictions Defined In
Can be instantiated No Unknown status No Forbidden Forbidden none config/schemas/config.yaml*

TYPE:

object (Grafana)

PROPERTIES:

Property Type Required Nullable Defined by
enabled boolean Optional cannot be null Compliant Kubernetes Apps Config
subdomain string Optional cannot be null Compliant Kubernetes Apps Config
oidc object Optional cannot be null Compliant Kubernetes Apps Config
viewersCanEdit boolean Optional cannot be null Compliant Kubernetes Apps Config
additionalConfigValues string Optional cannot be null Compliant Kubernetes Apps Config
additionalDatasources object Optional cannot be null Compliant Kubernetes Apps Config
dataproxy object Optional cannot be null Compliant Kubernetes Apps Config
plugins array Optional cannot be null Compliant Kubernetes Apps Config
trailingDots boolean Optional cannot be null Compliant Kubernetes Apps Config
sidecar object Optional cannot be null Compliant Kubernetes Apps Config
resources object Optional cannot be null Compliant Kubernetes Apps Config
tolerations array Optional cannot be null Compliant Kubernetes Apps Config
nodeSelector object Optional cannot be null Compliant Kubernetes Apps Config
affinity object Optional cannot be null Compliant Kubernetes Apps Config

enabled

enabled

TYPE:

boolean (Grafana Enabled)

DEFAULTS:

The default value is:

true

subdomain

For Admin Grafana the subdomain of opsDomain that the Ingress to Admin Grafana will be created with.

For Dev Grafana the subdomain of baseDomain that the Ingress to Dev Grafana will be created with.

Note

Must be set for both service and workload clusters.

subdomain

TYPE:

string (Grafana Subdomain)

DEFAULTS:

The default value is:

"grafana"

oidc

Configure authentication to Grafana via Dex.

oidc

TYPE:

object (Grafana OIDC)

viewersCanEdit

viewersCanEdit

TYPE:

boolean (Grafana Viewers Can Edit)

DEFAULTS:

The default value is:

true

additionalConfigValues

additionalConfigValues

TYPE:

string (Grafana Additional Config Values)

CONSTRAINTS:

unknown format: the value of this string must follow the format: yaml

additionalDatasources

additionalDatasources

TYPE:

object (Grafana Additional Datasources)

dataproxy

Configure Grafana dataproxy values

dataproxy

TYPE:

object (Grafana dataproxy values)

plugins

plugins

TYPE:

array (Grafana Additional Plugins)

trailingDots

Configure Grafana to use absolute domain names.

Warning

Some operating systems and web browsers may have problems accessing Grafana when with this enabled.

trailingDots

TYPE:

boolean (Grafana Trailing Dots)

DEFAULTS:

The default value is:

true

sidecar

Configure the sidecar provisioning dashboards from ConfigMaps in Grafana.

sidecar

TYPE:

object (Grafana Sidecar)

resources

Resource requests are used by the kube-scheduler to pick a node to schedule pods on.

Limits are enforced. Resources are commonly 'cpu' and 'memory'.

resources

TYPE:

object (Kubernetes Resource Requirements)

EXAMPLES:

requests:
  memory: 128Mi
  cpu: 100m
limits:
  memory: 256Mi
  cpu: 250m

tolerations

Kubernetes Tolerations

Kubernetes taint and toleration

tolerations

TYPE:

an array of merged types (Details)

nodeSelector

Kubernetes node selector

Kubernetes assign pod node

nodeSelector

TYPE:

object (Kubernetes Node Selector)

EXAMPLES:

kubernetes.io/os: linux

affinity

Affinity is a group of affinity scheduling rules.

affinity

TYPE:

object (Affinity)

Return to the root config schema


Generated Thu Nov 14 16:21:55 UTC 2024 from elastisys/compliantkubernetes-apps@v0.41.0