API Reference
Packages:
grafana.integreatly.org/v1beta1
Resource Types:
GrafanaAlertRuleGroup
GrafanaAlertRuleGroup is the Schema for the grafanaalertrulegroups API
Name | Type | Description | Required |
---|---|---|---|
apiVersion | string | grafana.integreatly.org/v1beta1 | true |
kind | string | GrafanaAlertRuleGroup | true |
metadata | object | Refer to the Kubernetes API documentation for the fields of the `metadata` field. | true |
spec | object | GrafanaAlertRuleGroupSpec defines the desired state of GrafanaAlertRuleGroup Validations: | false |
status | object | GrafanaAlertRuleGroupStatus defines the observed state of GrafanaAlertRuleGroup | false |
GrafanaAlertRuleGroup.spec
GrafanaAlertRuleGroupSpec defines the desired state of GrafanaAlertRuleGroup
Name | Type | Description | Required |
---|---|---|---|
instanceSelector | object | Selects Grafana instances for import Validations: | true |
interval | string | Format: duration | true |
rules | []object | true | |
allowCrossNamespaceImport | boolean | Allow the Operator to match this resource with Grafanas outside the current namespace | false |
editable | boolean | Whether to enable or disable editing of the alert rule group in Grafana UI Validations: | false |
folderRef | string | Match GrafanaFolders CRs to infer the uid | false |
folderUID | string | UID of the folder containing this rule group
Overrides the FolderSelector | false |
name | string | Name of the alert rule group. If not specified, the resource name will be used. | false |
resyncPeriod | string | How often the resource is synced, defaults to 10m0s if not set Format: duration Default: 10m0s | false |
GrafanaAlertRuleGroup.spec.instanceSelector
Selects Grafana instances for import
Name | Type | Description | Required |
---|---|---|---|
matchExpressions | []object | matchExpressions is a list of label selector requirements. The requirements are ANDed. | false |
matchLabels | map[string]string | 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. | false |
GrafanaAlertRuleGroup.spec.instanceSelector.matchExpressions[index]
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Name | Type | Description | Required |
---|---|---|---|
key | string | key is the label key that the selector applies to. | true |
operator | string | operator represents a key's relationship to a set of values.
Valid operators are In, NotIn, Exists and DoesNotExist. | true |
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. | false |
GrafanaAlertRuleGroup.spec.rules[index]
AlertRule defines a specific rule to be evaluated. It is based on the upstream model with some k8s specific type mappings
Name | Type | Description | Required |
---|---|---|---|
condition | string | true | |
data | []object | true | |
execErrState | enum | Enum: OK, Alerting, Error, KeepLast | true |
for | string | Format: duration | true |
noDataState | enum | Enum: Alerting, NoData, OK, KeepLast | true |
title | string | true | |
uid | string | true | |
annotations | map[string]string | false | |
isPaused | boolean | false | |
labels | map[string]string | false | |
notificationSettings | object | false |
GrafanaAlertRuleGroup.spec.rules[index].data[index]
Name | Type | Description | Required |
---|---|---|---|
datasourceUid | string | Grafana data source unique identifier; it should be '__expr__' for a Server Side Expression operation. | false |
model | JSON | JSON is the raw JSON query and includes the above properties as well as custom properties. | false |
queryType | string | QueryType is an optional identifier for the type of query.
It can be used to distinguish different types of queries. | false |
refId | string | RefID is the unique identifier of the query, set by the frontend call. | false |
relativeTimeRange | object | relative time range | false |
GrafanaAlertRuleGroup.spec.rules[index].data[index].relativeTimeRange
relative time range
Name | Type | Description | Required |
---|---|---|---|
from | integer | from Format: int64 | false |
to | integer | to Format: int64 | false |
GrafanaAlertRuleGroup.spec.rules[index].notificationSettings
Name | Type | Description | Required |
---|---|---|---|
receiver | string | true | |
group_by | []string | false | |
group_interval | string | false | |
group_wait | string | false | |
mute_time_intervals | []string | false | |
repeat_interval | string | false |
GrafanaAlertRuleGroup.status
GrafanaAlertRuleGroupStatus defines the observed state of GrafanaAlertRuleGroup
Name | Type | Description | Required |
---|---|---|---|
conditions | []object | true |
GrafanaAlertRuleGroup.status.conditions[index]
Condition contains details for one aspect of the current state of this API Resource.
Name | Type | Description | Required |
---|---|---|---|
lastTransitionTime | string | 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 | true |
message | string | message is a human readable message indicating details about the transition.
This may be an empty string. | true |
reason | string | 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. | true |
status | enum | status of the condition, one of True, False, Unknown. Enum: True, False, Unknown | true |
type | string | type of condition in CamelCase or in foo.example.com/CamelCase. | true |
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 | false |
GrafanaContactPoint
GrafanaContactPoint is the Schema for the grafanacontactpoints API
Name | Type | Description | Required |
---|---|---|---|
apiVersion | string | grafana.integreatly.org/v1beta1 | true |
kind | string | GrafanaContactPoint | true |
metadata | object | Refer to the Kubernetes API documentation for the fields of the `metadata` field. | true |
spec | object | GrafanaContactPointSpec defines the desired state of GrafanaContactPoint Validations: | false |
status | object | GrafanaContactPointStatus defines the observed state of GrafanaContactPoint | false |
GrafanaContactPoint.spec
GrafanaContactPointSpec defines the desired state of GrafanaContactPoint
Name | Type | Description | Required |
---|---|---|---|
instanceSelector | object | Selects Grafana instances for import Validations: | true |
name | string | true | |
settings | JSON | true | |
allowCrossNamespaceImport | boolean | Allow the Operator to match this resource with Grafanas outside the current namespace | false |
disableResolveMessage | boolean | false | |
resyncPeriod | string | How often the resource is synced, defaults to 10m0s if not set Format: duration Default: 10m0s | false |
type | enum | Enum: alertmanager, prometheus-alertmanager, dingding, discord, email, googlechat, kafka, line, opsgenie, pagerduty, pushover, sensugo, sensu, slack, teams, telegram, threema, victorops, webhook, wecom, hipchat, oncall | false |
uid | string | Manually specify the UID the Contact Point is created with Validations: | false |
valuesFrom | []object | false |
GrafanaContactPoint.spec.instanceSelector
Selects Grafana instances for import
Name | Type | Description | Required |
---|---|---|---|
matchExpressions | []object | matchExpressions is a list of label selector requirements. The requirements are ANDed. | false |
matchLabels | map[string]string | 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. | false |
GrafanaContactPoint.spec.instanceSelector.matchExpressions[index]
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Name | Type | Description | Required |
---|---|---|---|
key | string | key is the label key that the selector applies to. | true |
operator | string | operator represents a key's relationship to a set of values.
Valid operators are In, NotIn, Exists and DoesNotExist. | true |
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. | false |
GrafanaContactPoint.spec.valuesFrom[index]
Name | Type | Description | Required |
---|---|---|---|
targetPath | string | true | |
valueFrom | object | Validations: | true |
GrafanaContactPoint.spec.valuesFrom[index].valueFrom
Name | Type | Description | Required |
---|---|---|---|
configMapKeyRef | object | Selects a key of a ConfigMap. | false |
secretKeyRef | object | Selects a key of a Secret. | false |
GrafanaContactPoint.spec.valuesFrom[index].valueFrom.configMapKeyRef
Selects a key of a ConfigMap.
Name | Type | Description | Required |
---|---|---|---|
key | string | The key to select. | true |
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 Default: | false |
optional | boolean | Specify whether the ConfigMap or its key must be defined | false |
GrafanaContactPoint.spec.valuesFrom[index].valueFrom.secretKeyRef
Selects a key of a Secret.
Name | Type | Description | Required |
---|---|---|---|
key | string | The key of the secret to select from. Must be a valid secret key. | true |
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 Default: | false |
optional | boolean | Specify whether the Secret or its key must be defined | false |
GrafanaContactPoint.status
GrafanaContactPointStatus defines the observed state of GrafanaContactPoint
Name | Type | Description | Required |
---|---|---|---|
conditions | []object | INSERT ADDITIONAL STATUS FIELD - define observed state of cluster
Important: Run "make" to regenerate code after modifying this file | true |
GrafanaContactPoint.status.conditions[index]
Condition contains details for one aspect of the current state of this API Resource.
Name | Type | Description | Required |
---|---|---|---|
lastTransitionTime | string | 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 | true |
message | string | message is a human readable message indicating details about the transition.
This may be an empty string. | true |
reason | string | 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. | true |
status | enum | status of the condition, one of True, False, Unknown. Enum: True, False, Unknown | true |
type | string | type of condition in CamelCase or in foo.example.com/CamelCase. | true |
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 | false |
GrafanaDashboard
GrafanaDashboard is the Schema for the grafanadashboards API
Name | Type | Description | Required |
---|---|---|---|
apiVersion | string | grafana.integreatly.org/v1beta1 | true |
kind | string | GrafanaDashboard | true |
metadata | object | Refer to the Kubernetes API documentation for the fields of the `metadata` field. | true |
spec | object | GrafanaDashboardSpec defines the desired state of GrafanaDashboard Validations: | false |
status | object | GrafanaDashboardStatus defines the observed state of GrafanaDashboard | false |
GrafanaDashboard.spec
GrafanaDashboardSpec defines the desired state of GrafanaDashboard
Name | Type | Description | Required |
---|---|---|---|
instanceSelector | object | Selects Grafana instances for import Validations: | true |
allowCrossNamespaceImport | boolean | Allow the Operator to match this resource with Grafanas outside the current namespace | false |
configMapRef | object | dashboard from configmap | false |
contentCacheDuration | string | Cache duration for dashboards fetched from URLs | false |
datasources | []object | maps required data sources to existing ones | false |
envFrom | []object | environments variables from secrets or config maps | false |
envs | []object | environments variables as a map | false |
folder | string | folder assignment for dashboard | false |
folderRef | string | Name of a `GrafanaFolder` resource in the same namespace | false |
folderUID | string | UID of the target folder for this dashboard | false |
grafanaCom | object | grafana.com/dashboards | false |
gzipJson | string | GzipJson the dashboard's JSON compressed with Gzip. Base64-encoded when in YAML. Format: byte | false |
json | string | dashboard json | false |
jsonnet | string | Jsonnet | false |
jsonnetLib | object | Jsonnet project build | false |
plugins | []object | plugins | false |
resyncPeriod | string | How often the resource is synced, defaults to 10m0s if not set Format: duration Default: 10m0s | false |
uid | string | Manually specify the uid for the dashboard, overwrites uids already present in the json model Validations: | false |
url | string | dashboard url | false |
urlAuthorization | object | authorization options for dashboard from url | false |
GrafanaDashboard.spec.instanceSelector
Selects Grafana instances for import
Name | Type | Description | Required |
---|---|---|---|
matchExpressions | []object | matchExpressions is a list of label selector requirements. The requirements are ANDed. | false |
matchLabels | map[string]string | 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. | false |
GrafanaDashboard.spec.instanceSelector.matchExpressions[index]
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Name | Type | Description | Required |
---|---|---|---|
key | string | key is the label key that the selector applies to. | true |
operator | string | operator represents a key's relationship to a set of values.
Valid operators are In, NotIn, Exists and DoesNotExist. | true |
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. | false |
GrafanaDashboard.spec.configMapRef
dashboard from configmap
Name | Type | Description | Required |
---|---|---|---|
key | string | The key to select. | true |
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 Default: | false |
optional | boolean | Specify whether the ConfigMap or its key must be defined | false |
GrafanaDashboard.spec.datasources[index]
Name | Type | Description | Required |
---|---|---|---|
datasourceName | string | true | |
inputName | string | true |
GrafanaDashboard.spec.envFrom[index]
Name | Type | Description | Required |
---|---|---|---|
configMapKeyRef | object | Selects a key of a ConfigMap. | false |
secretKeyRef | object | Selects a key of a Secret. | false |
GrafanaDashboard.spec.envFrom[index].configMapKeyRef
Selects a key of a ConfigMap.
Name | Type | Description | Required |
---|---|---|---|
key | string | The key to select. | true |
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 Default: | false |
optional | boolean | Specify whether the ConfigMap or its key must be defined | false |
GrafanaDashboard.spec.envFrom[index].secretKeyRef
Selects a key of a Secret.
Name | Type | Description | Required |
---|---|---|---|
key | string | The key of the secret to select from. Must be a valid secret key. | true |
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 Default: | false |
optional | boolean | Specify whether the Secret or its key must be defined | false |
GrafanaDashboard.spec.envs[index]
Name | Type | Description | Required |
---|---|---|---|
name | string | true | |
value | string | Inline env value | false |
valueFrom | object | Reference on value source, might be the reference on a secret or config map | false |
GrafanaDashboard.spec.envs[index].valueFrom
Reference on value source, might be the reference on a secret or config map
Name | Type | Description | Required |
---|---|---|---|
configMapKeyRef | object | Selects a key of a ConfigMap. | false |
secretKeyRef | object | Selects a key of a Secret. | false |
GrafanaDashboard.spec.envs[index].valueFrom.configMapKeyRef
Selects a key of a ConfigMap.
Name | Type | Description | Required |
---|---|---|---|
key | string | The key to select. | true |
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 Default: | false |
optional | boolean | Specify whether the ConfigMap or its key must be defined | false |
GrafanaDashboard.spec.envs[index].valueFrom.secretKeyRef
Selects a key of a Secret.
Name | Type | Description | Required |
---|---|---|---|
key | string | The key of the secret to select from. Must be a valid secret key. | true |
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 Default: | false |
optional | boolean | Specify whether the Secret or its key must be defined | false |
GrafanaDashboard.spec.grafanaCom
grafana.com/dashboards
Name | Type | Description | Required |
---|---|---|---|
id | integer | true | |
revision | integer | false |
GrafanaDashboard.spec.jsonnetLib
Jsonnet project build
Name | Type | Description | Required |
---|---|---|---|
fileName | string | true | |
gzipJsonnetProject | string | Format: byte | true |
jPath | []string | false |
GrafanaDashboard.spec.plugins[index]
Name | Type | Description | Required |
---|---|---|---|
name | string | true | |
version | string | true |
GrafanaDashboard.spec.urlAuthorization
authorization options for dashboard from url
Name | Type | Description | Required |
---|---|---|---|
basicAuth | object | false |
GrafanaDashboard.spec.urlAuthorization.basicAuth
Name | Type | Description | Required |
---|---|---|---|
password | object | SecretKeySelector selects a key of a Secret. | false |
username | object | SecretKeySelector selects a key of a Secret. | false |
GrafanaDashboard.spec.urlAuthorization.basicAuth.password
SecretKeySelector selects a key of a Secret.
Name | Type | Description | Required |
---|---|---|---|
key | string | The key of the secret to select from. Must be a valid secret key. | true |
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 Default: | false |
optional | boolean | Specify whether the Secret or its key must be defined | false |
GrafanaDashboard.spec.urlAuthorization.basicAuth.username
SecretKeySelector selects a key of a Secret.
Name | Type | Description | Required |
---|---|---|---|
key | string | The key of the secret to select from. Must be a valid secret key. | true |
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 Default: | false |
optional | boolean | Specify whether the Secret or its key must be defined | false |
GrafanaDashboard.status
GrafanaDashboardStatus defines the observed state of GrafanaDashboard
Name | Type | Description | Required |
---|---|---|---|
NoMatchingInstances | boolean | The dashboard instanceSelector can't find matching grafana instances | false |
conditions | []object | false | |
contentCache | string | Format: byte | false |
contentTimestamp | string | Format: date-time | false |
contentUrl | string | false | |
hash | string | false | |
lastResync | string | Last time the dashboard was resynced Format: date-time | false |
uid | string | false |
GrafanaDashboard.status.conditions[index]
Condition contains details for one aspect of the current state of this API Resource.
Name | Type | Description | Required |
---|---|---|---|
lastTransitionTime | string | 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 | true |
message | string | message is a human readable message indicating details about the transition.
This may be an empty string. | true |
reason | string | 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. | true |
status | enum | status of the condition, one of True, False, Unknown. Enum: True, False, Unknown | true |
type | string | type of condition in CamelCase or in foo.example.com/CamelCase. | true |
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 | false |
GrafanaDatasource
GrafanaDatasource is the Schema for the grafanadatasources API
Name | Type | Description | Required |
---|---|---|---|
apiVersion | string | grafana.integreatly.org/v1beta1 | true |
kind | string | GrafanaDatasource | true |
metadata | object | Refer to the Kubernetes API documentation for the fields of the `metadata` field. | true |
spec | object | GrafanaDatasourceSpec defines the desired state of GrafanaDatasource Validations: | false |
status | object | GrafanaDatasourceStatus defines the observed state of GrafanaDatasource | false |
GrafanaDatasource.spec
GrafanaDatasourceSpec defines the desired state of GrafanaDatasource
Name | Type | Description | Required |
---|---|---|---|
datasource | object | true | |
instanceSelector | object | Selects Grafana instances for import Validations: | true |
allowCrossNamespaceImport | boolean | Allow the Operator to match this resource with Grafanas outside the current namespace | false |
plugins | []object | plugins | false |
resyncPeriod | string | How often the resource is synced, defaults to 10m0s if not set Format: duration Default: 10m0s | false |
uid | string | The UID, for the datasource, fallback to the deprecated spec.datasource.uid and metadata.uid Validations: | false |
valuesFrom | []object | environments variables from secrets or config maps | false |
GrafanaDatasource.spec.datasource
Name | Type | Description | Required |
---|---|---|---|
access | string | false | |
basicAuth | boolean | false | |
basicAuthUser | string | false | |
database | string | false | |
editable | boolean | Whether to enable/disable editing of the datasource in Grafana UI | false |
isDefault | boolean | false | |
jsonData | object | false | |
name | string | false | |
orgId | integer | Deprecated field, it has no effect Format: int64 | false |
secureJsonData | object | false | |
type | string | false | |
uid | string | Deprecated field, use spec.uid instead | false |
url | string | false | |
user | string | false |
GrafanaDatasource.spec.instanceSelector
Selects Grafana instances for import
Name | Type | Description | Required |
---|---|---|---|
matchExpressions | []object | matchExpressions is a list of label selector requirements. The requirements are ANDed. | false |
matchLabels | map[string]string | 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. | false |
GrafanaDatasource.spec.instanceSelector.matchExpressions[index]
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Name | Type | Description | Required |
---|---|---|---|
key | string | key is the label key that the selector applies to. | true |
operator | string | operator represents a key's relationship to a set of values.
Valid operators are In, NotIn, Exists and DoesNotExist. | true |
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. | false |
GrafanaDatasource.spec.plugins[index]
Name | Type | Description | Required |
---|---|---|---|
name | string | true | |
version | string | true |
GrafanaDatasource.spec.valuesFrom[index]
Name | Type | Description | Required |
---|---|---|---|
targetPath | string | true | |
valueFrom | object | Validations: | true |
GrafanaDatasource.spec.valuesFrom[index].valueFrom
Name | Type | Description | Required |
---|---|---|---|
configMapKeyRef | object | Selects a key of a ConfigMap. | false |
secretKeyRef | object | Selects a key of a Secret. | false |
GrafanaDatasource.spec.valuesFrom[index].valueFrom.configMapKeyRef
Selects a key of a ConfigMap.
Name | Type | Description | Required |
---|---|---|---|
key | string | The key to select. | true |
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 Default: | false |
optional | boolean | Specify whether the ConfigMap or its key must be defined | false |
GrafanaDatasource.spec.valuesFrom[index].valueFrom.secretKeyRef
Selects a key of a Secret.
Name | Type | Description | Required |
---|---|---|---|
key | string | The key of the secret to select from. Must be a valid secret key. | true |
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 Default: | false |
optional | boolean | Specify whether the Secret or its key must be defined | false |
GrafanaDatasource.status
GrafanaDatasourceStatus defines the observed state of GrafanaDatasource
Name | Type | Description | Required |
---|---|---|---|
NoMatchingInstances | boolean | The datasource instanceSelector can't find matching grafana instances | false |
hash | string | false | |
lastMessage | string | false | |
lastResync | string | Last time the datasource was resynced Format: date-time | false |
uid | string | false |
GrafanaFolder
GrafanaFolder is the Schema for the grafanafolders API
Name | Type | Description | Required |
---|---|---|---|
apiVersion | string | grafana.integreatly.org/v1beta1 | true |
kind | string | GrafanaFolder | true |
metadata | object | Refer to the Kubernetes API documentation for the fields of the `metadata` field. | true |
spec | object | GrafanaFolderSpec defines the desired state of GrafanaFolder Validations: | false |
status | object | GrafanaFolderStatus defines the observed state of GrafanaFolder | false |
GrafanaFolder.spec
GrafanaFolderSpec defines the desired state of GrafanaFolder
Name | Type | Description | Required |
---|---|---|---|
instanceSelector | object | Selects Grafana instances for import Validations: | true |
allowCrossNamespaceImport | boolean | Allow the Operator to match this resource with Grafanas outside the current namespace | false |
parentFolderRef | string | Reference to an existing GrafanaFolder CR in the same namespace | false |
parentFolderUID | string | UID of the folder in which the current folder should be created | false |
permissions | string | Raw json with folder permissions, potentially exported from Grafana | false |
resyncPeriod | string | How often the resource is synced, defaults to 10m0s if not set Format: duration Default: 10m0s | false |
title | string | Display name of the folder in Grafana | false |
uid | string | Manually specify the UID the Folder is created with Validations: | false |
GrafanaFolder.spec.instanceSelector
Selects Grafana instances for import
Name | Type | Description | Required |
---|---|---|---|
matchExpressions | []object | matchExpressions is a list of label selector requirements. The requirements are ANDed. | false |
matchLabels | map[string]string | 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. | false |
GrafanaFolder.spec.instanceSelector.matchExpressions[index]
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Name | Type | Description | Required |
---|---|---|---|
key | string | key is the label key that the selector applies to. | true |
operator | string | operator represents a key's relationship to a set of values.
Valid operators are In, NotIn, Exists and DoesNotExist. | true |
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. | false |
GrafanaFolder.status
GrafanaFolderStatus defines the observed state of GrafanaFolder
Name | Type | Description | Required |
---|---|---|---|
NoMatchingInstances | boolean | The folder instanceSelector can't find matching grafana instances | false |
conditions | []object | false | |
hash | string | INSERT ADDITIONAL STATUS FIELD - define observed state of cluster
Important: Run "make" to regenerate code after modifying this file | false |
lastResync | string | Last time the folder was resynced Format: date-time | false |
GrafanaFolder.status.conditions[index]
Condition contains details for one aspect of the current state of this API Resource.
Name | Type | Description | Required |
---|---|---|---|
lastTransitionTime | string | 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 | true |
message | string | message is a human readable message indicating details about the transition.
This may be an empty string. | true |
reason | string | 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. | true |
status | enum | status of the condition, one of True, False, Unknown. Enum: True, False, Unknown | true |
type | string | type of condition in CamelCase or in foo.example.com/CamelCase. | true |
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 | false |
GrafanaNotificationPolicy
GrafanaNotificationPolicy is the Schema for the GrafanaNotificationPolicy API
Name | Type | Description | Required |
---|---|---|---|
apiVersion | string | grafana.integreatly.org/v1beta1 | true |
kind | string | GrafanaNotificationPolicy | true |
metadata | object | Refer to the Kubernetes API documentation for the fields of the `metadata` field. | true |
spec | object | GrafanaNotificationPolicySpec defines the desired state of GrafanaNotificationPolicy Validations: | false |
status | object | GrafanaNotificationPolicyStatus defines the observed state of GrafanaNotificationPolicy | false |
GrafanaNotificationPolicy.spec
GrafanaNotificationPolicySpec defines the desired state of GrafanaNotificationPolicy
Name | Type | Description | Required |
---|---|---|---|
instanceSelector | object | Selects Grafana instances for import Validations: | true |
route | object | Routes for alerts to match against | true |
allowCrossNamespaceImport | boolean | Allow the Operator to match this resource with Grafanas outside the current namespace | false |
editable | boolean | Whether to enable or disable editing of the notification policy in Grafana UI Validations: | false |
resyncPeriod | string | How often the resource is synced, defaults to 10m0s if not set Format: duration Default: 10m0s | false |
GrafanaNotificationPolicy.spec.instanceSelector
Selects Grafana instances for import
Name | Type | Description | Required |
---|---|---|---|
matchExpressions | []object | matchExpressions is a list of label selector requirements. The requirements are ANDed. | false |
matchLabels | map[string]string | 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. | false |
GrafanaNotificationPolicy.spec.instanceSelector.matchExpressions[index]
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Name | Type | Description | Required |
---|---|---|---|
key | string | key is the label key that the selector applies to. | true |
operator | string | operator represents a key's relationship to a set of values.
Valid operators are In, NotIn, Exists and DoesNotExist. | true |
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. | false |
GrafanaNotificationPolicy.spec.route
Routes for alerts to match against
Name | Type | Description | Required |
---|---|---|---|
continue | boolean | continue | false |
group_by | []string | group by | false |
group_interval | string | group interval | false |
group_wait | string | group wait | false |
match_re | map[string]string | match re | false |
matchers | []object | matchers | false |
mute_time_intervals | []string | mute time intervals | false |
object_matchers | [][]string | object matchers | false |
provenance | string | provenance | false |
receiver | string | receiver | false |
repeat_interval | string | repeat interval | false |
routes | JSON | routes | false |
GrafanaNotificationPolicy.spec.route.matchers[index]
Name | Type | Description | Required |
---|---|---|---|
isRegex | boolean | is regex | true |
value | string | value | true |
isEqual | boolean | is equal | false |
name | string | name | false |
GrafanaNotificationPolicy.status
GrafanaNotificationPolicyStatus defines the observed state of GrafanaNotificationPolicy
Name | Type | Description | Required |
---|---|---|---|
conditions | []object | true |
GrafanaNotificationPolicy.status.conditions[index]
Condition contains details for one aspect of the current state of this API Resource.
Name | Type | Description | Required |
---|---|---|---|
lastTransitionTime | string | 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 | true |
message | string | message is a human readable message indicating details about the transition.
This may be an empty string. | true |
reason | string | 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. | true |
status | enum | status of the condition, one of True, False, Unknown. Enum: True, False, Unknown | true |
type | string | type of condition in CamelCase or in foo.example.com/CamelCase. | true |
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 | false |
Grafana
Grafana is the Schema for the grafanas API
Name | Type | Description | Required |
---|---|---|---|
apiVersion | string | grafana.integreatly.org/v1beta1 | true |
kind | string | Grafana | true |
metadata | object | Refer to the Kubernetes API documentation for the fields of the `metadata` field. | true |
spec | object | GrafanaSpec defines the desired state of Grafana | false |
status | object | GrafanaStatus defines the observed state of Grafana | false |
Grafana.spec
GrafanaSpec defines the desired state of Grafana
Name | Type | Description | Required |
---|---|---|---|
client | object | Client defines how the grafana-operator talks to the grafana instance. | false |
config | map[string]map[string]string | Config defines how your grafana ini file should looks like. | false |
deployment | object | Deployment sets how the deployment object should look like with your grafana instance, contains a number of defaults. | false |
external | object | External enables you to configure external grafana instances that is not managed by the operator. | false |
ingress | object | Ingress sets how the ingress object should look like with your grafana instance. | false |
jsonnet | object | false | |
persistentVolumeClaim | object | PersistentVolumeClaim creates a PVC if you need to attach one to your grafana instance. | false |
preferences | object | Preferences holds the Grafana Preferences settings | false |
route | object | Route sets how the ingress object should look like with your grafana instance, this only works in Openshift. | false |
service | object | Service sets how the service object should look like with your grafana instance, contains a number of defaults. | false |
serviceAccount | object | ServiceAccount sets how the ServiceAccount object should look like with your grafana instance, contains a number of defaults. | false |
version | string | Version specifies the version of Grafana to use for this deployment. It follows the same format as the docker.io/grafana/grafana tags | false |
Grafana.spec.client
Client defines how the grafana-operator talks to the grafana instance.
Name | Type | Description | Required |
---|---|---|---|
headers | map[string]string | Custom HTTP headers to use when interacting with this Grafana. | false |
preferIngress | boolean | If the operator should send it's request through the grafana instances ingress object instead of through the service. | false |
timeout | integer | false | |
tls | object | TLS Configuration used to talk with the grafana instance. Validations: | false |
Grafana.spec.client.tls
TLS Configuration used to talk with the grafana instance.
Name | Type | Description | Required |
---|---|---|---|
certSecretRef | object | Use a secret as a reference to give TLS Certificate information | false |
insecureSkipVerify | boolean | Disable the CA check of the server | false |
Grafana.spec.client.tls.certSecretRef
Use a secret as a reference to give TLS Certificate information
Name | Type | Description | Required |
---|---|---|---|
name | string | name is unique within a namespace to reference a secret resource. | false |
namespace | string | namespace defines the space within which the secret name must be unique. | false |
Grafana.spec.deployment
Deployment sets how the deployment object should look like with your grafana instance, contains a number of defaults.
Name | Type | Description | Required |
---|---|---|---|
metadata | object | ObjectMeta contains only a [subset of the fields included in k8s.io/apimachinery/pkg/apis/meta/v1.ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.27/#objectmeta-v1-meta). | false |
spec | object | false |
Grafana.spec.deployment.metadata
ObjectMeta contains only a subset of the fields included in k8s.io/apimachinery/pkg/apis/meta/v1.ObjectMeta.
Name | Type | Description | Required |
---|---|---|---|
annotations | map[string]string | false | |
labels | map[string]string | false |
Grafana.spec.deployment.spec
Name | Type | Description | Required |
---|---|---|---|
minReadySeconds | integer | Format: int32 | false |
paused | boolean | false | |
progressDeadlineSeconds | integer | Format: int32 | false |
replicas | integer | Format: int32 | false |
revisionHistoryLimit | integer | Format: int32 | false |
selector | object | A label selector is a label query over a set of resources. The result of matchLabels and
matchExpressions are ANDed. An empty label selector matches all objects. A null
label selector matches no objects. | false |
strategy | object | DeploymentStrategy describes how to replace existing pods with new ones. | false |
template | object | false |
Grafana.spec.deployment.spec.selector
A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects.
Name | Type | Description | Required |
---|---|---|---|
matchExpressions | []object | matchExpressions is a list of label selector requirements. The requirements are ANDed. | false |
matchLabels | map[string]string | 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. | false |
Grafana.spec.deployment.spec.selector.matchExpressions[index]
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Name | Type | Description | Required |
---|---|---|---|
key | string | key is the label key that the selector applies to. | true |
operator | string | operator represents a key's relationship to a set of values.
Valid operators are In, NotIn, Exists and DoesNotExist. | true |
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. | false |
Grafana.spec.deployment.spec.strategy
DeploymentStrategy describes how to replace existing pods with new ones.
Name | Type | Description | Required |
---|---|---|---|
rollingUpdate | object | Rolling update config params. Present only if DeploymentStrategyType =
RollingUpdate. | false |
type | string | Type of deployment. Can be "Recreate" or "RollingUpdate". Default is RollingUpdate. | false |
Grafana.spec.deployment.spec.strategy.rollingUpdate
Rolling update config params. Present only if DeploymentStrategyType = RollingUpdate.
Name | Type | Description | Required |
---|---|---|---|
maxSurge | int or string | The maximum number of pods that can be scheduled above the desired number of
pods.
Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%).
This can not be 0 if MaxUnavailable is 0.
Absolute number is calculated from percentage by rounding up.
Defaults to 25%.
Example: when this is set to 30%, the new ReplicaSet can be scaled up immediately when
the rolling update starts, such that the total number of old and new pods do not exceed
130% of desired pods. Once old pods have been killed,
new ReplicaSet can be scaled up further, ensuring that total number of pods running
at any time during the update is at most 130% of desired pods. | false |
maxUnavailable | int or string | The maximum number of pods that can be unavailable during the update.
Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%).
Absolute number is calculated from percentage by rounding down.
This can not be 0 if MaxSurge is 0.
Defaults to 25%.
Example: when this is set to 30%, the old ReplicaSet can be scaled down to 70% of desired pods
immediately when the rolling update starts. Once new pods are ready, old ReplicaSet
can be scaled down further, followed by scaling up the new ReplicaSet, ensuring
that the total number of pods available at all times during the update is at
least 70% of desired pods. | false |
Grafana.spec.deployment.spec.template
Name | Type | Description | Required |
---|---|---|---|
metadata | object | Standard object's metadata.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | false |
spec | object | Specification of the desired behavior of the pod.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status | false |
Grafana.spec.deployment.spec.template.metadata
Standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
Name | Type | Description | Required |
---|---|---|---|
annotations | map[string]string | false | |
labels | map[string]string | false |
Grafana.spec.deployment.spec.template.spec
Specification of the desired behavior of the pod. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
Name | Type | Description | Required |
---|---|---|---|
activeDeadlineSeconds | integer | Format: int64 | false |
affinity | object | If specified, the pod's scheduling constraints | false |
automountServiceAccountToken | boolean | AutomountServiceAccountToken indicates whether a service account token should be automatically mounted. | false |
containers | []object | false | |
dnsConfig | object | Specifies the DNS parameters of a pod.
Parameters specified here will be merged to the generated DNS
configuration based on DNSPolicy. | false |
dnsPolicy | string | DNSPolicy defines how a pod's DNS will be configured. | false |
enableServiceLinks | boolean | EnableServiceLinks indicates whether information about services should be injected into pod's
environment variables, matching the syntax of Docker links.
Optional: Defaults to true. | false |
ephemeralContainers | []object | false | |
hostAliases | []object | HostAliases is an optional list of hosts and IPs that will be injected into the pod's hosts
file if specified. This is only valid for non-hostNetwork pods. | false |
hostIPC | boolean | Use the host's ipc namespace.
Optional: Default to false. | false |
hostNetwork | boolean | Host networking requested for this pod. Use the host's network namespace.
If this option is set, the ports that will be used must be specified.
Default to false. | false |
hostPID | boolean | Use the host's pid namespace.
Optional: Default to false. | false |
hostUsers | boolean | Use the host's user namespace.
Optional: Default to true.
If set to true or not present, the pod will be run in the host user namespace, useful
for when the pod needs a feature only available to the host user namespace, such as
loading a kernel module with CAP_SYS_MODULE.
When set to false, a new userns is created for the pod. Setting false is useful for
mitigating container breakout vulnerabilities even allowing users to run their
containers as root without actually having root privileges on the host.
This field is alpha-level and is only honored by servers that enable the UserNamespacesSupport feature. | false |
hostname | string | Specifies the hostname of the Pod
If not specified, the pod's hostname will be set to a system-defined value. | false |
imagePullSecrets | []object | ImagePullSecrets is an optional list of references to secrets in the same namespace to use for pulling any of the images used by this PodSpec.
If specified, these secrets will be passed to individual puller implementations for them to use.
More info: https://kubernetes.io/docs/concepts/containers/images#specifying-imagepullsecrets-on-a-pod | false |
initContainers | []object | false | |
nodeName | string | NodeName is a request to schedule this pod onto a specific node. If it is non-empty,
the scheduler simply schedules this pod onto that node, assuming that it fits resource
requirements. | false |
nodeSelector | map[string]string | NodeSelector is a selector which must be true for the pod to fit on a node.
Selector which must match a node's labels for the pod to be scheduled on that node.
More info: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/ | false |
os | object | Specifies the OS of the containers in the pod.
Some pod and container fields are restricted if this is set. If the OS field is set to linux, the following fields must be unset: -securityContext.windowsOptions If the OS field is set to windows, following fields must be unset:
| false |
overhead | map[string]int or string | Overhead represents the resource overhead associated with running a pod for a given RuntimeClass.
This field will be autopopulated at admission time by the RuntimeClass admission controller. If
the RuntimeClass admission controller is enabled, overhead must not be set in Pod create requests.
The RuntimeClass admission controller will reject Pod create requests which have the overhead already
set. If RuntimeClass is configured and selected in the PodSpec, Overhead will be set to the value
defined in the corresponding RuntimeClass, otherwise it will remain unset and treated as zero.
More info: https://git.k8s.io/enhancements/keps/sig-node/688-pod-overhead/README.md | false |
preemptionPolicy | string | PreemptionPolicy is the Policy for preempting pods with lower priority.
One of Never, PreemptLowerPriority.
Defaults to PreemptLowerPriority if unset. | false |
priority | integer | The priority value. Various system components use this field to find the
priority of the pod. When Priority Admission Controller is enabled, it
prevents users from setting this field. The admission controller populates
this field from PriorityClassName.
The higher the value, the higher the priority. Format: int32 | false |
priorityClassName | string | If specified, indicates the pod’s priority. “system-node-critical” and
“system-cluster-critical” are two special keywords which indicate the
highest priorities with the former being the highest priority. Any other
name must be defined by creating a PriorityClass object with that name.
If not specified, the pod priority will be default or zero if there is no
default. | false |
readinessGates | []object | If specified, all readiness gates will be evaluated for pod readiness.
A pod is ready when all its containers are ready AND
all conditions specified in the readiness gates have status equal to “True”
More info: https://git.k8s.io/enhancements/keps/sig-network/580-pod-readiness-gates | false |
restartPolicy | string | RestartPolicy describes how the container should be restarted.
Only one of the following restart policies may be specified.
If none of the following policies is specified, the default one
is RestartPolicyAlways. | false |
runtimeClassName | string | RuntimeClassName refers to a RuntimeClass object in the node.k8s.io group, which should be used
to run this pod. If no RuntimeClass resource matches the named class, the pod will not be run.
If unset or empty, the “legacy” RuntimeClass will be used, which is an implicit class with an
empty definition that uses the default runtime handler.
More info: https://git.k8s.io/enhancements/keps/sig-node/585-runtime-class | false |
schedulerName | string | If specified, the pod will be dispatched by specified scheduler.
If not specified, the pod will be dispatched by default scheduler. | false |
securityContext | object | SecurityContext holds pod-level security attributes and common container settings.
Optional: Defaults to empty. See type description for default values of each field. | false |
serviceAccount | string | DeprecatedServiceAccount is a depreciated alias for ServiceAccountName.
Deprecated: Use serviceAccountName instead. | false |
serviceAccountName | string | ServiceAccountName is the name of the ServiceAccount to use to run this pod.
More info: https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/ | false |
setHostnameAsFQDN | boolean | If true the pod’s hostname will be configured as the pod’s FQDN, rather than the leaf name (the default).
In Linux containers, this means setting the FQDN in the hostname field of the kernel (the nodename field of struct utsname).
In Windows containers, this means setting the registry value of hostname for the registry key HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\Tcpip\Parameters to FQDN.
If a pod does not have FQDN, this has no effect.
Default to false. | false |
shareProcessNamespace | boolean | Share a single process namespace between all of the containers in a pod.
When this is set containers will be able to view and signal processes from other containers
in the same pod, and the first process in each container will not be assigned PID 1.
HostPID and ShareProcessNamespace cannot both be set.
Optional: Default to false. | false |
subdomain | string | If specified, the fully qualified Pod hostname will be “ | false |
terminationGracePeriodSeconds | integer | Format: int64 | false |
tolerations | []object | If specified, the pod’s tolerations. | false |
topologySpreadConstraints | []object | TopologySpreadConstraints describes how a group of pods ought to spread across topology
domains. Scheduler will schedule pods in a way which abides by the constraints.
All topologySpreadConstraints are ANDed. | false |
volumes | []object | false |
Grafana.spec.deployment.spec.template.spec.affinity
If specified, the pod’s scheduling constraints
Name | Type | Description | Required |
---|---|---|---|
nodeAffinity | object | Describes node affinity scheduling rules for the pod. | false |
podAffinity | object | Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s)). | false |
podAntiAffinity | object | Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s)). | false |
Grafana.spec.deployment.spec.template.spec.affinity.nodeAffinity
Describes node affinity scheduling rules for the pod.
Name | Type | Description | Required |
---|---|---|---|
preferredDuringSchedulingIgnoredDuringExecution | []object | The scheduler will prefer to schedule pods to nodes that satisfy
the affinity expressions specified by this field, but it may choose
a node that violates one or more of the expressions. The node that is
most preferred is the one with the greatest sum of weights, i.e.
for each node that meets all of the scheduling requirements (resource
request, requiredDuringScheduling affinity expressions, etc.),
compute a sum by iterating through the elements of this field and adding
"weight" to the sum if the node matches the corresponding matchExpressions; the
node(s) with the highest sum are the most preferred. | false |
requiredDuringSchedulingIgnoredDuringExecution | object | If the affinity requirements specified by this field are not met at
scheduling time, the pod will not be scheduled onto the node.
If the affinity requirements specified by this field cease to be met
at some point during pod execution (e.g. due to an update), the system
may or may not try to eventually evict the pod from its node. | false |
Grafana.spec.deployment.spec.template.spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index]
An empty preferred scheduling term matches all objects with implicit weight 0 (i.e. it’s a no-op). A null preferred scheduling term matches no objects (i.e. is also a no-op).
Name | Type | Description | Required |
---|---|---|---|
preference | object | A node selector term, associated with the corresponding weight. | true |
weight | integer | Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100. Format: int32 | true |
Grafana.spec.deployment.spec.template.spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].preference
A node selector term, associated with the corresponding weight.
Name | Type | Description | Required |
---|---|---|---|
matchExpressions | []object | A list of node selector requirements by node's labels. | false |
matchFields | []object | A list of node selector requirements by node's fields. | false |
Grafana.spec.deployment.spec.template.spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].preference.matchExpressions[index]
A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Name | Type | Description | Required |
---|---|---|---|
key | string | The label key that the selector applies to. | true |
operator | string | Represents a key's relationship to a set of values.
Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt. | true |
values | []string | 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. If the operator is Gt or Lt, the values
array must have a single element, which will be interpreted as an integer.
This array is replaced during a strategic merge patch. | false |
Grafana.spec.deployment.spec.template.spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].preference.matchFields[index]
A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Name | Type | Description | Required |
---|---|---|---|
key | string | The label key that the selector applies to. | true |
operator | string | Represents a key's relationship to a set of values.
Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt. | true |
values | []string | 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. If the operator is Gt or Lt, the values
array must have a single element, which will be interpreted as an integer.
This array is replaced during a strategic merge patch. | false |
Grafana.spec.deployment.spec.template.spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution
If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to an update), the system may or may not try to eventually evict the pod from its node.
Name | Type | Description | Required |
---|---|---|---|
nodeSelectorTerms | []object | Required. A list of node selector terms. The terms are ORed. | true |
Grafana.spec.deployment.spec.template.spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[index]
A null or empty node selector term matches no objects. The requirements of them are ANDed. The TopologySelectorTerm type implements a subset of the NodeSelectorTerm.
Name | Type | Description | Required |
---|---|---|---|
matchExpressions | []object | A list of node selector requirements by node's labels. | false |
matchFields | []object | A list of node selector requirements by node's fields. | false |
Grafana.spec.deployment.spec.template.spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[index].matchExpressions[index]
A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Name | Type | Description | Required |
---|---|---|---|
key | string | The label key that the selector applies to. | true |
operator | string | Represents a key's relationship to a set of values.
Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt. | true |
values | []string | 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. If the operator is Gt or Lt, the values
array must have a single element, which will be interpreted as an integer.
This array is replaced during a strategic merge patch. | false |
Grafana.spec.deployment.spec.template.spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[index].matchFields[index]
A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Name | Type | Description | Required |
---|---|---|---|
key | string | The label key that the selector applies to. | true |
operator | string | Represents a key's relationship to a set of values.
Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt. | true |
values | []string | 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. If the operator is Gt or Lt, the values
array must have a single element, which will be interpreted as an integer.
This array is replaced during a strategic merge patch. | false |
Grafana.spec.deployment.spec.template.spec.affinity.podAffinity
Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s)).
Name | Type | Description | Required |
---|---|---|---|
preferredDuringSchedulingIgnoredDuringExecution | []object | The scheduler will prefer to schedule pods to nodes that satisfy
the affinity expressions specified by this field, but it may choose
a node that violates one or more of the expressions. The node that is
most preferred is the one with the greatest sum of weights, i.e.
for each node that meets all of the scheduling requirements (resource
request, requiredDuringScheduling affinity expressions, etc.),
compute a sum by iterating through the elements of this field and adding
"weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the
node(s) with the highest sum are the most preferred. | false |
requiredDuringSchedulingIgnoredDuringExecution | []object | If the affinity requirements specified by this field are not met at
scheduling time, the pod will not be scheduled onto the node.
If the affinity requirements specified by this field cease to be met
at some point during pod execution (e.g. due to a pod label update), the
system may or may not try to eventually evict the pod from its node.
When there are multiple elements, the lists of nodes corresponding to each
podAffinityTerm are intersected, i.e. all terms must be satisfied. | false |
Grafana.spec.deployment.spec.template.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index]
The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s)
Name | Type | Description | Required |
---|---|---|---|
podAffinityTerm | object | Required. A pod affinity term, associated with the corresponding weight. | true |
weight | integer | weight associated with matching the corresponding podAffinityTerm,
in the range 1-100. Format: int32 | true |
Grafana.spec.deployment.spec.template.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm
Required. A pod affinity term, associated with the corresponding weight.
Name | Type | Description | Required |
---|---|---|---|
topologyKey | string | This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching
the labelSelector in the specified namespaces, where co-located is defined as running on a node
whose value of the label with key topologyKey matches that of any node on which any of the
selected pods is running.
Empty topologyKey is not allowed. | true |
labelSelector | object | A label query over a set of resources, in this case pods.
If it's null, this PodAffinityTerm matches with no Pods. | false |
matchLabelKeys | []string | MatchLabelKeys is a set of pod label keys to select which pods will
be taken into consideration. The keys are used to lookup values from the
incoming pod labels, those key-value labels are merged with `labelSelector` as `key in (value)`
to select the group of existing pods which pods will be taken into consideration
for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming
pod labels will be ignored. The default value is empty.
The same key is forbidden to exist in both matchLabelKeys and labelSelector.
Also, matchLabelKeys cannot be set when labelSelector isn't set.
This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default). | false |
mismatchLabelKeys | []string | MismatchLabelKeys is a set of pod label keys to select which pods will
be taken into consideration. The keys are used to lookup values from the
incoming pod labels, those key-value labels are merged with `labelSelector` as `key notin (value)`
to select the group of existing pods which pods will be taken into consideration
for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming
pod labels will be ignored. The default value is empty.
The same key is forbidden to exist in both mismatchLabelKeys and labelSelector.
Also, mismatchLabelKeys cannot be set when labelSelector isn't set.
This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default). | false |
namespaceSelector | object | A label query over the set of namespaces that the term applies to.
The term is applied to the union of the namespaces selected by this field
and the ones listed in the namespaces field.
null selector and null or empty namespaces list means "this pod's namespace".
An empty selector ({}) matches all namespaces. | false |
namespaces | []string | namespaces specifies a static list of namespace names that the term applies to.
The term is applied to the union of the namespaces listed in this field
and the ones selected by namespaceSelector.
null or empty namespaces list and null namespaceSelector means "this pod's namespace". | false |
Grafana.spec.deployment.spec.template.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.labelSelector
A label query over a set of resources, in this case pods. If it’s null, this PodAffinityTerm matches with no Pods.
Name | Type | Description | Required |
---|---|---|---|
matchExpressions | []object | matchExpressions is a list of label selector requirements. The requirements are ANDed. | false |
matchLabels | map[string]string | 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. | false |
Grafana.spec.deployment.spec.template.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.labelSelector.matchExpressions[index]
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Name | Type | Description | Required |
---|---|---|---|
key | string | key is the label key that the selector applies to. | true |
operator | string | operator represents a key's relationship to a set of values.
Valid operators are In, NotIn, Exists and DoesNotExist. | true |
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. | false |
Grafana.spec.deployment.spec.template.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.namespaceSelector
A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means “this pod’s namespace”. An empty selector ({}) matches all namespaces.
Name | Type | Description | Required |
---|---|---|---|
matchExpressions | []object | matchExpressions is a list of label selector requirements. The requirements are ANDed. | false |
matchLabels | map[string]string | 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. | false |
Grafana.spec.deployment.spec.template.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.namespaceSelector.matchExpressions[index]
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Name | Type | Description | Required |
---|---|---|---|
key | string | key is the label key that the selector applies to. | true |
operator | string | operator represents a key's relationship to a set of values.
Valid operators are In, NotIn, Exists and DoesNotExist. | true |
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. | false |
Grafana.spec.deployment.spec.template.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index]
Defines a set of pods (namely those matching the labelSelector
relative to the given namespace(s)) that this pod should be
co-located (affinity) or not co-located (anti-affinity) with,
where co-located is defined as running on a node whose value of
the label with key
Name | Type | Description | Required |
---|---|---|---|
topologyKey | string | This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching
the labelSelector in the specified namespaces, where co-located is defined as running on a node
whose value of the label with key topologyKey matches that of any node on which any of the
selected pods is running.
Empty topologyKey is not allowed. | true |
labelSelector | object | A label query over a set of resources, in this case pods.
If it's null, this PodAffinityTerm matches with no Pods. | false |
matchLabelKeys | []string | MatchLabelKeys is a set of pod label keys to select which pods will
be taken into consideration. The keys are used to lookup values from the
incoming pod labels, those key-value labels are merged with `labelSelector` as `key in (value)`
to select the group of existing pods which pods will be taken into consideration
for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming
pod labels will be ignored. The default value is empty.
The same key is forbidden to exist in both matchLabelKeys and labelSelector.
Also, matchLabelKeys cannot be set when labelSelector isn't set.
This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default). | false |
mismatchLabelKeys | []string | MismatchLabelKeys is a set of pod label keys to select which pods will
be taken into consideration. The keys are used to lookup values from the
incoming pod labels, those key-value labels are merged with `labelSelector` as `key notin (value)`
to select the group of existing pods which pods will be taken into consideration
for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming
pod labels will be ignored. The default value is empty.
The same key is forbidden to exist in both mismatchLabelKeys and labelSelector.
Also, mismatchLabelKeys cannot be set when labelSelector isn't set.
This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default). | false |
namespaceSelector | object | A label query over the set of namespaces that the term applies to.
The term is applied to the union of the namespaces selected by this field
and the ones listed in the namespaces field.
null selector and null or empty namespaces list means "this pod's namespace".
An empty selector ({}) matches all namespaces. | false |
namespaces | []string | namespaces specifies a static list of namespace names that the term applies to.
The term is applied to the union of the namespaces listed in this field
and the ones selected by namespaceSelector.
null or empty namespaces list and null namespaceSelector means "this pod's namespace". | false |
Grafana.spec.deployment.spec.template.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].labelSelector
A label query over a set of resources, in this case pods. If it’s null, this PodAffinityTerm matches with no Pods.
Name | Type | Description | Required |
---|---|---|---|
matchExpressions | []object | matchExpressions is a list of label selector requirements. The requirements are ANDed. | false |
matchLabels | map[string]string | 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. | false |
Grafana.spec.deployment.spec.template.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].labelSelector.matchExpressions[index]
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Name | Type | Description | Required |
---|---|---|---|
key | string | key is the label key that the selector applies to. | true |
operator | string | operator represents a key's relationship to a set of values.
Valid operators are In, NotIn, Exists and DoesNotExist. | true |
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. | false |
Grafana.spec.deployment.spec.template.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].namespaceSelector
A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means “this pod’s namespace”. An empty selector ({}) matches all namespaces.
Name | Type | Description | Required |
---|---|---|---|
matchExpressions | []object | matchExpressions is a list of label selector requirements. The requirements are ANDed. | false |
matchLabels | map[string]string | 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. | false |
Grafana.spec.deployment.spec.template.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].namespaceSelector.matchExpressions[index]
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Name | Type | Description | Required |
---|---|---|---|
key | string | key is the label key that the selector applies to. | true |
operator | string | operator represents a key's relationship to a set of values.
Valid operators are In, NotIn, Exists and DoesNotExist. | true |
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. | false |
Grafana.spec.deployment.spec.template.spec.affinity.podAntiAffinity
Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s)).
Name | Type | Description | Required |
---|---|---|---|
preferredDuringSchedulingIgnoredDuringExecution | []object | The scheduler will prefer to schedule pods to nodes that satisfy
the anti-affinity expressions specified by this field, but it may choose
a node that violates one or more of the expressions. The node that is
most preferred is the one with the greatest sum of weights, i.e.
for each node that meets all of the scheduling requirements (resource
request, requiredDuringScheduling anti-affinity expressions, etc.),
compute a sum by iterating through the elements of this field and adding
"weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the
node(s) with the highest sum are the most preferred. | false |
requiredDuringSchedulingIgnoredDuringExecution | []object | If the anti-affinity requirements specified by this field are not met at
scheduling time, the pod will not be scheduled onto the node.
If the anti-affinity requirements specified by this field cease to be met
at some point during pod execution (e.g. due to a pod label update), the
system may or may not try to eventually evict the pod from its node.
When there are multiple elements, the lists of nodes corresponding to each
podAffinityTerm are intersected, i.e. all terms must be satisfied. | false |
Grafana.spec.deployment.spec.template.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index]
The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s)
Name | Type | Description | Required |
---|---|---|---|
podAffinityTerm | object | Required. A pod affinity term, associated with the corresponding weight. | true |
weight | integer | weight associated with matching the corresponding podAffinityTerm,
in the range 1-100. Format: int32 | true |
Grafana.spec.deployment.spec.template.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm
Required. A pod affinity term, associated with the corresponding weight.
Name | Type | Description | Required |
---|---|---|---|
topologyKey | string | This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching
the labelSelector in the specified namespaces, where co-located is defined as running on a node
whose value of the label with key topologyKey matches that of any node on which any of the
selected pods is running.
Empty topologyKey is not allowed. | true |
labelSelector | object | A label query over a set of resources, in this case pods.
If it's null, this PodAffinityTerm matches with no Pods. | false |
matchLabelKeys | []string | MatchLabelKeys is a set of pod label keys to select which pods will
be taken into consideration. The keys are used to lookup values from the
incoming pod labels, those key-value labels are merged with `labelSelector` as `key in (value)`
to select the group of existing pods which pods will be taken into consideration
for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming
pod labels will be ignored. The default value is empty.
The same key is forbidden to exist in both matchLabelKeys and labelSelector.
Also, matchLabelKeys cannot be set when labelSelector isn't set.
This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default). | false |
mismatchLabelKeys | []string | MismatchLabelKeys is a set of pod label keys to select which pods will
be taken into consideration. The keys are used to lookup values from the
incoming pod labels, those key-value labels are merged with `labelSelector` as `key notin (value)`
to select the group of existing pods which pods will be taken into consideration
for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming
pod labels will be ignored. The default value is empty.
The same key is forbidden to exist in both mismatchLabelKeys and labelSelector.
Also, mismatchLabelKeys cannot be set when labelSelector isn't set.
This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default). | false |
namespaceSelector | object | A label query over the set of namespaces that the term applies to.
The term is applied to the union of the namespaces selected by this field
and the ones listed in the namespaces field.
null selector and null or empty namespaces list means "this pod's namespace".
An empty selector ({}) matches all namespaces. | false |
namespaces | []string | namespaces specifies a static list of namespace names that the term applies to.
The term is applied to the union of the namespaces listed in this field
and the ones selected by namespaceSelector.
null or empty namespaces list and null namespaceSelector means "this pod's namespace". | false |
Grafana.spec.deployment.spec.template.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.labelSelector
A label query over a set of resources, in this case pods. If it’s null, this PodAffinityTerm matches with no Pods.
Name | Type | Description | Required |
---|---|---|---|
matchExpressions | []object | matchExpressions is a list of label selector requirements. The requirements are ANDed. | false |
matchLabels | map[string]string | 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. | false |
Grafana.spec.deployment.spec.template.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.labelSelector.matchExpressions[index]
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Name | Type | Description | Required |
---|---|---|---|
key | string | key is the label key that the selector applies to. | true |
operator | string | operator represents a key's relationship to a set of values.
Valid operators are In, NotIn, Exists and DoesNotExist. | true |
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. | false |
Grafana.spec.deployment.spec.template.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.namespaceSelector
A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means “this pod’s namespace”. An empty selector ({}) matches all namespaces.
Name | Type | Description | Required |
---|---|---|---|
matchExpressions | []object | matchExpressions is a list of label selector requirements. The requirements are ANDed. | false |
matchLabels | map[string]string | 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. | false |
Grafana.spec.deployment.spec.template.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.namespaceSelector.matchExpressions[index]
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Name | Type | Description | Required |
---|---|---|---|
key | string | key is the label key that the selector applies to. | true |
operator | string | operator represents a key's relationship to a set of values.
Valid operators are In, NotIn, Exists and DoesNotExist. | true |
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. | false |
Grafana.spec.deployment.spec.template.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index]
Defines a set of pods (namely those matching the labelSelector
relative to the given namespace(s)) that this pod should be
co-located (affinity) or not co-located (anti-affinity) with,
where co-located is defined as running on a node whose value of
the label with key
Name | Type | Description | Required |
---|---|---|---|
topologyKey | string | This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching
the labelSelector in the specified namespaces, where co-located is defined as running on a node
whose value of the label with key topologyKey matches that of any node on which any of the
selected pods is running.
Empty topologyKey is not allowed. | true |
labelSelector | object | A label query over a set of resources, in this case pods.
If it's null, this PodAffinityTerm matches with no Pods. | false |
matchLabelKeys | []string | MatchLabelKeys is a set of pod label keys to select which pods will
be taken into consideration. The keys are used to lookup values from the
incoming pod labels, those key-value labels are merged with `labelSelector` as `key in (value)`
to select the group of existing pods which pods will be taken into consideration
for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming
pod labels will be ignored. The default value is empty.
The same key is forbidden to exist in both matchLabelKeys and labelSelector.
Also, matchLabelKeys cannot be set when labelSelector isn't set.
This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default). | false |
mismatchLabelKeys | []string | MismatchLabelKeys is a set of pod label keys to select which pods will
be taken into consideration. The keys are used to lookup values from the
incoming pod labels, those key-value labels are merged with `labelSelector` as `key notin (value)`
to select the group of existing pods which pods will be taken into consideration
for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming
pod labels will be ignored. The default value is empty.
The same key is forbidden to exist in both mismatchLabelKeys and labelSelector.
Also, mismatchLabelKeys cannot be set when labelSelector isn't set.
This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default). | false |
namespaceSelector | object | A label query over the set of namespaces that the term applies to.
The term is applied to the union of the namespaces selected by this field
and the ones listed in the namespaces field.
null selector and null or empty namespaces list means "this pod's namespace".
An empty selector ({}) matches all namespaces. | false |
namespaces | []string | namespaces specifies a static list of namespace names that the term applies to.
The term is applied to the union of the namespaces listed in this field
and the ones selected by namespaceSelector.
null or empty namespaces list and null namespaceSelector means "this pod's namespace". | false |
Grafana.spec.deployment.spec.template.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].labelSelector
A label query over a set of resources, in this case pods. If it’s null, this PodAffinityTerm matches with no Pods.
Name | Type | Description | Required |
---|---|---|---|
matchExpressions | []object | matchExpressions is a list of label selector requirements. The requirements are ANDed. | false |
matchLabels | map[string]string | 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. | false |
Grafana.spec.deployment.spec.template.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].labelSelector.matchExpressions[index]
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Name | Type | Description | Required |
---|---|---|---|
key | string | key is the label key that the selector applies to. | true |
operator | string | operator represents a key's relationship to a set of values.
Valid operators are In, NotIn, Exists and DoesNotExist. | true |
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. | false |
Grafana.spec.deployment.spec.template.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].namespaceSelector
A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means “this pod’s namespace”. An empty selector ({}) matches all namespaces.
Name | Type | Description | Required |
---|---|---|---|
matchExpressions | []object | matchExpressions is a list of label selector requirements. The requirements are ANDed. | false |
matchLabels | map[string]string | 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. | false |
Grafana.spec.deployment.spec.template.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].namespaceSelector.matchExpressions[index]
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Name | Type | Description | Required |
---|---|---|---|
key | string | key is the label key that the selector applies to. | true |
operator | string | operator represents a key's relationship to a set of values.
Valid operators are In, NotIn, Exists and DoesNotExist. | true |
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. | false |
Grafana.spec.deployment.spec.template.spec.containers[index]
A single application container that you want to run within a pod.
Name | Type | Description | Required |
---|---|---|---|
name | string | Name of the container specified as a DNS_LABEL.
Each container in a pod must have a unique name (DNS_LABEL).
Cannot be updated. | true |
args | []string | Arguments to the entrypoint.
The container image's CMD is used if this is not provided.
Variable references $(VAR_NAME) are expanded using the container's environment. If a variable
cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced
to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will
produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless
of whether the variable exists or not. Cannot be updated.
More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell | false |
command | []string | Entrypoint array. Not executed within a shell.
The container image's ENTRYPOINT is used if this is not provided.
Variable references $(VAR_NAME) are expanded using the container's environment. If a variable
cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced
to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will
produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless
of whether the variable exists or not. Cannot be updated.
More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell | false |
env | []object | List of environment variables to set in the container.
Cannot be updated. | false |
envFrom | []object | List of sources to populate environment variables in the container.
The keys defined within a source must be a C_IDENTIFIER. All invalid keys
will be reported as an event when the container is starting. When a key exists in multiple
sources, the value associated with the last source will take precedence.
Values defined by an Env with a duplicate key will take precedence.
Cannot be updated. | false |
image | string | Container image name.
More info: https://kubernetes.io/docs/concepts/containers/images
This field is optional to allow higher level config management to default or override
container images in workload controllers like Deployments and StatefulSets. | false |
imagePullPolicy | string | Image pull policy.
One of Always, Never, IfNotPresent.
Defaults to Always if :latest tag is specified, or IfNotPresent otherwise.
Cannot be updated.
More info: https://kubernetes.io/docs/concepts/containers/images#updating-images | false |
lifecycle | object | Actions that the management system should take in response to container lifecycle events.
Cannot be updated. | false |
livenessProbe | object | Periodic probe of container liveness.
Container will be restarted if the probe fails.
Cannot be updated.
More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes | false |
ports | []object | List of ports to expose from the container. Not specifying a port here
DOES NOT prevent that port from being exposed. Any port which is
listening on the default "0.0.0.0" address inside a container will be
accessible from the network.
Modifying this array with strategic merge patch may corrupt the data.
For more information See https://github.com/kubernetes/kubernetes/issues/108255.
Cannot be updated. | false |
readinessProbe | object | Periodic probe of container service readiness.
Container will be removed from service endpoints if the probe fails.
Cannot be updated.
More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes | false |
resizePolicy | []object | Resources resize policy for the container. | false |
resources | object | Compute Resources required by this container.
Cannot be updated.
More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ | false |
restartPolicy | string | RestartPolicy defines the restart behavior of individual containers in a pod.
This field may only be set for init containers, and the only allowed value is "Always".
For non-init containers or when this field is not specified,
the restart behavior is defined by the Pod's restart policy and the container type.
Setting the RestartPolicy as "Always" for the init container will have the following effect:
this init container will be continually restarted on
exit until all regular containers have terminated. Once all regular
containers have completed, all init containers with restartPolicy "Always"
will be shut down. This lifecycle differs from normal init containers and
is often referred to as a "sidecar" container. Although this init
container still starts in the init container sequence, it does not wait
for the container to complete before proceeding to the next init
container. Instead, the next init container starts immediately after this
init container is started, or after any startupProbe has successfully
completed. | false |
securityContext | object | SecurityContext defines the security options the container should be run with.
If set, the fields of SecurityContext override the equivalent fields of PodSecurityContext.
More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/ | false |
startupProbe | object | StartupProbe indicates that the Pod has successfully initialized.
If specified, no other probes are executed until this completes successfully.
If this probe fails, the Pod will be restarted, just as if the livenessProbe failed.
This can be used to provide different probe parameters at the beginning of a Pod's lifecycle,
when it might take a long time to load data or warm a cache, than during steady-state operation.
This cannot be updated.
More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes | false |
stdin | boolean | Whether this container should allocate a buffer for stdin in the container runtime. If this
is not set, reads from stdin in the container will always result in EOF.
Default is false. | false |
stdinOnce | boolean | Whether the container runtime should close the stdin channel after it has been opened by
a single attach. When stdin is true the stdin stream will remain open across multiple attach
sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the
first client attaches to stdin, and then remains open and accepts data until the client disconnects,
at which time stdin is closed and remains closed until the container is restarted. If this
flag is false, a container processes that reads from stdin will never receive an EOF.
Default is false | false |
terminationMessagePath | string | Optional: Path at which the file to which the container's termination message
will be written is mounted into the container's filesystem.
Message written is intended to be brief final status, such as an assertion failure message.
Will be truncated by the node if greater than 4096 bytes. The total message length across
all containers will be limited to 12kb.
Defaults to /dev/termination-log.
Cannot be updated. | false |
terminationMessagePolicy | string | Indicate how the termination message should be populated. File will use the contents of
terminationMessagePath to populate the container status message on both success and failure.
FallbackToLogsOnError will use the last chunk of container log output if the termination
message file is empty and the container exited with an error.
The log output is limited to 2048 bytes or 80 lines, whichever is smaller.
Defaults to File.
Cannot be updated. | false |
tty | boolean | Whether this container should allocate a TTY for itself, also requires 'stdin' to be true.
Default is false. | false |
volumeDevices | []object | volumeDevices is the list of block devices to be used by the container. | false |
volumeMounts | []object | Pod volumes to mount into the container's filesystem.
Cannot be updated. | false |
workingDir | string | Container's working directory.
If not specified, the container runtime's default will be used, which
might be configured in the container image.
Cannot be updated. | false |
Grafana.spec.deployment.spec.template.spec.containers[index].env[index]
EnvVar represents an environment variable present in a Container.
Name | Type | Description | Required |
---|---|---|---|
name | string | Name of the environment variable. Must be a C_IDENTIFIER. | true |
value | string | Variable references $(VAR_NAME) are expanded
using the previously defined environment variables in the container and
any service environment variables. If a variable cannot be resolved,
the reference in the input string will be unchanged. Double $$ are reduced
to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e.
"$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)".
Escaped references will never be expanded, regardless of whether the variable
exists or not.
Defaults to "". | false |
valueFrom | object | Source for the environment variable's value. Cannot be used if value is not empty. | false |
Grafana.spec.deployment.spec.template.spec.containers[index].env[index].valueFrom
Source for the environment variable’s value. Cannot be used if value is not empty.
Name | Type | Description | Required |
---|---|---|---|
configMapKeyRef | object | Selects a key of a ConfigMap. | false |
fieldRef | object | Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels[' | false |
resourceFieldRef | object | Selects a resource of the container: only resources limits and requests
(limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported. | false |
secretKeyRef | object | Selects a key of a secret in the pod's namespace | false |
Grafana.spec.deployment.spec.template.spec.containers[index].env[index].valueFrom.configMapKeyRef
Selects a key of a ConfigMap.
Name | Type | Description | Required |
---|---|---|---|
key | string | The key to select. | true |
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 Default: | false |
optional | boolean | Specify whether the ConfigMap or its key must be defined | false |
Grafana.spec.deployment.spec.template.spec.containers[index].env[index].valueFrom.fieldRef
Selects a field of the pod: supports metadata.name, metadata.namespace, metadata.labels['<KEY>']
, metadata.annotations['<KEY>']
,
spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.
Name | Type | Description | Required |
---|---|---|---|
fieldPath | string | Path of the field to select in the specified API version. | true |
apiVersion | string | Version of the schema the FieldPath is written in terms of, defaults to "v1". | false |
Grafana.spec.deployment.spec.template.spec.containers[index].env[index].valueFrom.resourceFieldRef
Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported.
Name | Type | Description | Required |
---|---|---|---|
resource | string | Required: resource to select | true |
containerName | string | Container name: required for volumes, optional for env vars | false |
divisor | int or string | Specifies the output format of the exposed resources, defaults to "1" | false |
Grafana.spec.deployment.spec.template.spec.containers[index].env[index].valueFrom.secretKeyRef
Selects a key of a secret in the pod’s namespace
Name | Type | Description | Required |
---|---|---|---|
key | string | The key of the secret to select from. Must be a valid secret key. | true |
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 Default: | false |
optional | boolean | Specify whether the Secret or its key must be defined | false |
Grafana.spec.deployment.spec.template.spec.containers[index].envFrom[index]
EnvFromSource represents the source of a set of ConfigMaps
Name | Type | Description | Required |
---|---|---|---|
configMapRef | object | The ConfigMap to select from | false |
prefix | string | An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER. | false |
secretRef | object | The Secret to select from | false |
Grafana.spec.deployment.spec.template.spec.containers[index].envFrom[index].configMapRef
The ConfigMap to select from
Name | Type | Description | Required |
---|---|---|---|
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 Default: | false |
optional | boolean | Specify whether the ConfigMap must be defined | false |
Grafana.spec.deployment.spec.template.spec.containers[index].envFrom[index].secretRef
The Secret to select from
Name | Type | Description | Required |
---|---|---|---|
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 Default: | false |
optional | boolean | Specify whether the Secret must be defined | false |
Grafana.spec.deployment.spec.template.spec.containers[index].lifecycle
Actions that the management system should take in response to container lifecycle events. Cannot be updated.
Name | Type | Description | Required |
---|---|---|---|
postStart | object | PostStart is called immediately after a container is created. If the handler fails,
the container is terminated and restarted according to its restart policy.
Other management of the container blocks until the hook completes.
More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks | false |
preStop | object | PreStop is called immediately before a container is terminated due to an
API request or management event such as liveness/startup probe failure,
preemption, resource contention, etc. The handler is not called if the
container crashes or exits. The Pod's termination grace period countdown begins before the
PreStop hook is executed. Regardless of the outcome of the handler, the
container will eventually terminate within the Pod's termination grace
period (unless delayed by finalizers). Other management of the container blocks until the hook completes
or until the termination grace period is reached.
More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks | false |
Grafana.spec.deployment.spec.template.spec.containers[index].lifecycle.postStart
PostStart is called immediately after a container is created. If the handler fails, the container is terminated and restarted according to its restart policy. Other management of the container blocks until the hook completes. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks
Name | Type | Description | Required |
---|---|---|---|
exec | object | Exec specifies a command to execute in the container. | false |
httpGet | object | HTTPGet specifies an HTTP GET request to perform. | false |
sleep | object | Sleep represents a duration that the container should sleep. | false |
tcpSocket | object | Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept
for backward compatibility. There is no validation of this field and
lifecycle hooks will fail at runtime when it is specified. | false |
Grafana.spec.deployment.spec.template.spec.containers[index].lifecycle.postStart.exec
Exec specifies a command to execute in the container.
Name | Type | Description | Required |
---|---|---|---|
command | []string | Command is the command line to execute inside the container, the working directory for the
command is root ('/') in the container's filesystem. The command is simply exec'd, it is
not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use
a shell, you need to explicitly call out to that shell.
Exit status of 0 is treated as live/healthy and non-zero is unhealthy. | false |
Grafana.spec.deployment.spec.template.spec.containers[index].lifecycle.postStart.httpGet
HTTPGet specifies an HTTP GET request to perform.
Name | Type | Description | Required |
---|---|---|---|
port | int or string | Name or number of the port to access on the container.
Number must be in the range 1 to 65535.
Name must be an IANA_SVC_NAME. | true |
host | string | Host name to connect to, defaults to the pod IP. You probably want to set
"Host" in httpHeaders instead. | false |
httpHeaders | []object | Custom headers to set in the request. HTTP allows repeated headers. | false |
path | string | Path to access on the HTTP server. | false |
scheme | string | Scheme to use for connecting to the host.
Defaults to HTTP. | false |
Grafana.spec.deployment.spec.template.spec.containers[index].lifecycle.postStart.httpGet.httpHeaders[index]
HTTPHeader describes a custom header to be used in HTTP probes
Name | Type | Description | Required |
---|---|---|---|
name | string | The header field name.
This will be canonicalized upon output, so case-variant names will be understood as the same header. | true |
value | string | The header field value | true |
Grafana.spec.deployment.spec.template.spec.containers[index].lifecycle.postStart.sleep
Sleep represents a duration that the container should sleep.
Name | Type | Description | Required |
---|---|---|---|
seconds | integer | Seconds is the number of seconds to sleep. Format: int64 | true |
Grafana.spec.deployment.spec.template.spec.containers[index].lifecycle.postStart.tcpSocket
Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept for backward compatibility. There is no validation of this field and lifecycle hooks will fail at runtime when it is specified.
Name | Type | Description | Required |
---|---|---|---|
port | int or string | Number or name of the port to access on the container.
Number must be in the range 1 to 65535.
Name must be an IANA_SVC_NAME. | true |
host | string | Optional: Host name to connect to, defaults to the pod IP. | false |
Grafana.spec.deployment.spec.template.spec.containers[index].lifecycle.preStop
PreStop is called immediately before a container is terminated due to an API request or management event such as liveness/startup probe failure, preemption, resource contention, etc. The handler is not called if the container crashes or exits. The Pod’s termination grace period countdown begins before the PreStop hook is executed. Regardless of the outcome of the handler, the container will eventually terminate within the Pod’s termination grace period (unless delayed by finalizers). Other management of the container blocks until the hook completes or until the termination grace period is reached. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks
Name | Type | Description | Required |
---|---|---|---|
exec | object | Exec specifies a command to execute in the container. | false |
httpGet | object | HTTPGet specifies an HTTP GET request to perform. | false |
sleep | object | Sleep represents a duration that the container should sleep. | false |
tcpSocket | object | Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept
for backward compatibility. There is no validation of this field and
lifecycle hooks will fail at runtime when it is specified. | false |
Grafana.spec.deployment.spec.template.spec.containers[index].lifecycle.preStop.exec
Exec specifies a command to execute in the container.
Name | Type | Description | Required |
---|---|---|---|
command | []string | Command is the command line to execute inside the container, the working directory for the
command is root ('/') in the container's filesystem. The command is simply exec'd, it is
not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use
a shell, you need to explicitly call out to that shell.
Exit status of 0 is treated as live/healthy and non-zero is unhealthy. | false |
Grafana.spec.deployment.spec.template.spec.containers[index].lifecycle.preStop.httpGet
HTTPGet specifies an HTTP GET request to perform.
Name | Type | Description | Required |
---|---|---|---|
port | int or string | Name or number of the port to access on the container.
Number must be in the range 1 to 65535.
Name must be an IANA_SVC_NAME. | true |
host | string | Host name to connect to, defaults to the pod IP. You probably want to set
"Host" in httpHeaders instead. | false |
httpHeaders | []object | Custom headers to set in the request. HTTP allows repeated headers. | false |
path | string | Path to access on the HTTP server. | false |
scheme | string | Scheme to use for connecting to the host.
Defaults to HTTP. | false |
Grafana.spec.deployment.spec.template.spec.containers[index].lifecycle.preStop.httpGet.httpHeaders[index]
HTTPHeader describes a custom header to be used in HTTP probes
Name | Type | Description | Required |
---|---|---|---|
name | string | The header field name.
This will be canonicalized upon output, so case-variant names will be understood as the same header. | true |
value | string | The header field value | true |
Grafana.spec.deployment.spec.template.spec.containers[index].lifecycle.preStop.sleep
Sleep represents a duration that the container should sleep.
Name | Type | Description | Required |
---|---|---|---|
seconds | integer | Seconds is the number of seconds to sleep. Format: int64 | true |
Grafana.spec.deployment.spec.template.spec.containers[index].lifecycle.preStop.tcpSocket
Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept for backward compatibility. There is no validation of this field and lifecycle hooks will fail at runtime when it is specified.
Name | Type | Description | Required |
---|---|---|---|
port | int or string | Number or name of the port to access on the container.
Number must be in the range 1 to 65535.
Name must be an IANA_SVC_NAME. | true |
host | string | Optional: Host name to connect to, defaults to the pod IP. | false |
Grafana.spec.deployment.spec.template.spec.containers[index].livenessProbe
Periodic probe of container liveness. Container will be restarted if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
Name | Type | Description | Required |
---|---|---|---|
exec | object | Exec specifies a command to execute in the container. | false |
failureThreshold | integer | Minimum consecutive failures for the probe to be considered failed after having succeeded.
Defaults to 3. Minimum value is 1. Format: int32 | false |
grpc | object | GRPC specifies a GRPC HealthCheckRequest. | false |
httpGet | object | HTTPGet specifies an HTTP GET request to perform. | false |
initialDelaySeconds | integer | Number of seconds after the container has started before liveness probes are initiated.
More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes Format: int32 | false |
periodSeconds | integer | How often (in seconds) to perform the probe.
Default to 10 seconds. Minimum value is 1. Format: int32 | false |
successThreshold | integer | Minimum consecutive successes for the probe to be considered successful after having failed.
Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. Format: int32 | false |
tcpSocket | object | TCPSocket specifies a connection to a TCP port. | false |
terminationGracePeriodSeconds | integer | Optional duration in seconds the pod needs to terminate gracefully upon probe failure.
The grace period is the duration in seconds after the processes running in the pod are sent
a termination signal and the time when the processes are forcibly halted with a kill signal.
Set this value longer than the expected cleanup time for your process.
If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this
value overrides the value provided by the pod spec.
Value must be non-negative integer. The value zero indicates stop immediately via
the kill signal (no opportunity to shut down).
This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate.
Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset. Format: int64 | false |
timeoutSeconds | integer | Number of seconds after which the probe times out.
Defaults to 1 second. Minimum value is 1.
More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes Format: int32 | false |
Grafana.spec.deployment.spec.template.spec.containers[index].livenessProbe.exec
Exec specifies a command to execute in the container.
Name | Type | Description | Required |
---|---|---|---|
command | []string | Command is the command line to execute inside the container, the working directory for the
command is root ('/') in the container's filesystem. The command is simply exec'd, it is
not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use
a shell, you need to explicitly call out to that shell.
Exit status of 0 is treated as live/healthy and non-zero is unhealthy. | false |
Grafana.spec.deployment.spec.template.spec.containers[index].livenessProbe.grpc
GRPC specifies a GRPC HealthCheckRequest.
Name | Type | Description | Required |
---|---|---|---|
port | integer | Port number of the gRPC service. Number must be in the range 1 to 65535. Format: int32 | true |
service | string | Service is the name of the service to place in the gRPC HealthCheckRequest
(see https://github.com/grpc/grpc/blob/master/doc/health-checking.md). If this is not specified, the default behavior is defined by gRPC. | false |
Grafana.spec.deployment.spec.template.spec.containers[index].livenessProbe.httpGet
HTTPGet specifies an HTTP GET request to perform.
Name | Type | Description | Required |
---|---|---|---|
port | int or string | Name or number of the port to access on the container.
Number must be in the range 1 to 65535.
Name must be an IANA_SVC_NAME. | true |
host | string | Host name to connect to, defaults to the pod IP. You probably want to set
"Host" in httpHeaders instead. | false |
httpHeaders | []object | Custom headers to set in the request. HTTP allows repeated headers. | false |
path | string | Path to access on the HTTP server. | false |
scheme | string | Scheme to use for connecting to the host.
Defaults to HTTP. | false |
Grafana.spec.deployment.spec.template.spec.containers[index].livenessProbe.httpGet.httpHeaders[index]
HTTPHeader describes a custom header to be used in HTTP probes
Name | Type | Description | Required |
---|---|---|---|
name | string | The header field name.
This will be canonicalized upon output, so case-variant names will be understood as the same header. | true |
value | string | The header field value | true |
Grafana.spec.deployment.spec.template.spec.containers[index].livenessProbe.tcpSocket
TCPSocket specifies a connection to a TCP port.
Name | Type | Description | Required |
---|---|---|---|
port | int or string | Number or name of the port to access on the container.
Number must be in the range 1 to 65535.
Name must be an IANA_SVC_NAME. | true |
host | string | Optional: Host name to connect to, defaults to the pod IP. | false |
Grafana.spec.deployment.spec.template.spec.containers[index].ports[index]
ContainerPort represents a network port in a single container.
Name | Type | Description | Required |
---|---|---|---|
containerPort | integer | Number of port to expose on the pod's IP address.
This must be a valid port number, 0 < x < 65536. Format: int32 | true |
hostIP | string | What host IP to bind the external port to. | false |
hostPort | integer | Number of port to expose on the host.
If specified, this must be a valid port number, 0 < x < 65536.
If HostNetwork is specified, this must match ContainerPort.
Most containers do not need this. Format: int32 | false |
name | string | If specified, this must be an IANA_SVC_NAME and unique within the pod. Each
named port in a pod must have a unique name. Name for the port that can be
referred to by services. | false |
protocol | string | Protocol for port. Must be UDP, TCP, or SCTP.
Defaults to "TCP". Default: TCP | false |
Grafana.spec.deployment.spec.template.spec.containers[index].readinessProbe
Periodic probe of container service readiness. Container will be removed from service endpoints if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
Name | Type | Description | Required |
---|---|---|---|
exec | object | Exec specifies a command to execute in the container. | false |
failureThreshold | integer | Minimum consecutive failures for the probe to be considered failed after having succeeded.
Defaults to 3. Minimum value is 1. Format: int32 | false |
grpc | object | GRPC specifies a GRPC HealthCheckRequest. | false |
httpGet | object | HTTPGet specifies an HTTP GET request to perform. | false |
initialDelaySeconds | integer | Number of seconds after the container has started before liveness probes are initiated.
More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes Format: int32 | false |
periodSeconds | integer | How often (in seconds) to perform the probe.
Default to 10 seconds. Minimum value is 1. Format: int32 | false |
successThreshold | integer | Minimum consecutive successes for the probe to be considered successful after having failed.
Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. Format: int32 | false |
tcpSocket | object | TCPSocket specifies a connection to a TCP port. | false |
terminationGracePeriodSeconds | integer | Optional duration in seconds the pod needs to terminate gracefully upon probe failure.
The grace period is the duration in seconds after the processes running in the pod are sent
a termination signal and the time when the processes are forcibly halted with a kill signal.
Set this value longer than the expected cleanup time for your process.
If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this
value overrides the value provided by the pod spec.
Value must be non-negative integer. The value zero indicates stop immediately via
the kill signal (no opportunity to shut down).
This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate.
Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset. Format: int64 | false |
timeoutSeconds | integer | Number of seconds after which the probe times out.
Defaults to 1 second. Minimum value is 1.
More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes Format: int32 | false |
Grafana.spec.deployment.spec.template.spec.containers[index].readinessProbe.exec
Exec specifies a command to execute in the container.
Name | Type | Description | Required |
---|---|---|---|
command | []string | Command is the command line to execute inside the container, the working directory for the
command is root ('/') in the container's filesystem. The command is simply exec'd, it is
not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use
a shell, you need to explicitly call out to that shell.
Exit status of 0 is treated as live/healthy and non-zero is unhealthy. | false |
Grafana.spec.deployment.spec.template.spec.containers[index].readinessProbe.grpc
GRPC specifies a GRPC HealthCheckRequest.
Name | Type | Description | Required |
---|---|---|---|
port | integer | Port number of the gRPC service. Number must be in the range 1 to 65535. Format: int32 | true |
service | string | Service is the name of the service to place in the gRPC HealthCheckRequest
(see https://github.com/grpc/grpc/blob/master/doc/health-checking.md). If this is not specified, the default behavior is defined by gRPC. | false |
Grafana.spec.deployment.spec.template.spec.containers[index].readinessProbe.httpGet
HTTPGet specifies an HTTP GET request to perform.
Name | Type | Description | Required |
---|---|---|---|
port | int or string | Name or number of the port to access on the container.
Number must be in the range 1 to 65535.
Name must be an IANA_SVC_NAME. | true |
host | string | Host name to connect to, defaults to the pod IP. You probably want to set
"Host" in httpHeaders instead. | false |
httpHeaders | []object | Custom headers to set in the request. HTTP allows repeated headers. | false |
path | string | Path to access on the HTTP server. | false |
scheme | string | Scheme to use for connecting to the host.
Defaults to HTTP. | false |
Grafana.spec.deployment.spec.template.spec.containers[index].readinessProbe.httpGet.httpHeaders[index]
HTTPHeader describes a custom header to be used in HTTP probes
Name | Type | Description | Required |
---|---|---|---|
name | string | The header field name.
This will be canonicalized upon output, so case-variant names will be understood as the same header. | true |
value | string | The header field value | true |
Grafana.spec.deployment.spec.template.spec.containers[index].readinessProbe.tcpSocket
TCPSocket specifies a connection to a TCP port.
Name | Type | Description | Required |
---|---|---|---|
port | int or string | Number or name of the port to access on the container.
Number must be in the range 1 to 65535.
Name must be an IANA_SVC_NAME. | true |
host | string | Optional: Host name to connect to, defaults to the pod IP. | false |
Grafana.spec.deployment.spec.template.spec.containers[index].resizePolicy[index]
ContainerResizePolicy represents resource resize policy for the container.
Name | Type | Description | Required |
---|---|---|---|
resourceName | string | Name of the resource to which this resource resize policy applies.
Supported values: cpu, memory. | true |
restartPolicy | string | Restart policy to apply when specified resource is resized.
If not specified, it defaults to NotRequired. | true |
Grafana.spec.deployment.spec.template.spec.containers[index].resources
Compute Resources required by this container. Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
Name | Type | Description | Required |
---|---|---|---|
claims | []object | Claims lists the names of resources, defined in spec.resourceClaims,
that are used by this container. This is an alpha field and requires enabling the DynamicResourceAllocation feature gate. This field is immutable. It can only be set for containers. | false |
limits | map[string]int or string | Limits describes the maximum amount of compute resources allowed.
More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ | false |
requests | map[string]int or string | Requests describes the minimum amount of compute resources required.
If Requests is omitted for a container, it defaults to Limits if that is explicitly specified,
otherwise to an implementation-defined value. Requests cannot exceed Limits.
More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ | false |
Grafana.spec.deployment.spec.template.spec.containers[index].resources.claims[index]
ResourceClaim references one entry in PodSpec.ResourceClaims.
Name | Type | Description | Required |
---|---|---|---|
name | string | Name must match the name of one entry in pod.spec.resourceClaims of
the Pod where this field is used. It makes that resource available
inside a container. | true |
request | string | Request is the name chosen for a request in the referenced claim.
If empty, everything from the claim is made available, otherwise
only the result of this request. | false |
Grafana.spec.deployment.spec.template.spec.containers[index].securityContext
SecurityContext defines the security options the container should be run with. If set, the fields of SecurityContext override the equivalent fields of PodSecurityContext. More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/
Name | Type | Description | Required |
---|---|---|---|
allowPrivilegeEscalation | boolean | AllowPrivilegeEscalation controls whether a process can gain more
privileges than its parent process. This bool directly controls if
the no_new_privs flag will be set on the container process.
AllowPrivilegeEscalation is true always when the container is:
1) run as Privileged
2) has CAP_SYS_ADMIN
Note that this field cannot be set when spec.os.name is windows. | false |
appArmorProfile | object | appArmorProfile is the AppArmor options to use by this container. If set, this profile
overrides the pod's appArmorProfile.
Note that this field cannot be set when spec.os.name is windows. | false |
capabilities | object | The capabilities to add/drop when running containers.
Defaults to the default set of capabilities granted by the container runtime.
Note that this field cannot be set when spec.os.name is windows. | false |
privileged | boolean | Run container in privileged mode.
Processes in privileged containers are essentially equivalent to root on the host.
Defaults to false.
Note that this field cannot be set when spec.os.name is windows. | false |
procMount | string | procMount denotes the type of proc mount to use for the containers.
The default value is Default which uses the container runtime defaults for
readonly paths and masked paths.
This requires the ProcMountType feature flag to be enabled.
Note that this field cannot be set when spec.os.name is windows. | false |
readOnlyRootFilesystem | boolean | Whether this container has a read-only root filesystem.
Default is false.
Note that this field cannot be set when spec.os.name is windows. | false |
runAsGroup | integer | The GID to run the entrypoint of the container process.
Uses runtime default if unset.
May also be set in PodSecurityContext. If set in both SecurityContext and
PodSecurityContext, the value specified in SecurityContext takes precedence.
Note that this field cannot be set when spec.os.name is windows. Format: int64 | false |
runAsNonRoot | boolean | Indicates that the container must run as a non-root user.
If true, the Kubelet will validate the image at runtime to ensure that it
does not run as UID 0 (root) and fail to start the container if it does.
If unset or false, no such validation will be performed.
May also be set in PodSecurityContext. If set in both SecurityContext and
PodSecurityContext, the value specified in SecurityContext takes precedence. | false |
runAsUser | integer | The UID to run the entrypoint of the container process.
Defaults to user specified in image metadata if unspecified.
May also be set in PodSecurityContext. If set in both SecurityContext and
PodSecurityContext, the value specified in SecurityContext takes precedence.
Note that this field cannot be set when spec.os.name is windows. Format: int64 | false |
seLinuxOptions | object | The SELinux context to be applied to the container.
If unspecified, the container runtime will allocate a random SELinux context for each
container. May also be set in PodSecurityContext. If set in both SecurityContext and
PodSecurityContext, the value specified in SecurityContext takes precedence.
Note that this field cannot be set when spec.os.name is windows. | false |
seccompProfile | object | The seccomp options to use by this container. If seccomp options are
provided at both the pod & container level, the container options
override the pod options.
Note that this field cannot be set when spec.os.name is windows. | false |
windowsOptions | object | The Windows specific settings applied to all containers.
If unspecified, the options from the PodSecurityContext will be used.
If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.
Note that this field cannot be set when spec.os.name is linux. | false |
Grafana.spec.deployment.spec.template.spec.containers[index].securityContext.appArmorProfile
appArmorProfile is the AppArmor options to use by this container. If set, this profile overrides the pod’s appArmorProfile. Note that this field cannot be set when spec.os.name is windows.
Name | Type | Description | Required |
---|---|---|---|
type | string | type indicates which kind of AppArmor profile will be applied.
Valid options are:
Localhost - a profile pre-loaded on the node.
RuntimeDefault - the container runtime's default profile.
Unconfined - no AppArmor enforcement. | true |
localhostProfile | string | localhostProfile indicates a profile loaded on the node that should be used.
The profile must be preconfigured on the node to work.
Must match the loaded name of the profile.
Must be set if and only if type is "Localhost". | false |
Grafana.spec.deployment.spec.template.spec.containers[index].securityContext.capabilities
The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime. Note that this field cannot be set when spec.os.name is windows.
Name | Type | Description | Required |
---|---|---|---|
add | []string | Added capabilities | false |
drop | []string | Removed capabilities | false |
Grafana.spec.deployment.spec.template.spec.containers[index].securityContext.seLinuxOptions
The SELinux context to be applied to the container. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows.
Name | Type | Description | Required |
---|---|---|---|
level | string | Level is SELinux level label that applies to the container. | false |
role | string | Role is a SELinux role label that applies to the container. | false |
type | string | Type is a SELinux type label that applies to the container. | false |
user | string | User is a SELinux user label that applies to the container. | false |
Grafana.spec.deployment.spec.template.spec.containers[index].securityContext.seccompProfile
The seccomp options to use by this container. If seccomp options are provided at both the pod & container level, the container options override the pod options. Note that this field cannot be set when spec.os.name is windows.
Name | Type | Description | Required |
---|---|---|---|
type | string | type indicates which kind of seccomp profile will be applied.
Valid options are: Localhost - a profile defined in a file on the node should be used.
RuntimeDefault - the container runtime default profile should be used.
Unconfined - no profile should be applied. | true |
localhostProfile | string | localhostProfile indicates a profile defined in a file on the node should be used.
The profile must be preconfigured on the node to work.
Must be a descending path, relative to the kubelet’s configured seccomp profile location.
Must be set if type is “Localhost”. Must NOT be set for any other type. | false |
Grafana.spec.deployment.spec.template.spec.containers[index].securityContext.windowsOptions
The Windows specific settings applied to all containers. If unspecified, the options from the PodSecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is linux.
Name | Type | Description | Required |
---|---|---|---|
gmsaCredentialSpec | string | GMSACredentialSpec is where the GMSA admission webhook
(https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the
GMSA credential spec named by the GMSACredentialSpecName field. | false |
gmsaCredentialSpecName | string | GMSACredentialSpecName is the name of the GMSA credential spec to use. | false |
hostProcess | boolean | HostProcess determines if a container should be run as a 'Host Process' container.
All of a Pod's containers must have the same effective HostProcess value
(it is not allowed to have a mix of HostProcess containers and non-HostProcess containers).
In addition, if HostProcess is true then HostNetwork must also be set to true. | false |
runAsUserName | string | The UserName in Windows to run the entrypoint of the container process.
Defaults to the user specified in image metadata if unspecified.
May also be set in PodSecurityContext. If set in both SecurityContext and
PodSecurityContext, the value specified in SecurityContext takes precedence. | false |
Grafana.spec.deployment.spec.template.spec.containers[index].startupProbe
StartupProbe indicates that the Pod has successfully initialized. If specified, no other probes are executed until this completes successfully. If this probe fails, the Pod will be restarted, just as if the livenessProbe failed. This can be used to provide different probe parameters at the beginning of a Pod’s lifecycle, when it might take a long time to load data or warm a cache, than during steady-state operation. This cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
Name | Type | Description | Required |
---|---|---|---|
exec | object | Exec specifies a command to execute in the container. | false |
failureThreshold | integer | Minimum consecutive failures for the probe to be considered failed after having succeeded.
Defaults to 3. Minimum value is 1. Format: int32 | false |
grpc | object | GRPC specifies a GRPC HealthCheckRequest. | false |
httpGet | object | HTTPGet specifies an HTTP GET request to perform. | false |
initialDelaySeconds | integer | Number of seconds after the container has started before liveness probes are initiated.
More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes Format: int32 | false |
periodSeconds | integer | How often (in seconds) to perform the probe.
Default to 10 seconds. Minimum value is 1. Format: int32 | false |
successThreshold | integer | Minimum consecutive successes for the probe to be considered successful after having failed.
Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. Format: int32 | false |
tcpSocket | object | TCPSocket specifies a connection to a TCP port. | false |
terminationGracePeriodSeconds | integer | Optional duration in seconds the pod needs to terminate gracefully upon probe failure.
The grace period is the duration in seconds after the processes running in the pod are sent
a termination signal and the time when the processes are forcibly halted with a kill signal.
Set this value longer than the expected cleanup time for your process.
If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this
value overrides the value provided by the pod spec.
Value must be non-negative integer. The value zero indicates stop immediately via
the kill signal (no opportunity to shut down).
This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate.
Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset. Format: int64 | false |
timeoutSeconds | integer | Number of seconds after which the probe times out.
Defaults to 1 second. Minimum value is 1.
More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes Format: int32 | false |
Grafana.spec.deployment.spec.template.spec.containers[index].startupProbe.exec
Exec specifies a command to execute in the container.
Name | Type | Description | Required |
---|---|---|---|
command | []string | Command is the command line to execute inside the container, the working directory for the
command is root ('/') in the container's filesystem. The command is simply exec'd, it is
not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use
a shell, you need to explicitly call out to that shell.
Exit status of 0 is treated as live/healthy and non-zero is unhealthy. | false |
Grafana.spec.deployment.spec.template.spec.containers[index].startupProbe.grpc
GRPC specifies a GRPC HealthCheckRequest.
Name | Type | Description | Required |
---|---|---|---|
port | integer | Port number of the gRPC service. Number must be in the range 1 to 65535. Format: int32 | true |
service | string | Service is the name of the service to place in the gRPC HealthCheckRequest
(see https://github.com/grpc/grpc/blob/master/doc/health-checking.md). If this is not specified, the default behavior is defined by gRPC. | false |
Grafana.spec.deployment.spec.template.spec.containers[index].startupProbe.httpGet
HTTPGet specifies an HTTP GET request to perform.
Name | Type | Description | Required |
---|---|---|---|
port | int or string | Name or number of the port to access on the container.
Number must be in the range 1 to 65535.
Name must be an IANA_SVC_NAME. | true |
host | string | Host name to connect to, defaults to the pod IP. You probably want to set
"Host" in httpHeaders instead. | false |
httpHeaders | []object | Custom headers to set in the request. HTTP allows repeated headers. | false |
path | string | Path to access on the HTTP server. | false |
scheme | string | Scheme to use for connecting to the host.
Defaults to HTTP. | false |
Grafana.spec.deployment.spec.template.spec.containers[index].startupProbe.httpGet.httpHeaders[index]
HTTPHeader describes a custom header to be used in HTTP probes
Name | Type | Description | Required |
---|---|---|---|
name | string | The header field name.
This will be canonicalized upon output, so case-variant names will be understood as the same header. | true |
value | string | The header field value | true |
Grafana.spec.deployment.spec.template.spec.containers[index].startupProbe.tcpSocket
TCPSocket specifies a connection to a TCP port.
Name | Type | Description | Required |
---|---|---|---|
port | int or string | Number or name of the port to access on the container.
Number must be in the range 1 to 65535.
Name must be an IANA_SVC_NAME. | true |
host | string | Optional: Host name to connect to, defaults to the pod IP. | false |
Grafana.spec.deployment.spec.template.spec.containers[index].volumeDevices[index]
volumeDevice describes a mapping of a raw block device within a container.
Name | Type | Description | Required |
---|---|---|---|
devicePath | string | devicePath is the path inside of the container that the device will be mapped to. | true |
name | string | name must match the name of a persistentVolumeClaim in the pod | true |
Grafana.spec.deployment.spec.template.spec.containers[index].volumeMounts[index]
VolumeMount describes a mounting of a Volume within a container.
Name | Type | Description | Required |
---|---|---|---|
mountPath | string | Path within the container at which the volume should be mounted. Must
not contain ':'. | true |
name | string | This must match the Name of a Volume. | true |
mountPropagation | string | mountPropagation determines how mounts are propagated from the host
to container and the other way around.
When not set, MountPropagationNone is used.
This field is beta in 1.10.
When RecursiveReadOnly is set to IfPossible or to Enabled, MountPropagation must be None or unspecified
(which defaults to None). | false |
readOnly | boolean | Mounted read-only if true, read-write otherwise (false or unspecified).
Defaults to false. | false |
recursiveReadOnly | string | RecursiveReadOnly specifies whether read-only mounts should be handled
recursively. If ReadOnly is false, this field has no meaning and must be unspecified. If ReadOnly is true, and this field is set to Disabled, the mount is not made recursively read-only. If this field is set to IfPossible, the mount is made recursively read-only, if it is supported by the container runtime. If this field is set to Enabled, the mount is made recursively read-only if it is supported by the container runtime, otherwise the pod will not be started and an error will be generated to indicate the reason. If this field is set to IfPossible or Enabled, MountPropagation must be set to None (or be unspecified, which defaults to None). If this field is not specified, it is treated as an equivalent of Disabled. | false |
subPath | string | Path within the volume from which the container’s volume should be mounted.
Defaults to "" (volume’s root). | false |
subPathExpr | string | Expanded path within the volume from which the container’s volume should be mounted.
Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container’s environment.
Defaults to "" (volume’s root).
SubPathExpr and SubPath are mutually exclusive. | false |
Grafana.spec.deployment.spec.template.spec.dnsConfig
Specifies the DNS parameters of a pod. Parameters specified here will be merged to the generated DNS configuration based on DNSPolicy.
Name | Type | Description | Required |
---|---|---|---|
nameservers | []string | A list of DNS name server IP addresses.
This will be appended to the base nameservers generated from DNSPolicy.
Duplicated nameservers will be removed. | false |
options | []object | A list of DNS resolver options.
This will be merged with the base options generated from DNSPolicy.
Duplicated entries will be removed. Resolution options given in Options
will override those that appear in the base DNSPolicy. | false |
searches | []string | A list of DNS search domains for host-name lookup.
This will be appended to the base search paths generated from DNSPolicy.
Duplicated search paths will be removed. | false |
Grafana.spec.deployment.spec.template.spec.dnsConfig.options[index]
PodDNSConfigOption defines DNS resolver options of a pod.
Name | Type | Description | Required |
---|---|---|---|
name | string | Name is this DNS resolver option's name.
Required. | false |
value | string | Value is this DNS resolver option's value. | false |
Grafana.spec.deployment.spec.template.spec.ephemeralContainers[index]
An EphemeralContainer is a temporary container that you may add to an existing Pod for user-initiated activities such as debugging. Ephemeral containers have no resource or scheduling guarantees, and they will not be restarted when they exit or when a Pod is removed or restarted. The kubelet may evict a Pod if an ephemeral container causes the Pod to exceed its resource allocation.
To add an ephemeral container, use the ephemeralcontainers subresource of an existing Pod. Ephemeral containers may not be removed or restarted.
Name | Type | Description | Required |
---|---|---|---|
name | string | Name of the ephemeral container specified as a DNS_LABEL.
This name must be unique among all containers, init containers and ephemeral containers. | true |
args | []string | Arguments to the entrypoint.
The image's CMD is used if this is not provided.
Variable references $(VAR_NAME) are expanded using the container's environment. If a variable
cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced
to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will
produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless
of whether the variable exists or not. Cannot be updated.
More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell | false |
command | []string | Entrypoint array. Not executed within a shell.
The image's ENTRYPOINT is used if this is not provided.
Variable references $(VAR_NAME) are expanded using the container's environment. If a variable
cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced
to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will
produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless
of whether the variable exists or not. Cannot be updated.
More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell | false |
env | []object | List of environment variables to set in the container.
Cannot be updated. | false |
envFrom | []object | List of sources to populate environment variables in the container.
The keys defined within a source must be a C_IDENTIFIER. All invalid keys
will be reported as an event when the container is starting. When a key exists in multiple
sources, the value associated with the last source will take precedence.
Values defined by an Env with a duplicate key will take precedence.
Cannot be updated. | false |
image | string | Container image name.
More info: https://kubernetes.io/docs/concepts/containers/images | false |
imagePullPolicy | string | Image pull policy.
One of Always, Never, IfNotPresent.
Defaults to Always if :latest tag is specified, or IfNotPresent otherwise.
Cannot be updated.
More info: https://kubernetes.io/docs/concepts/containers/images#updating-images | false |
lifecycle | object | Lifecycle is not allowed for ephemeral containers. | false |
livenessProbe | object | Probes are not allowed for ephemeral containers. | false |
ports | []object | Ports are not allowed for ephemeral containers. | false |
readinessProbe | object | Probes are not allowed for ephemeral containers. | false |
resizePolicy | []object | Resources resize policy for the container. | false |
resources | object | Resources are not allowed for ephemeral containers. Ephemeral containers use spare resources
already allocated to the pod. | false |
restartPolicy | string | Restart policy for the container to manage the restart behavior of each
container within a pod.
This may only be set for init containers. You cannot set this field on
ephemeral containers. | false |
securityContext | object | Optional: SecurityContext defines the security options the ephemeral container should be run with.
If set, the fields of SecurityContext override the equivalent fields of PodSecurityContext. | false |
startupProbe | object | Probes are not allowed for ephemeral containers. | false |
stdin | boolean | Whether this container should allocate a buffer for stdin in the container runtime. If this
is not set, reads from stdin in the container will always result in EOF.
Default is false. | false |
stdinOnce | boolean | Whether the container runtime should close the stdin channel after it has been opened by
a single attach. When stdin is true the stdin stream will remain open across multiple attach
sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the
first client attaches to stdin, and then remains open and accepts data until the client disconnects,
at which time stdin is closed and remains closed until the container is restarted. If this
flag is false, a container processes that reads from stdin will never receive an EOF.
Default is false | false |
targetContainerName | string | If set, the name of the container from PodSpec that this ephemeral container targets.
The ephemeral container will be run in the namespaces (IPC, PID, etc) of this container.
If not set then the ephemeral container uses the namespaces configured in the Pod spec. The container runtime must implement support for this feature. If the runtime does not
support namespace targeting then the result of setting this field is undefined. | false |
terminationMessagePath | string | Optional: Path at which the file to which the container’s termination message
will be written is mounted into the container’s filesystem.
Message written is intended to be brief final status, such as an assertion failure message.
Will be truncated by the node if greater than 4096 bytes. The total message length across
all containers will be limited to 12kb.
Defaults to /dev/termination-log.
Cannot be updated. | false |
terminationMessagePolicy | string | Indicate how the termination message should be populated. File will use the contents of
terminationMessagePath to populate the container status message on both success and failure.
FallbackToLogsOnError will use the last chunk of container log output if the termination
message file is empty and the container exited with an error.
The log output is limited to 2048 bytes or 80 lines, whichever is smaller.
Defaults to File.
Cannot be updated. | false |
tty | boolean | Whether this container should allocate a TTY for itself, also requires ‘stdin’ to be true.
Default is false. | false |
volumeDevices | []object | volumeDevices is the list of block devices to be used by the container. | false |
volumeMounts | []object | Pod volumes to mount into the container’s filesystem. Subpath mounts are not allowed for ephemeral containers.
Cannot be updated. | false |
workingDir | string | Container’s working directory.
If not specified, the container runtime’s default will be used, which
might be configured in the container image.
Cannot be updated. | false |
Grafana.spec.deployment.spec.template.spec.ephemeralContainers[index].env[index]
EnvVar represents an environment variable present in a Container.
Name | Type | Description | Required |
---|---|---|---|
name | string | Name of the environment variable. Must be a C_IDENTIFIER. | true |
value | string | Variable references $(VAR_NAME) are expanded
using the previously defined environment variables in the container and
any service environment variables. If a variable cannot be resolved,
the reference in the input string will be unchanged. Double $$ are reduced
to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e.
"$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)".
Escaped references will never be expanded, regardless of whether the variable
exists or not.
Defaults to "". | false |
valueFrom | object | Source for the environment variable's value. Cannot be used if value is not empty. | false |
Grafana.spec.deployment.spec.template.spec.ephemeralContainers[index].env[index].valueFrom
Source for the environment variable’s value. Cannot be used if value is not empty.
Name | Type | Description | Required |
---|---|---|---|
configMapKeyRef | object | Selects a key of a ConfigMap. | false |
fieldRef | object | Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels[' | false |
resourceFieldRef | object | Selects a resource of the container: only resources limits and requests
(limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported. | false |
secretKeyRef | object | Selects a key of a secret in the pod's namespace | false |
Grafana.spec.deployment.spec.template.spec.ephemeralContainers[index].env[index].valueFrom.configMapKeyRef
Selects a key of a ConfigMap.
Name | Type | Description | Required |
---|---|---|---|
key | string | The key to select. | true |
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 Default: | false |
optional | boolean | Specify whether the ConfigMap or its key must be defined | false |
Grafana.spec.deployment.spec.template.spec.ephemeralContainers[index].env[index].valueFrom.fieldRef
Selects a field of the pod: supports metadata.name, metadata.namespace, metadata.labels['<KEY>']
, metadata.annotations['<KEY>']
,
spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.
Name | Type | Description | Required |
---|---|---|---|
fieldPath | string | Path of the field to select in the specified API version. | true |
apiVersion | string | Version of the schema the FieldPath is written in terms of, defaults to "v1". | false |
Grafana.spec.deployment.spec.template.spec.ephemeralContainers[index].env[index].valueFrom.resourceFieldRef
Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported.
Name | Type | Description | Required |
---|---|---|---|
resource | string | Required: resource to select | true |
containerName | string | Container name: required for volumes, optional for env vars | false |
divisor | int or string | Specifies the output format of the exposed resources, defaults to "1" | false |
Grafana.spec.deployment.spec.template.spec.ephemeralContainers[index].env[index].valueFrom.secretKeyRef
Selects a key of a secret in the pod’s namespace
Name | Type | Description | Required |
---|---|---|---|
key | string | The key of the secret to select from. Must be a valid secret key. | true |
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 Default: | false |
optional | boolean | Specify whether the Secret or its key must be defined | false |
Grafana.spec.deployment.spec.template.spec.ephemeralContainers[index].envFrom[index]
EnvFromSource represents the source of a set of ConfigMaps
Name | Type | Description | Required |
---|---|---|---|
configMapRef | object | The ConfigMap to select from | false |
prefix | string | An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER. | false |
secretRef | object | The Secret to select from | false |
Grafana.spec.deployment.spec.template.spec.ephemeralContainers[index].envFrom[index].configMapRef
The ConfigMap to select from
Name | Type | Description | Required |
---|---|---|---|
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 Default: | false |
optional | boolean | Specify whether the ConfigMap must be defined | false |
Grafana.spec.deployment.spec.template.spec.ephemeralContainers[index].envFrom[index].secretRef
The Secret to select from
Name | Type | Description | Required |
---|---|---|---|
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 Default: | false |
optional | boolean | Specify whether the Secret must be defined | false |
Grafana.spec.deployment.spec.template.spec.ephemeralContainers[index].lifecycle
Lifecycle is not allowed for ephemeral containers.
Name | Type | Description | Required |
---|---|---|---|
postStart | object | PostStart is called immediately after a container is created. If the handler fails,
the container is terminated and restarted according to its restart policy.
Other management of the container blocks until the hook completes.
More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks | false |
preStop | object | PreStop is called immediately before a container is terminated due to an
API request or management event such as liveness/startup probe failure,
preemption, resource contention, etc. The handler is not called if the
container crashes or exits. The Pod's termination grace period countdown begins before the
PreStop hook is executed. Regardless of the outcome of the handler, the
container will eventually terminate within the Pod's termination grace
period (unless delayed by finalizers). Other management of the container blocks until the hook completes
or until the termination grace period is reached.
More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks | false |
Grafana.spec.deployment.spec.template.spec.ephemeralContainers[index].lifecycle.postStart
PostStart is called immediately after a container is created. If the handler fails, the container is terminated and restarted according to its restart policy. Other management of the container blocks until the hook completes. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks
Name | Type | Description | Required |
---|---|---|---|
exec | object | Exec specifies a command to execute in the container. | false |
httpGet | object | HTTPGet specifies an HTTP GET request to perform. | false |
sleep | object | Sleep represents a duration that the container should sleep. | false |
tcpSocket | object | Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept
for backward compatibility. There is no validation of this field and
lifecycle hooks will fail at runtime when it is specified. | false |
Grafana.spec.deployment.spec.template.spec.ephemeralContainers[index].lifecycle.postStart.exec
Exec specifies a command to execute in the container.
Name | Type | Description | Required |
---|---|---|---|
command | []string | Command is the command line to execute inside the container, the working directory for the
command is root ('/') in the container's filesystem. The command is simply exec'd, it is
not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use
a shell, you need to explicitly call out to that shell.
Exit status of 0 is treated as live/healthy and non-zero is unhealthy. | false |
Grafana.spec.deployment.spec.template.spec.ephemeralContainers[index].lifecycle.postStart.httpGet
HTTPGet specifies an HTTP GET request to perform.
Name | Type | Description | Required |
---|---|---|---|
port | int or string | Name or number of the port to access on the container.
Number must be in the range 1 to 65535.
Name must be an IANA_SVC_NAME. | true |
host | string | Host name to connect to, defaults to the pod IP. You probably want to set
"Host" in httpHeaders instead. | false |
httpHeaders | []object | Custom headers to set in the request. HTTP allows repeated headers. | false |
path | string | Path to access on the HTTP server. | false |
scheme | string | Scheme to use for connecting to the host.
Defaults to HTTP. | false |
Grafana.spec.deployment.spec.template.spec.ephemeralContainers[index].lifecycle.postStart.httpGet.httpHeaders[index]
HTTPHeader describes a custom header to be used in HTTP probes
Name | Type | Description | Required |
---|---|---|---|
name | string | The header field name.
This will be canonicalized upon output, so case-variant names will be understood as the same header. | true |
value | string | The header field value | true |
Grafana.spec.deployment.spec.template.spec.ephemeralContainers[index].lifecycle.postStart.sleep
Sleep represents a duration that the container should sleep.
Name | Type | Description | Required |
---|---|---|---|
seconds | integer | Seconds is the number of seconds to sleep. Format: int64 | true |
Grafana.spec.deployment.spec.template.spec.ephemeralContainers[index].lifecycle.postStart.tcpSocket
Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept for backward compatibility. There is no validation of this field and lifecycle hooks will fail at runtime when it is specified.
Name | Type | Description | Required |
---|---|---|---|
port | int or string | Number or name of the port to access on the container.
Number must be in the range 1 to 65535.
Name must be an IANA_SVC_NAME. | true |
host | string | Optional: Host name to connect to, defaults to the pod IP. | false |
Grafana.spec.deployment.spec.template.spec.ephemeralContainers[index].lifecycle.preStop
PreStop is called immediately before a container is terminated due to an API request or management event such as liveness/startup probe failure, preemption, resource contention, etc. The handler is not called if the container crashes or exits. The Pod’s termination grace period countdown begins before the PreStop hook is executed. Regardless of the outcome of the handler, the container will eventually terminate within the Pod’s termination grace period (unless delayed by finalizers). Other management of the container blocks until the hook completes or until the termination grace period is reached. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks
Name | Type | Description | Required |
---|---|---|---|
exec | object | Exec specifies a command to execute in the container. | false |
httpGet | object | HTTPGet specifies an HTTP GET request to perform. | false |
sleep | object | Sleep represents a duration that the container should sleep. | false |
tcpSocket | object | Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept
for backward compatibility. There is no validation of this field and
lifecycle hooks will fail at runtime when it is specified. | false |
Grafana.spec.deployment.spec.template.spec.ephemeralContainers[index].lifecycle.preStop.exec
Exec specifies a command to execute in the container.
Name | Type | Description | Required |
---|---|---|---|
command | []string | Command is the command line to execute inside the container, the working directory for the
command is root ('/') in the container's filesystem. The command is simply exec'd, it is
not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use
a shell, you need to explicitly call out to that shell.
Exit status of 0 is treated as live/healthy and non-zero is unhealthy. | false |
Grafana.spec.deployment.spec.template.spec.ephemeralContainers[index].lifecycle.preStop.httpGet
HTTPGet specifies an HTTP GET request to perform.
Name | Type | Description | Required |
---|---|---|---|
port | int or string | Name or number of the port to access on the container.
Number must be in the range 1 to 65535.
Name must be an IANA_SVC_NAME. | true |
host | string | Host name to connect to, defaults to the pod IP. You probably want to set
"Host" in httpHeaders instead. | false |
httpHeaders | []object | Custom headers to set in the request. HTTP allows repeated headers. | false |
path | string | Path to access on the HTTP server. | false |
scheme | string | Scheme to use for connecting to the host.
Defaults to HTTP. | false |
Grafana.spec.deployment.spec.template.spec.ephemeralContainers[index].lifecycle.preStop.httpGet.httpHeaders[index]
HTTPHeader describes a custom header to be used in HTTP probes
Name | Type | Description | Required |
---|---|---|---|
name | string | The header field name.
This will be canonicalized upon output, so case-variant names will be understood as the same header. | true |
value | string | The header field value | true |
Grafana.spec.deployment.spec.template.spec.ephemeralContainers[index].lifecycle.preStop.sleep
Sleep represents a duration that the container should sleep.
Name | Type | Description | Required |
---|---|---|---|
seconds | integer | Seconds is the number of seconds to sleep. Format: int64 | true |
Grafana.spec.deployment.spec.template.spec.ephemeralContainers[index].lifecycle.preStop.tcpSocket
Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept for backward compatibility. There is no validation of this field and lifecycle hooks will fail at runtime when it is specified.
Name | Type | Description | Required |
---|---|---|---|
port | int or string | Number or name of the port to access on the container.
Number must be in the range 1 to 65535.
Name must be an IANA_SVC_NAME. | true |
host | string | Optional: Host name to connect to, defaults to the pod IP. | false |
Grafana.spec.deployment.spec.template.spec.ephemeralContainers[index].livenessProbe
Probes are not allowed for ephemeral containers.
Name | Type | Description | Required |
---|---|---|---|
exec | object | Exec specifies a command to execute in the container. | false |
failureThreshold | integer | Minimum consecutive failures for the probe to be considered failed after having succeeded.
Defaults to 3. Minimum value is 1. Format: int32 | false |
grpc | object | GRPC specifies a GRPC HealthCheckRequest. | false |
httpGet | object | HTTPGet specifies an HTTP GET request to perform. | false |
initialDelaySeconds | integer | Number of seconds after the container has started before liveness probes are initiated.
More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes Format: int32 | false |
periodSeconds | integer | How often (in seconds) to perform the probe.
Default to 10 seconds. Minimum value is 1. Format: int32 | false |
successThreshold | integer | Minimum consecutive successes for the probe to be considered successful after having failed.
Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. Format: int32 | false |
tcpSocket | object | TCPSocket specifies a connection to a TCP port. | false |
terminationGracePeriodSeconds | integer | Optional duration in seconds the pod needs to terminate gracefully upon probe failure.
The grace period is the duration in seconds after the processes running in the pod are sent
a termination signal and the time when the processes are forcibly halted with a kill signal.
Set this value longer than the expected cleanup time for your process.
If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this
value overrides the value provided by the pod spec.
Value must be non-negative integer. The value zero indicates stop immediately via
the kill signal (no opportunity to shut down).
This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate.
Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset. Format: int64 | false |
timeoutSeconds | integer | Number of seconds after which the probe times out.
Defaults to 1 second. Minimum value is 1.
More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes Format: int32 | false |
Grafana.spec.deployment.spec.template.spec.ephemeralContainers[index].livenessProbe.exec
Exec specifies a command to execute in the container.
Name | Type | Description | Required |
---|---|---|---|
command | []string | Command is the command line to execute inside the container, the working directory for the
command is root ('/') in the container's filesystem. The command is simply exec'd, it is
not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use
a shell, you need to explicitly call out to that shell.
Exit status of 0 is treated as live/healthy and non-zero is unhealthy. | false |
Grafana.spec.deployment.spec.template.spec.ephemeralContainers[index].livenessProbe.grpc
GRPC specifies a GRPC HealthCheckRequest.
Name | Type | Description | Required |
---|---|---|---|
port | integer | Port number of the gRPC service. Number must be in the range 1 to 65535. Format: int32 | true |
service | string | Service is the name of the service to place in the gRPC HealthCheckRequest
(see https://github.com/grpc/grpc/blob/master/doc/health-checking.md). If this is not specified, the default behavior is defined by gRPC. | false |
Grafana.spec.deployment.spec.template.spec.ephemeralContainers[index].livenessProbe.httpGet
HTTPGet specifies an HTTP GET request to perform.
Name | Type | Description | Required |
---|---|---|---|
port | int or string | Name or number of the port to access on the container.
Number must be in the range 1 to 65535.
Name must be an IANA_SVC_NAME. | true |
host | string | Host name to connect to, defaults to the pod IP. You probably want to set
"Host" in httpHeaders instead. | false |
httpHeaders | []object | Custom headers to set in the request. HTTP allows repeated headers. | false |
path | string | Path to access on the HTTP server. | false |
scheme | string | Scheme to use for connecting to the host.
Defaults to HTTP. | false |
Grafana.spec.deployment.spec.template.spec.ephemeralContainers[index].livenessProbe.httpGet.httpHeaders[index]
HTTPHeader describes a custom header to be used in HTTP probes
Name | Type | Description | Required |
---|---|---|---|
name | string | The header field name.
This will be canonicalized upon output, so case-variant names will be understood as the same header. | true |
value | string | The header field value | true |
Grafana.spec.deployment.spec.template.spec.ephemeralContainers[index].livenessProbe.tcpSocket
TCPSocket specifies a connection to a TCP port.
Name | Type | Description | Required |
---|---|---|---|
port | int or string | Number or name of the port to access on the container.
Number must be in the range 1 to 65535.
Name must be an IANA_SVC_NAME. | true |
host | string | Optional: Host name to connect to, defaults to the pod IP. | false |
Grafana.spec.deployment.spec.template.spec.ephemeralContainers[index].ports[index]
ContainerPort represents a network port in a single container.
Name | Type | Description | Required |
---|---|---|---|
containerPort | integer | Number of port to expose on the pod's IP address.
This must be a valid port number, 0 < x < 65536. Format: int32 | true |
hostIP | string | What host IP to bind the external port to. | false |
hostPort | integer | Number of port to expose on the host.
If specified, this must be a valid port number, 0 < x < 65536.
If HostNetwork is specified, this must match ContainerPort.
Most containers do not need this. Format: int32 | false |
name | string | If specified, this must be an IANA_SVC_NAME and unique within the pod. Each
named port in a pod must have a unique name. Name for the port that can be
referred to by services. | false |
protocol | string | Protocol for port. Must be UDP, TCP, or SCTP.
Defaults to "TCP". Default: TCP | false |
Grafana.spec.deployment.spec.template.spec.ephemeralContainers[index].readinessProbe
Probes are not allowed for ephemeral containers.
Name | Type | Description | Required |
---|---|---|---|
exec | object | Exec specifies a command to execute in the container. | false |
failureThreshold | integer | Minimum consecutive failures for the probe to be considered failed after having succeeded.
Defaults to 3. Minimum value is 1. Format: int32 | false |
grpc | object | GRPC specifies a GRPC HealthCheckRequest. | false |
httpGet | object | HTTPGet specifies an HTTP GET request to perform. | false |
initialDelaySeconds | integer | Number of seconds after the container has started before liveness probes are initiated.
More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes Format: int32 | false |
periodSeconds | integer | How often (in seconds) to perform the probe.
Default to 10 seconds. Minimum value is 1. Format: int32 | false |
successThreshold | integer | Minimum consecutive successes for the probe to be considered successful after having failed.
Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. Format: int32 | false |
tcpSocket | object | TCPSocket specifies a connection to a TCP port. | false |
terminationGracePeriodSeconds | integer | Optional duration in seconds the pod needs to terminate gracefully upon probe failure.
The grace period is the duration in seconds after the processes running in the pod are sent
a termination signal and the time when the processes are forcibly halted with a kill signal.
Set this value longer than the expected cleanup time for your process.
If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this
value overrides the value provided by the pod spec.
Value must be non-negative integer. The value zero indicates stop immediately via
the kill signal (no opportunity to shut down).
This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate.
Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset. Format: int64 | false |
timeoutSeconds | integer | Number of seconds after which the probe times out.
Defaults to 1 second. Minimum value is 1.
More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes Format: int32 | false |
Grafana.spec.deployment.spec.template.spec.ephemeralContainers[index].readinessProbe.exec
Exec specifies a command to execute in the container.
Name | Type | Description | Required |
---|---|---|---|
command | []string | Command is the command line to execute inside the container, the working directory for the
command is root ('/') in the container's filesystem. The command is simply exec'd, it is
not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use
a shell, you need to explicitly call out to that shell.
Exit status of 0 is treated as live/healthy and non-zero is unhealthy. | false |
Grafana.spec.deployment.spec.template.spec.ephemeralContainers[index].readinessProbe.grpc
GRPC specifies a GRPC HealthCheckRequest.
Name | Type | Description | Required |
---|---|---|---|
port | integer | Port number of the gRPC service. Number must be in the range 1 to 65535. Format: int32 | true |
service | string | Service is the name of the service to place in the gRPC HealthCheckRequest
(see https://github.com/grpc/grpc/blob/master/doc/health-checking.md). If this is not specified, the default behavior is defined by gRPC. | false |
Grafana.spec.deployment.spec.template.spec.ephemeralContainers[index].readinessProbe.httpGet
HTTPGet specifies an HTTP GET request to perform.
Name | Type | Description | Required |
---|---|---|---|
port | int or string | Name or number of the port to access on the container.
Number must be in the range 1 to 65535.
Name must be an IANA_SVC_NAME. | true |
host | string | Host name to connect to, defaults to the pod IP. You probably want to set
"Host" in httpHeaders instead. | false |
httpHeaders | []object | Custom headers to set in the request. HTTP allows repeated headers. | false |
path | string | Path to access on the HTTP server. | false |
scheme | string | Scheme to use for connecting to the host.
Defaults to HTTP. | false |
Grafana.spec.deployment.spec.template.spec.ephemeralContainers[index].readinessProbe.httpGet.httpHeaders[index]
HTTPHeader describes a custom header to be used in HTTP probes
Name | Type | Description | Required |
---|---|---|---|
name | string | The header field name.
This will be canonicalized upon output, so case-variant names will be understood as the same header. | true |
value | string | The header field value | true |
Grafana.spec.deployment.spec.template.spec.ephemeralContainers[index].readinessProbe.tcpSocket
TCPSocket specifies a connection to a TCP port.
Name | Type | Description | Required |
---|---|---|---|
port | int or string | Number or name of the port to access on the container.
Number must be in the range 1 to 65535.
Name must be an IANA_SVC_NAME. | true |
host | string | Optional: Host name to connect to, defaults to the pod IP. | false |
Grafana.spec.deployment.spec.template.spec.ephemeralContainers[index].resizePolicy[index]
ContainerResizePolicy represents resource resize policy for the container.
Name | Type | Description | Required |
---|---|---|---|
resourceName | string | Name of the resource to which this resource resize policy applies.
Supported values: cpu, memory. | true |
restartPolicy | string | Restart policy to apply when specified resource is resized.
If not specified, it defaults to NotRequired. | true |
Grafana.spec.deployment.spec.template.spec.ephemeralContainers[index].resources
Resources are not allowed for ephemeral containers. Ephemeral containers use spare resources already allocated to the pod.
Name | Type | Description | Required |
---|---|---|---|
claims | []object | Claims lists the names of resources, defined in spec.resourceClaims,
that are used by this container. This is an alpha field and requires enabling the DynamicResourceAllocation feature gate. This field is immutable. It can only be set for containers. | false |
limits | map[string]int or string | Limits describes the maximum amount of compute resources allowed.
More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ | false |
requests | map[string]int or string | Requests describes the minimum amount of compute resources required.
If Requests is omitted for a container, it defaults to Limits if that is explicitly specified,
otherwise to an implementation-defined value. Requests cannot exceed Limits.
More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ | false |
Grafana.spec.deployment.spec.template.spec.ephemeralContainers[index].resources.claims[index]
ResourceClaim references one entry in PodSpec.ResourceClaims.
Name | Type | Description | Required |
---|---|---|---|
name | string | Name must match the name of one entry in pod.spec.resourceClaims of
the Pod where this field is used. It makes that resource available
inside a container. | true |
request | string | Request is the name chosen for a request in the referenced claim.
If empty, everything from the claim is made available, otherwise
only the result of this request. | false |
Grafana.spec.deployment.spec.template.spec.ephemeralContainers[index].securityContext
Optional: SecurityContext defines the security options the ephemeral container should be run with. If set, the fields of SecurityContext override the equivalent fields of PodSecurityContext.
Name | Type | Description | Required |
---|---|---|---|
allowPrivilegeEscalation | boolean | AllowPrivilegeEscalation controls whether a process can gain more
privileges than its parent process. This bool directly controls if
the no_new_privs flag will be set on the container process.
AllowPrivilegeEscalation is true always when the container is:
1) run as Privileged
2) has CAP_SYS_ADMIN
Note that this field cannot be set when spec.os.name is windows. | false |
appArmorProfile | object | appArmorProfile is the AppArmor options to use by this container. If set, this profile
overrides the pod's appArmorProfile.
Note that this field cannot be set when spec.os.name is windows. | false |
capabilities | object | The capabilities to add/drop when running containers.
Defaults to the default set of capabilities granted by the container runtime.
Note that this field cannot be set when spec.os.name is windows. | false |
privileged | boolean | Run container in privileged mode.
Processes in privileged containers are essentially equivalent to root on the host.
Defaults to false.
Note that this field cannot be set when spec.os.name is windows. | false |
procMount | string | procMount denotes the type of proc mount to use for the containers.
The default value is Default which uses the container runtime defaults for
readonly paths and masked paths.
This requires the ProcMountType feature flag to be enabled.
Note that this field cannot be set when spec.os.name is windows. | false |
readOnlyRootFilesystem | boolean | Whether this container has a read-only root filesystem.
Default is false.
Note that this field cannot be set when spec.os.name is windows. | false |
runAsGroup | integer | The GID to run the entrypoint of the container process.
Uses runtime default if unset.
May also be set in PodSecurityContext. If set in both SecurityContext and
PodSecurityContext, the value specified in SecurityContext takes precedence.
Note that this field cannot be set when spec.os.name is windows. Format: int64 | false |
runAsNonRoot | boolean | Indicates that the container must run as a non-root user.
If true, the Kubelet will validate the image at runtime to ensure that it
does not run as UID 0 (root) and fail to start the container if it does.
If unset or false, no such validation will be performed.
May also be set in PodSecurityContext. If set in both SecurityContext and
PodSecurityContext, the value specified in SecurityContext takes precedence. | false |
runAsUser | integer | The UID to run the entrypoint of the container process.
Defaults to user specified in image metadata if unspecified.
May also be set in PodSecurityContext. If set in both SecurityContext and
PodSecurityContext, the value specified in SecurityContext takes precedence.
Note that this field cannot be set when spec.os.name is windows. Format: int64 | false |
seLinuxOptions | object | The SELinux context to be applied to the container.
If unspecified, the container runtime will allocate a random SELinux context for each
container. May also be set in PodSecurityContext. If set in both SecurityContext and
PodSecurityContext, the value specified in SecurityContext takes precedence.
Note that this field cannot be set when spec.os.name is windows. | false |
seccompProfile | object | The seccomp options to use by this container. If seccomp options are
provided at both the pod & container level, the container options
override the pod options.
Note that this field cannot be set when spec.os.name is windows. | false |
windowsOptions | object | The Windows specific settings applied to all containers.
If unspecified, the options from the PodSecurityContext will be used.
If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.
Note that this field cannot be set when spec.os.name is linux. | false |
Grafana.spec.deployment.spec.template.spec.ephemeralContainers[index].securityContext.appArmorProfile
appArmorProfile is the AppArmor options to use by this container. If set, this profile overrides the pod’s appArmorProfile. Note that this field cannot be set when spec.os.name is windows.
Name | Type | Description | Required |
---|---|---|---|
type | string | type indicates which kind of AppArmor profile will be applied.
Valid options are:
Localhost - a profile pre-loaded on the node.
RuntimeDefault - the container runtime's default profile.
Unconfined - no AppArmor enforcement. | true |
localhostProfile | string | localhostProfile indicates a profile loaded on the node that should be used.
The profile must be preconfigured on the node to work.
Must match the loaded name of the profile.
Must be set if and only if type is "Localhost". | false |
Grafana.spec.deployment.spec.template.spec.ephemeralContainers[index].securityContext.capabilities
The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime. Note that this field cannot be set when spec.os.name is windows.
Name | Type | Description | Required |
---|---|---|---|
add | []string | Added capabilities | false |
drop | []string | Removed capabilities | false |
Grafana.spec.deployment.spec.template.spec.ephemeralContainers[index].securityContext.seLinuxOptions
The SELinux context to be applied to the container. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows.
Name | Type | Description | Required |
---|---|---|---|
level | string | Level is SELinux level label that applies to the container. | false |
role | string | Role is a SELinux role label that applies to the container. | false |
type | string | Type is a SELinux type label that applies to the container. | false |
user | string | User is a SELinux user label that applies to the container. | false |
Grafana.spec.deployment.spec.template.spec.ephemeralContainers[index].securityContext.seccompProfile
The seccomp options to use by this container. If seccomp options are provided at both the pod & container level, the container options override the pod options. Note that this field cannot be set when spec.os.name is windows.
Name | Type | Description | Required |
---|---|---|---|
type | string | type indicates which kind of seccomp profile will be applied.
Valid options are: Localhost - a profile defined in a file on the node should be used.
RuntimeDefault - the container runtime default profile should be used.
Unconfined - no profile should be applied. | true |
localhostProfile | string | localhostProfile indicates a profile defined in a file on the node should be used.
The profile must be preconfigured on the node to work.
Must be a descending path, relative to the kubelet’s configured seccomp profile location.
Must be set if type is “Localhost”. Must NOT be set for any other type. | false |
Grafana.spec.deployment.spec.template.spec.ephemeralContainers[index].securityContext.windowsOptions
The Windows specific settings applied to all containers. If unspecified, the options from the PodSecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is linux.
Name | Type | Description | Required |
---|---|---|---|
gmsaCredentialSpec | string | GMSACredentialSpec is where the GMSA admission webhook
(https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the
GMSA credential spec named by the GMSACredentialSpecName field. | false |
gmsaCredentialSpecName | string | GMSACredentialSpecName is the name of the GMSA credential spec to use. | false |
hostProcess | boolean | HostProcess determines if a container should be run as a 'Host Process' container.
All of a Pod's containers must have the same effective HostProcess value
(it is not allowed to have a mix of HostProcess containers and non-HostProcess containers).
In addition, if HostProcess is true then HostNetwork must also be set to true. | false |
runAsUserName | string | The UserName in Windows to run the entrypoint of the container process.
Defaults to the user specified in image metadata if unspecified.
May also be set in PodSecurityContext. If set in both SecurityContext and
PodSecurityContext, the value specified in SecurityContext takes precedence. | false |
Grafana.spec.deployment.spec.template.spec.ephemeralContainers[index].startupProbe
Probes are not allowed for ephemeral containers.
Name | Type | Description | Required |
---|---|---|---|
exec | object | Exec specifies a command to execute in the container. | false |
failureThreshold | integer | Minimum consecutive failures for the probe to be considered failed after having succeeded.
Defaults to 3. Minimum value is 1. Format: int32 | false |
grpc | object | GRPC specifies a GRPC HealthCheckRequest. | false |
httpGet | object | HTTPGet specifies an HTTP GET request to perform. | false |
initialDelaySeconds | integer | Number of seconds after the container has started before liveness probes are initiated.
More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes Format: int32 | false |
periodSeconds | integer | How often (in seconds) to perform the probe.
Default to 10 seconds. Minimum value is 1. Format: int32 | false |
successThreshold | integer | Minimum consecutive successes for the probe to be considered successful after having failed.
Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. Format: int32 | false |
tcpSocket | object | TCPSocket specifies a connection to a TCP port. | false |
terminationGracePeriodSeconds | integer | Optional duration in seconds the pod needs to terminate gracefully upon probe failure.
The grace period is the duration in seconds after the processes running in the pod are sent
a termination signal and the time when the processes are forcibly halted with a kill signal.
Set this value longer than the expected cleanup time for your process.
If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this
value overrides the value provided by the pod spec.
Value must be non-negative integer. The value zero indicates stop immediately via
the kill signal (no opportunity to shut down).
This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate.
Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset. Format: int64 | false |
timeoutSeconds | integer | Number of seconds after which the probe times out.
Defaults to 1 second. Minimum value is 1.
More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes Format: int32 | false |
Grafana.spec.deployment.spec.template.spec.ephemeralContainers[index].startupProbe.exec
Exec specifies a command to execute in the container.
Name | Type | Description | Required |
---|---|---|---|
command | []string | Command is the command line to execute inside the container, the working directory for the
command is root ('/') in the container's filesystem. The command is simply exec'd, it is
not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use
a shell, you need to explicitly call out to that shell.
Exit status of 0 is treated as live/healthy and non-zero is unhealthy. | false |
Grafana.spec.deployment.spec.template.spec.ephemeralContainers[index].startupProbe.grpc
GRPC specifies a GRPC HealthCheckRequest.
Name | Type | Description | Required |
---|---|---|---|
port | integer | Port number of the gRPC service. Number must be in the range 1 to 65535. Format: int32 | true |
service | string | Service is the name of the service to place in the gRPC HealthCheckRequest
(see https://github.com/grpc/grpc/blob/master/doc/health-checking.md). If this is not specified, the default behavior is defined by gRPC. | false |
Grafana.spec.deployment.spec.template.spec.ephemeralContainers[index].startupProbe.httpGet
HTTPGet specifies an HTTP GET request to perform.
Name | Type | Description | Required |
---|---|---|---|
port | int or string | Name or number of the port to access on the container.
Number must be in the range 1 to 65535.
Name must be an IANA_SVC_NAME. | true |
host | string | Host name to connect to, defaults to the pod IP. You probably want to set
"Host" in httpHeaders instead. | false |
httpHeaders | []object | Custom headers to set in the request. HTTP allows repeated headers. | false |
path | string | Path to access on the HTTP server. | false |
scheme | string | Scheme to use for connecting to the host.
Defaults to HTTP. | false |
Grafana.spec.deployment.spec.template.spec.ephemeralContainers[index].startupProbe.httpGet.httpHeaders[index]
HTTPHeader describes a custom header to be used in HTTP probes
Name | Type | Description | Required |
---|---|---|---|
name | string | The header field name.
This will be canonicalized upon output, so case-variant names will be understood as the same header. | true |
value | string | The header field value | true |
Grafana.spec.deployment.spec.template.spec.ephemeralContainers[index].startupProbe.tcpSocket
TCPSocket specifies a connection to a TCP port.
Name | Type | Description | Required |
---|---|---|---|
port | int or string | Number or name of the port to access on the container.
Number must be in the range 1 to 65535.
Name must be an IANA_SVC_NAME. | true |
host | string | Optional: Host name to connect to, defaults to the pod IP. | false |
Grafana.spec.deployment.spec.template.spec.ephemeralContainers[index].volumeDevices[index]
volumeDevice describes a mapping of a raw block device within a container.
Name | Type | Description | Required |
---|---|---|---|
devicePath | string | devicePath is the path inside of the container that the device will be mapped to. | true |
name | string | name must match the name of a persistentVolumeClaim in the pod | true |
Grafana.spec.deployment.spec.template.spec.ephemeralContainers[index].volumeMounts[index]
VolumeMount describes a mounting of a Volume within a container.
Name | Type | Description | Required |
---|---|---|---|
mountPath | string | Path within the container at which the volume should be mounted. Must
not contain ':'. | true |
name | string | This must match the Name of a Volume. | true |
mountPropagation | string | mountPropagation determines how mounts are propagated from the host
to container and the other way around.
When not set, MountPropagationNone is used.
This field is beta in 1.10.
When RecursiveReadOnly is set to IfPossible or to Enabled, MountPropagation must be None or unspecified
(which defaults to None). | false |
readOnly | boolean | Mounted read-only if true, read-write otherwise (false or unspecified).
Defaults to false. | false |
recursiveReadOnly | string | RecursiveReadOnly specifies whether read-only mounts should be handled
recursively. If ReadOnly is false, this field has no meaning and must be unspecified. If ReadOnly is true, and this field is set to Disabled, the mount is not made recursively read-only. If this field is set to IfPossible, the mount is made recursively read-only, if it is supported by the container runtime. If this field is set to Enabled, the mount is made recursively read-only if it is supported by the container runtime, otherwise the pod will not be started and an error will be generated to indicate the reason. If this field is set to IfPossible or Enabled, MountPropagation must be set to None (or be unspecified, which defaults to None). If this field is not specified, it is treated as an equivalent of Disabled. | false |
subPath | string | Path within the volume from which the container’s volume should be mounted.
Defaults to "" (volume’s root). | false |
subPathExpr | string | Expanded path within the volume from which the container’s volume should be mounted.
Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container’s environment.
Defaults to "" (volume’s root).
SubPathExpr and SubPath are mutually exclusive. | false |
Grafana.spec.deployment.spec.template.spec.hostAliases[index]
HostAlias holds the mapping between IP and hostnames that will be injected as an entry in the pod’s hosts file.
Name | Type | Description | Required |
---|---|---|---|
ip | string | IP address of the host file entry. | true |
hostnames | []string | Hostnames for the above IP address. | false |
Grafana.spec.deployment.spec.template.spec.imagePullSecrets[index]
LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace.
Name | Type | Description | Required |
---|---|---|---|
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 Default: | false |
Grafana.spec.deployment.spec.template.spec.initContainers[index]
A single application container that you want to run within a pod.
Name | Type | Description | Required |
---|---|---|---|
name | string | Name of the container specified as a DNS_LABEL.
Each container in a pod must have a unique name (DNS_LABEL).
Cannot be updated. | true |
args | []string | Arguments to the entrypoint.
The container image's CMD is used if this is not provided.
Variable references $(VAR_NAME) are expanded using the container's environment. If a variable
cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced
to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will
produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless
of whether the variable exists or not. Cannot be updated.
More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell | false |
command | []string | Entrypoint array. Not executed within a shell.
The container image's ENTRYPOINT is used if this is not provided.
Variable references $(VAR_NAME) are expanded using the container's environment. If a variable
cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced
to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will
produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless
of whether the variable exists or not. Cannot be updated.
More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell | false |
env | []object | List of environment variables to set in the container.
Cannot be updated. | false |
envFrom | []object | List of sources to populate environment variables in the container.
The keys defined within a source must be a C_IDENTIFIER. All invalid keys
will be reported as an event when the container is starting. When a key exists in multiple
sources, the value associated with the last source will take precedence.
Values defined by an Env with a duplicate key will take precedence.
Cannot be updated. | false |
image | string | Container image name.
More info: https://kubernetes.io/docs/concepts/containers/images
This field is optional to allow higher level config management to default or override
container images in workload controllers like Deployments and StatefulSets. | false |
imagePullPolicy | string | Image pull policy.
One of Always, Never, IfNotPresent.
Defaults to Always if :latest tag is specified, or IfNotPresent otherwise.
Cannot be updated.
More info: https://kubernetes.io/docs/concepts/containers/images#updating-images | false |
lifecycle | object | Actions that the management system should take in response to container lifecycle events.
Cannot be updated. | false |
livenessProbe | object | Periodic probe of container liveness.
Container will be restarted if the probe fails.
Cannot be updated.
More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes | false |
ports | []object | List of ports to expose from the container. Not specifying a port here
DOES NOT prevent that port from being exposed. Any port which is
listening on the default "0.0.0.0" address inside a container will be
accessible from the network.
Modifying this array with strategic merge patch may corrupt the data.
For more information See https://github.com/kubernetes/kubernetes/issues/108255.
Cannot be updated. | false |
readinessProbe | object | Periodic probe of container service readiness.
Container will be removed from service endpoints if the probe fails.
Cannot be updated.
More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes | false |
resizePolicy | []object | Resources resize policy for the container. | false |
resources | object | Compute Resources required by this container.
Cannot be updated.
More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ | false |
restartPolicy | string | RestartPolicy defines the restart behavior of individual containers in a pod.
This field may only be set for init containers, and the only allowed value is "Always".
For non-init containers or when this field is not specified,
the restart behavior is defined by the Pod's restart policy and the container type.
Setting the RestartPolicy as "Always" for the init container will have the following effect:
this init container will be continually restarted on
exit until all regular containers have terminated. Once all regular
containers have completed, all init containers with restartPolicy "Always"
will be shut down. This lifecycle differs from normal init containers and
is often referred to as a "sidecar" container. Although this init
container still starts in the init container sequence, it does not wait
for the container to complete before proceeding to the next init
container. Instead, the next init container starts immediately after this
init container is started, or after any startupProbe has successfully
completed. | false |
securityContext | object | SecurityContext defines the security options the container should be run with.
If set, the fields of SecurityContext override the equivalent fields of PodSecurityContext.
More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/ | false |
startupProbe | object | StartupProbe indicates that the Pod has successfully initialized.
If specified, no other probes are executed until this completes successfully.
If this probe fails, the Pod will be restarted, just as if the livenessProbe failed.
This can be used to provide different probe parameters at the beginning of a Pod's lifecycle,
when it might take a long time to load data or warm a cache, than during steady-state operation.
This cannot be updated.
More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes | false |
stdin | boolean | Whether this container should allocate a buffer for stdin in the container runtime. If this
is not set, reads from stdin in the container will always result in EOF.
Default is false. | false |
stdinOnce | boolean | Whether the container runtime should close the stdin channel after it has been opened by
a single attach. When stdin is true the stdin stream will remain open across multiple attach
sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the
first client attaches to stdin, and then remains open and accepts data until the client disconnects,
at which time stdin is closed and remains closed until the container is restarted. If this
flag is false, a container processes that reads from stdin will never receive an EOF.
Default is false | false |
terminationMessagePath | string | Optional: Path at which the file to which the container's termination message
will be written is mounted into the container's filesystem.
Message written is intended to be brief final status, such as an assertion failure message.
Will be truncated by the node if greater than 4096 bytes. The total message length across
all containers will be limited to 12kb.
Defaults to /dev/termination-log.
Cannot be updated. | false |
terminationMessagePolicy | string | Indicate how the termination message should be populated. File will use the contents of
terminationMessagePath to populate the container status message on both success and failure.
FallbackToLogsOnError will use the last chunk of container log output if the termination
message file is empty and the container exited with an error.
The log output is limited to 2048 bytes or 80 lines, whichever is smaller.
Defaults to File.
Cannot be updated. | false |
tty | boolean | Whether this container should allocate a TTY for itself, also requires 'stdin' to be true.
Default is false. | false |
volumeDevices | []object | volumeDevices is the list of block devices to be used by the container. | false |
volumeMounts | []object | Pod volumes to mount into the container's filesystem.
Cannot be updated. | false |
workingDir | string | Container's working directory.
If not specified, the container runtime's default will be used, which
might be configured in the container image.
Cannot be updated. | false |
Grafana.spec.deployment.spec.template.spec.initContainers[index].env[index]
EnvVar represents an environment variable present in a Container.
Name | Type | Description | Required |
---|---|---|---|
name | string | Name of the environment variable. Must be a C_IDENTIFIER. | true |
value | string | Variable references $(VAR_NAME) are expanded
using the previously defined environment variables in the container and
any service environment variables. If a variable cannot be resolved,
the reference in the input string will be unchanged. Double $$ are reduced
to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e.
"$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)".
Escaped references will never be expanded, regardless of whether the variable
exists or not.
Defaults to "". | false |
valueFrom | object | Source for the environment variable's value. Cannot be used if value is not empty. | false |
Grafana.spec.deployment.spec.template.spec.initContainers[index].env[index].valueFrom
Source for the environment variable’s value. Cannot be used if value is not empty.
Name | Type | Description | Required |
---|---|---|---|
configMapKeyRef | object | Selects a key of a ConfigMap. | false |
fieldRef | object | Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels[' | false |
resourceFieldRef | object | Selects a resource of the container: only resources limits and requests
(limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported. | false |
secretKeyRef | object | Selects a key of a secret in the pod's namespace | false |
Grafana.spec.deployment.spec.template.spec.initContainers[index].env[index].valueFrom.configMapKeyRef
Selects a key of a ConfigMap.
Name | Type | Description | Required |
---|---|---|---|
key | string | The key to select. | true |
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 Default: | false |
optional | boolean | Specify whether the ConfigMap or its key must be defined | false |
Grafana.spec.deployment.spec.template.spec.initContainers[index].env[index].valueFrom.fieldRef
Selects a field of the pod: supports metadata.name, metadata.namespace, metadata.labels['<KEY>']
, metadata.annotations['<KEY>']
,
spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.
Name | Type | Description | Required |
---|---|---|---|
fieldPath | string | Path of the field to select in the specified API version. | true |
apiVersion | string | Version of the schema the FieldPath is written in terms of, defaults to "v1". | false |
Grafana.spec.deployment.spec.template.spec.initContainers[index].env[index].valueFrom.resourceFieldRef
Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported.
Name | Type | Description | Required |
---|---|---|---|
resource | string | Required: resource to select | true |
containerName | string | Container name: required for volumes, optional for env vars | false |
divisor | int or string | Specifies the output format of the exposed resources, defaults to "1" | false |
Grafana.spec.deployment.spec.template.spec.initContainers[index].env[index].valueFrom.secretKeyRef
Selects a key of a secret in the pod’s namespace
Name | Type | Description | Required |
---|---|---|---|
key | string | The key of the secret to select from. Must be a valid secret key. | true |
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 Default: | false |
optional | boolean | Specify whether the Secret or its key must be defined | false |
Grafana.spec.deployment.spec.template.spec.initContainers[index].envFrom[index]
EnvFromSource represents the source of a set of ConfigMaps
Name | Type | Description | Required |
---|---|---|---|
configMapRef | object | The ConfigMap to select from | false |
prefix | string | An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER. | false |
secretRef | object | The Secret to select from | false |
Grafana.spec.deployment.spec.template.spec.initContainers[index].envFrom[index].configMapRef
The ConfigMap to select from
Name | Type | Description | Required |
---|---|---|---|
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 Default: | false |
optional | boolean | Specify whether the ConfigMap must be defined | false |
Grafana.spec.deployment.spec.template.spec.initContainers[index].envFrom[index].secretRef
The Secret to select from
Name | Type | Description | Required |
---|---|---|---|
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 Default: | false |
optional | boolean | Specify whether the Secret must be defined | false |
Grafana.spec.deployment.spec.template.spec.initContainers[index].lifecycle
Actions that the management system should take in response to container lifecycle events. Cannot be updated.
Name | Type | Description | Required |
---|---|---|---|
postStart | object | PostStart is called immediately after a container is created. If the handler fails,
the container is terminated and restarted according to its restart policy.
Other management of the container blocks until the hook completes.
More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks | false |
preStop | object | PreStop is called immediately before a container is terminated due to an
API request or management event such as liveness/startup probe failure,
preemption, resource contention, etc. The handler is not called if the
container crashes or exits. The Pod's termination grace period countdown begins before the
PreStop hook is executed. Regardless of the outcome of the handler, the
container will eventually terminate within the Pod's termination grace
period (unless delayed by finalizers). Other management of the container blocks until the hook completes
or until the termination grace period is reached.
More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks | false |
Grafana.spec.deployment.spec.template.spec.initContainers[index].lifecycle.postStart
PostStart is called immediately after a container is created. If the handler fails, the container is terminated and restarted according to its restart policy. Other management of the container blocks until the hook completes. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks
Name | Type | Description | Required |
---|---|---|---|
exec | object | Exec specifies a command to execute in the container. | false |
httpGet | object | HTTPGet specifies an HTTP GET request to perform. | false |
sleep | object | Sleep represents a duration that the container should sleep. | false |
tcpSocket | object | Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept
for backward compatibility. There is no validation of this field and
lifecycle hooks will fail at runtime when it is specified. | false |
Grafana.spec.deployment.spec.template.spec.initContainers[index].lifecycle.postStart.exec
Exec specifies a command to execute in the container.
Name | Type | Description | Required |
---|---|---|---|
command | []string | Command is the command line to execute inside the container, the working directory for the
command is root ('/') in the container's filesystem. The command is simply exec'd, it is
not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use
a shell, you need to explicitly call out to that shell.
Exit status of 0 is treated as live/healthy and non-zero is unhealthy. | false |
Grafana.spec.deployment.spec.template.spec.initContainers[index].lifecycle.postStart.httpGet
HTTPGet specifies an HTTP GET request to perform.
Name | Type | Description | Required |
---|---|---|---|
port | int or string | Name or number of the port to access on the container.
Number must be in the range 1 to 65535.
Name must be an IANA_SVC_NAME. | true |
host | string | Host name to connect to, defaults to the pod IP. You probably want to set
"Host" in httpHeaders instead. | false |
httpHeaders | []object | Custom headers to set in the request. HTTP allows repeated headers. | false |
path | string | Path to access on the HTTP server. | false |
scheme | string | Scheme to use for connecting to the host.
Defaults to HTTP. | false |
Grafana.spec.deployment.spec.template.spec.initContainers[index].lifecycle.postStart.httpGet.httpHeaders[index]
HTTPHeader describes a custom header to be used in HTTP probes
Name | Type | Description | Required |
---|---|---|---|
name | string | The header field name.
This will be canonicalized upon output, so case-variant names will be understood as the same header. | true |
value | string | The header field value | true |
Grafana.spec.deployment.spec.template.spec.initContainers[index].lifecycle.postStart.sleep
Sleep represents a duration that the container should sleep.
Name | Type | Description | Required |
---|---|---|---|
seconds | integer | Seconds is the number of seconds to sleep. Format: int64 | true |
Grafana.spec.deployment.spec.template.spec.initContainers[index].lifecycle.postStart.tcpSocket
Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept for backward compatibility. There is no validation of this field and lifecycle hooks will fail at runtime when it is specified.
Name | Type | Description | Required |
---|---|---|---|
port | int or string | Number or name of the port to access on the container.
Number must be in the range 1 to 65535.
Name must be an IANA_SVC_NAME. | true |
host | string | Optional: Host name to connect to, defaults to the pod IP. | false |
Grafana.spec.deployment.spec.template.spec.initContainers[index].lifecycle.preStop
PreStop is called immediately before a container is terminated due to an API request or management event such as liveness/startup probe failure, preemption, resource contention, etc. The handler is not called if the container crashes or exits. The Pod’s termination grace period countdown begins before the PreStop hook is executed. Regardless of the outcome of the handler, the container will eventually terminate within the Pod’s termination grace period (unless delayed by finalizers). Other management of the container blocks until the hook completes or until the termination grace period is reached. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks
Name | Type | Description | Required |
---|---|---|---|
exec | object | Exec specifies a command to execute in the container. | false |
httpGet | object | HTTPGet specifies an HTTP GET request to perform. | false |
sleep | object | Sleep represents a duration that the container should sleep. | false |
tcpSocket | object | Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept
for backward compatibility. There is no validation of this field and
lifecycle hooks will fail at runtime when it is specified. | false |
Grafana.spec.deployment.spec.template.spec.initContainers[index].lifecycle.preStop.exec
Exec specifies a command to execute in the container.
Name | Type | Description | Required |
---|---|---|---|
command | []string | Command is the command line to execute inside the container, the working directory for the
command is root ('/') in the container's filesystem. The command is simply exec'd, it is
not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use
a shell, you need to explicitly call out to that shell.
Exit status of 0 is treated as live/healthy and non-zero is unhealthy. | false |
Grafana.spec.deployment.spec.template.spec.initContainers[index].lifecycle.preStop.httpGet
HTTPGet specifies an HTTP GET request to perform.
Name | Type | Description | Required |
---|---|---|---|
port | int or string | Name or number of the port to access on the container.
Number must be in the range 1 to 65535.
Name must be an IANA_SVC_NAME. | true |
host | string | Host name to connect to, defaults to the pod IP. You probably want to set
"Host" in httpHeaders instead. | false |
httpHeaders | []object | Custom headers to set in the request. HTTP allows repeated headers. | false |
path | string | Path to access on the HTTP server. | false |
scheme | string | Scheme to use for connecting to the host.
Defaults to HTTP. | false |
Grafana.spec.deployment.spec.template.spec.initContainers[index].lifecycle.preStop.httpGet.httpHeaders[index]
HTTPHeader describes a custom header to be used in HTTP probes
Name | Type | Description | Required |
---|---|---|---|
name | string | The header field name.
This will be canonicalized upon output, so case-variant names will be understood as the same header. | true |
value | string | The header field value | true |
Grafana.spec.deployment.spec.template.spec.initContainers[index].lifecycle.preStop.sleep
Sleep represents a duration that the container should sleep.
Name | Type | Description | Required |
---|---|---|---|
seconds | integer | Seconds is the number of seconds to sleep. Format: int64 | true |
Grafana.spec.deployment.spec.template.spec.initContainers[index].lifecycle.preStop.tcpSocket
Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept for backward compatibility. There is no validation of this field and lifecycle hooks will fail at runtime when it is specified.
Name | Type | Description | Required |
---|---|---|---|
port | int or string | Number or name of the port to access on the container.
Number must be in the range 1 to 65535.
Name must be an IANA_SVC_NAME. | true |
host | string | Optional: Host name to connect to, defaults to the pod IP. | false |
Grafana.spec.deployment.spec.template.spec.initContainers[index].livenessProbe
Periodic probe of container liveness. Container will be restarted if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
Name | Type | Description | Required |
---|---|---|---|
exec | object | Exec specifies a command to execute in the container. | false |
failureThreshold | integer | Minimum consecutive failures for the probe to be considered failed after having succeeded.
Defaults to 3. Minimum value is 1. Format: int32 | false |
grpc | object | GRPC specifies a GRPC HealthCheckRequest. | false |
httpGet | object | HTTPGet specifies an HTTP GET request to perform. | false |
initialDelaySeconds | integer | Number of seconds after the container has started before liveness probes are initiated.
More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes Format: int32 | false |
periodSeconds | integer | How often (in seconds) to perform the probe.
Default to 10 seconds. Minimum value is 1. Format: int32 | false |
successThreshold | integer | Minimum consecutive successes for the probe to be considered successful after having failed.
Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. Format: int32 | false |
tcpSocket | object | TCPSocket specifies a connection to a TCP port. | false |
terminationGracePeriodSeconds | integer | Optional duration in seconds the pod needs to terminate gracefully upon probe failure.
The grace period is the duration in seconds after the processes running in the pod are sent
a termination signal and the time when the processes are forcibly halted with a kill signal.
Set this value longer than the expected cleanup time for your process.
If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this
value overrides the value provided by the pod spec.
Value must be non-negative integer. The value zero indicates stop immediately via
the kill signal (no opportunity to shut down).
This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate.
Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset. Format: int64 | false |
timeoutSeconds | integer | Number of seconds after which the probe times out.
Defaults to 1 second. Minimum value is 1.
More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes Format: int32 | false |
Grafana.spec.deployment.spec.template.spec.initContainers[index].livenessProbe.exec
Exec specifies a command to execute in the container.
Name | Type | Description | Required |
---|---|---|---|
command | []string | Command is the command line to execute inside the container, the working directory for the
command is root ('/') in the container's filesystem. The command is simply exec'd, it is
not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use
a shell, you need to explicitly call out to that shell.
Exit status of 0 is treated as live/healthy and non-zero is unhealthy. | false |
Grafana.spec.deployment.spec.template.spec.initContainers[index].livenessProbe.grpc
GRPC specifies a GRPC HealthCheckRequest.
Name | Type | Description | Required |
---|---|---|---|
port | integer | Port number of the gRPC service. Number must be in the range 1 to 65535. Format: int32 | true |
service | string | Service is the name of the service to place in the gRPC HealthCheckRequest
(see https://github.com/grpc/grpc/blob/master/doc/health-checking.md). If this is not specified, the default behavior is defined by gRPC. | false |
Grafana.spec.deployment.spec.template.spec.initContainers[index].livenessProbe.httpGet
HTTPGet specifies an HTTP GET request to perform.
Name | Type | Description | Required |
---|---|---|---|
port | int or string | Name or number of the port to access on the container.
Number must be in the range 1 to 65535.
Name must be an IANA_SVC_NAME. | true |
host | string | Host name to connect to, defaults to the pod IP. You probably want to set
"Host" in httpHeaders instead. | false |
httpHeaders | []object | Custom headers to set in the request. HTTP allows repeated headers. | false |
path | string | Path to access on the HTTP server. | false |
scheme | string | Scheme to use for connecting to the host.
Defaults to HTTP. | false |
Grafana.spec.deployment.spec.template.spec.initContainers[index].livenessProbe.httpGet.httpHeaders[index]
HTTPHeader describes a custom header to be used in HTTP probes
Name | Type | Description | Required |
---|---|---|---|
name | string | The header field name.
This will be canonicalized upon output, so case-variant names will be understood as the same header. | true |
value | string | The header field value | true |
Grafana.spec.deployment.spec.template.spec.initContainers[index].livenessProbe.tcpSocket
TCPSocket specifies a connection to a TCP port.
Name | Type | Description | Required |
---|---|---|---|
port | int or string | Number or name of the port to access on the container.
Number must be in the range 1 to 65535.
Name must be an IANA_SVC_NAME. | true |
host | string | Optional: Host name to connect to, defaults to the pod IP. | false |
Grafana.spec.deployment.spec.template.spec.initContainers[index].ports[index]
ContainerPort represents a network port in a single container.
Name | Type | Description | Required |
---|---|---|---|
containerPort | integer | Number of port to expose on the pod's IP address.
This must be a valid port number, 0 < x < 65536. Format: int32 | true |
hostIP | string | What host IP to bind the external port to. | false |
hostPort | integer | Number of port to expose on the host.
If specified, this must be a valid port number, 0 < x < 65536.
If HostNetwork is specified, this must match ContainerPort.
Most containers do not need this. Format: int32 | false |
name | string | If specified, this must be an IANA_SVC_NAME and unique within the pod. Each
named port in a pod must have a unique name. Name for the port that can be
referred to by services. | false |
protocol | string | Protocol for port. Must be UDP, TCP, or SCTP.
Defaults to "TCP". Default: TCP | false |
Grafana.spec.deployment.spec.template.spec.initContainers[index].readinessProbe
Periodic probe of container service readiness. Container will be removed from service endpoints if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
Name | Type | Description | Required |
---|---|---|---|
exec | object | Exec specifies a command to execute in the container. | false |
failureThreshold | integer | Minimum consecutive failures for the probe to be considered failed after having succeeded.
Defaults to 3. Minimum value is 1. Format: int32 | false |
grpc | object | GRPC specifies a GRPC HealthCheckRequest. | false |
httpGet | object | HTTPGet specifies an HTTP GET request to perform. | false |
initialDelaySeconds | integer | Number of seconds after the container has started before liveness probes are initiated.
More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes Format: int32 | false |
periodSeconds | integer | How often (in seconds) to perform the probe.
Default to 10 seconds. Minimum value is 1. Format: int32 | false |
successThreshold | integer | Minimum consecutive successes for the probe to be considered successful after having failed.
Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. Format: int32 | false |
tcpSocket | object | TCPSocket specifies a connection to a TCP port. | false |
terminationGracePeriodSeconds | integer | Optional duration in seconds the pod needs to terminate gracefully upon probe failure.
The grace period is the duration in seconds after the processes running in the pod are sent
a termination signal and the time when the processes are forcibly halted with a kill signal.
Set this value longer than the expected cleanup time for your process.
If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this
value overrides the value provided by the pod spec.
Value must be non-negative integer. The value zero indicates stop immediately via
the kill signal (no opportunity to shut down).
This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate.
Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset. Format: int64 | false |
timeoutSeconds | integer | Number of seconds after which the probe times out.
Defaults to 1 second. Minimum value is 1.
More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes Format: int32 | false |
Grafana.spec.deployment.spec.template.spec.initContainers[index].readinessProbe.exec
Exec specifies a command to execute in the container.
Name | Type | Description | Required |
---|---|---|---|
command | []string | Command is the command line to execute inside the container, the working directory for the
command is root ('/') in the container's filesystem. The command is simply exec'd, it is
not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use
a shell, you need to explicitly call out to that shell.
Exit status of 0 is treated as live/healthy and non-zero is unhealthy. | false |
Grafana.spec.deployment.spec.template.spec.initContainers[index].readinessProbe.grpc
GRPC specifies a GRPC HealthCheckRequest.
Name | Type | Description | Required |
---|---|---|---|
port | integer | Port number of the gRPC service. Number must be in the range 1 to 65535. Format: int32 | true |
service | string | Service is the name of the service to place in the gRPC HealthCheckRequest
(see https://github.com/grpc/grpc/blob/master/doc/health-checking.md). If this is not specified, the default behavior is defined by gRPC. | false |
Grafana.spec.deployment.spec.template.spec.initContainers[index].readinessProbe.httpGet
HTTPGet specifies an HTTP GET request to perform.
Name | Type | Description | Required |
---|---|---|---|
port | int or string | Name or number of the port to access on the container.
Number must be in the range 1 to 65535.
Name must be an IANA_SVC_NAME. | true |
host | string | Host name to connect to, defaults to the pod IP. You probably want to set
"Host" in httpHeaders instead. | false |
httpHeaders | []object | Custom headers to set in the request. HTTP allows repeated headers. | false |
path | string | Path to access on the HTTP server. | false |
scheme | string | Scheme to use for connecting to the host.
Defaults to HTTP. | false |
Grafana.spec.deployment.spec.template.spec.initContainers[index].readinessProbe.httpGet.httpHeaders[index]
HTTPHeader describes a custom header to be used in HTTP probes
Name | Type | Description | Required |
---|---|---|---|
name | string | The header field name.
This will be canonicalized upon output, so case-variant names will be understood as the same header. | true |
value | string | The header field value | true |
Grafana.spec.deployment.spec.template.spec.initContainers[index].readinessProbe.tcpSocket
TCPSocket specifies a connection to a TCP port.
Name | Type | Description | Required |
---|---|---|---|
port | int or string | Number or name of the port to access on the container.
Number must be in the range 1 to 65535.
Name must be an IANA_SVC_NAME. | true |
host | string | Optional: Host name to connect to, defaults to the pod IP. | false |
Grafana.spec.deployment.spec.template.spec.initContainers[index].resizePolicy[index]
ContainerResizePolicy represents resource resize policy for the container.
Name | Type | Description | Required |
---|---|---|---|
resourceName | string | Name of the resource to which this resource resize policy applies.
Supported values: cpu, memory. | true |
restartPolicy | string | Restart policy to apply when specified resource is resized.
If not specified, it defaults to NotRequired. | true |
Grafana.spec.deployment.spec.template.spec.initContainers[index].resources
Compute Resources required by this container. Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
Name | Type | Description | Required |
---|---|---|---|
claims | []object | Claims lists the names of resources, defined in spec.resourceClaims,
that are used by this container. This is an alpha field and requires enabling the DynamicResourceAllocation feature gate. This field is immutable. It can only be set for containers. | false |
limits | map[string]int or string | Limits describes the maximum amount of compute resources allowed.
More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ | false |
requests | map[string]int or string | Requests describes the minimum amount of compute resources required.
If Requests is omitted for a container, it defaults to Limits if that is explicitly specified,
otherwise to an implementation-defined value. Requests cannot exceed Limits.
More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ | false |
Grafana.spec.deployment.spec.template.spec.initContainers[index].resources.claims[index]
ResourceClaim references one entry in PodSpec.ResourceClaims.
Name | Type | Description | Required |
---|---|---|---|
name | string | Name must match the name of one entry in pod.spec.resourceClaims of
the Pod where this field is used. It makes that resource available
inside a container. | true |
request | string | Request is the name chosen for a request in the referenced claim.
If empty, everything from the claim is made available, otherwise
only the result of this request. | false |
Grafana.spec.deployment.spec.template.spec.initContainers[index].securityContext
SecurityContext defines the security options the container should be run with. If set, the fields of SecurityContext override the equivalent fields of PodSecurityContext. More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/
Name | Type | Description | Required |
---|---|---|---|
allowPrivilegeEscalation | boolean | AllowPrivilegeEscalation controls whether a process can gain more
privileges than its parent process. This bool directly controls if
the no_new_privs flag will be set on the container process.
AllowPrivilegeEscalation is true always when the container is:
1) run as Privileged
2) has CAP_SYS_ADMIN
Note that this field cannot be set when spec.os.name is windows. | false |
appArmorProfile | object | appArmorProfile is the AppArmor options to use by this container. If set, this profile
overrides the pod's appArmorProfile.
Note that this field cannot be set when spec.os.name is windows. | false |
capabilities | object | The capabilities to add/drop when running containers.
Defaults to the default set of capabilities granted by the container runtime.
Note that this field cannot be set when spec.os.name is windows. | false |
privileged | boolean | Run container in privileged mode.
Processes in privileged containers are essentially equivalent to root on the host.
Defaults to false.
Note that this field cannot be set when spec.os.name is windows. | false |
procMount | string | procMount denotes the type of proc mount to use for the containers.
The default value is Default which uses the container runtime defaults for
readonly paths and masked paths.
This requires the ProcMountType feature flag to be enabled.
Note that this field cannot be set when spec.os.name is windows. | false |
readOnlyRootFilesystem | boolean | Whether this container has a read-only root filesystem.
Default is false.
Note that this field cannot be set when spec.os.name is windows. | false |
runAsGroup | integer | The GID to run the entrypoint of the container process.
Uses runtime default if unset.
May also be set in PodSecurityContext. If set in both SecurityContext and
PodSecurityContext, the value specified in SecurityContext takes precedence.
Note that this field cannot be set when spec.os.name is windows. Format: int64 | false |
runAsNonRoot | boolean | Indicates that the container must run as a non-root user.
If true, the Kubelet will validate the image at runtime to ensure that it
does not run as UID 0 (root) and fail to start the container if it does.
If unset or false, no such validation will be performed.
May also be set in PodSecurityContext. If set in both SecurityContext and
PodSecurityContext, the value specified in SecurityContext takes precedence. | false |
runAsUser | integer | The UID to run the entrypoint of the container process.
Defaults to user specified in image metadata if unspecified.
May also be set in PodSecurityContext. If set in both SecurityContext and
PodSecurityContext, the value specified in SecurityContext takes precedence.
Note that this field cannot be set when spec.os.name is windows. Format: int64 | false |
seLinuxOptions | object | The SELinux context to be applied to the container.
If unspecified, the container runtime will allocate a random SELinux context for each
container. May also be set in PodSecurityContext. If set in both SecurityContext and
PodSecurityContext, the value specified in SecurityContext takes precedence.
Note that this field cannot be set when spec.os.name is windows. | false |
seccompProfile | object | The seccomp options to use by this container. If seccomp options are
provided at both the pod & container level, the container options
override the pod options.
Note that this field cannot be set when spec.os.name is windows. | false |
windowsOptions | object | The Windows specific settings applied to all containers.
If unspecified, the options from the PodSecurityContext will be used.
If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.
Note that this field cannot be set when spec.os.name is linux. | false |
Grafana.spec.deployment.spec.template.spec.initContainers[index].securityContext.appArmorProfile
appArmorProfile is the AppArmor options to use by this container. If set, this profile overrides the pod’s appArmorProfile. Note that this field cannot be set when spec.os.name is windows.
Name | Type | Description | Required |
---|---|---|---|
type | string | type indicates which kind of AppArmor profile will be applied.
Valid options are:
Localhost - a profile pre-loaded on the node.
RuntimeDefault - the container runtime's default profile.
Unconfined - no AppArmor enforcement. | true |
localhostProfile | string | localhostProfile indicates a profile loaded on the node that should be used.
The profile must be preconfigured on the node to work.
Must match the loaded name of the profile.
Must be set if and only if type is "Localhost". | false |
Grafana.spec.deployment.spec.template.spec.initContainers[index].securityContext.capabilities
The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime. Note that this field cannot be set when spec.os.name is windows.
Name | Type | Description | Required |
---|---|---|---|
add | []string | Added capabilities | false |
drop | []string | Removed capabilities | false |
Grafana.spec.deployment.spec.template.spec.initContainers[index].securityContext.seLinuxOptions
The SELinux context to be applied to the container. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows.
Name | Type | Description | Required |
---|---|---|---|
level | string | Level is SELinux level label that applies to the container. | false |
role | string | Role is a SELinux role label that applies to the container. | false |
type | string | Type is a SELinux type label that applies to the container. | false |
user | string | User is a SELinux user label that applies to the container. | false |
Grafana.spec.deployment.spec.template.spec.initContainers[index].securityContext.seccompProfile
The seccomp options to use by this container. If seccomp options are provided at both the pod & container level, the container options override the pod options. Note that this field cannot be set when spec.os.name is windows.
Name | Type | Description | Required |
---|---|---|---|
type | string | type indicates which kind of seccomp profile will be applied.
Valid options are: Localhost - a profile defined in a file on the node should be used.
RuntimeDefault - the container runtime default profile should be used.
Unconfined - no profile should be applied. | true |
localhostProfile | string | localhostProfile indicates a profile defined in a file on the node should be used.
The profile must be preconfigured on the node to work.
Must be a descending path, relative to the kubelet’s configured seccomp profile location.
Must be set if type is “Localhost”. Must NOT be set for any other type. | false |
Grafana.spec.deployment.spec.template.spec.initContainers[index].securityContext.windowsOptions
The Windows specific settings applied to all containers. If unspecified, the options from the PodSecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is linux.
Name | Type | Description | Required |
---|---|---|---|
gmsaCredentialSpec | string | GMSACredentialSpec is where the GMSA admission webhook
(https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the
GMSA credential spec named by the GMSACredentialSpecName field. | false |
gmsaCredentialSpecName | string | GMSACredentialSpecName is the name of the GMSA credential spec to use. | false |
hostProcess | boolean | HostProcess determines if a container should be run as a 'Host Process' container.
All of a Pod's containers must have the same effective HostProcess value
(it is not allowed to have a mix of HostProcess containers and non-HostProcess containers).
In addition, if HostProcess is true then HostNetwork must also be set to true. | false |
runAsUserName | string | The UserName in Windows to run the entrypoint of the container process.
Defaults to the user specified in image metadata if unspecified.
May also be set in PodSecurityContext. If set in both SecurityContext and
PodSecurityContext, the value specified in SecurityContext takes precedence. | false |
Grafana.spec.deployment.spec.template.spec.initContainers[index].startupProbe
StartupProbe indicates that the Pod has successfully initialized. If specified, no other probes are executed until this completes successfully. If this probe fails, the Pod will be restarted, just as if the livenessProbe failed. This can be used to provide different probe parameters at the beginning of a Pod’s lifecycle, when it might take a long time to load data or warm a cache, than during steady-state operation. This cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
Name | Type | Description | Required |
---|---|---|---|
exec | object | Exec specifies a command to execute in the container. | false |
failureThreshold | integer | Minimum consecutive failures for the probe to be considered failed after having succeeded.
Defaults to 3. Minimum value is 1. Format: int32 | false |
grpc | object | GRPC specifies a GRPC HealthCheckRequest. | false |
httpGet | object | HTTPGet specifies an HTTP GET request to perform. | false |
initialDelaySeconds | integer | Number of seconds after the container has started before liveness probes are initiated.
More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes Format: int32 | false |
periodSeconds | integer | How often (in seconds) to perform the probe.
Default to 10 seconds. Minimum value is 1. Format: int32 | false |
successThreshold | integer | Minimum consecutive successes for the probe to be considered successful after having failed.
Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. Format: int32 | false |
tcpSocket | object | TCPSocket specifies a connection to a TCP port. | false |
terminationGracePeriodSeconds | integer | Optional duration in seconds the pod needs to terminate gracefully upon probe failure.
The grace period is the duration in seconds after the processes running in the pod are sent
a termination signal and the time when the processes are forcibly halted with a kill signal.
Set this value longer than the expected cleanup time for your process.
If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this
value overrides the value provided by the pod spec.
Value must be non-negative integer. The value zero indicates stop immediately via
the kill signal (no opportunity to shut down).
This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate.
Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset. Format: int64 | false |
timeoutSeconds | integer | Number of seconds after which the probe times out.
Defaults to 1 second. Minimum value is 1.
More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes Format: int32 | false |
Grafana.spec.deployment.spec.template.spec.initContainers[index].startupProbe.exec
Exec specifies a command to execute in the container.
Name | Type | Description | Required |
---|---|---|---|
command | []string | Command is the command line to execute inside the container, the working directory for the
command is root ('/') in the container's filesystem. The command is simply exec'd, it is
not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use
a shell, you need to explicitly call out to that shell.
Exit status of 0 is treated as live/healthy and non-zero is unhealthy. | false |
Grafana.spec.deployment.spec.template.spec.initContainers[index].startupProbe.grpc
GRPC specifies a GRPC HealthCheckRequest.
Name | Type | Description | Required |
---|---|---|---|
port | integer | Port number of the gRPC service. Number must be in the range 1 to 65535. Format: int32 | true |
service | string | Service is the name of the service to place in the gRPC HealthCheckRequest
(see https://github.com/grpc/grpc/blob/master/doc/health-checking.md). If this is not specified, the default behavior is defined by gRPC. | false |
Grafana.spec.deployment.spec.template.spec.initContainers[index].startupProbe.httpGet
HTTPGet specifies an HTTP GET request to perform.
Name | Type | Description | Required |
---|---|---|---|
port | int or string | Name or number of the port to access on the container.
Number must be in the range 1 to 65535.
Name must be an IANA_SVC_NAME. | true |
host | string | Host name to connect to, defaults to the pod IP. You probably want to set
"Host" in httpHeaders instead. | false |
httpHeaders | []object | Custom headers to set in the request. HTTP allows repeated headers. | false |
path | string | Path to access on the HTTP server. | false |
scheme | string | Scheme to use for connecting to the host.
Defaults to HTTP. | false |
Grafana.spec.deployment.spec.template.spec.initContainers[index].startupProbe.httpGet.httpHeaders[index]
HTTPHeader describes a custom header to be used in HTTP probes
Name | Type | Description | Required |
---|---|---|---|
name | string | The header field name.
This will be canonicalized upon output, so case-variant names will be understood as the same header. | true |
value | string | The header field value | true |
Grafana.spec.deployment.spec.template.spec.initContainers[index].startupProbe.tcpSocket
TCPSocket specifies a connection to a TCP port.
Name | Type | Description | Required |
---|---|---|---|
port | int or string | Number or name of the port to access on the container.
Number must be in the range 1 to 65535.
Name must be an IANA_SVC_NAME. | true |
host | string | Optional: Host name to connect to, defaults to the pod IP. | false |
Grafana.spec.deployment.spec.template.spec.initContainers[index].volumeDevices[index]
volumeDevice describes a mapping of a raw block device within a container.
Name | Type | Description | Required |
---|---|---|---|
devicePath | string | devicePath is the path inside of the container that the device will be mapped to. | true |
name | string | name must match the name of a persistentVolumeClaim in the pod | true |
Grafana.spec.deployment.spec.template.spec.initContainers[index].volumeMounts[index]
VolumeMount describes a mounting of a Volume within a container.
Name | Type | Description | Required |
---|---|---|---|
mountPath | string | Path within the container at which the volume should be mounted. Must
not contain ':'. | true |
name | string | This must match the Name of a Volume. | true |
mountPropagation | string | mountPropagation determines how mounts are propagated from the host
to container and the other way around.
When not set, MountPropagationNone is used.
This field is beta in 1.10.
When RecursiveReadOnly is set to IfPossible or to Enabled, MountPropagation must be None or unspecified
(which defaults to None). | false |
readOnly | boolean | Mounted read-only if true, read-write otherwise (false or unspecified).
Defaults to false. | false |
recursiveReadOnly | string | RecursiveReadOnly specifies whether read-only mounts should be handled
recursively. If ReadOnly is false, this field has no meaning and must be unspecified. If ReadOnly is true, and this field is set to Disabled, the mount is not made recursively read-only. If this field is set to IfPossible, the mount is made recursively read-only, if it is supported by the container runtime. If this field is set to Enabled, the mount is made recursively read-only if it is supported by the container runtime, otherwise the pod will not be started and an error will be generated to indicate the reason. If this field is set to IfPossible or Enabled, MountPropagation must be set to None (or be unspecified, which defaults to None). If this field is not specified, it is treated as an equivalent of Disabled. | false |
subPath | string | Path within the volume from which the container’s volume should be mounted.
Defaults to "" (volume’s root). | false |
subPathExpr | string | Expanded path within the volume from which the container’s volume should be mounted.
Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container’s environment.
Defaults to "" (volume’s root).
SubPathExpr and SubPath are mutually exclusive. | false |
Grafana.spec.deployment.spec.template.spec.os
Specifies the OS of the containers in the pod. Some pod and container fields are restricted if this is set.
If the OS field is set to linux, the following fields must be unset: -securityContext.windowsOptions
If the OS field is set to windows, following fields must be unset:
- spec.hostPID
- spec.hostIPC
- spec.hostUsers
- spec.securityContext.seLinuxOptions
- spec.securityContext.seccompProfile
- spec.securityContext.fsGroup
- spec.securityContext.fsGroupChangePolicy
- spec.securityContext.sysctls
- spec.shareProcessNamespace
- spec.securityContext.runAsUser
- spec.securityContext.runAsGroup
- spec.securityContext.supplementalGroups
- spec.containers[*].securityContext.seLinuxOptions
- spec.containers[*].securityContext.seccompProfile
- spec.containers[*].securityContext.capabilities
- spec.containers[*].securityContext.readOnlyRootFilesystem
- spec.containers[*].securityContext.privileged
- spec.containers[*].securityContext.allowPrivilegeEscalation
- spec.containers[*].securityContext.procMount
- spec.containers[*].securityContext.runAsUser
- spec.containers[*].securityContext.runAsGroup
Name | Type | Description | Required |
---|---|---|---|
name | string | Name is the name of the operating system. The currently supported values are linux and windows.
Additional value may be defined in future and can be one of:
https://github.com/opencontainers/runtime-spec/blob/master/config.md#platform-specific-configuration
Clients should expect to handle additional values and treat unrecognized values in this field as os: null | true |
Grafana.spec.deployment.spec.template.spec.readinessGates[index]
PodReadinessGate contains the reference to a pod condition
Name | Type | Description | Required |
---|---|---|---|
conditionType | string | ConditionType refers to a condition in the pod's condition list with matching type. | true |
Grafana.spec.deployment.spec.template.spec.securityContext
SecurityContext holds pod-level security attributes and common container settings. Optional: Defaults to empty. See type description for default values of each field.
Name | Type | Description | Required |
---|---|---|---|
appArmorProfile | object | appArmorProfile is the AppArmor options to use by the containers in this pod.
Note that this field cannot be set when spec.os.name is windows. | false |
fsGroup | integer | A special supplemental group that applies to all containers in a pod.
Some volume types allow the Kubelet to change the ownership of that volume
to be owned by the pod:
If unset, the Kubelet will not modify the ownership and permissions of any volume.
Note that this field cannot be set when spec.os.name is windows. | false |
fsGroupChangePolicy | string | fsGroupChangePolicy defines behavior of changing ownership and permission of the volume
before being exposed inside Pod. This field will only apply to
volume types which support fsGroup based ownership(and permissions).
It will have no effect on ephemeral volume types such as: secret, configmaps
and emptydir.
Valid values are “OnRootMismatch” and “Always”. If not specified, “Always” is used.
Note that this field cannot be set when spec.os.name is windows. | false |
runAsGroup | integer | The GID to run the entrypoint of the container process.
Uses runtime default if unset.
May also be set in SecurityContext. If set in both SecurityContext and
PodSecurityContext, the value specified in SecurityContext takes precedence
for that container.
Note that this field cannot be set when spec.os.name is windows. Format: int64 | false |
runAsNonRoot | boolean | Indicates that the container must run as a non-root user.
If true, the Kubelet will validate the image at runtime to ensure that it
does not run as UID 0 (root) and fail to start the container if it does.
If unset or false, no such validation will be performed.
May also be set in SecurityContext. If set in both SecurityContext and
PodSecurityContext, the value specified in SecurityContext takes precedence. | false |
runAsUser | integer | The UID to run the entrypoint of the container process.
Defaults to user specified in image metadata if unspecified.
May also be set in SecurityContext. If set in both SecurityContext and
PodSecurityContext, the value specified in SecurityContext takes precedence
for that container.
Note that this field cannot be set when spec.os.name is windows. Format: int64 | false |
seLinuxChangePolicy | string | seLinuxChangePolicy defines how the container’s SELinux label is applied to all volumes used by the Pod.
It has no effect on nodes that do not support SELinux or to volumes does not support SELinux.
Valid values are “MountOption” and “Recursive”. “Recursive” means relabeling of all files on all Pod volumes by the container runtime. This may be slow for large volumes, but allows mixing privileged and unprivileged Pods sharing the same volume on the same node. “MountOption” mounts all eligible Pod volumes with If not specified and SELinuxMount feature gate is enabled, “MountOption” is used. If not specified and SELinuxMount feature gate is disabled, “MountOption” is used for ReadWriteOncePod volumes and “Recursive” for all other volumes. This field affects only Pods that have SELinux label set, either in PodSecurityContext or in SecurityContext of all containers. All Pods that use the same volume should use the same seLinuxChangePolicy, otherwise some pods can get stuck in ContainerCreating state.
Note that this field cannot be set when spec.os.name is windows. | false |
seLinuxOptions | object | The SELinux context to be applied to all containers.
If unspecified, the container runtime will allocate a random SELinux context for each
container. May also be set in SecurityContext. If set in
both SecurityContext and PodSecurityContext, the value specified in SecurityContext
takes precedence for that container.
Note that this field cannot be set when spec.os.name is windows. | false |
seccompProfile | object | The seccomp options to use by the containers in this pod.
Note that this field cannot be set when spec.os.name is windows. | false |
supplementalGroups | []integer | A list of groups applied to the first process run in each container, in
addition to the container’s primary GID and fsGroup (if specified). If
the SupplementalGroupsPolicy feature is enabled, the
supplementalGroupsPolicy field determines whether these are in addition
to or instead of any group memberships defined in the container image.
If unspecified, no additional groups are added, though group memberships
defined in the container image may still be used, depending on the
supplementalGroupsPolicy field.
Note that this field cannot be set when spec.os.name is windows. | false |
supplementalGroupsPolicy | string | Defines how supplemental groups of the first container processes are calculated.
Valid values are “Merge” and “Strict”. If not specified, “Merge” is used.
(Alpha) Using the field requires the SupplementalGroupsPolicy feature gate to be enabled
and the container runtime must implement support for this feature.
Note that this field cannot be set when spec.os.name is windows. | false |
sysctls | []object | Sysctls hold a list of namespaced sysctls used for the pod. Pods with unsupported
sysctls (by the container runtime) might fail to launch.
Note that this field cannot be set when spec.os.name is windows. | false |
windowsOptions | object | The Windows specific settings applied to all containers.
If unspecified, the options within a container’s SecurityContext will be used.
If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.
Note that this field cannot be set when spec.os.name is linux. | false |
Grafana.spec.deployment.spec.template.spec.securityContext.appArmorProfile
appArmorProfile is the AppArmor options to use by the containers in this pod. Note that this field cannot be set when spec.os.name is windows.
Name | Type | Description | Required |
---|---|---|---|
type | string | type indicates which kind of AppArmor profile will be applied.
Valid options are:
Localhost - a profile pre-loaded on the node.
RuntimeDefault - the container runtime's default profile.
Unconfined - no AppArmor enforcement. | true |
localhostProfile | string | localhostProfile indicates a profile loaded on the node that should be used.
The profile must be preconfigured on the node to work.
Must match the loaded name of the profile.
Must be set if and only if type is "Localhost". | false |
Grafana.spec.deployment.spec.template.spec.securityContext.seLinuxOptions
The SELinux context to be applied to all containers. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container. Note that this field cannot be set when spec.os.name is windows.
Name | Type | Description | Required |
---|---|---|---|
level | string | Level is SELinux level label that applies to the container. | false |
role | string | Role is a SELinux role label that applies to the container. | false |
type | string | Type is a SELinux type label that applies to the container. | false |
user | string | User is a SELinux user label that applies to the container. | false |
Grafana.spec.deployment.spec.template.spec.securityContext.seccompProfile
The seccomp options to use by the containers in this pod. Note that this field cannot be set when spec.os.name is windows.
Name | Type | Description | Required |
---|---|---|---|
type | string | type indicates which kind of seccomp profile will be applied.
Valid options are: Localhost - a profile defined in a file on the node should be used.
RuntimeDefault - the container runtime default profile should be used.
Unconfined - no profile should be applied. | true |
localhostProfile | string | localhostProfile indicates a profile defined in a file on the node should be used.
The profile must be preconfigured on the node to work.
Must be a descending path, relative to the kubelet’s configured seccomp profile location.
Must be set if type is “Localhost”. Must NOT be set for any other type. | false |
Grafana.spec.deployment.spec.template.spec.securityContext.sysctls[index]
Sysctl defines a kernel parameter to be set
Name | Type | Description | Required |
---|---|---|---|
name | string | Name of a property to set | true |
value | string | Value of a property to set | true |
Grafana.spec.deployment.spec.template.spec.securityContext.windowsOptions
The Windows specific settings applied to all containers. If unspecified, the options within a container’s SecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is linux.
Name | Type | Description | Required |
---|---|---|---|
gmsaCredentialSpec | string | GMSACredentialSpec is where the GMSA admission webhook
(https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the
GMSA credential spec named by the GMSACredentialSpecName field. | false |
gmsaCredentialSpecName | string | GMSACredentialSpecName is the name of the GMSA credential spec to use. | false |
hostProcess | boolean | HostProcess determines if a container should be run as a 'Host Process' container.
All of a Pod's containers must have the same effective HostProcess value
(it is not allowed to have a mix of HostProcess containers and non-HostProcess containers).
In addition, if HostProcess is true then HostNetwork must also be set to true. | false |
runAsUserName | string | The UserName in Windows to run the entrypoint of the container process.
Defaults to the user specified in image metadata if unspecified.
May also be set in PodSecurityContext. If set in both SecurityContext and
PodSecurityContext, the value specified in SecurityContext takes precedence. | false |
Grafana.spec.deployment.spec.template.spec.tolerations[index]
The pod this Toleration is attached to tolerates any taint that matches
the triple <key,value,effect> using the matching operator
Name | Type | Description | Required |
---|---|---|---|
effect | string | Effect indicates the taint effect to match. Empty means match all taint effects.
When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute. | false |
key | string | Key is the taint key that the toleration applies to. Empty means match all taint keys.
If the key is empty, operator must be Exists; this combination means to match all values and all keys. | false |
operator | string | Operator represents a key's relationship to the value.
Valid operators are Exists and Equal. Defaults to Equal.
Exists is equivalent to wildcard for value, so that a pod can
tolerate all taints of a particular category. | false |
tolerationSeconds | integer | TolerationSeconds represents the period of time the toleration (which must be
of effect NoExecute, otherwise this field is ignored) tolerates the taint. By default,
it is not set, which means tolerate the taint forever (do not evict). Zero and
negative values will be treated as 0 (evict immediately) by the system. Format: int64 | false |
value | string | Value is the taint value the toleration matches to.
If the operator is Exists, the value should be empty, otherwise just a regular string. | false |
Grafana.spec.deployment.spec.template.spec.topologySpreadConstraints[index]
TopologySpreadConstraint specifies how to spread matching pods among the given topology.
Name | Type | Description | Required |
---|---|---|---|
maxSkew | integer | MaxSkew describes the degree to which pods may be unevenly distributed.
When `whenUnsatisfiable=DoNotSchedule`, it is the maximum permitted difference
between the number of matching pods in the target topology and the global minimum.
The global minimum is the minimum number of matching pods in an eligible domain
or zero if the number of eligible domains is less than MinDomains.
For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same
labelSelector spread as 2/2/1:
In this case, the global minimum is 1.
| zone1 | zone2 | zone3 |
| P P | P P | P |
- if MaxSkew is 1, incoming pod can only be scheduled to zone3 to become 2/2/2;
scheduling it onto zone1(zone2) would make the ActualSkew(3-1) on zone1(zone2)
violate MaxSkew(1).
- if MaxSkew is 2, incoming pod can be scheduled onto any zone.
When `whenUnsatisfiable=ScheduleAnyway`, it is used to give higher precedence
to topologies that satisfy it.
It's a required field. Default value is 1 and 0 is not allowed. Format: int32 | true |
topologyKey | string | TopologyKey is the key of node labels. Nodes that have a label with this key
and identical values are considered to be in the same topology.
We consider each | true |
whenUnsatisfiable | string | WhenUnsatisfiable indicates how to deal with a pod if it doesn't satisfy
the spread constraint.
- DoNotSchedule (default) tells the scheduler not to schedule it.
- ScheduleAnyway tells the scheduler to schedule the pod in any location,
but giving higher precedence to topologies that would help reduce the
skew.
A constraint is considered "Unsatisfiable" for an incoming pod
if and only if every possible node assignment for that pod would violate
"MaxSkew" on some topology.
For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same
labelSelector spread as 3/1/1:
| zone1 | zone2 | zone3 |
| P P P | P | P |
If WhenUnsatisfiable is set to DoNotSchedule, incoming pod can only be scheduled
to zone2(zone3) to become 3/2/1(3/1/2) as ActualSkew(2-1) on zone2(zone3) satisfies
MaxSkew(1). In other words, the cluster can still be imbalanced, but scheduler
won't make it *more* imbalanced.
It's a required field. | true |
labelSelector | object | LabelSelector is used to find matching pods.
Pods that match this label selector are counted to determine the number of pods
in their corresponding topology domain. | false |
matchLabelKeys | []string | MatchLabelKeys is a set of pod label keys to select the pods over which
spreading will be calculated. The keys are used to lookup values from the
incoming pod labels, those key-value labels are ANDed with labelSelector
to select the group of existing pods over which spreading will be calculated
for the incoming pod. The same key is forbidden to exist in both MatchLabelKeys and LabelSelector.
MatchLabelKeys cannot be set when LabelSelector isn't set.
Keys that don't exist in the incoming pod labels will
be ignored. A null or empty list means only match against labelSelector. This is a beta field and requires the MatchLabelKeysInPodTopologySpread feature gate to be enabled (enabled by default). | false |
minDomains | integer | MinDomains indicates a minimum number of eligible domains.
When the number of eligible domains with matching topology keys is less than minDomains,
Pod Topology Spread treats “global minimum” as 0, and then the calculation of Skew is performed.
And when the number of eligible domains with matching topology keys equals or greater than minDomains,
this value has no effect on scheduling.
As a result, when the number of eligible domains is less than minDomains,
scheduler won’t schedule more than maxSkew Pods to those domains.
If value is nil, the constraint behaves as if MinDomains is equal to 1.
Valid values are integers greater than 0.
When value is not nil, WhenUnsatisfiable must be DoNotSchedule. For example, in a 3-zone cluster, MaxSkew is set to 2, MinDomains is set to 5 and pods with the same
labelSelector spread as 2/2/2:
| zone1 | zone2 | zone3 |
| P P | P P | P P |
The number of domains is less than 5(MinDomains), so “global minimum” is treated as 0.
In this situation, new pod with the same labelSelector cannot be scheduled,
because computed skew will be 3(3 - 0) if new Pod is scheduled to any of the three zones,
it will violate MaxSkew. | false |
nodeAffinityPolicy | string | NodeAffinityPolicy indicates how we will treat Pod’s nodeAffinity/nodeSelector
when calculating pod topology spread skew. Options are:
If this value is nil, the behavior is equivalent to the Honor policy.
This is a beta-level feature default enabled by the NodeInclusionPolicyInPodTopologySpread feature flag. | false |
nodeTaintsPolicy | string | NodeTaintsPolicy indicates how we will treat node taints when calculating
pod topology spread skew. Options are:
If this value is nil, the behavior is equivalent to the Ignore policy.
This is a beta-level feature default enabled by the NodeInclusionPolicyInPodTopologySpread feature flag. | false |
Grafana.spec.deployment.spec.template.spec.topologySpreadConstraints[index].labelSelector
LabelSelector is used to find matching pods. Pods that match this label selector are counted to determine the number of pods in their corresponding topology domain.
Name | Type | Description | Required |
---|---|---|---|
matchExpressions | []object | matchExpressions is a list of label selector requirements. The requirements are ANDed. | false |
matchLabels | map[string]string | 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. | false |
Grafana.spec.deployment.spec.template.spec.topologySpreadConstraints[index].labelSelector.matchExpressions[index]
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Name | Type | Description | Required |
---|---|---|---|
key | string | key is the label key that the selector applies to. | true |
operator | string | operator represents a key's relationship to a set of values.
Valid operators are In, NotIn, Exists and DoesNotExist. | true |
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. | false |
Grafana.spec.deployment.spec.template.spec.volumes[index]
Volume represents a named volume in a pod that may be accessed by any container in the pod.
Name | Type | Description | Required |
---|---|---|---|
name | string | name of the volume.
Must be a DNS_LABEL and unique within the pod.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names | true |
awsElasticBlockStore | object | awsElasticBlockStore represents an AWS Disk resource that is attached to a
kubelet's host machine and then exposed to the pod.
Deprecated: AWSElasticBlockStore is deprecated. All operations for the in-tree
awsElasticBlockStore type are redirected to the ebs.csi.aws.com CSI driver.
More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore | false |
azureDisk | object | azureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.
Deprecated: AzureDisk is deprecated. All operations for the in-tree azureDisk type
are redirected to the disk.csi.azure.com CSI driver. | false |
azureFile | object | azureFile represents an Azure File Service mount on the host and bind mount to the pod.
Deprecated: AzureFile is deprecated. All operations for the in-tree azureFile type
are redirected to the file.csi.azure.com CSI driver. | false |
cephfs | object | cephFS represents a Ceph FS mount on the host that shares a pod's lifetime.
Deprecated: CephFS is deprecated and the in-tree cephfs type is no longer supported. | false |
cinder | object | cinder represents a cinder volume attached and mounted on kubelets host machine.
Deprecated: Cinder is deprecated. All operations for the in-tree cinder type
are redirected to the cinder.csi.openstack.org CSI driver.
More info: https://examples.k8s.io/mysql-cinder-pd/README.md | false |
configMap | object | configMap represents a configMap that should populate this volume | false |
csi | object | csi (Container Storage Interface) represents ephemeral storage that is handled by certain external CSI drivers. | false |
downwardAPI | object | downwardAPI represents downward API about the pod that should populate this volume | false |
emptyDir | object | emptyDir represents a temporary directory that shares a pod's lifetime.
More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir | false |
ephemeral | object | ephemeral represents a volume that is handled by a cluster storage driver.
The volume's lifecycle is tied to the pod that defines it - it will be created before the pod starts,
and deleted when the pod is removed. Use this if: a) the volume is only needed while the pod runs, b) features of normal volumes like restoring from snapshot or capacity tracking are needed, c) the storage driver is specified through a storage class, and d) the storage driver supports dynamic volume provisioning through a PersistentVolumeClaim (see EphemeralVolumeSource for more information on the connection between this volume type and PersistentVolumeClaim). Use PersistentVolumeClaim or one of the vendor-specific APIs for volumes that persist for longer than the lifecycle of an individual pod. Use CSI for light-weight local ephemeral volumes if the CSI driver is meant to be used that way - see the documentation of the driver for more information. A pod can use both types of ephemeral volumes and
persistent volumes at the same time. | false |
fc | object | fc represents a Fibre Channel resource that is attached to a kubelet’s host machine and then exposed to the pod. | false |
flexVolume | object | flexVolume represents a generic volume resource that is
provisioned/attached using an exec based plugin.
Deprecated: FlexVolume is deprecated. Consider using a CSIDriver instead. | false |
flocker | object | flocker represents a Flocker volume attached to a kubelet’s host machine. This depends on the Flocker control service being running.
Deprecated: Flocker is deprecated and the in-tree flocker type is no longer supported. | false |
gcePersistentDisk | object | gcePersistentDisk represents a GCE Disk resource that is attached to a
kubelet’s host machine and then exposed to the pod.
Deprecated: GCEPersistentDisk is deprecated. All operations for the in-tree
gcePersistentDisk type are redirected to the pd.csi.storage.gke.io CSI driver.
More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk | false |
gitRepo | object | gitRepo represents a git repository at a particular revision.
Deprecated: GitRepo is deprecated. To provision a container with a git repo, mount an
EmptyDir into an InitContainer that clones the repo using git, then mount the EmptyDir
into the Pod’s container. | false |
glusterfs | object | glusterfs represents a Glusterfs mount on the host that shares a pod’s lifetime.
Deprecated: Glusterfs is deprecated and the in-tree glusterfs type is no longer supported.
More info: https://examples.k8s.io/volumes/glusterfs/README.md | false |
hostPath | object | hostPath represents a pre-existing file or directory on the host
machine that is directly exposed to the container. This is generally
used for system agents or other privileged things that are allowed
to see the host machine. Most containers will NOT need this.
More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath | false |
image | object | image represents an OCI object (a container image or artifact) pulled and mounted on the kubelet’s host machine.
The volume is resolved at pod startup depending on which PullPolicy value is provided:
The volume gets re-resolved if the pod gets deleted and recreated, which means that new remote content will become available on pod recreation.
A failure to resolve or pull the image during pod startup will block containers from starting and may add significant latency. Failures will be retried using normal volume backoff and will be reported on the pod reason and message.
The types of objects that may be mounted by this volume are defined by the container runtime implementation on a host machine and at minimum must include all valid types supported by the container image field.
The OCI object gets mounted in a single directory (spec.containers[].volumeMounts.mountPath) by merging the manifest layers in the same way as for container images.
The volume will be mounted read-only (ro) and non-executable files (noexec).
Sub path mounts for containers are not supported (spec.containers[].volumeMounts.subpath).
The field spec.securityContext.fsGroupChangePolicy has no effect on this volume type. | false |
iscsi | object | iscsi represents an ISCSI Disk resource that is attached to a
kubelet’s host machine and then exposed to the pod.
More info: https://examples.k8s.io/volumes/iscsi/README.md | false |
nfs | object | nfs represents an NFS mount on the host that shares a pod’s lifetime
More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs | false |
persistentVolumeClaim | object | persistentVolumeClaimVolumeSource represents a reference to a
PersistentVolumeClaim in the same namespace.
More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims | false |
photonPersistentDisk | object | photonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine.
Deprecated: PhotonPersistentDisk is deprecated and the in-tree photonPersistentDisk type is no longer supported. | false |
portworxVolume | object | portworxVolume represents a portworx volume attached and mounted on kubelets host machine.
Deprecated: PortworxVolume is deprecated. All operations for the in-tree portworxVolume type
are redirected to the pxd.portworx.com CSI driver when the CSIMigrationPortworx feature-gate
is on. | false |
projected | object | projected items for all in one resources secrets, configmaps, and downward API | false |
quobyte | object | quobyte represents a Quobyte mount on the host that shares a pod’s lifetime.
Deprecated: Quobyte is deprecated and the in-tree quobyte type is no longer supported. | false |
rbd | object | rbd represents a Rados Block Device mount on the host that shares a pod’s lifetime.
Deprecated: RBD is deprecated and the in-tree rbd type is no longer supported.
More info: https://examples.k8s.io/volumes/rbd/README.md | false |
scaleIO | object | scaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes.
Deprecated: ScaleIO is deprecated and the in-tree scaleIO type is no longer supported. | false |
secret | object | secret represents a secret that should populate this volume.
More info: https://kubernetes.io/docs/concepts/storage/volumes#secret | false |
storageos | object | storageOS represents a StorageOS volume attached and mounted on Kubernetes nodes.
Deprecated: StorageOS is deprecated and the in-tree storageos type is no longer supported. | false |
vsphereVolume | object | vsphereVolume represents a vSphere volume attached and mounted on kubelets host machine.
Deprecated: VsphereVolume is deprecated. All operations for the in-tree vsphereVolume type
are redirected to the csi.vsphere.vmware.com CSI driver. | false |
Grafana.spec.deployment.spec.template.spec.volumes[index].awsElasticBlockStore
awsElasticBlockStore represents an AWS Disk resource that is attached to a kubelet’s host machine and then exposed to the pod. Deprecated: AWSElasticBlockStore is deprecated. All operations for the in-tree awsElasticBlockStore type are redirected to the ebs.csi.aws.com CSI driver. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore
Name | Type | Description | Required |
---|---|---|---|
volumeID | string | volumeID is unique ID of the persistent disk resource in AWS (Amazon EBS volume).
More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore | true |
fsType | string | fsType is the filesystem type of the volume that you want to mount.
Tip: Ensure that the filesystem type is supported by the host operating system.
Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore | false |
partition | integer | partition is the partition in the volume that you want to mount.
If omitted, the default is to mount by volume name.
Examples: For volume /dev/sda1, you specify the partition as "1".
Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty). Format: int32 | false |
readOnly | boolean | readOnly value true will force the readOnly setting in VolumeMounts.
More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore | false |
Grafana.spec.deployment.spec.template.spec.volumes[index].azureDisk
azureDisk represents an Azure Data Disk mount on the host and bind mount to the pod. Deprecated: AzureDisk is deprecated. All operations for the in-tree azureDisk type are redirected to the disk.csi.azure.com CSI driver.
Name | Type | Description | Required |
---|---|---|---|
diskName | string | diskName is the Name of the data disk in the blob storage | true |
diskURI | string | diskURI is the URI of data disk in the blob storage | true |
cachingMode | string | cachingMode is the Host Caching mode: None, Read Only, Read Write. | false |
fsType | string | fsType is Filesystem type to mount.
Must be a filesystem type supported by the host operating system.
Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. Default: ext4 | false |
kind | string | kind expected values are Shared: multiple blob disks per storage account Dedicated: single blob disk per storage account Managed: azure managed data disk (only in managed availability set). defaults to shared | false |
readOnly | boolean | readOnly Defaults to false (read/write). ReadOnly here will force
the ReadOnly setting in VolumeMounts. Default: false | false |
Grafana.spec.deployment.spec.template.spec.volumes[index].azureFile
azureFile represents an Azure File Service mount on the host and bind mount to the pod. Deprecated: AzureFile is deprecated. All operations for the in-tree azureFile type are redirected to the file.csi.azure.com CSI driver.
Name | Type | Description | Required |
---|---|---|---|
secretName | string | secretName is the name of secret that contains Azure Storage Account Name and Key | true |
shareName | string | shareName is the azure share Name | true |
readOnly | boolean | readOnly defaults to false (read/write). ReadOnly here will force
the ReadOnly setting in VolumeMounts. | false |
Grafana.spec.deployment.spec.template.spec.volumes[index].cephfs
cephFS represents a Ceph FS mount on the host that shares a pod’s lifetime. Deprecated: CephFS is deprecated and the in-tree cephfs type is no longer supported.
Name | Type | Description | Required |
---|---|---|---|
monitors | []string | monitors is Required: Monitors is a collection of Ceph monitors
More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it | true |
path | string | path is Optional: Used as the mounted root, rather than the full Ceph tree, default is / | false |
readOnly | boolean | readOnly is Optional: Defaults to false (read/write). ReadOnly here will force
the ReadOnly setting in VolumeMounts.
More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it | false |
secretFile | string | secretFile is Optional: SecretFile is the path to key ring for User, default is /etc/ceph/user.secret
More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it | false |
secretRef | object | secretRef is Optional: SecretRef is reference to the authentication secret for User, default is empty.
More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it | false |
user | string | user is optional: User is the rados user name, default is admin
More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it | false |
Grafana.spec.deployment.spec.template.spec.volumes[index].cephfs.secretRef
secretRef is Optional: SecretRef is reference to the authentication secret for User, default is empty. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it
Name | Type | Description | Required |
---|---|---|---|
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 Default: | false |
Grafana.spec.deployment.spec.template.spec.volumes[index].cinder
cinder represents a cinder volume attached and mounted on kubelets host machine. Deprecated: Cinder is deprecated. All operations for the in-tree cinder type are redirected to the cinder.csi.openstack.org CSI driver. More info: https://examples.k8s.io/mysql-cinder-pd/README.md
Name | Type | Description | Required |
---|---|---|---|
volumeID | string | volumeID used to identify the volume in cinder.
More info: https://examples.k8s.io/mysql-cinder-pd/README.md | true |
fsType | string | fsType is the filesystem type to mount.
Must be a filesystem type supported by the host operating system.
Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
More info: https://examples.k8s.io/mysql-cinder-pd/README.md | false |
readOnly | boolean | readOnly defaults to false (read/write). ReadOnly here will force
the ReadOnly setting in VolumeMounts.
More info: https://examples.k8s.io/mysql-cinder-pd/README.md | false |
secretRef | object | secretRef is optional: points to a secret object containing parameters used to connect
to OpenStack. | false |
Grafana.spec.deployment.spec.template.spec.volumes[index].cinder.secretRef
secretRef is optional: points to a secret object containing parameters used to connect to OpenStack.
Name | Type | Description | Required |
---|---|---|---|
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 Default: | false |
Grafana.spec.deployment.spec.template.spec.volumes[index].configMap
configMap represents a configMap that should populate this volume
Name | Type | Description | Required |
---|---|---|---|
defaultMode | integer | defaultMode is optional: mode bits used to set permissions on created files by default.
Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511.
YAML accepts both octal and decimal values, JSON requires decimal values for mode bits.
Defaults to 0644.
Directories within the path are not affected by this setting.
This might be in conflict with other options that affect the file
mode, like fsGroup, and the result can be other mode bits set. Format: int32 | false |
items | []object | items if unspecified, each key-value pair in the Data field of the referenced
ConfigMap will be projected into the volume as a file whose name is the
key and content is the value. If specified, the listed keys will be
projected into the specified paths, and unlisted keys will not be
present. If a key is specified which is not present in the ConfigMap,
the volume setup will error unless it is marked optional. Paths must be
relative and may not contain the '..' path or start with '..'. | false |
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 Default: | false |
optional | boolean | optional specify whether the ConfigMap or its keys must be defined | false |
Grafana.spec.deployment.spec.template.spec.volumes[index].configMap.items[index]
Maps a string key to a path within a volume.
Name | Type | Description | Required |
---|---|---|---|
key | string | key is the key to project. | true |
path | string | path is the relative path of the file to map the key to.
May not be an absolute path.
May not contain the path element '..'.
May not start with the string '..'. | true |
mode | integer | mode is Optional: mode bits used to set permissions on this file.
Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511.
YAML accepts both octal and decimal values, JSON requires decimal values for mode bits.
If not specified, the volume defaultMode will be used.
This might be in conflict with other options that affect the file
mode, like fsGroup, and the result can be other mode bits set. Format: int32 | false |
Grafana.spec.deployment.spec.template.spec.volumes[index].csi
csi (Container Storage Interface) represents ephemeral storage that is handled by certain external CSI drivers.
Name | Type | Description | Required |
---|---|---|---|
driver | string | driver is the name of the CSI driver that handles this volume.
Consult with your admin for the correct name as registered in the cluster. | true |
fsType | string | fsType to mount. Ex. "ext4", "xfs", "ntfs".
If not provided, the empty value is passed to the associated CSI driver
which will determine the default filesystem to apply. | false |
nodePublishSecretRef | object | nodePublishSecretRef is a reference to the secret object containing
sensitive information to pass to the CSI driver to complete the CSI
NodePublishVolume and NodeUnpublishVolume calls.
This field is optional, and may be empty if no secret is required. If the
secret object contains more than one secret, all secret references are passed. | false |
readOnly | boolean | readOnly specifies a read-only configuration for the volume.
Defaults to false (read/write). | false |
volumeAttributes | map[string]string | volumeAttributes stores driver-specific properties that are passed to the CSI
driver. Consult your driver's documentation for supported values. | false |
Grafana.spec.deployment.spec.template.spec.volumes[index].csi.nodePublishSecretRef
nodePublishSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI NodePublishVolume and NodeUnpublishVolume calls. This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secret references are passed.
Name | Type | Description | Required |
---|---|---|---|
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 Default: | false |
Grafana.spec.deployment.spec.template.spec.volumes[index].downwardAPI
downwardAPI represents downward API about the pod that should populate this volume
Name | Type | Description | Required |
---|---|---|---|
defaultMode | integer | Optional: mode bits to use on created files by default. Must be a
Optional: mode bits used to set permissions on created files by default.
Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511.
YAML accepts both octal and decimal values, JSON requires decimal values for mode bits.
Defaults to 0644.
Directories within the path are not affected by this setting.
This might be in conflict with other options that affect the file
mode, like fsGroup, and the result can be other mode bits set. Format: int32 | false |
items | []object | Items is a list of downward API volume file | false |
Grafana.spec.deployment.spec.template.spec.volumes[index].downwardAPI.items[index]
DownwardAPIVolumeFile represents information to create the file containing the pod field
Name | Type | Description | Required |
---|---|---|---|
path | string | Required: Path is the relative path name of the file to be created. Must not be absolute or contain the '..' path. Must be utf-8 encoded. The first item of the relative path must not start with '..' | true |
fieldRef | object | Required: Selects a field of the pod: only annotations, labels, name, namespace and uid are supported. | false |
mode | integer | Optional: mode bits used to set permissions on this file, must be an octal value
between 0000 and 0777 or a decimal value between 0 and 511.
YAML accepts both octal and decimal values, JSON requires decimal values for mode bits.
If not specified, the volume defaultMode will be used.
This might be in conflict with other options that affect the file
mode, like fsGroup, and the result can be other mode bits set. Format: int32 | false |
resourceFieldRef | object | Selects a resource of the container: only resources limits and requests
(limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported. | false |
Grafana.spec.deployment.spec.template.spec.volumes[index].downwardAPI.items[index].fieldRef
Required: Selects a field of the pod: only annotations, labels, name, namespace and uid are supported.
Name | Type | Description | Required |
---|---|---|---|
fieldPath | string | Path of the field to select in the specified API version. | true |
apiVersion | string | Version of the schema the FieldPath is written in terms of, defaults to "v1". | false |
Grafana.spec.deployment.spec.template.spec.volumes[index].downwardAPI.items[index].resourceFieldRef
Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.
Name | Type | Description | Required |
---|---|---|---|
resource | string | Required: resource to select | true |
containerName | string | Container name: required for volumes, optional for env vars | false |
divisor | int or string | Specifies the output format of the exposed resources, defaults to "1" | false |
Grafana.spec.deployment.spec.template.spec.volumes[index].emptyDir
emptyDir represents a temporary directory that shares a pod’s lifetime. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir
Name | Type | Description | Required |
---|---|---|---|
medium | string | medium represents what type of storage medium should back this directory.
The default is "" which means to use the node's default medium.
Must be an empty string (default) or Memory.
More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir | false |
sizeLimit | int or string | sizeLimit is the total amount of local storage required for this EmptyDir volume.
The size limit is also applicable for memory medium.
The maximum usage on memory medium EmptyDir would be the minimum value between
the SizeLimit specified here and the sum of memory limits of all containers in a pod.
The default is nil which means that the limit is undefined.
More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir | false |
Grafana.spec.deployment.spec.template.spec.volumes[index].ephemeral
ephemeral represents a volume that is handled by a cluster storage driver. The volume’s lifecycle is tied to the pod that defines it - it will be created before the pod starts, and deleted when the pod is removed.
Use this if: a) the volume is only needed while the pod runs, b) features of normal volumes like restoring from snapshot or capacity tracking are needed, c) the storage driver is specified through a storage class, and d) the storage driver supports dynamic volume provisioning through a PersistentVolumeClaim (see EphemeralVolumeSource for more information on the connection between this volume type and PersistentVolumeClaim).
Use PersistentVolumeClaim or one of the vendor-specific APIs for volumes that persist for longer than the lifecycle of an individual pod.
Use CSI for light-weight local ephemeral volumes if the CSI driver is meant to be used that way - see the documentation of the driver for more information.
A pod can use both types of ephemeral volumes and persistent volumes at the same time.
Name | Type | Description | Required |
---|---|---|---|
volumeClaimTemplate | object | Will be used to create a stand-alone PVC to provision the volume.
The pod in which this EphemeralVolumeSource is embedded will be the
owner of the PVC, i.e. the PVC will be deleted together with the
pod. The name of the PVC will be ` An existing PVC with that name that is not owned by the pod will not be used for the pod to avoid using an unrelated volume by mistake. Starting the pod is then blocked until the unrelated PVC is removed. If such a pre-created PVC is meant to be used by the pod, the PVC has to updated with an owner reference to the pod once the pod exists. Normally this should not be necessary, but it may be useful when manually reconstructing a broken cluster. This field is read-only and no changes will be made by Kubernetes to the PVC after it has been created. Required, must not be nil. | false |
Grafana.spec.deployment.spec.template.spec.volumes[index].ephemeral.volumeClaimTemplate
Will be used to create a stand-alone PVC to provision the volume.
The pod in which this EphemeralVolumeSource is embedded will be the
owner of the PVC, i.e. the PVC will be deleted together with the
pod. The name of the PVC will be <pod name>-<volume name>
where
<volume name>
is the name from the PodSpec.Volumes
array
entry. Pod validation will reject the pod if the concatenated name
is not valid for a PVC (for example, too long).
An existing PVC with that name that is not owned by the pod will not be used for the pod to avoid using an unrelated volume by mistake. Starting the pod is then blocked until the unrelated PVC is removed. If such a pre-created PVC is meant to be used by the pod, the PVC has to updated with an owner reference to the pod once the pod exists. Normally this should not be necessary, but it may be useful when manually reconstructing a broken cluster.
This field is read-only and no changes will be made by Kubernetes to the PVC after it has been created.
Required, must not be nil.
Name | Type | Description | Required |
---|---|---|---|
spec | object | The specification for the PersistentVolumeClaim. The entire content is
copied unchanged into the PVC that gets created from this
template. The same fields as in a PersistentVolumeClaim
are also valid here. | true |
metadata | object | May contain labels and annotations that will be copied into the PVC
when creating it. No other fields are allowed and will be rejected during
validation. | false |
Grafana.spec.deployment.spec.template.spec.volumes[index].ephemeral.volumeClaimTemplate.spec
The specification for the PersistentVolumeClaim. The entire content is copied unchanged into the PVC that gets created from this template. The same fields as in a PersistentVolumeClaim are also valid here.
Name | Type | Description | Required |
---|---|---|---|
accessModes | []string | accessModes contains the desired access modes the volume should have.
More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1 | false |
dataSource | object | dataSource field can be used to specify either:
* An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot)
* An existing PVC (PersistentVolumeClaim)
If the provisioner or an external controller can support the specified data source,
it will create a new volume based on the contents of the specified data source.
When the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef,
and dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified.
If the namespace is specified, then dataSourceRef will not be copied to dataSource. | false |
dataSourceRef | object | dataSourceRef specifies the object from which to populate the volume with data, if a non-empty
volume is desired. This may be any object from a non-empty API group (non
core object) or a PersistentVolumeClaim object.
When this field is specified, volume binding will only succeed if the type of
the specified object matches some installed volume populator or dynamic
provisioner.
This field will replace the functionality of the dataSource field and as such
if both fields are non-empty, they must have the same value. For backwards
compatibility, when namespace isn't specified in dataSourceRef,
both fields (dataSource and dataSourceRef) will be set to the same
value automatically if one of them is empty and the other is non-empty.
When namespace is specified in dataSourceRef,
dataSource isn't set to the same value and must be empty.
There are three important differences between dataSource and dataSourceRef:
* While dataSource only allows two specific types of objects, dataSourceRef
allows any non-core object, as well as PersistentVolumeClaim objects.
* While dataSource ignores disallowed values (dropping them), dataSourceRef
preserves all values, and generates an error if a disallowed value is
specified.
* While dataSource only allows local objects, dataSourceRef allows objects
in any namespaces.
(Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled.
(Alpha) Using the namespace field of dataSourceRef requires the CrossNamespaceVolumeDataSource feature gate to be enabled. | false |
resources | object | resources represents the minimum resources the volume should have.
If RecoverVolumeExpansionFailure feature is enabled users are allowed to specify resource requirements
that are lower than previous value but must still be higher than capacity recorded in the
status field of the claim.
More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources | false |
selector | object | selector is a label query over volumes to consider for binding. | false |
storageClassName | string | storageClassName is the name of the StorageClass required by the claim.
More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1 | false |
volumeAttributesClassName | string | volumeAttributesClassName may be used to set the VolumeAttributesClass used by this claim.
If specified, the CSI driver will create or update the volume with the attributes defined
in the corresponding VolumeAttributesClass. This has a different purpose than storageClassName,
it can be changed after the claim is created. An empty string value means that no VolumeAttributesClass
will be applied to the claim but it's not allowed to reset this field to empty string once it is set.
If unspecified and the PersistentVolumeClaim is unbound, the default VolumeAttributesClass
will be set by the persistentvolume controller if it exists.
If the resource referred to by volumeAttributesClass does not exist, this PersistentVolumeClaim will be
set to a Pending state, as reflected by the modifyVolumeStatus field, until such as a resource
exists.
More info: https://kubernetes.io/docs/concepts/storage/volume-attributes-classes/
(Beta) Using this field requires the VolumeAttributesClass feature gate to be enabled (off by default). | false |
volumeMode | string | volumeMode defines what type of volume is required by the claim.
Value of Filesystem is implied when not included in claim spec. | false |
volumeName | string | volumeName is the binding reference to the PersistentVolume backing this claim. | false |
Grafana.spec.deployment.spec.template.spec.volumes[index].ephemeral.volumeClaimTemplate.spec.dataSource
dataSource field can be used to specify either:
- An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot)
- An existing PVC (PersistentVolumeClaim) If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source. When the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef, and dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified. If the namespace is specified, then dataSourceRef will not be copied to dataSource.
Name | Type | Description | Required |
---|---|---|---|
kind | string | Kind is the type of resource being referenced | true |
name | string | Name is the name of resource being referenced | true |
apiGroup | string | APIGroup is the group for the resource being referenced.
If APIGroup is not specified, the specified Kind must be in the core API group.
For any other third-party types, APIGroup is required. | false |
Grafana.spec.deployment.spec.template.spec.volumes[index].ephemeral.volumeClaimTemplate.spec.dataSourceRef
dataSourceRef specifies the object from which to populate the volume with data, if a non-empty volume is desired. This may be any object from a non-empty API group (non core object) or a PersistentVolumeClaim object. When this field is specified, volume binding will only succeed if the type of the specified object matches some installed volume populator or dynamic provisioner. This field will replace the functionality of the dataSource field and as such if both fields are non-empty, they must have the same value. For backwards compatibility, when namespace isn’t specified in dataSourceRef, both fields (dataSource and dataSourceRef) will be set to the same value automatically if one of them is empty and the other is non-empty. When namespace is specified in dataSourceRef, dataSource isn’t set to the same value and must be empty. There are three important differences between dataSource and dataSourceRef:
- While dataSource only allows two specific types of objects, dataSourceRef allows any non-core object, as well as PersistentVolumeClaim objects.
- While dataSource ignores disallowed values (dropping them), dataSourceRef preserves all values, and generates an error if a disallowed value is specified.
- While dataSource only allows local objects, dataSourceRef allows objects in any namespaces. (Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled. (Alpha) Using the namespace field of dataSourceRef requires the CrossNamespaceVolumeDataSource feature gate to be enabled.
Name | Type | Description | Required |
---|---|---|---|
kind | string | Kind is the type of resource being referenced | true |
name | string | Name is the name of resource being referenced | true |
apiGroup | string | APIGroup is the group for the resource being referenced.
If APIGroup is not specified, the specified Kind must be in the core API group.
For any other third-party types, APIGroup is required. | false |
namespace | string | Namespace is the namespace of resource being referenced
Note that when a namespace is specified, a gateway.networking.k8s.io/ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details.
(Alpha) This field requires the CrossNamespaceVolumeDataSource feature gate to be enabled. | false |
Grafana.spec.deployment.spec.template.spec.volumes[index].ephemeral.volumeClaimTemplate.spec.resources
resources represents the minimum resources the volume should have. If RecoverVolumeExpansionFailure feature is enabled users are allowed to specify resource requirements that are lower than previous value but must still be higher than capacity recorded in the status field of the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources
Name | Type | Description | Required |
---|---|---|---|
limits | map[string]int or string | Limits describes the maximum amount of compute resources allowed.
More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ | false |
requests | map[string]int or string | Requests describes the minimum amount of compute resources required.
If Requests is omitted for a container, it defaults to Limits if that is explicitly specified,
otherwise to an implementation-defined value. Requests cannot exceed Limits.
More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ | false |
Grafana.spec.deployment.spec.template.spec.volumes[index].ephemeral.volumeClaimTemplate.spec.selector
selector is a label query over volumes to consider for binding.
Name | Type | Description | Required |
---|---|---|---|
matchExpressions | []object | matchExpressions is a list of label selector requirements. The requirements are ANDed. | false |
matchLabels | map[string]string | 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. | false |
Grafana.spec.deployment.spec.template.spec.volumes[index].ephemeral.volumeClaimTemplate.spec.selector.matchExpressions[index]
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Name | Type | Description | Required |
---|---|---|---|
key | string | key is the label key that the selector applies to. | true |
operator | string | operator represents a key's relationship to a set of values.
Valid operators are In, NotIn, Exists and DoesNotExist. | true |
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. | false |
Grafana.spec.deployment.spec.template.spec.volumes[index].fc
fc represents a Fibre Channel resource that is attached to a kubelet’s host machine and then exposed to the pod.
Name | Type | Description | Required |
---|---|---|---|
fsType | string | fsType is the filesystem type to mount.
Must be a filesystem type supported by the host operating system.
Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. | false |
lun | integer | lun is Optional: FC target lun number Format: int32 | false |
readOnly | boolean | readOnly is Optional: Defaults to false (read/write). ReadOnly here will force
the ReadOnly setting in VolumeMounts. | false |
targetWWNs | []string | targetWWNs is Optional: FC target worldwide names (WWNs) | false |
wwids | []string | wwids Optional: FC volume world wide identifiers (wwids)
Either wwids or combination of targetWWNs and lun must be set, but not both simultaneously. | false |
Grafana.spec.deployment.spec.template.spec.volumes[index].flexVolume
flexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin. Deprecated: FlexVolume is deprecated. Consider using a CSIDriver instead.
Name | Type | Description | Required |
---|---|---|---|
driver | string | driver is the name of the driver to use for this volume. | true |
fsType | string | fsType is the filesystem type to mount.
Must be a filesystem type supported by the host operating system.
Ex. "ext4", "xfs", "ntfs". The default filesystem depends on FlexVolume script. | false |
options | map[string]string | options is Optional: this field holds extra command options if any. | false |
readOnly | boolean | readOnly is Optional: defaults to false (read/write). ReadOnly here will force
the ReadOnly setting in VolumeMounts. | false |
secretRef | object | secretRef is Optional: secretRef is reference to the secret object containing
sensitive information to pass to the plugin scripts. This may be
empty if no secret object is specified. If the secret object
contains more than one secret, all secrets are passed to the plugin
scripts. | false |
Grafana.spec.deployment.spec.template.spec.volumes[index].flexVolume.secretRef
secretRef is Optional: secretRef is reference to the secret object containing sensitive information to pass to the plugin scripts. This may be empty if no secret object is specified. If the secret object contains more than one secret, all secrets are passed to the plugin scripts.
Name | Type | Description | Required |
---|---|---|---|
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 Default: | false |
Grafana.spec.deployment.spec.template.spec.volumes[index].flocker
flocker represents a Flocker volume attached to a kubelet’s host machine. This depends on the Flocker control service being running. Deprecated: Flocker is deprecated and the in-tree flocker type is no longer supported.
Name | Type | Description | Required |
---|---|---|---|
datasetName | string | datasetName is Name of the dataset stored as metadata -> name on the dataset for Flocker
should be considered as deprecated | false |
datasetUUID | string | datasetUUID is the UUID of the dataset. This is unique identifier of a Flocker dataset | false |
Grafana.spec.deployment.spec.template.spec.volumes[index].gcePersistentDisk
gcePersistentDisk represents a GCE Disk resource that is attached to a kubelet’s host machine and then exposed to the pod. Deprecated: GCEPersistentDisk is deprecated. All operations for the in-tree gcePersistentDisk type are redirected to the pd.csi.storage.gke.io CSI driver. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk
Name | Type | Description | Required |
---|---|---|---|
pdName | string | pdName is unique name of the PD resource in GCE. Used to identify the disk in GCE.
More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk | true |
fsType | string | fsType is filesystem type of the volume that you want to mount.
Tip: Ensure that the filesystem type is supported by the host operating system.
Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk | false |
partition | integer | partition is the partition in the volume that you want to mount.
If omitted, the default is to mount by volume name.
Examples: For volume /dev/sda1, you specify the partition as "1".
Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty).
More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk Format: int32 | false |
readOnly | boolean | readOnly here will force the ReadOnly setting in VolumeMounts.
Defaults to false.
More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk | false |
Grafana.spec.deployment.spec.template.spec.volumes[index].gitRepo
gitRepo represents a git repository at a particular revision. Deprecated: GitRepo is deprecated. To provision a container with a git repo, mount an EmptyDir into an InitContainer that clones the repo using git, then mount the EmptyDir into the Pod’s container.
Name | Type | Description | Required |
---|---|---|---|
repository | string | repository is the URL | true |
directory | string | directory is the target directory name.
Must not contain or start with '..'. If '.' is supplied, the volume directory will be the
git repository. Otherwise, if specified, the volume will contain the git repository in
the subdirectory with the given name. | false |
revision | string | revision is the commit hash for the specified revision. | false |
Grafana.spec.deployment.spec.template.spec.volumes[index].glusterfs
glusterfs represents a Glusterfs mount on the host that shares a pod’s lifetime. Deprecated: Glusterfs is deprecated and the in-tree glusterfs type is no longer supported. More info: https://examples.k8s.io/volumes/glusterfs/README.md
Name | Type | Description | Required |
---|---|---|---|
endpoints | string | endpoints is the endpoint name that details Glusterfs topology.
More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod | true |
path | string | path is the Glusterfs volume path.
More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod | true |
readOnly | boolean | readOnly here will force the Glusterfs volume to be mounted with read-only permissions.
Defaults to false.
More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod | false |
Grafana.spec.deployment.spec.template.spec.volumes[index].hostPath
hostPath represents a pre-existing file or directory on the host machine that is directly exposed to the container. This is generally used for system agents or other privileged things that are allowed to see the host machine. Most containers will NOT need this. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath
Name | Type | Description | Required |
---|---|---|---|
path | string | path of the directory on the host.
If the path is a symlink, it will follow the link to the real path.
More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath | true |
type | string | type for HostPath Volume
Defaults to ""
More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath | false |
Grafana.spec.deployment.spec.template.spec.volumes[index].image
image represents an OCI object (a container image or artifact) pulled and mounted on the kubelet’s host machine. The volume is resolved at pod startup depending on which PullPolicy value is provided:
- Always: the kubelet always attempts to pull the reference. Container creation will fail If the pull fails.
- Never: the kubelet never pulls the reference and only uses a local image or artifact. Container creation will fail if the reference isn’t present.
- IfNotPresent: the kubelet pulls if the reference isn’t already present on disk. Container creation will fail if the reference isn’t present and the pull fails.
The volume gets re-resolved if the pod gets deleted and recreated, which means that new remote content will become available on pod recreation. A failure to resolve or pull the image during pod startup will block containers from starting and may add significant latency. Failures will be retried using normal volume backoff and will be reported on the pod reason and message. The types of objects that may be mounted by this volume are defined by the container runtime implementation on a host machine and at minimum must include all valid types supported by the container image field. The OCI object gets mounted in a single directory (spec.containers[].volumeMounts.mountPath) by merging the manifest layers in the same way as for container images. The volume will be mounted read-only (ro) and non-executable files (noexec). Sub path mounts for containers are not supported (spec.containers[].volumeMounts.subpath). The field spec.securityContext.fsGroupChangePolicy has no effect on this volume type.
Name | Type | Description | Required |
---|---|---|---|
pullPolicy | string | Policy for pulling OCI objects. Possible values are:
Always: the kubelet always attempts to pull the reference. Container creation will fail If the pull fails.
Never: the kubelet never pulls the reference and only uses a local image or artifact. Container creation will fail if the reference isn't present.
IfNotPresent: the kubelet pulls if the reference isn't already present on disk. Container creation will fail if the reference isn't present and the pull fails.
Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. | false |
reference | string | Required: Image or artifact reference to be used.
Behaves in the same way as pod.spec.containers[*].image.
Pull secrets will be assembled in the same way as for the container image by looking up node credentials, SA image pull secrets, and pod spec image pull secrets.
More info: https://kubernetes.io/docs/concepts/containers/images
This field is optional to allow higher level config management to default or override
container images in workload controllers like Deployments and StatefulSets. | false |
Grafana.spec.deployment.spec.template.spec.volumes[index].iscsi
iscsi represents an ISCSI Disk resource that is attached to a kubelet’s host machine and then exposed to the pod. More info: https://examples.k8s.io/volumes/iscsi/README.md
Name | Type | Description | Required |
---|---|---|---|
iqn | string | iqn is the target iSCSI Qualified Name. | true |
lun | integer | lun represents iSCSI Target Lun number. Format: int32 | true |
targetPortal | string | targetPortal is iSCSI Target Portal. The Portal is either an IP or ip_addr:port if the port
is other than default (typically TCP ports 860 and 3260). | true |
chapAuthDiscovery | boolean | chapAuthDiscovery defines whether support iSCSI Discovery CHAP authentication | false |
chapAuthSession | boolean | chapAuthSession defines whether support iSCSI Session CHAP authentication | false |
fsType | string | fsType is the filesystem type of the volume that you want to mount.
Tip: Ensure that the filesystem type is supported by the host operating system.
Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
More info: https://kubernetes.io/docs/concepts/storage/volumes#iscsi | false |
initiatorName | string | initiatorName is the custom iSCSI Initiator Name.
If initiatorName is specified with iscsiInterface simultaneously, new iSCSI interface
| false |
iscsiInterface | string | iscsiInterface is the interface Name that uses an iSCSI transport.
Defaults to 'default' (tcp). Default: default | false |
portals | []string | portals is the iSCSI Target Portal List. The portal is either an IP or ip_addr:port if the port
is other than default (typically TCP ports 860 and 3260). | false |
readOnly | boolean | readOnly here will force the ReadOnly setting in VolumeMounts.
Defaults to false. | false |
secretRef | object | secretRef is the CHAP Secret for iSCSI target and initiator authentication | false |
Grafana.spec.deployment.spec.template.spec.volumes[index].iscsi.secretRef
secretRef is the CHAP Secret for iSCSI target and initiator authentication
Name | Type | Description | Required |
---|---|---|---|
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 Default: | false |
Grafana.spec.deployment.spec.template.spec.volumes[index].nfs
nfs represents an NFS mount on the host that shares a pod’s lifetime More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs
Name | Type | Description | Required |
---|---|---|---|
path | string | path that is exported by the NFS server.
More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs | true |
server | string | server is the hostname or IP address of the NFS server.
More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs | true |
readOnly | boolean | readOnly here will force the NFS export to be mounted with read-only permissions.
Defaults to false.
More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs | false |
Grafana.spec.deployment.spec.template.spec.volumes[index].persistentVolumeClaim
persistentVolumeClaimVolumeSource represents a reference to a PersistentVolumeClaim in the same namespace. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims
Name | Type | Description | Required |
---|---|---|---|
claimName | string | claimName is the name of a PersistentVolumeClaim in the same namespace as the pod using this volume.
More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims | true |
readOnly | boolean | readOnly Will force the ReadOnly setting in VolumeMounts.
Default false. | false |
Grafana.spec.deployment.spec.template.spec.volumes[index].photonPersistentDisk
photonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine. Deprecated: PhotonPersistentDisk is deprecated and the in-tree photonPersistentDisk type is no longer supported.
Name | Type | Description | Required |
---|---|---|---|
pdID | string | pdID is the ID that identifies Photon Controller persistent disk | true |
fsType | string | fsType is the filesystem type to mount.
Must be a filesystem type supported by the host operating system.
Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. | false |
Grafana.spec.deployment.spec.template.spec.volumes[index].portworxVolume
portworxVolume represents a portworx volume attached and mounted on kubelets host machine. Deprecated: PortworxVolume is deprecated. All operations for the in-tree portworxVolume type are redirected to the pxd.portworx.com CSI driver when the CSIMigrationPortworx feature-gate is on.
Name | Type | Description | Required |
---|---|---|---|
volumeID | string | volumeID uniquely identifies a Portworx volume | true |
fsType | string | fSType represents the filesystem type to mount
Must be a filesystem type supported by the host operating system.
Ex. "ext4", "xfs". Implicitly inferred to be "ext4" if unspecified. | false |
readOnly | boolean | readOnly defaults to false (read/write). ReadOnly here will force
the ReadOnly setting in VolumeMounts. | false |
Grafana.spec.deployment.spec.template.spec.volumes[index].projected
projected items for all in one resources secrets, configmaps, and downward API
Name | Type | Description | Required |
---|---|---|---|
defaultMode | integer | defaultMode are the mode bits used to set permissions on created files by default.
Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511.
YAML accepts both octal and decimal values, JSON requires decimal values for mode bits.
Directories within the path are not affected by this setting.
This might be in conflict with other options that affect the file
mode, like fsGroup, and the result can be other mode bits set. Format: int32 | false |
sources | []object | sources is the list of volume projections. Each entry in this list
handles one source. | false |
Grafana.spec.deployment.spec.template.spec.volumes[index].projected.sources[index]
Projection that may be projected along with other supported volume types. Exactly one of these fields must be set.
Name | Type | Description | Required |
---|---|---|---|
clusterTrustBundle | object | ClusterTrustBundle allows a pod to access the `.spec.trustBundle` field
of ClusterTrustBundle objects in an auto-updating file. Alpha, gated by the ClusterTrustBundleProjection feature gate. ClusterTrustBundle objects can either be selected by name, or by the combination of signer name and a label selector. Kubelet performs aggressive normalization of the PEM contents written
into the pod filesystem. Esoteric PEM features such as inter-block
comments and block headers are stripped. Certificates are deduplicated.
The ordering of certificates within the file is arbitrary, and Kubelet
may change the order over time. | false |
configMap | object | configMap information about the configMap data to project | false |
downwardAPI | object | downwardAPI information about the downwardAPI data to project | false |
secret | object | secret information about the secret data to project | false |
serviceAccountToken | object | serviceAccountToken is information about the serviceAccountToken data to project | false |
Grafana.spec.deployment.spec.template.spec.volumes[index].projected.sources[index].clusterTrustBundle
ClusterTrustBundle allows a pod to access the .spec.trustBundle
field
of ClusterTrustBundle objects in an auto-updating file.
Alpha, gated by the ClusterTrustBundleProjection feature gate.
ClusterTrustBundle objects can either be selected by name, or by the combination of signer name and a label selector.
Kubelet performs aggressive normalization of the PEM contents written into the pod filesystem. Esoteric PEM features such as inter-block comments and block headers are stripped. Certificates are deduplicated. The ordering of certificates within the file is arbitrary, and Kubelet may change the order over time.
Name | Type | Description | Required |
---|---|---|---|
path | string | Relative path from the volume root to write the bundle. | true |
labelSelector | object | Select all ClusterTrustBundles that match this label selector. Only has
effect if signerName is set. Mutually-exclusive with name. If unset,
interpreted as "match nothing". If set but empty, interpreted as "match
everything". | false |
name | string | Select a single ClusterTrustBundle by object name. Mutually-exclusive
with signerName and labelSelector. | false |
optional | boolean | If true, don't block pod startup if the referenced ClusterTrustBundle(s)
aren't available. If using name, then the named ClusterTrustBundle is
allowed not to exist. If using signerName, then the combination of
signerName and labelSelector is allowed to match zero
ClusterTrustBundles. | false |
signerName | string | Select all ClusterTrustBundles that match this signer name.
Mutually-exclusive with name. The contents of all selected
ClusterTrustBundles will be unified and deduplicated. | false |
Grafana.spec.deployment.spec.template.spec.volumes[index].projected.sources[index].clusterTrustBundle.labelSelector
Select all ClusterTrustBundles that match this label selector. Only has effect if signerName is set. Mutually-exclusive with name. If unset, interpreted as “match nothing”. If set but empty, interpreted as “match everything”.
Name | Type | Description | Required |
---|---|---|---|
matchExpressions | []object | matchExpressions is a list of label selector requirements. The requirements are ANDed. | false |
matchLabels | map[string]string | 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. | false |
Grafana.spec.deployment.spec.template.spec.volumes[index].projected.sources[index].clusterTrustBundle.labelSelector.matchExpressions[index]
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Name | Type | Description | Required |
---|---|---|---|
key | string | key is the label key that the selector applies to. | true |
operator | string | operator represents a key's relationship to a set of values.
Valid operators are In, NotIn, Exists and DoesNotExist. | true |
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. | false |
Grafana.spec.deployment.spec.template.spec.volumes[index].projected.sources[index].configMap
configMap information about the configMap data to project
Name | Type | Description | Required |
---|---|---|---|
items | []object | items if unspecified, each key-value pair in the Data field of the referenced
ConfigMap will be projected into the volume as a file whose name is the
key and content is the value. If specified, the listed keys will be
projected into the specified paths, and unlisted keys will not be
present. If a key is specified which is not present in the ConfigMap,
the volume setup will error unless it is marked optional. Paths must be
relative and may not contain the '..' path or start with '..'. | false |
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 Default: | false |
optional | boolean | optional specify whether the ConfigMap or its keys must be defined | false |
Grafana.spec.deployment.spec.template.spec.volumes[index].projected.sources[index].configMap.items[index]
Maps a string key to a path within a volume.
Name | Type | Description | Required |
---|---|---|---|
key | string | key is the key to project. | true |
path | string | path is the relative path of the file to map the key to.
May not be an absolute path.
May not contain the path element '..'.
May not start with the string '..'. | true |
mode | integer | mode is Optional: mode bits used to set permissions on this file.
Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511.
YAML accepts both octal and decimal values, JSON requires decimal values for mode bits.
If not specified, the volume defaultMode will be used.
This might be in conflict with other options that affect the file
mode, like fsGroup, and the result can be other mode bits set. Format: int32 | false |
Grafana.spec.deployment.spec.template.spec.volumes[index].projected.sources[index].downwardAPI
downwardAPI information about the downwardAPI data to project
Name | Type | Description | Required |
---|---|---|---|
items | []object | Items is a list of DownwardAPIVolume file | false |
Grafana.spec.deployment.spec.template.spec.volumes[index].projected.sources[index].downwardAPI.items[index]
DownwardAPIVolumeFile represents information to create the file containing the pod field
Name | Type | Description | Required |
---|---|---|---|
path | string | Required: Path is the relative path name of the file to be created. Must not be absolute or contain the '..' path. Must be utf-8 encoded. The first item of the relative path must not start with '..' | true |
fieldRef | object | Required: Selects a field of the pod: only annotations, labels, name, namespace and uid are supported. | false |
mode | integer | Optional: mode bits used to set permissions on this file, must be an octal value
between 0000 and 0777 or a decimal value between 0 and 511.
YAML accepts both octal and decimal values, JSON requires decimal values for mode bits.
If not specified, the volume defaultMode will be used.
This might be in conflict with other options that affect the file
mode, like fsGroup, and the result can be other mode bits set. Format: int32 | false |
resourceFieldRef | object | Selects a resource of the container: only resources limits and requests
(limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported. | false |
Grafana.spec.deployment.spec.template.spec.volumes[index].projected.sources[index].downwardAPI.items[index].fieldRef
Required: Selects a field of the pod: only annotations, labels, name, namespace and uid are supported.
Name | Type | Description | Required |
---|---|---|---|
fieldPath | string | Path of the field to select in the specified API version. | true |
apiVersion | string | Version of the schema the FieldPath is written in terms of, defaults to "v1". | false |
Grafana.spec.deployment.spec.template.spec.volumes[index].projected.sources[index].downwardAPI.items[index].resourceFieldRef
Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.
Name | Type | Description | Required |
---|---|---|---|
resource | string | Required: resource to select | true |
containerName | string | Container name: required for volumes, optional for env vars | false |
divisor | int or string | Specifies the output format of the exposed resources, defaults to "1" | false |
Grafana.spec.deployment.spec.template.spec.volumes[index].projected.sources[index].secret
secret information about the secret data to project
Name | Type | Description | Required |
---|---|---|---|
items | []object | items if unspecified, each key-value pair in the Data field of the referenced
Secret will be projected into the volume as a file whose name is the
key and content is the value. If specified, the listed keys will be
projected into the specified paths, and unlisted keys will not be
present. If a key is specified which is not present in the Secret,
the volume setup will error unless it is marked optional. Paths must be
relative and may not contain the '..' path or start with '..'. | false |
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 Default: | false |
optional | boolean | optional field specify whether the Secret or its key must be defined | false |
Grafana.spec.deployment.spec.template.spec.volumes[index].projected.sources[index].secret.items[index]
Maps a string key to a path within a volume.
Name | Type | Description | Required |
---|---|---|---|
key | string | key is the key to project. | true |
path | string | path is the relative path of the file to map the key to.
May not be an absolute path.
May not contain the path element '..'.
May not start with the string '..'. | true |
mode | integer | mode is Optional: mode bits used to set permissions on this file.
Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511.
YAML accepts both octal and decimal values, JSON requires decimal values for mode bits.
If not specified, the volume defaultMode will be used.
This might be in conflict with other options that affect the file
mode, like fsGroup, and the result can be other mode bits set. Format: int32 | false |
Grafana.spec.deployment.spec.template.spec.volumes[index].projected.sources[index].serviceAccountToken
serviceAccountToken is information about the serviceAccountToken data to project
Name | Type | Description | Required |
---|---|---|---|
path | string | path is the path relative to the mount point of the file to project the
token into. | true |
audience | string | audience is the intended audience of the token. A recipient of a token
must identify itself with an identifier specified in the audience of the
token, and otherwise should reject the token. The audience defaults to the
identifier of the apiserver. | false |
expirationSeconds | integer | expirationSeconds is the requested duration of validity of the service
account token. As the token approaches expiration, the kubelet volume
plugin will proactively rotate the service account token. The kubelet will
start trying to rotate the token if the token is older than 80 percent of
its time to live or if the token is older than 24 hours.Defaults to 1 hour
and must be at least 10 minutes. Format: int64 | false |
Grafana.spec.deployment.spec.template.spec.volumes[index].quobyte
quobyte represents a Quobyte mount on the host that shares a pod’s lifetime. Deprecated: Quobyte is deprecated and the in-tree quobyte type is no longer supported.
Name | Type | Description | Required |
---|---|---|---|
registry | string | registry represents a single or multiple Quobyte Registry services
specified as a string as host:port pair (multiple entries are separated with commas)
which acts as the central registry for volumes | true |
volume | string | volume is a string that references an already created Quobyte volume by name. | true |
group | string | group to map volume access to
Default is no group | false |
readOnly | boolean | readOnly here will force the Quobyte volume to be mounted with read-only permissions.
Defaults to false. | false |
tenant | string | tenant owning the given Quobyte volume in the Backend
Used with dynamically provisioned Quobyte volumes, value is set by the plugin | false |
user | string | user to map volume access to
Defaults to serivceaccount user | false |
Grafana.spec.deployment.spec.template.spec.volumes[index].rbd
rbd represents a Rados Block Device mount on the host that shares a pod’s lifetime. Deprecated: RBD is deprecated and the in-tree rbd type is no longer supported. More info: https://examples.k8s.io/volumes/rbd/README.md
Name | Type | Description | Required |
---|---|---|---|
image | string | image is the rados image name.
More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it | true |
monitors | []string | monitors is a collection of Ceph monitors.
More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it | true |
fsType | string | fsType is the filesystem type of the volume that you want to mount.
Tip: Ensure that the filesystem type is supported by the host operating system.
Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
More info: https://kubernetes.io/docs/concepts/storage/volumes#rbd | false |
keyring | string | keyring is the path to key ring for RBDUser.
Default is /etc/ceph/keyring.
More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it Default: /etc/ceph/keyring | false |
pool | string | pool is the rados pool name.
Default is rbd.
More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it Default: rbd | false |
readOnly | boolean | readOnly here will force the ReadOnly setting in VolumeMounts.
Defaults to false.
More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it | false |
secretRef | object | secretRef is name of the authentication secret for RBDUser. If provided
overrides keyring.
Default is nil.
More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it | false |
user | string | user is the rados user name.
Default is admin.
More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it Default: admin | false |
Grafana.spec.deployment.spec.template.spec.volumes[index].rbd.secretRef
secretRef is name of the authentication secret for RBDUser. If provided overrides keyring. Default is nil. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
Name | Type | Description | Required |
---|---|---|---|
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 Default: | false |
Grafana.spec.deployment.spec.template.spec.volumes[index].scaleIO
scaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes. Deprecated: ScaleIO is deprecated and the in-tree scaleIO type is no longer supported.
Name | Type | Description | Required |
---|---|---|---|
gateway | string | gateway is the host address of the ScaleIO API Gateway. | true |
secretRef | object | secretRef references to the secret for ScaleIO user and other
sensitive information. If this is not provided, Login operation will fail. | true |
system | string | system is the name of the storage system as configured in ScaleIO. | true |
fsType | string | fsType is the filesystem type to mount.
Must be a filesystem type supported by the host operating system.
Ex. "ext4", "xfs", "ntfs".
Default is "xfs". Default: xfs | false |
protectionDomain | string | protectionDomain is the name of the ScaleIO Protection Domain for the configured storage. | false |
readOnly | boolean | readOnly Defaults to false (read/write). ReadOnly here will force
the ReadOnly setting in VolumeMounts. | false |
sslEnabled | boolean | sslEnabled Flag enable/disable SSL communication with Gateway, default false | false |
storageMode | string | storageMode indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned.
Default is ThinProvisioned. Default: ThinProvisioned | false |
storagePool | string | storagePool is the ScaleIO Storage Pool associated with the protection domain. | false |
volumeName | string | volumeName is the name of a volume already created in the ScaleIO system
that is associated with this volume source. | false |
Grafana.spec.deployment.spec.template.spec.volumes[index].scaleIO.secretRef
secretRef references to the secret for ScaleIO user and other sensitive information. If this is not provided, Login operation will fail.
Name | Type | Description | Required |
---|---|---|---|
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 Default: | false |
Grafana.spec.deployment.spec.template.spec.volumes[index].secret
secret represents a secret that should populate this volume. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret
Name | Type | Description | Required |
---|---|---|---|
defaultMode | integer | defaultMode is Optional: mode bits used to set permissions on created files by default.
Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511.
YAML accepts both octal and decimal values, JSON requires decimal values
for mode bits. Defaults to 0644.
Directories within the path are not affected by this setting.
This might be in conflict with other options that affect the file
mode, like fsGroup, and the result can be other mode bits set. Format: int32 | false |
items | []object | items If unspecified, each key-value pair in the Data field of the referenced
Secret will be projected into the volume as a file whose name is the
key and content is the value. If specified, the listed keys will be
projected into the specified paths, and unlisted keys will not be
present. If a key is specified which is not present in the Secret,
the volume setup will error unless it is marked optional. Paths must be
relative and may not contain the '..' path or start with '..'. | false |
optional | boolean | optional field specify whether the Secret or its keys must be defined | false |
secretName | string | secretName is the name of the secret in the pod's namespace to use.
More info: https://kubernetes.io/docs/concepts/storage/volumes#secret | false |
Grafana.spec.deployment.spec.template.spec.volumes[index].secret.items[index]
Maps a string key to a path within a volume.
Name | Type | Description | Required |
---|---|---|---|
key | string | key is the key to project. | true |
path | string | path is the relative path of the file to map the key to.
May not be an absolute path.
May not contain the path element '..'.
May not start with the string '..'. | true |
mode | integer | mode is Optional: mode bits used to set permissions on this file.
Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511.
YAML accepts both octal and decimal values, JSON requires decimal values for mode bits.
If not specified, the volume defaultMode will be used.
This might be in conflict with other options that affect the file
mode, like fsGroup, and the result can be other mode bits set. Format: int32 | false |
Grafana.spec.deployment.spec.template.spec.volumes[index].storageos
storageOS represents a StorageOS volume attached and mounted on Kubernetes nodes. Deprecated: StorageOS is deprecated and the in-tree storageos type is no longer supported.
Name | Type | Description | Required |
---|---|---|---|
fsType | string | fsType is the filesystem type to mount.
Must be a filesystem type supported by the host operating system.
Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. | false |
readOnly | boolean | readOnly defaults to false (read/write). ReadOnly here will force
the ReadOnly setting in VolumeMounts. | false |
secretRef | object | secretRef specifies the secret to use for obtaining the StorageOS API
credentials. If not specified, default values will be attempted. | false |
volumeName | string | volumeName is the human-readable name of the StorageOS volume. Volume
names are only unique within a namespace. | false |
volumeNamespace | string | volumeNamespace specifies the scope of the volume within StorageOS. If no
namespace is specified then the Pod's namespace will be used. This allows the
Kubernetes name scoping to be mirrored within StorageOS for tighter integration.
Set VolumeName to any name to override the default behaviour.
Set to "default" if you are not using namespaces within StorageOS.
Namespaces that do not pre-exist within StorageOS will be created. | false |
Grafana.spec.deployment.spec.template.spec.volumes[index].storageos.secretRef
secretRef specifies the secret to use for obtaining the StorageOS API credentials. If not specified, default values will be attempted.
Name | Type | Description | Required |
---|---|---|---|
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 Default: | false |
Grafana.spec.deployment.spec.template.spec.volumes[index].vsphereVolume
vsphereVolume represents a vSphere volume attached and mounted on kubelets host machine. Deprecated: VsphereVolume is deprecated. All operations for the in-tree vsphereVolume type are redirected to the csi.vsphere.vmware.com CSI driver.
Name | Type | Description | Required |
---|---|---|---|
volumePath | string | volumePath is the path that identifies vSphere volume vmdk | true |
fsType | string | fsType is filesystem type to mount.
Must be a filesystem type supported by the host operating system.
Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. | false |
storagePolicyID | string | storagePolicyID is the storage Policy Based Management (SPBM) profile ID associated with the StoragePolicyName. | false |
storagePolicyName | string | storagePolicyName is the storage Policy Based Management (SPBM) profile name. | false |
Grafana.spec.external
External enables you to configure external grafana instances that is not managed by the operator.
Name | Type | Description | Required |
---|---|---|---|
url | string | URL of the external grafana instance you want to manage. | true |
adminPassword | object | AdminPassword key to talk to the external grafana instance. | false |
adminUser | object | AdminUser key to talk to the external grafana instance. | false |
apiKey | object | The API key to talk to the external grafana instance, you need to define ether apiKey or adminUser/adminPassword. | false |
tls | object | DEPRECATED, use top level `tls` instead. Validations: | false |
Grafana.spec.external.adminPassword
AdminPassword key to talk to the external grafana instance.
Name | Type | Description | Required |
---|---|---|---|
key | string | The key of the secret to select from. Must be a valid secret key. | true |
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 Default: | false |
optional | boolean | Specify whether the Secret or its key must be defined | false |
Grafana.spec.external.adminUser
AdminUser key to talk to the external grafana instance.
Name | Type | Description | Required |
---|---|---|---|
key | string | The key of the secret to select from. Must be a valid secret key. | true |
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 Default: | false |
optional | boolean | Specify whether the Secret or its key must be defined | false |
Grafana.spec.external.apiKey
The API key to talk to the external grafana instance, you need to define ether apiKey or adminUser/adminPassword.
Name | Type | Description | Required |
---|---|---|---|
key | string | The key of the secret to select from. Must be a valid secret key. | true |
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 Default: | false |
optional | boolean | Specify whether the Secret or its key must be defined | false |
Grafana.spec.external.tls
DEPRECATED, use top level tls
instead.
Name | Type | Description | Required |
---|---|---|---|
certSecretRef | object | Use a secret as a reference to give TLS Certificate information | false |
insecureSkipVerify | boolean | Disable the CA check of the server | false |
Grafana.spec.external.tls.certSecretRef
Use a secret as a reference to give TLS Certificate information
Name | Type | Description | Required |
---|---|---|---|
name | string | name is unique within a namespace to reference a secret resource. | false |
namespace | string | namespace defines the space within which the secret name must be unique. | false |
Grafana.spec.ingress
Ingress sets how the ingress object should look like with your grafana instance.
Name | Type | Description | Required |
---|---|---|---|
metadata | object | ObjectMeta contains only a [subset of the fields included in k8s.io/apimachinery/pkg/apis/meta/v1.ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.27/#objectmeta-v1-meta). | false |
spec | object | IngressSpec describes the Ingress the user wishes to exist. | false |
Grafana.spec.ingress.metadata
ObjectMeta contains only a subset of the fields included in k8s.io/apimachinery/pkg/apis/meta/v1.ObjectMeta.
Name | Type | Description | Required |
---|---|---|---|
annotations | map[string]string | false | |
labels | map[string]string | false |
Grafana.spec.ingress.spec
IngressSpec describes the Ingress the user wishes to exist.
Name | Type | Description | Required |
---|---|---|---|
defaultBackend | object | defaultBackend is the backend that should handle requests that don't
match any rule. If Rules are not specified, DefaultBackend must be specified.
If DefaultBackend is not set, the handling of requests that do not match any
of the rules will be up to the Ingress controller. | false |
ingressClassName | string | ingressClassName is the name of an IngressClass cluster resource. Ingress
controller implementations use this field to know whether they should be
serving this Ingress resource, by a transitive connection
(controller -> IngressClass -> Ingress resource). Although the
`kubernetes.io/ingress.class` annotation (simple constant name) was never
formally defined, it was widely supported by Ingress controllers to create
a direct binding between Ingress controller and Ingress resources. Newly
created Ingress resources should prefer using the field. However, even
though the annotation is officially deprecated, for backwards compatibility
reasons, ingress controllers should still honor that annotation if present. | false |
rules | []object | rules is a list of host rules used to configure the Ingress. If unspecified,
or no rule matches, all traffic is sent to the default backend. | false |
tls | []object | tls represents the TLS configuration. Currently the Ingress only supports a
single TLS port, 443. If multiple members of this list specify different hosts,
they will be multiplexed on the same port according to the hostname specified
through the SNI TLS extension, if the ingress controller fulfilling the
ingress supports SNI. | false |
Grafana.spec.ingress.spec.defaultBackend
defaultBackend is the backend that should handle requests that don’t match any rule. If Rules are not specified, DefaultBackend must be specified. If DefaultBackend is not set, the handling of requests that do not match any of the rules will be up to the Ingress controller.
Name | Type | Description | Required |
---|---|---|---|
resource | object | resource is an ObjectRef to another Kubernetes resource in the namespace
of the Ingress object. If resource is specified, a service.Name and
service.Port must not be specified.
This is a mutually exclusive setting with "Service". | false |
service | object | service references a service as a backend.
This is a mutually exclusive setting with "Resource". | false |
Grafana.spec.ingress.spec.defaultBackend.resource
resource is an ObjectRef to another Kubernetes resource in the namespace of the Ingress object. If resource is specified, a service.Name and service.Port must not be specified. This is a mutually exclusive setting with “Service”.
Name | Type | Description | Required |
---|---|---|---|
kind | string | Kind is the type of resource being referenced | true |
name | string | Name is the name of resource being referenced | true |
apiGroup | string | APIGroup is the group for the resource being referenced.
If APIGroup is not specified, the specified Kind must be in the core API group.
For any other third-party types, APIGroup is required. | false |
Grafana.spec.ingress.spec.defaultBackend.service
service references a service as a backend. This is a mutually exclusive setting with “Resource”.
Name | Type | Description | Required |
---|---|---|---|
name | string | name is the referenced service. The service must exist in
the same namespace as the Ingress object. | true |
port | object | port of the referenced service. A port name or port number
is required for a IngressServiceBackend. | false |
Grafana.spec.ingress.spec.defaultBackend.service.port
port of the referenced service. A port name or port number is required for a IngressServiceBackend.
Name | Type | Description | Required |
---|---|---|---|
name | string | name is the name of the port on the Service.
This is a mutually exclusive setting with "Number". | false |
number | integer | number is the numerical port number (e.g. 80) on the Service.
This is a mutually exclusive setting with "Name". Format: int32 | false |
Grafana.spec.ingress.spec.rules[index]
IngressRule represents the rules mapping the paths under a specified host to the related backend services. Incoming requests are first evaluated for a host match, then routed to the backend associated with the matching IngressRuleValue.
Name | Type | Description | Required |
---|---|---|---|
host | string | host is the fully qualified domain name of a network host, as defined by RFC 3986.
Note the following deviations from the "host" part of the
URI as defined in RFC 3986:
1. IPs are not allowed. Currently an IngressRuleValue can only apply to
the IP in the Spec of the parent Ingress.
2. The `:` delimiter is not respected because ports are not allowed.
Currently the port of an Ingress is implicitly :80 for http and
:443 for https.
Both these may change in the future.
Incoming requests are matched against the host before the
IngressRuleValue. If the host is unspecified, the Ingress routes all
traffic based on the specified IngressRuleValue. host can be “precise” which is a domain name without the terminating dot of a network host (e.g. “foo.bar.com”) or “wildcard”, which is a domain name prefixed with a single wildcard label (e.g. “.foo.com”). The wildcard character ‘’ must appear by itself as the first DNS label and matches only a single label. You cannot have a wildcard label by itself (e.g. Host == “*”). Requests will be matched against the Host field in the following way:
| false |
http | object | HTTPIngressRuleValue is a list of http selectors pointing to backends. In the example: http:// | false |
Grafana.spec.ingress.spec.rules[index].http
HTTPIngressRuleValue is a list of http selectors pointing to backends.
In the example: http://
Name | Type | Description | Required |
---|---|---|---|
paths | []object | paths is a collection of paths that map requests to backends. | true |
Grafana.spec.ingress.spec.rules[index].http.paths[index]
HTTPIngressPath associates a path with a backend. Incoming urls matching the path are forwarded to the backend.
Name | Type | Description | Required |
---|---|---|---|
backend | object | backend defines the referenced service endpoint to which the traffic
will be forwarded to. | true |
pathType | string | pathType determines the interpretation of the path matching. PathType can
be one of the following values:
* Exact: Matches the URL path exactly.
* Prefix: Matches based on a URL path prefix split by '/'. Matching is
done on a path element by element basis. A path element refers is the
list of labels in the path split by the '/' separator. A request is a
match for path p if every p is an element-wise prefix of p of the
request path. Note that if the last element of the path is a substring
of the last element in request path, it is not a match (e.g. /foo/bar
matches /foo/bar/baz, but does not match /foo/barbaz).
* ImplementationSpecific: Interpretation of the Path matching is up to
the IngressClass. Implementations can treat this as a separate PathType
or treat it identically to Prefix or Exact path types.
Implementations are required to support all path types. | true |
path | string | path is matched against the path of an incoming request. Currently it can
contain characters disallowed from the conventional "path" part of a URL
as defined by RFC 3986. Paths must begin with a '/' and must be present
when using PathType with value "Exact" or "Prefix". | false |
Grafana.spec.ingress.spec.rules[index].http.paths[index].backend
backend defines the referenced service endpoint to which the traffic will be forwarded to.
Name | Type | Description | Required |
---|---|---|---|
resource | object | resource is an ObjectRef to another Kubernetes resource in the namespace
of the Ingress object. If resource is specified, a service.Name and
service.Port must not be specified.
This is a mutually exclusive setting with "Service". | false |
service | object | service references a service as a backend.
This is a mutually exclusive setting with "Resource". | false |
Grafana.spec.ingress.spec.rules[index].http.paths[index].backend.resource
resource is an ObjectRef to another Kubernetes resource in the namespace of the Ingress object. If resource is specified, a service.Name and service.Port must not be specified. This is a mutually exclusive setting with “Service”.
Name | Type | Description | Required |
---|---|---|---|
kind | string | Kind is the type of resource being referenced | true |
name | string | Name is the name of resource being referenced | true |
apiGroup | string | APIGroup is the group for the resource being referenced.
If APIGroup is not specified, the specified Kind must be in the core API group.
For any other third-party types, APIGroup is required. | false |
Grafana.spec.ingress.spec.rules[index].http.paths[index].backend.service
service references a service as a backend. This is a mutually exclusive setting with “Resource”.
Name | Type | Description | Required |
---|---|---|---|
name | string | name is the referenced service. The service must exist in
the same namespace as the Ingress object. | true |
port | object | port of the referenced service. A port name or port number
is required for a IngressServiceBackend. | false |
Grafana.spec.ingress.spec.rules[index].http.paths[index].backend.service.port
port of the referenced service. A port name or port number is required for a IngressServiceBackend.
Name | Type | Description | Required |
---|---|---|---|
name | string | name is the name of the port on the Service.
This is a mutually exclusive setting with "Number". | false |
number | integer | number is the numerical port number (e.g. 80) on the Service.
This is a mutually exclusive setting with "Name". Format: int32 | false |
Grafana.spec.ingress.spec.tls[index]
IngressTLS describes the transport layer security associated with an ingress.
Name | Type | Description | Required |
---|---|---|---|
hosts | []string | hosts is a list of hosts included in the TLS certificate. The values in
this list must match the name/s used in the tlsSecret. Defaults to the
wildcard host setting for the loadbalancer controller fulfilling this
Ingress, if left unspecified. | false |
secretName | string | secretName is the name of the secret used to terminate TLS traffic on
port 443. Field is left optional to allow TLS routing based on SNI
hostname alone. If the SNI host in a listener conflicts with the "Host"
header field used by an IngressRule, the SNI host is used for termination
and value of the "Host" header is used for routing. | false |
Grafana.spec.jsonnet
Name | Type | Description | Required |
---|---|---|---|
libraryLabelSelector | object | A label selector is a label query over a set of resources. The result of matchLabels and
matchExpressions are ANDed. An empty label selector matches all objects. A null
label selector matches no objects. | false |
Grafana.spec.jsonnet.libraryLabelSelector
A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects.
Name | Type | Description | Required |
---|---|---|---|
matchExpressions | []object | matchExpressions is a list of label selector requirements. The requirements are ANDed. | false |
matchLabels | map[string]string | 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. | false |
Grafana.spec.jsonnet.libraryLabelSelector.matchExpressions[index]
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Name | Type | Description | Required |
---|---|---|---|
key | string | key is the label key that the selector applies to. | true |
operator | string | operator represents a key's relationship to a set of values.
Valid operators are In, NotIn, Exists and DoesNotExist. | true |
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. | false |
Grafana.spec.persistentVolumeClaim
PersistentVolumeClaim creates a PVC if you need to attach one to your grafana instance.
Name | Type | Description | Required |
---|---|---|---|
metadata | object | ObjectMeta contains only a [subset of the fields included in k8s.io/apimachinery/pkg/apis/meta/v1.ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.27/#objectmeta-v1-meta). | false |
spec | object | false |
Grafana.spec.persistentVolumeClaim.metadata
ObjectMeta contains only a subset of the fields included in k8s.io/apimachinery/pkg/apis/meta/v1.ObjectMeta.
Name | Type | Description | Required |
---|---|---|---|
annotations | map[string]string | false | |
labels | map[string]string | false |
Grafana.spec.persistentVolumeClaim.spec
Name | Type | Description | Required |
---|---|---|---|
accessModes | []string | false | |
dataSource | object | TypedLocalObjectReference contains enough information to let you locate the
typed referenced object inside the same namespace. | false |
dataSourceRef | object | TypedLocalObjectReference contains enough information to let you locate the
typed referenced object inside the same namespace. | false |
resources | object | ResourceRequirements describes the compute resource requirements. | false |
selector | object | A label selector is a label query over a set of resources. The result of matchLabels and
matchExpressions are ANDed. An empty label selector matches all objects. A null
label selector matches no objects. | false |
storageClassName | string | false | |
volumeMode | string | PersistentVolumeMode describes how a volume is intended to be consumed, either Block or Filesystem. | false |
volumeName | string | VolumeName is the binding reference to the PersistentVolume backing this claim. | false |
Grafana.spec.persistentVolumeClaim.spec.dataSource
TypedLocalObjectReference contains enough information to let you locate the typed referenced object inside the same namespace.
Name | Type | Description | Required |
---|---|---|---|
kind | string | Kind is the type of resource being referenced | true |
name | string | Name is the name of resource being referenced | true |
apiGroup | string | APIGroup is the group for the resource being referenced.
If APIGroup is not specified, the specified Kind must be in the core API group.
For any other third-party types, APIGroup is required. | false |
Grafana.spec.persistentVolumeClaim.spec.dataSourceRef
TypedLocalObjectReference contains enough information to let you locate the typed referenced object inside the same namespace.
Name | Type | Description | Required |
---|---|---|---|
kind | string | Kind is the type of resource being referenced | true |
name | string | Name is the name of resource being referenced | true |
apiGroup | string | APIGroup is the group for the resource being referenced.
If APIGroup is not specified, the specified Kind must be in the core API group.
For any other third-party types, APIGroup is required. | false |
Grafana.spec.persistentVolumeClaim.spec.resources
ResourceRequirements describes the compute resource requirements.
Name | Type | Description | Required |
---|---|---|---|
claims | []object | Claims lists the names of resources, defined in spec.resourceClaims,
that are used by this container. This is an alpha field and requires enabling the DynamicResourceAllocation feature gate. This field is immutable. It can only be set for containers. | false |
limits | map[string]int or string | Limits describes the maximum amount of compute resources allowed.
More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ | false |
requests | map[string]int or string | Requests describes the minimum amount of compute resources required.
If Requests is omitted for a container, it defaults to Limits if that is explicitly specified,
otherwise to an implementation-defined value. Requests cannot exceed Limits.
More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ | false |
Grafana.spec.persistentVolumeClaim.spec.resources.claims[index]
ResourceClaim references one entry in PodSpec.ResourceClaims.
Name | Type | Description | Required |
---|---|---|---|
name | string | Name must match the name of one entry in pod.spec.resourceClaims of
the Pod where this field is used. It makes that resource available
inside a container. | true |
request | string | Request is the name chosen for a request in the referenced claim.
If empty, everything from the claim is made available, otherwise
only the result of this request. | false |
Grafana.spec.persistentVolumeClaim.spec.selector
A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects.
Name | Type | Description | Required |
---|---|---|---|
matchExpressions | []object | matchExpressions is a list of label selector requirements. The requirements are ANDed. | false |
matchLabels | map[string]string | 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. | false |
Grafana.spec.persistentVolumeClaim.spec.selector.matchExpressions[index]
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Name | Type | Description | Required |
---|---|---|---|
key | string | key is the label key that the selector applies to. | true |
operator | string | operator represents a key's relationship to a set of values.
Valid operators are In, NotIn, Exists and DoesNotExist. | true |
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. | false |
Grafana.spec.preferences
Preferences holds the Grafana Preferences settings
Name | Type | Description | Required |
---|---|---|---|
homeDashboardUid | string | false |
Grafana.spec.route
Route sets how the ingress object should look like with your grafana instance, this only works in Openshift.
Name | Type | Description | Required |
---|---|---|---|
metadata | object | ObjectMeta contains only a [subset of the fields included in k8s.io/apimachinery/pkg/apis/meta/v1.ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.27/#objectmeta-v1-meta). | false |
spec | object | false |
Grafana.spec.route.metadata
ObjectMeta contains only a subset of the fields included in k8s.io/apimachinery/pkg/apis/meta/v1.ObjectMeta.
Name | Type | Description | Required |
---|---|---|---|
annotations | map[string]string | false | |
labels | map[string]string | false |
Grafana.spec.route.spec
Name | Type | Description | Required |
---|---|---|---|
alternateBackends | []object | false | |
host | string | false | |
path | string | false | |
port | object | RoutePort defines a port mapping from a router to an endpoint in the service endpoints. | false |
tls | object | TLSConfig defines config used to secure a route and provide termination | false |
to | object | RouteTargetReference specifies the target that resolve into endpoints. Only the 'Service'
kind is allowed. Use 'weight' field to emphasize one over others. | false |
wildcardPolicy | string | WildcardPolicyType indicates the type of wildcard support needed by routes. | false |
Grafana.spec.route.spec.alternateBackends[index]
RouteTargetReference specifies the target that resolve into endpoints. Only the ‘Service’ kind is allowed. Use ‘weight’ field to emphasize one over others.
Name | Type | Description | Required |
---|---|---|---|
kind | string | The kind of target that the route is referring to. Currently, only 'Service' is allowed | true |
name | string | name of the service/target that is being referred to. e.g. name of the service | true |
weight | integer | weight as an integer between 0 and 256, default 100, that specifies the target's relative weight
against other target reference objects. 0 suppresses requests to this backend. Format: int32 | true |
Grafana.spec.route.spec.port
RoutePort defines a port mapping from a router to an endpoint in the service endpoints.
Name | Type | Description | Required |
---|---|---|---|
targetPort | int or string | The target port on pods selected by the service this route points to.
If this is a string, it will be looked up as a named port in the target
endpoints port list. Required | true |
Grafana.spec.route.spec.tls
TLSConfig defines config used to secure a route and provide termination
Name | Type | Description | Required |
---|---|---|---|
termination | string | termination indicates termination type. | true |
caCertificate | string | caCertificate provides the cert authority certificate contents | false |
certificate | string | certificate provides certificate contents | false |
destinationCACertificate | string | destinationCACertificate provides the contents of the ca certificate of the final destination. When using reencrypt
termination this file should be provided in order to have routers use it for health checks on the secure connection.
If this field is not specified, the router may provide its own destination CA and perform hostname validation using
the short service name (service.namespace.svc), which allows infrastructure generated certificates to automatically
verify. | false |
insecureEdgeTerminationPolicy | string | insecureEdgeTerminationPolicy indicates the desired behavior for insecure connections to a route. While
each router may make its own decisions on which ports to expose, this is normally port 80.
| false |
key | string | key provides key file contents | false |
Grafana.spec.route.spec.to
RouteTargetReference specifies the target that resolve into endpoints. Only the ‘Service’ kind is allowed. Use ‘weight’ field to emphasize one over others.
Name | Type | Description | Required |
---|---|---|---|
kind | string | The kind of target that the route is referring to. Currently, only 'Service' is allowed | true |
name | string | name of the service/target that is being referred to. e.g. name of the service | true |
weight | integer | weight as an integer between 0 and 256, default 100, that specifies the target's relative weight
against other target reference objects. 0 suppresses requests to this backend. Format: int32 | true |
Grafana.spec.service
Service sets how the service object should look like with your grafana instance, contains a number of defaults.
Name | Type | Description | Required |
---|---|---|---|
metadata | object | ObjectMeta contains only a [subset of the fields included in k8s.io/apimachinery/pkg/apis/meta/v1.ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.27/#objectmeta-v1-meta). | false |
spec | object | ServiceSpec describes the attributes that a user creates on a service. | false |
Grafana.spec.service.metadata
ObjectMeta contains only a subset of the fields included in k8s.io/apimachinery/pkg/apis/meta/v1.ObjectMeta.
Name | Type | Description | Required |
---|---|---|---|
annotations | map[string]string | false | |
labels | map[string]string | false |
Grafana.spec.service.spec
ServiceSpec describes the attributes that a user creates on a service.
Name | Type | Description | Required |
---|---|---|---|
allocateLoadBalancerNodePorts | boolean | allocateLoadBalancerNodePorts defines if NodePorts will be automatically
allocated for services with type LoadBalancer. Default is "true". It
may be set to "false" if the cluster load-balancer does not rely on
NodePorts. If the caller requests specific NodePorts (by specifying a
value), those requests will be respected, regardless of this field.
This field may only be set for services with type LoadBalancer and will
be cleared if the type is changed to any other type. | false |
clusterIP | string | clusterIP is the IP address of the service and is usually assigned
randomly. If an address is specified manually, is in-range (as per
system configuration), and is not in use, it will be allocated to the
service; otherwise creation of the service will fail. This field may not
be changed through updates unless the type field is also being changed
to ExternalName (which requires this field to be blank) or the type
field is being changed from ExternalName (in which case this field may
optionally be specified, as describe above). Valid values are "None",
empty string (""), or a valid IP address. Setting this to "None" makes a
"headless service" (no virtual IP), which is useful when direct endpoint
connections are preferred and proxying is not required. Only applies to
types ClusterIP, NodePort, and LoadBalancer. If this field is specified
when creating a Service of type ExternalName, creation will fail. This
field will be wiped when updating a Service to type ExternalName.
More info: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies | false |
clusterIPs | []string | ClusterIPs is a list of IP addresses assigned to this service, and are
usually assigned randomly. If an address is specified manually, is
in-range (as per system configuration), and is not in use, it will be
allocated to the service; otherwise creation of the service will fail.
This field may not be changed through updates unless the type field is
also being changed to ExternalName (which requires this field to be
empty) or the type field is being changed from ExternalName (in which
case this field may optionally be specified, as describe above). Valid
values are "None", empty string (""), or a valid IP address. Setting
this to "None" makes a "headless service" (no virtual IP), which is
useful when direct endpoint connections are preferred and proxying is
not required. Only applies to types ClusterIP, NodePort, and
LoadBalancer. If this field is specified when creating a Service of type
ExternalName, creation will fail. This field will be wiped when updating
a Service to type ExternalName. If this field is not specified, it will
be initialized from the clusterIP field. If this field is specified,
clients must ensure that clusterIPs[0] and clusterIP have the same
value. This field may hold a maximum of two entries (dual-stack IPs, in either order).
These IPs must correspond to the values of the ipFamilies field. Both
clusterIPs and ipFamilies are governed by the ipFamilyPolicy field.
More info: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies | false |
externalIPs | []string | externalIPs is a list of IP addresses for which nodes in the cluster
will also accept traffic for this service. These IPs are not managed by
Kubernetes. The user is responsible for ensuring that traffic arrives
at a node with this IP. A common example is external load-balancers
that are not part of the Kubernetes system. | false |
externalName | string | externalName is the external reference that discovery mechanisms will
return as an alias for this service (e.g. a DNS CNAME record). No
proxying will be involved. Must be a lowercase RFC-1123 hostname
(https://tools.ietf.org/html/rfc1123) and requires type to be “ExternalName”. | false |
externalTrafficPolicy | string | externalTrafficPolicy describes how nodes distribute service traffic they
receive on one of the Service’s “externally-facing” addresses (NodePorts,
ExternalIPs, and LoadBalancer IPs). If set to “Local”, the proxy will configure
the service in a way that assumes that external load balancers will take care
of balancing the service traffic between nodes, and so each node will deliver
traffic only to the node-local endpoints of the service, without masquerading
the client source IP. (Traffic mistakenly sent to a node with no endpoints will
be dropped.) The default value, “Cluster”, uses the standard behavior of
routing to all endpoints evenly (possibly modified by topology and other
features). Note that traffic sent to an External IP or LoadBalancer IP from
within the cluster will always get “Cluster” semantics, but clients sending to
a NodePort from within the cluster may need to take traffic policy into account
when picking a node. | false |
healthCheckNodePort | integer | healthCheckNodePort specifies the healthcheck nodePort for the service.
This only applies when type is set to LoadBalancer and
externalTrafficPolicy is set to Local. If a value is specified, is
in-range, and is not in use, it will be used. If not specified, a value
will be automatically allocated. External systems (e.g. load-balancers)
can use this port to determine if a given node holds endpoints for this
service or not. If this field is specified when creating a Service
which does not need it, creation will fail. This field will be wiped
when updating a Service to no longer need it (e.g. changing type).
This field cannot be updated once set. Format: int32 | false |
internalTrafficPolicy | string | InternalTrafficPolicy describes how nodes distribute service traffic they
receive on the ClusterIP. If set to “Local”, the proxy will assume that pods
only want to talk to endpoints of the service on the same node as the pod,
dropping the traffic if there are no local endpoints. The default value,
“Cluster”, uses the standard behavior of routing to all endpoints evenly
(possibly modified by topology and other features). | false |
ipFamilies | []string | IPFamilies is a list of IP families (e.g. IPv4, IPv6) assigned to this
service. This field is usually assigned automatically based on cluster
configuration and the ipFamilyPolicy field. If this field is specified
manually, the requested family is available in the cluster,
and ipFamilyPolicy allows it, it will be used; otherwise creation of
the service will fail. This field is conditionally mutable: it allows
for adding or removing a secondary IP family, but it does not allow
changing the primary IP family of the Service. Valid values are “IPv4”
and “IPv6”. This field only applies to Services of types ClusterIP,
NodePort, and LoadBalancer, and does apply to “headless” services.
This field will be wiped when updating a Service to type ExternalName. This field may hold a maximum of two entries (dual-stack families, in
either order). These families must correspond to the values of the
clusterIPs field, if specified. Both clusterIPs and ipFamilies are
governed by the ipFamilyPolicy field. | false |
ipFamilyPolicy | string | IPFamilyPolicy represents the dual-stack-ness requested or required by
this Service. If there is no value provided, then this field will be set
to SingleStack. Services can be “SingleStack” (a single IP family),
“PreferDualStack” (two IP families on dual-stack configured clusters or
a single IP family on single-stack clusters), or “RequireDualStack”
(two IP families on dual-stack configured clusters, otherwise fail). The
ipFamilies and clusterIPs fields depend on the value of this field. This
field will be wiped when updating a service to type ExternalName. | false |
loadBalancerClass | string | loadBalancerClass is the class of the load balancer implementation this Service belongs to.
If specified, the value of this field must be a label-style identifier, with an optional prefix,
e.g. “internal-vip” or “example.com/internal-vip”. Unprefixed names are reserved for end-users.
This field can only be set when the Service type is ‘LoadBalancer’. If not set, the default load
balancer implementation is used, today this is typically done through the cloud provider integration,
but should apply for any default implementation. If set, it is assumed that a load balancer
implementation is watching for Services with a matching class. Any default load balancer
implementation (e.g. cloud providers) should ignore Services that set this field.
This field can only be set when creating or updating a Service to type ‘LoadBalancer’.
Once set, it can not be changed. This field will be wiped when a service is updated to a non ‘LoadBalancer’ type. | false |
loadBalancerIP | string | Only applies to Service Type: LoadBalancer.
This feature depends on whether the underlying cloud-provider supports specifying
the loadBalancerIP when a load balancer is created.
This field will be ignored if the cloud-provider does not support the feature.
Deprecated: This field was under-specified and its meaning varies across implementations.
Using it is non-portable and it may not support dual-stack.
Users are encouraged to use implementation-specific annotations when available. | false |
loadBalancerSourceRanges | []string | If specified and supported by the platform, this will restrict traffic through the cloud-provider
load-balancer will be restricted to the specified client IPs. This field will be ignored if the
cloud-provider does not support the feature."
More info: https://kubernetes.io/docs/tasks/access-application-cluster/create-external-load-balancer/ | false |
ports | []object | The list of ports that are exposed by this service.
More info: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies | false |
publishNotReadyAddresses | boolean | publishNotReadyAddresses indicates that any agent which deals with endpoints for this
Service should disregard any indications of ready/not-ready.
The primary use case for setting this field is for a StatefulSet’s Headless Service to
propagate SRV DNS records for its Pods for the purpose of peer discovery.
The Kubernetes controllers that generate Endpoints and EndpointSlice resources for
Services interpret this to mean that all endpoints are considered “ready” even if the
Pods themselves are not. Agents which consume only Kubernetes generated endpoints
through the Endpoints or EndpointSlice resources can safely assume this behavior. | false |
selector | map[string]string | Route service traffic to pods with label keys and values matching this
selector. If empty or not present, the service is assumed to have an
external process managing its endpoints, which Kubernetes will not
modify. Only applies to types ClusterIP, NodePort, and LoadBalancer.
Ignored if type is ExternalName.
More info: https://kubernetes.io/docs/concepts/services-networking/service/ | false |
sessionAffinity | string | Supports “ClientIP” and “None”. Used to maintain session affinity.
Enable client IP based session affinity.
Must be ClientIP or None.
Defaults to None.
More info: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies | false |
sessionAffinityConfig | object | sessionAffinityConfig contains the configurations of session affinity. | false |
trafficDistribution | string | TrafficDistribution offers a way to express preferences for how traffic is
distributed to Service endpoints. Implementations can use this field as a
hint, but are not required to guarantee strict adherence. If the field is
not set, the implementation will apply its default routing strategy. If set
to “PreferClose”, implementations should prioritize endpoints that are
topologically close (e.g., same zone).
This is a beta field and requires enabling ServiceTrafficDistribution feature. | false |
type | string | type determines how the Service is exposed. Defaults to ClusterIP. Valid
options are ExternalName, ClusterIP, NodePort, and LoadBalancer.
“ClusterIP” allocates a cluster-internal IP address for load-balancing
to endpoints. Endpoints are determined by the selector or if that is not
specified, by manual construction of an Endpoints object or
EndpointSlice objects. If clusterIP is “None”, no virtual IP is
allocated and the endpoints are published as a set of endpoints rather
than a virtual IP.
“NodePort” builds on ClusterIP and allocates a port on every node which
routes to the same endpoints as the clusterIP.
“LoadBalancer” builds on NodePort and creates an external load-balancer
(if supported in the current cloud) which routes to the same endpoints
as the clusterIP.
“ExternalName” aliases this service to the specified externalName.
Several other fields do not apply to ExternalName services.
More info: https://kubernetes.io/docs/concepts/services-networking/service/#publishing-services-service-types | false |
Grafana.spec.service.spec.ports[index]
ServicePort contains information on service’s port.
Name | Type | Description | Required |
---|---|---|---|
port | integer | The port that will be exposed by this service. Format: int32 | true |
appProtocol | string | The application protocol for this port.
This is used as a hint for implementations to offer richer behavior for protocols that they understand.
This field follows standard Kubernetes label syntax.
Valid values are either:
| false |
name | string | The name of this port within the service. This must be a DNS_LABEL.
All ports within a ServiceSpec must have unique names. When considering
the endpoints for a Service, this must match the ’name’ field in the
EndpointPort.
Optional if only one ServicePort is defined on this service. | false |
nodePort | integer | The port on each node on which this service is exposed when type is
NodePort or LoadBalancer. Usually assigned by the system. If a value is
specified, in-range, and not in use it will be used, otherwise the
operation will fail. If not specified, a port will be allocated if this
Service requires one. If this field is specified when creating a
Service which does not need it, creation will fail. This field will be
wiped when updating a Service to no longer need it (e.g. changing type
from NodePort to ClusterIP).
More info: https://kubernetes.io/docs/concepts/services-networking/service/#type-nodeport Format: int32 | false |
protocol | string | The IP protocol for this port. Supports “TCP”, “UDP”, and “SCTP”.
Default is TCP. Default: TCP | false |
targetPort | int or string | Number or name of the port to access on the pods targeted by the service.
Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.
If this is a string, it will be looked up as a named port in the
target Pod’s container ports. If this is not specified, the value
of the ‘port’ field is used (an identity map).
This field is ignored for services with clusterIP=None, and should be
omitted or set equal to the ‘port’ field.
More info: https://kubernetes.io/docs/concepts/services-networking/service/#defining-a-service | false |
Grafana.spec.service.spec.sessionAffinityConfig
sessionAffinityConfig contains the configurations of session affinity.
Name | Type | Description | Required |
---|---|---|---|
clientIP | object | clientIP contains the configurations of Client IP based session affinity. | false |
Grafana.spec.service.spec.sessionAffinityConfig.clientIP
clientIP contains the configurations of Client IP based session affinity.
Name | Type | Description | Required |
---|---|---|---|
timeoutSeconds | integer | timeoutSeconds specifies the seconds of ClientIP type session sticky time.
The value must be >0 && <=86400(for 1 day) if ServiceAffinity == "ClientIP".
Default value is 10800(for 3 hours). Format: int32 | false |
Grafana.spec.serviceAccount
ServiceAccount sets how the ServiceAccount object should look like with your grafana instance, contains a number of defaults.
Name | Type | Description | Required |
---|---|---|---|
automountServiceAccountToken | boolean | false | |
imagePullSecrets | []object | false | |
metadata | object | ObjectMeta contains only a [subset of the fields included in k8s.io/apimachinery/pkg/apis/meta/v1.ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.27/#objectmeta-v1-meta). | false |
secrets | []object | false |
Grafana.spec.serviceAccount.imagePullSecrets[index]
LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace.
Name | Type | Description | Required |
---|---|---|---|
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 Default: | false |
Grafana.spec.serviceAccount.metadata
ObjectMeta contains only a subset of the fields included in k8s.io/apimachinery/pkg/apis/meta/v1.ObjectMeta.
Name | Type | Description | Required |
---|---|---|---|
annotations | map[string]string | false | |
labels | map[string]string | false |
Grafana.spec.serviceAccount.secrets[index]
ObjectReference contains enough information to let you inspect or modify the referred object.
Name | Type | Description | Required |
---|---|---|---|
apiVersion | string | API version of the referent. | false |
fieldPath | string | If referring to a piece of an object instead of an entire object, this string
should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2].
For example, if the object reference is to a container within a pod, this would take on a value like:
"spec.containers{name}" (where "name" refers to the name of the container that triggered
the event) or if no container name is specified "spec.containers[2]" (container with
index 2 in this pod). This syntax is chosen only to have some well-defined way of
referencing a part of an object. | false |
kind | string | Kind of the referent.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | false |
name | string | Name of the referent.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names | false |
namespace | string | Namespace of the referent.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/ | false |
resourceVersion | string | Specific resourceVersion to which this reference is made, if any.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency | false |
uid | string | UID of the referent.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids | false |
Grafana.status
GrafanaStatus defines the observed state of Grafana
Name | Type | Description | Required |
---|---|---|---|
adminUrl | string | false | |
dashboards | []string | false | |
datasources | []string | false | |
folders | []string | false | |
lastMessage | string | false | |
stage | string | false | |
stageStatus | string | false | |
version | string | false |