Skip to content

Welcoming Dashboard 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.40.1/config/schemas/config.yaml#/properties/welcomingDashboard

If you want to add extra text to the grafana/opensearch "welcoming dashboards" then write the text in these values as a one-line string. Note, first line of the string is a header, not all characters are supported. For newline in Grafana dashboard use format \\n

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 (Welcoming Dashboard)

PROPERTIES:

Property Type Required Nullable Defined by
extraTextGrafana string Optional cannot be null Compliant Kubernetes Apps Config
extraTextOpensearch string Optional cannot be null Compliant Kubernetes Apps Config
extraVersions array Optional cannot be null Compliant Kubernetes Apps Config

extraTextGrafana

Extra text added to the Grafana welcoming dashboard.

extraTextGrafana

TYPE:

string (Extra Text Grafana)

CONSTRAINTS:

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

EXAMPLES:

Hello\n\n[This is an example link](https:/elastisys.io)

extraTextOpensearch

Extra text added to the Opensearch welcoming dashboard.

extraTextOpensearch

TYPE:

string (Extra Text OpenSearch)

CONSTRAINTS:

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

extraVersions

List of additional components to list on the welcoming dashboard.

extraVersions

TYPE:

object[] (Extra Version)

Return to the root config schema

Generated Thu Nov 14 16:18:57 UTC 2024 from elastisys/compliantkubernetes-apps@v0.40.1