Packages:
Resource Types:
GrafanaDashboard is the Schema for the grafanadashboards API
Name | Type | Description | Required |
---|---|---|---|
apiVersion | string | integreatly.org/v1alpha1 | 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 |
false |
status | object |
|
false |
GrafanaDashboardSpec defines the desired state of GrafanaDashboard
Name | Type | Description | Required |
---|---|---|---|
configMapRef | object |
ConfigMapRef is a reference to a ConfigMap data field containing the dashboard's JSON |
false |
contentCacheDuration | string |
ContentCacheDuration sets how often the operator should resync with the external source when using the `grafanaCom.id` or `url` field to specify the source of the dashboard. The default value is decided by the `dashboardContentCacheDuration` field in the `Grafana` resource. The default is 0 which is interpreted as never refetching. |
false |
customFolderName | string |
|
false |
datasources | []object |
|
false |
grafanaCom | object |
|
false |
gzipConfigMapRef | object |
GzipConfigMapRef is a reference to a ConfigMap binaryData field containing the dashboard's JSON, compressed with Gzip. |
false |
gzipJson | string |
GzipJson the dashboard's JSON compressed with Gzip. Base64-encoded when in YAML. Format: byte |
false |
json | string |
Json is the dashboard's JSON |
false |
jsonnet | string |
|
false |
plugins | []object |
|
false |
url | string |
|
false |
ConfigMapRef is a reference to a ConfigMap data field containing the dashboard's JSON
Name | Type | Description | Required |
---|---|---|---|
key | string |
The key to select. |
true |
name | string |
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? |
false |
optional | boolean |
Specify whether the ConfigMap or its key must be defined |
false |
Name | Type | Description | Required |
---|---|---|---|
datasourceName | string |
|
true |
inputName | string |
|
true |
Name | Type | Description | Required |
---|---|---|---|
id | integer |
|
true |
revision | integer |
|
false |
GzipConfigMapRef is a reference to a ConfigMap binaryData field containing the dashboard's JSON, compressed with Gzip.
Name | Type | Description | Required |
---|---|---|---|
key | string |
The key to select. |
true |
name | string |
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? |
false |
optional | boolean |
Specify whether the ConfigMap or its key must be defined |
false |
GrafanaPlugin contains information about a single plugin
Name | Type | Description | Required |
---|---|---|---|
name | string |
|
true |
version | string |
|
true |
Name | Type | Description | Required |
---|---|---|---|
contentCache | string |
Format: byte |
false |
contentTimestamp | string |
Format: date-time |
false |
contentUrl | string |
|
false |
error | object |
|
false |
Name | Type | Description | Required |
---|---|---|---|
code | integer |
|
true |
error | string |
|
true |
retries | integer |
|
false |
GrafanaDataSource is the Schema for the grafanadatasources API
Name | Type | Description | Required |
---|---|---|---|
apiVersion | string | integreatly.org/v1alpha1 | 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 |
false |
status | object |
|
false |
GrafanaDataSourceSpec defines the desired state of GrafanaDataSource
Name | Type | Description | Required |
---|---|---|---|
datasources | []object |
|
true |
name | string |
|
true |
Name | Type | Description | Required |
---|---|---|---|
name | string |
|
true |
type | string |
|
true |
access | string |
|
false |
basicAuth | boolean |
|
false |
basicAuthPassword | string |
|
false |
basicAuthUser | string |
|
false |
customJsonData | object |
CustomJsonData will be used in place of jsonData, if present, and supports arbitrary JSON, not just those of official datasources |
false |
customSecureJsonData | object |
SecureCustomJsonData will be used in place of secureJsonData, if present, and supports arbitrary JSON, not just those of official datasources |
false |
database | string |
|
false |
editable | boolean |
|
false |
isDefault | boolean |
|
false |
jsonData | object |
GrafanaDataSourceJsonData contains the most common json options See https://grafana.com/docs/administration/provisioning/#datasources |
false |
orgId | integer |
|
false |
password | string |
|
false |
secureJsonData | object |
GrafanaDataSourceSecureJsonData contains the most common secure json options See https://grafana.com/docs/administration/provisioning/#datasources |
false |
uid | string |
|
false |
url | string |
|
false |
user | string |
|
false |
version | integer |
|
false |
withCredentials | boolean |
|
false |
GrafanaDataSourceJsonData contains the most common json options See https://grafana.com/docs/administration/provisioning/#datasources
Name | Type | Description | Required |
---|---|---|---|
addCorsHeader | boolean |
Useful fields for clickhouse datasource See https://github.com/Vertamedia/clickhouse-grafana/tree/master/dist/README.md#configure-the-datasource-with-provisioning See https://github.com/Vertamedia/clickhouse-grafana/tree/master/src/datasource.ts#L44 |
false |
alertmanagerUid | string |
AlertManagerUID if null use the internal grafana alertmanager |
false |
allowInfraExplore | boolean |
|
false |
apiToken | string |
|
false |
appInsightsAppId | string |
Fields for Azure data sources |
false |
assumeRoleArn | string |
|
false |
authType | string |
|
false |
authenticationType | string |
|
false |
azureLogAnalyticsSameAs | string |
|
false |
clientEmail | string |
|
false |
clientId | string |
|
false |
cloudName | string |
|
false |
clusterUrl | string |
|
false |
connMaxLifetime | integer |
|
false |
customMetricsNamespaces | string |
|
false |
customQueryParameters | string |
Fields for Prometheus data sources |
false |
defaultBucket | string |
|
false |
defaultDatabase | string |
|
false |
defaultProject | string |
|
false |
defaultRegion | string |
|
false |
derivedFields | []object |
|
false |
encrypt | string |
|
false |
esVersion | int or string |
|
false |
exemplarTraceIdDestinations | []object |
|
false |
githubUrl | string |
Fields for Github data sources |
false |
graphiteVersion | string |
|
false |
httpHeaderName1 | string |
Custom HTTP headers for datasources See https://grafana.com/docs/grafana/latest/administration/provisioning/#datasources |
false |
httpHeaderName2 | string |
|
false |
httpHeaderName3 | string |
|
false |
httpHeaderName4 | string |
|
false |
httpHeaderName5 | string |
|
false |
httpHeaderName6 | string |
|
false |
httpHeaderName7 | string |
|
false |
httpHeaderName8 | string |
|
false |
httpHeaderName9 | string |
|
false |
httpMethod | string |
|
false |
httpMode | string |
Fields for InfluxDB data sources |
false |
implementation | string |
Fields for Alertmanager data sources |
false |
interval | string |
|
false |
logAnalyticsClientId | string |
|
false |
logAnalyticsDefaultWorkspace | string |
|
false |
logAnalyticsSubscriptionId | string |
|
false |
logAnalyticsTenantId | string |
|
false |
logLevelField | string |
|
false |
logMessageField | string |
|
false |
manageAlerts | boolean |
ManageAlerts turns on alert management from UI |
false |
maxIdleConns | integer |
|
false |
maxLines | integer |
Fields for Loki data sources |
false |
maxOpenConns | integer |
|
false |
nodeGraph | object |
|
false |
oauthPassThru | boolean |
|
false |
organization | string |
|
false |
port | integer |
|
false |
postgresVersion | integer |
|
false |
queryTimeout | string |
|
false |
search | object |
|
false |
server | string |
Fields for Grafana Clickhouse data sources |
false |
serviceMap | object |
|
false |
showOffline | boolean |
|
false |
sigV4AssumeRoleArn | string |
|
false |
sigV4Auth | boolean |
Fields for AWS Prometheus data sources |
false |
sigV4AuthType | string |
|
false |
sigV4ExternalId | string |
|
false |
sigV4Profile | string |
|
false |
sigV4Region | string |
|
false |
sslmode | string |
|
false |
subscriptionId | string |
|
false |
tenantId | string |
|
false |
timeField | string |
|
false |
timeInterval | string |
|
false |
timeout | integer |
HTTP Request timeout in seconds. Overrides dataproxy.timeout option |
false |
timescaledb | boolean |
|
false |
timezone | string |
Extra field for MySQL data source |
false |
tlsAuth | boolean |
|
false |
tlsAuthWithCACert | boolean |
|
false |
tlsSkipVerify | boolean |
|
false |
tokenUri | string |
Fields for Stackdriver data sources |
false |
tracesToLogs | object |
Fields for tracing data sources |
false |
tsdbResolution | string |
|
false |
tsdbVersion | string |
|
false |
url | string |
Fields for Instana data sources See https://github.com/instana/instana-grafana-datasource/blob/main/provisioning/datasources/datasource.yml |
false |
usePOST | boolean |
|
false |
useProxy | boolean |
|
false |
useYandexCloudAuthorization | boolean |
|
false |
username | string |
|
false |
version | string |
|
false |
xHeaderKey | string |
|
false |
xHeaderUser | string |
|
false |
Name | Type | Description | Required |
---|---|---|---|
datasourceUid | string |
|
false |
matcherRegex | string |
|
false |
name | string |
|
false |
url | string |
|
false |
Name | Type | Description | Required |
---|---|---|---|
datasourceUid | string |
|
false |
name | string |
|
false |
url | string |
|
false |
urlDisplayLabel | string |
|
false |
Name | Type | Description | Required |
---|---|---|---|
enabled | boolean |
|
false |
Name | Type | Description | Required |
---|---|---|---|
hide | boolean |
|
false |
Name | Type | Description | Required |
---|---|---|---|
datasourceUid | string |
|
false |
Fields for tracing data sources
Name | Type | Description | Required |
---|---|---|---|
datasourceUid | string |
|
false |
filterBySpanID | boolean |
|
false |
filterByTraceID | boolean |
|
false |
lokiSearch | boolean |
|
false |
spanEndTimeShift | string |
|
false |
spanStartTimeShift | string |
|
false |
tags | []string |
|
false |
GrafanaDataSourceSecureJsonData contains the most common secure json options See https://grafana.com/docs/administration/provisioning/#datasources
Name | Type | Description | Required |
---|---|---|---|
accessKey | string |
|
false |
accessToken | string |
Fields for Github data sources |
false |
appInsightsApiKey | string |
|
false |
basicAuthPassword | string |
|
false |
clientSecret | string |
Fields for Azure data sources |
false |
httpHeaderValue1 | string |
Custom HTTP headers for datasources See https://grafana.com/docs/grafana/latest/administration/provisioning/#datasources |
false |
httpHeaderValue2 | string |
|
false |
httpHeaderValue3 | string |
|
false |
httpHeaderValue4 | string |
|
false |
httpHeaderValue5 | string |
|
false |
httpHeaderValue6 | string |
|
false |
httpHeaderValue7 | string |
|
false |
httpHeaderValue8 | string |
|
false |
httpHeaderValue9 | string |
|
false |
logAnalyticsClientSecret | string |
|
false |
password | string |
|
false |
privateKey | string |
Fields for Stackdriver data sources |
false |
secretKey | string |
|
false |
sigV4AccessKey | string |
Fields for AWS data sources |
false |
sigV4SecretKey | string |
|
false |
tlsCACert | string |
|
false |
tlsClientCert | string |
|
false |
tlsClientKey | string |
|
false |
token | string |
Fields for InfluxDB data sources |
false |
Name | Type | Description | Required |
---|---|---|---|
message | string |
|
true |
phase | string |
|
true |
GrafanaFolder is the Schema for the grafana folders and folderpermissions API
Name | Type | Description | Required |
---|---|---|---|
apiVersion | string | integreatly.org/v1alpha1 | true |
kind | string | GrafanaFolder | true |
metadata | object | Refer to the Kubernetes API documentation for the fields of the `metadata` field. | true |
spec | object |
|
false |
Name | Type | Description | Required |
---|---|---|---|
title | string |
FolderName is the display-name of the folder and must match CustomFolderName of any GrafanaDashboard you want to put in |
true |
permissions | []object |
FolderPermissions shall contain the _complete_ permissions for the folder. Any permission not listed here, will be removed from the folder. |
false |
Name | Type | Description | Required |
---|---|---|---|
permissionLevel | integer |
|
true |
permissionTarget | string |
|
true |
permissionTargetType | string |
|
true |
GrafanaNotificationChannel is the Schema for the GrafanaNotificationChannels API
Name | Type | Description | Required |
---|---|---|---|
apiVersion | string | integreatly.org/v1alpha1 | true |
kind | string | GrafanaNotificationChannel | true |
metadata | object | Refer to the Kubernetes API documentation for the fields of the `metadata` field. | true |
spec | object |
GrafanaNotificationChannelSpec defines the desired state of GrafanaNotificationChannel |
false |
status | object |
GrafanaNotificationChannelStatus defines the observed state of GrafanaNotificationChannel |
false |
GrafanaNotificationChannelSpec defines the desired state of GrafanaNotificationChannel
Name | Type | Description | Required |
---|---|---|---|
json | string |
|
true |
name | string |
|
true |
GrafanaNotificationChannelStatus defines the observed state of GrafanaNotificationChannel
Name | Type | Description | Required |
---|---|---|---|
hash | string |
|
true |
id | integer |
|
true |
message | string |
|
true |
phase | string |
|
true |
uid | string |
|
true |
Grafana is the Schema for the grafanas API
Name | Type | Description | Required |
---|---|---|---|
apiVersion | string | integreatly.org/v1alpha1 | true |
kind | string | Grafana | true |
metadata | object | Refer to the Kubernetes API documentation for the fields of the `metadata` field. | true |
spec | object |
|
false |
status | object |
GrafanaStatus defines the observed state of Grafana |
false |
Name | Type | Description | Required |
---|---|---|---|
config | object |
GrafanaConfig is the configuration for grafana |
true |
baseImage | string |
|
false |
client | object |
GrafanaClient contains the Grafana API client settings |
false |
configMaps | []string |
|
false |
containers | []object |
|
false |
dashboardContentCacheDuration | string |
DashboardContentCacheDuration sets a default for when a `GrafanaDashboard` resource doesn't specify a `contentCacheDuration`. If left unset or 0 the default behavior is to cache indefinitely. |
false |
dashboardLabelSelector | []object |
|
false |
dashboardNamespaceSelector | 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 |
dataStorage | object |
GrafanaDataStorage provides a means to configure the grafana data storage |
false |
deployment | object |
GrafanaDeployment provides a means to configure the deployment |
false |
ingress | object |
GrafanaIngress provides a means to configure the ingress created |
false |
initImage | string |
|
false |
initResources | object |
ResourceRequirements describes the compute resource requirements. |
false |
jsonnet | object |
|
false |
livenessProbeSpec | object |
|
false |
readinessProbeSpec | object |
|
false |
resources | object |
ResourceRequirements describes the compute resource requirements. |
false |
secrets | []string |
|
false |
service | object |
GrafanaService provides a means to configure the service |
false |
serviceAccount | object |
|
false |
GrafanaConfig is the configuration for grafana
Name | Type | Description | Required |
---|---|---|---|
alerting | object |
|
false |
analytics | object |
|
false |
auth | object |
|
false |
auth.anonymous | object |
|
false |
auth.azuread | object |
|
false |
auth.basic | object |
|
false |
auth.generic_oauth | object |
|
false |
auth.github | object |
|
false |
auth.gitlab | object |
|
false |
auth.google | object |
|
false |
auth.ldap | object |
|
false |
auth.okta | object |
|
false |
auth.proxy | object |
|
false |
auth.saml | object |
|
false |
dashboards | object |
|
false |
database | object |
|
false |
dataproxy | object |
|
false |
external_image_storage | object |
|
false |
external_image_storage.azure_blob | object |
|
false |
external_image_storage.gcs | object |
|
false |
external_image_storage.s3 | object |
|
false |
external_image_storage.webdav | object |
|
false |
feature_toggles | object |
|
false |
live | object |
|
false |
log | object |
|
false |
log.console | object |
|
false |
log.frontend | object |
|
false |
metrics | object |
|
false |
metrics.graphite | object |
|
false |
panels | object |
|
false |
paths | object |
|
false |
plugins | object |
|
false |
remote_cache | object |
|
false |
rendering | object |
|
false |
security | object |
|
false |
server | object |
|
false |
smtp | object |
|
false |
snapshots | object |
|
false |
unified_alerting | object |
|
false |
users | object |
|
false |
Name | Type | Description | Required |
---|---|---|---|
concurrent_render_limit | integer |
|
false |
enabled | boolean |
|
false |
error_or_timeout | string |
|
false |
evaluation_timeout_seconds | integer |
|
false |
execute_alerts | boolean |
|
false |
max_attempts | integer |
|
false |
nodata_or_nullvalues | string |
|
false |
notification_timeout_seconds | integer |
|
false |
Name | Type | Description | Required |
---|---|---|---|
check_for_updates | boolean |
|
false |
google_analytics_ua_id | string |
|
false |
reporting_enabled | boolean |
|
false |
Name | Type | Description | Required |
---|---|---|---|
disable_login_form | boolean |
|
false |
disable_signout_menu | boolean |
|
false |
login_cookie_name | string |
|
false |
login_maximum_inactive_lifetime_days | integer |
|
false |
login_maximum_inactive_lifetime_duration | string |
|
false |
login_maximum_lifetime_days | integer |
|
false |
login_maximum_lifetime_duration | string |
|
false |
oauth_auto_login | boolean |
|
false |
signout_redirect_url | string |
|
false |
sigv4_auth_enabled | boolean |
|
false |
token_rotation_interval_minutes | integer |
|
false |
Name | Type | Description | Required |
---|---|---|---|
enabled | boolean |
|
false |
org_name | string |
|
false |
org_role | string |
|
false |
Name | Type | Description | Required |
---|---|---|---|
allow_sign_up | boolean |
|
false |
allowed_domains | string |
|
false |
allowed_groups | string |
|
false |
auth_url | string |
|
false |
client_id | string |
|
false |
client_secret | string |
|
false |
enabled | boolean |
|
false |
scopes | string |
|
false |
token_url | string |
|
false |
Name | Type | Description | Required |
---|---|---|---|
enabled | boolean |
|
false |
Name | Type | Description | Required |
---|---|---|---|
allow_sign_up | boolean |
|
false |
allowed_domains | string |
|
false |
api_url | string |
|
false |
auth_url | string |
|
false |
client_id | string |
|
false |
client_secret | string |
|
false |
email_attribute_path | string |
|
false |
enabled | boolean |
|
false |
role_attribute_path | string |
|
false |
role_attribute_strict | boolean |
|
false |
scopes | string |
|
false |
team_ids | string |
|
false |
team_ids_attribute_path | string |
|
false |
teams_url | string |
|
false |
tls_client_ca | string |
|
false |
tls_client_cert | string |
|
false |
tls_client_key | string |
|
false |
tls_skip_verify_insecure | boolean |
|
false |
token_url | string |
|
false |
Name | Type | Description | Required |
---|---|---|---|
allow_sign_up | boolean |
|
false |
allowed_organizations | string |
|
false |
api_url | string |
|
false |
auth_url | string |
|
false |
client_id | string |
|
false |
client_secret | string |
|
false |
enabled | boolean |
|
false |
scopes | string |
|
false |
team_ids | string |
|
false |
token_url | string |
|
false |
Name | Type | Description | Required |
---|---|---|---|
allow_assign_grafana_admin | boolean |
|
false |
allow_sign_up | boolean |
|
false |
allowed_groups | string |
|
false |
api_url | string |
|
false |
auth_url | string |
|
false |
client_id | string |
|
false |
client_secret | string |
|
false |
enabled | boolean |
|
false |
role_attribute_path | string |
|
false |
role_attribute_strict | boolean |
|
false |
scopes | string |
|
false |
token_url | string |
|
false |
Name | Type | Description | Required |
---|---|---|---|
allow_sign_up | boolean |
|
false |
allowed_domains | string |
|
false |
auth_url | string |
|
false |
client_id | string |
|
false |
client_secret | string |
|
false |
enabled | boolean |
|
false |
scopes | string |
|
false |
token_url | string |
|
false |
Name | Type | Description | Required |
---|---|---|---|
allow_sign_up | boolean |
|
false |
config_file | string |
|
false |
enabled | boolean |
|
false |
Name | Type | Description | Required |
---|---|---|---|
allow_sign_up | boolean |
|
false |
allowed_domains | string |
|
false |
allowed_groups | string |
|
false |
api_url | string |
|
false |
auth_url | string |
|
false |
client_id | string |
|
false |
client_secret | string |
|
false |
enabled | boolean |
|
false |
name | string |
|
false |
role_attribute_path | string |
|
false |
role_attribute_strict | boolean |
|
false |
scopes | string |
|
false |
token_url | string |
|
false |
Name | Type | Description | Required |
---|---|---|---|
auto_sign_up | boolean |
|
false |
enable_login_token | boolean |
|
false |
enabled | boolean |
|
false |
header_name | string |
|
false |
header_property | string |
|
false |
headers | string |
|
false |
ldap_sync_ttl | string |
|
false |
whitelist | string |
|
false |
Name | Type | Description | Required |
---|---|---|---|
allow_idp_initiated | boolean |
|
false |
allowed_organizations | string |
|
false |
assertion_attribute_email | string |
|
false |
assertion_attribute_groups | string |
|
false |
assertion_attribute_login | string |
|
false |
assertion_attribute_name | string |
|
false |
assertion_attribute_org | string |
|
false |
assertion_attribute_role | string |
|
false |
certificate_path | string |
|
false |
enabled | boolean |
|
false |
idp_metadata_url | string |
|
false |
max_issue_delay | string |
|
false |
metadata_valid_duration | string |
|
false |
org_mapping | string |
|
false |
private_key_path | string |
|
false |
relay_state | string |
|
false |
role_values_admin | string |
|
false |
role_values_editor | string |
|
false |
role_values_grafana_admin | string |
|
false |
signature_algorithm | string |
|
false |
single_logout | boolean |
|
false |
Name | Type | Description | Required |
---|---|---|---|
default_home_dashboard_path | string |
|
false |
versions_to_keep | integer |
|
false |
Name | Type | Description | Required |
---|---|---|---|
ca_cert_path | string |
|
false |
cache_mode | string |
|
false |
client_cert_path | string |
|
false |
client_key_path | string |
|
false |
conn_max_lifetime | integer |
|
false |
host | string |
|
false |
log_queries | boolean |
|
false |
max_idle_conn | integer |
|
false |
max_open_conn | integer |
|
false |
name | string |
|
false |
password | string |
|
false |
path | string |
|
false |
server_cert_name | string |
|
false |
ssl_mode | string |
|
false |
type | string |
|
false |
url | string |
|
false |
user | string |
|
false |
Name | Type | Description | Required |
---|---|---|---|
logging | boolean |
|
false |
send_user_header | boolean |
|
false |
timeout | integer |
|
false |
Name | Type | Description | Required |
---|---|---|---|
provider | string |
|
false |
Name | Type | Description | Required |
---|---|---|---|
account_key | string |
|
false |
account_name | string |
|
false |
container_name | string |
|
false |
Name | Type | Description | Required |
---|---|---|---|
bucket | string |
|
false |
key_file | string |
|
false |
path | string |
|
false |
Name | Type | Description | Required |
---|---|---|---|
access_key | string |
|
false |
bucket | string |
|
false |
bucket_url | string |
|
false |
path | string |
|
false |
region | string |
|
false |
secret_key | string |
|
false |
Name | Type | Description | Required |
---|---|---|---|
password | string |
|
false |
public_url | string |
|
false |
url | string |
|
false |
username | string |
|
false |
Name | Type | Description | Required |
---|---|---|---|
enable | string |
|
false |
Name | Type | Description | Required |
---|---|---|---|
allowed_origins | string |
|
false |
max_connections | integer |
|
false |
Name | Type | Description | Required |
---|---|---|---|
filters | string |
|
false |
level | string |
|
false |
mode | string |
|
false |
Name | Type | Description | Required |
---|---|---|---|
format | string |
|
false |
level | string |
|
false |
Name | Type | Description | Required |
---|---|---|---|
custom_endpoint | string |
|
false |
enabled | boolean |
|
false |
log_endpoint_burst_limit | integer |
|
false |
log_endpoint_requests_per_second_limit | integer |
|
false |
sample_rate | string |
|
false |
sentry_dsn | string |
|
false |
Name | Type | Description | Required |
---|---|---|---|
basic_auth_password | string |
|
false |
basic_auth_username | string |
|
false |
enabled | boolean |
|
false |
interval_seconds | integer |
|
false |
Name | Type | Description | Required |
---|---|---|---|
address | string |
|
false |
prefix | string |
|
false |
Name | Type | Description | Required |
---|---|---|---|
disable_sanitize_html | boolean |
|
false |
Name | Type | Description | Required |
---|---|---|---|
temp_data_lifetime | string |
|
false |
Name | Type | Description | Required |
---|---|---|---|
plugin_admin_enabled | boolean |
Available to Grafana administrators only, enables installing / uninstalling / updating plugins directly from the Grafana UI. Set to true by default. Setting it to false will hide the install / uninstall / update controls. For more information, refer to https://grafana.com/docs/grafana/next/administration/plugin-management/#plugin-catalog |
true |
allow_loading_unsigned_plugins | string |
Enter a comma-separated list of plugin identifiers to identify plugins to load even if they are unsigned. Plugins with modified signatures are never loaded. We do not recommend using this option. For more information, refer to https://grafana.com/docs/grafana/next/administration/plugin-management/#plugin-signatures |
false |
enable_alpha | boolean |
Set to true if you want to test alpha plugins that are not yet ready for general usage. Default is false. |
false |
plugin_catalog_hidden_plugins | string |
Enter a comma-separated list of plugin identifiers to hide in the plugin catalog. |
false |
plugin_catalog_url | string |
Custom install/learn more URL for enterprise plugins. Defaults to https://grafana.com/grafana/plugins/. |
false |
Name | Type | Description | Required |
---|---|---|---|
connstr | string |
|
false |
type | string |
|
false |
Name | Type | Description | Required |
---|---|---|---|
callback_url | string |
|
false |
concurrent_render_request_limit | integer |
|
false |
server_url | string |
|
false |
Name | Type | Description | Required |
---|---|---|---|
admin_password | string |
|
false |
admin_user | string |
|
false |
allow_embedding | boolean |
|
false |
cookie_samesite | string |
|
false |
cookie_secure | boolean |
|
false |
data_source_proxy_whitelist | string |
|
false |
disable_gravatar | boolean |
|
false |
login_remember_days | integer |
|
false |
secret_key | string |
|
false |
strict_transport_security | boolean |
|
false |
strict_transport_security_max_age_seconds | integer |
|
false |
strict_transport_security_preload | boolean |
|
false |
strict_transport_security_subdomains | boolean |
|
false |
x_content_type_options | boolean |
|
false |
x_xss_protection | boolean |
|
false |
Name | Type | Description | Required |
---|---|---|---|
cert_file | string |
|
false |
cert_key | string |
|
false |
domain | string |
|
false |
enable_gzip | boolean |
|
false |
enforce_domain | boolean |
|
false |
http_addr | string |
|
false |
http_port | string |
|
false |
protocol | enum |
Enum: http, https |
false |
root_url | string |
|
false |
router_logging | boolean |
|
false |
serve_from_sub_path | boolean |
|
false |
socket | string |
|
false |
static_root_path | string |
|
false |
Name | Type | Description | Required |
---|---|---|---|
cert_file | string |
|
false |
ehlo_identity | string |
|
false |
enabled | boolean |
|
false |
from_address | string |
|
false |
from_name | string |
|
false |
host | string |
|
false |
key_file | string |
|
false |
password | string |
|
false |
skip_verify | boolean |
|
false |
user | string |
|
false |
Name | Type | Description | Required |
---|---|---|---|
external_enabled | boolean |
|
false |
external_snapshot_name | string |
|
false |
external_snapshot_url | string |
|
false |
snapshot_remove_expired | boolean |
|
false |
Name | Type | Description | Required |
---|---|---|---|
enabled | boolean |
|
false |
evaluation_timeout | string |
|
false |
execute_alerts | boolean |
|
false |
max_attempts | integer |
|
false |
min_interval | string |
|
false |
Name | Type | Description | Required |
---|---|---|---|
allow_org_create | boolean |
|
false |
allow_sign_up | boolean |
|
false |
auto_assign_org | boolean |
|
false |
auto_assign_org_id | string |
|
false |
auto_assign_org_role | string |
|
false |
default_theme | string |
|
false |
editors_can_admin | boolean |
|
false |
login_hint | string |
|
false |
password_hint | string |
|
false |
viewers_can_edit | boolean |
|
false |
GrafanaClient contains the Grafana API client settings
Name | Type | Description | Required |
---|---|---|---|
preferService | boolean |
|
false |
timeout | integer |
|
false |
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 |
false |
command | []string |
Entrypoint array. Not executed within a shell. The container image's ENTRYPOINT is used if this is not provided. Variable references |
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. Exposing a port here gives the system additional information about the network connections a container uses, but is primarily informational. 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. 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 |
resources | object |
Compute Resources required by this container. Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ |
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 |
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 |
false |
valueFrom | object |
Source for the environment variable's value. Cannot be used if value is not empty. |
false |
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['']`, `metadata.annotations['']`, spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. |
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 |
Selects a key of a ConfigMap.
Name | Type | Description | Required |
---|---|---|---|
key | string |
The key to select. |
true |
name | string |
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? |
false |
optional | boolean |
Specify whether the ConfigMap or its key must be defined |
false |
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 |
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 |
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. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? |
false |
optional | boolean |
Specify whether the Secret or its key must be defined |
false |
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 |
The ConfigMap to select from
Name | Type | Description | Required |
---|---|---|---|
name | string |
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? |
false |
optional | boolean |
Specify whether the ConfigMap must be defined |
false |
The Secret to select from
Name | Type | Description | Required |
---|---|---|---|
name | string |
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? |
false |
optional | boolean |
Specify whether the Secret must be defined |
false |
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 |
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 the action to take. |
false |
httpGet | object |
HTTPGet specifies the http request to perform. |
false |
tcpSocket | object |
Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept for the backward compatibility. There are no validation of this field and lifecycle hooks will fail in runtime when tcp handler is specified. |
false |
Exec specifies the action to take.
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 |
HTTPGet specifies the http 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 |
HTTPHeader describes a custom header to be used in HTTP probes
Name | Type | Description | Required |
---|---|---|---|
name | string |
The header field name |
true |
value | string |
The header field value |
true |
Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept for the backward compatibility. There are no validation of this field and lifecycle hooks will fail in runtime when tcp handler 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 |
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 the action to take. |
false |
httpGet | object |
HTTPGet specifies the http request to perform. |
false |
tcpSocket | object |
Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept for the backward compatibility. There are no validation of this field and lifecycle hooks will fail in runtime when tcp handler is specified. |
false |
Exec specifies the action to take.
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 |
HTTPGet specifies the http 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 |
HTTPHeader describes a custom header to be used in HTTP probes
Name | Type | Description | Required |
---|---|---|---|
name | string |
The header field name |
true |
value | string |
The header field value |
true |
Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept for the backward compatibility. There are no validation of this field and lifecycle hooks will fail in runtime when tcp handler 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 |
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 the action to take. |
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 an action involving a GRPC port. This is a beta field and requires enabling GRPCContainerProbe feature gate. |
false |
httpGet | object |
HTTPGet specifies the http 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 an action involving 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 |
Exec specifies the action to take.
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 |
GRPC specifies an action involving a GRPC port. This is a beta field and requires enabling GRPCContainerProbe feature gate.
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 |
HTTPGet specifies the http 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 |
HTTPHeader describes a custom header to be used in HTTP probes
Name | Type | Description | Required |
---|---|---|---|
name | string |
The header field name |
true |
value | string |
The header field value |
true |
TCPSocket specifies an action involving 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 |
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 |
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 the action to take. |
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 an action involving a GRPC port. This is a beta field and requires enabling GRPCContainerProbe feature gate. |
false |
httpGet | object |
HTTPGet specifies the http 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 an action involving 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 |
Exec specifies the action to take.
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 |
GRPC specifies an action involving a GRPC port. This is a beta field and requires enabling GRPCContainerProbe feature gate.
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 |
HTTPGet specifies the http 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 |
HTTPHeader describes a custom header to be used in HTTP probes
Name | Type | Description | Required |
---|---|---|---|
name | string |
The header field name |
true |
value | string |
The header field value |
true |
TCPSocket specifies an action involving 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 |
Compute Resources required by this container. Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
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. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ |
false |
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 |
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 is DefaultProcMount 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 |
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 |
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 |
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 only be set if type is "Localhost". |
false |
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. This field is alpha-level and will only be honored by components that enable the WindowsHostProcessContainers feature flag. Setting this field without the feature flag will result in errors when validating the Pod. 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 |
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 the action to take. |
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 an action involving a GRPC port. This is a beta field and requires enabling GRPCContainerProbe feature gate. |
false |
httpGet | object |
HTTPGet specifies the http 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 an action involving 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 |
Exec specifies the action to take.
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 |
GRPC specifies an action involving a GRPC port. This is a beta field and requires enabling GRPCContainerProbe feature gate.
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 |
HTTPGet specifies the http 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 |
HTTPHeader describes a custom header to be used in HTTP probes
Name | Type | Description | Required |
---|---|---|---|
name | string |
The header field name |
true |
value | string |
The header field value |
true |
TCPSocket specifies an action involving 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 |
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 |
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. |
false |
readOnly | boolean |
Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false. |
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 |
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 |
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 |
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 |
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 |
GrafanaDataStorage provides a means to configure the grafana data storage
Name | Type | Description | Required |
---|---|---|---|
accessModes | []string |
|
false |
annotations | map[string]string |
|
false |
class | string |
|
false |
labels | map[string]string |
|
false |
size | int or string |
|
false |
volumeName | string |
|
false |
GrafanaDeployment provides a means to configure the deployment
Name | Type | Description | Required |
---|---|---|---|
affinity | object |
Affinity is a group of affinity scheduling rules. |
false |
annotations | map[string]string |
|
false |
containerSecurityContext | object |
SecurityContext holds security configuration that will be applied to a container. Some fields are present in both SecurityContext and PodSecurityContext. When both are set, the values in SecurityContext take precedence. |
false |
env | []object |
|
false |
envFrom | []object |
|
false |
extraVolumeMounts | []object |
|
false |
extraVolumes | []object |
|
false |
hostNetwork | boolean |
|
false |
httpProxy | object |
GrafanaHttpProxy provides a means to configure the Grafana deployment to use an HTTP(S) proxy when making requests and resolving plugins. |
false |
labels | map[string]string |
|
false |
nodeSelector | map[string]string |
|
false |
priorityClassName | string |
|
false |
replicas | integer |
Format: int32 |
false |
securityContext | object |
PodSecurityContext holds pod-level security attributes and common container settings. Some fields are also present in container.securityContext. Field values of container.securityContext take precedence over field values of PodSecurityContext. |
false |
skipCreateAdminAccount | boolean |
|
false |
strategy | object |
DeploymentStrategy describes how to replace existing pods with new ones. |
false |
terminationGracePeriodSeconds | integer |
Format: int64 |
false |
tolerations | []object |
|
false |
topologySpreadConstraints | []object |
|
false |
Affinity is a group of affinity scheduling rules.
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 |
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.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.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.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.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 |
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.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.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.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 |
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 |
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.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. |
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.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.labelSelector
A label query over a set of resources, in this case 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.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.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.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 |
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 matches that of any node on which a pod of the set of pods is running
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. |
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.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].labelSelector
A label query over a set of resources, in this case 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.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.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.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 |
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.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.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. |
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.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.labelSelector
A label query over a set of resources, in this case 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.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.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.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.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 matches that of any node on which a pod of the set of pods is running
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. |
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.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].labelSelector
A label query over a set of resources, in this case 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.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.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.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 |
SecurityContext holds security configuration that will be applied to a container. Some fields are present in both SecurityContext and PodSecurityContext. When both are set, the values in SecurityContext take precedence.
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 |
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 is DefaultProcMount 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 |
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 |
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 |
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 only be set if type is "Localhost". |
false |
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. This field is alpha-level and will only be honored by components that enable the WindowsHostProcessContainers feature flag. Setting this field without the feature flag will result in errors when validating the Pod. 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 |
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 |
false |
valueFrom | object |
Source for the environment variable's value. Cannot be used if value is not empty. |
false |
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['']`, `metadata.annotations['']`, spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. |
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 |
Selects a key of a ConfigMap.
Name | Type | Description | Required |
---|---|---|---|
key | string |
The key to select. |
true |
name | string |
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? |
false |
optional | boolean |
Specify whether the ConfigMap or its key must be defined |
false |
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 |
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 |
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. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? |
false |
optional | boolean |
Specify whether the Secret or its key must be defined |
false |
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 |
The ConfigMap to select from
Name | Type | Description | Required |
---|---|---|---|
name | string |
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? |
false |
optional | boolean |
Specify whether the ConfigMap must be defined |
false |
The Secret to select from
Name | Type | Description | Required |
---|---|---|---|
name | string |
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? |
false |
optional | boolean |
Specify whether the Secret must be defined |
false |
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. |
false |
readOnly | boolean |
Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false. |
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 |
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. 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. |
false |
azureFile | object |
azureFile represents an Azure File Service mount on the host and bind mount to the pod. |
false |
cephfs | object |
cephFS represents a Ceph FS mount on the host that shares a pod's lifetime |
false |
cinder | object |
cinder represents a cinder volume attached and mounted on kubelets host machine. 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 (Beta feature). |
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. |
false |
flocker | object |
flocker represents a Flocker volume attached to a kubelet's host machine. This depends on the Flocker control service being running |
false |
gcePersistentDisk | object |
gcePersistentDisk represents a GCE Disk resource that is attached to a kubelet's host machine and then exposed to the pod. 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. 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 --- TODO(jonesdl) We need to restrict who can use host directory mounts and who can/can not mount host directories as read/write. |
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 |
false |
portworxVolume | object |
portworxVolume represents a portworx volume attached and mounted on kubelets host machine |
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 |
false |
rbd | object |
rbd represents a Rados Block Device mount on the host that shares a pod's lifetime. 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. |
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. |
false |
vsphereVolume | object |
vsphereVolume represents a vSphere volume attached and mounted on kubelets host machine |
false |
awsElasticBlockStore represents an AWS Disk resource that is attached to a kubelet's host machine and then exposed to the pod. 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 TODO: how do we prevent errors in the filesystem from compromising the machine |
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 |
azureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.
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. |
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. |
false |
azureFile represents an Azure File Service mount on the host and bind mount to the pod.
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 |
cephFS represents a Ceph FS mount on the host that shares a pod's lifetime
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 |
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. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? |
false |
cinder represents a cinder volume attached and mounted on kubelets host machine. 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 |
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. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? |
false |
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. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? |
false |
optional | boolean |
optional specify whether the ConfigMap or its keys must be defined |
false |
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 |
csi (Container Storage Interface) represents ephemeral storage that is handled by certain external CSI drivers (Beta feature).
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 |
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. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? |
false |
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 |
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 and namespace 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 |
Required: Selects a field of the pod: only annotations, labels, name and namespace 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 |
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 |
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: http://kubernetes.io/docs/user-guide/volumes#emptydir |
false |
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 `-` where `` 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. |
false |
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 |
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. If the AnyVolumeDataSource feature gate is enabled, this field will always have the same contents as the DataSourceRef field. |
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 local 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, 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. There are two 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. (Beta) Using this field requires the AnyVolumeDataSource 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 |
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 |
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. If the AnyVolumeDataSource feature gate is enabled, this field will always have the same contents as the DataSourceRef field.
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 |
dataSourceRef specifies the object from which to populate the volume with data, if a non-empty volume is desired. This may be any local 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, 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. There are two 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. (Beta) Using this field requires the AnyVolumeDataSource 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 |
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. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ |
false |
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.extraVolumes[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 |
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. TODO: how do we prevent errors in the filesystem from compromising the machine |
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 |
flexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin.
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 |
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. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? |
false |
flocker represents a Flocker volume attached to a kubelet's host machine. This depends on the Flocker control service being running
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 |
gcePersistentDisk represents a GCE Disk resource that is attached to a kubelet's host machine and then exposed to the pod. 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 TODO: how do we prevent errors in the filesystem from compromising the machine |
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 |
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 |
glusterfs represents a Glusterfs mount on the host that shares a pod's lifetime. 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 |
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 --- TODO(jonesdl) We need to restrict who can use host directory mounts and who can/can not mount host directories as read/write.
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 |
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 TODO: how do we prevent errors in the filesystem from compromising the machine |
false |
initiatorName | string |
initiatorName is the custom iSCSI Initiator Name. If initiatorName is specified with iscsiInterface simultaneously, new iSCSI interface : will be created for the connection. |
false |
iscsiInterface | string |
iscsiInterface is the interface Name that uses an iSCSI transport. Defaults to 'default' (tcp). |
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 |
secretRef is the CHAP Secret for iSCSI target and initiator authentication
Name | Type | Description | Required |
---|---|---|---|
name | string |
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? |
false |
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 |
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 |
photonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine
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 |
portworxVolume represents a portworx volume attached and mounted on kubelets host machine
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 |
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 |
false |
Projection that may be projected along with other supported volume types
Name | Type | Description | Required |
---|---|---|---|
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 |
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. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? |
false |
optional | boolean |
optional specify whether the ConfigMap or its keys must be defined |
false |
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 |
downwardAPI information about the downwardAPI data to project
Name | Type | Description | Required |
---|---|---|---|
items | []object |
Items is a list of DownwardAPIVolume file |
false |
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 and namespace 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.extraVolumes[index].projected.sources[index].downwardAPI.items[index].fieldRef
Required: Selects a field of the pod: only annotations, labels, name and namespace 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.extraVolumes[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 |
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. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? |
false |
optional | boolean |
optional field specify whether the Secret or its key must be defined |
false |
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 |
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 |
quobyte represents a Quobyte mount on the host that shares a pod's lifetime
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 |
rbd represents a Rados Block Device mount on the host that shares a pod's lifetime. 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 TODO: how do we prevent errors in the filesystem from compromising the machine |
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 |
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 |
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 |
false |
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. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? |
false |
scaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes.
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". |
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. |
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 |
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. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? |
false |
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 |
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 |
storageOS represents a StorageOS volume attached and mounted on Kubernetes nodes.
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 |
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. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? |
false |
vsphereVolume represents a vSphere volume attached and mounted on kubelets host machine
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 |
GrafanaHttpProxy provides a means to configure the Grafana deployment to use an HTTP(S) proxy when making requests and resolving plugins.
Name | Type | Description | Required |
---|---|---|---|
enabled | boolean |
|
true |
noProxy | string |
|
false |
secureUrl | string |
|
false |
url | string |
|
false |
PodSecurityContext holds pod-level security attributes and common container settings. Some fields are also present in container.securityContext. Field values of container.securityContext take precedence over field values of PodSecurityContext.
Name | Type | Description | Required |
---|---|---|---|
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:
1. The owning GID will be the FSGroup 2. The setgid bit is set (new files created in the volume will be owned by FSGroup) 3. The permission bits are OR'd with rw-rw----
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. Format: int64 |
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 |
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. If unspecified, no groups will be added to any container. 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 |
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 |
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 only be set if type is "Localhost". |
false |
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 |
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. This field is alpha-level and will only be honored by components that enable the WindowsHostProcessContainers feature flag. Setting this field without the feature flag will result in errors when validating the Pod. 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 |
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. --- TODO: Update this to follow our convention for oneOf, whatever we decide it to be. |
false |
type | string |
Type of deployment. Can be "Recreate" or "RollingUpdate". Default is RollingUpdate. |
false |
Rolling update config params. Present only if DeploymentStrategyType = RollingUpdate. --- TODO: Update this to follow our convention for oneOf, whatever we decide it to be.
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 |
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 |
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 as a "bucket", and try to put balanced number of pods into each bucket. We define a domain as a particular instance of a topology. Also, we define an eligible domain as a domain whose nodes match the node selector. e.g. If TopologyKey is "kubernetes.io/hostname", each Node is a domain of that topology. And, if TopologyKey is "topology.kubernetes.io/zone", each zone is a domain of that topology. It's a required field. |
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 |
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.
This is an alpha field and requires enabling MinDomainsInPodTopologySpread feature gate. Format: int32 |
false |
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 |
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 |
GrafanaIngress provides a means to configure the ingress created
Name | Type | Description | Required |
---|---|---|---|
annotations | map[string]string |
|
false |
enabled | boolean |
|
false |
hostname | string |
|
false |
ingressClassName | string |
|
false |
labels | map[string]string |
|
false |
path | string |
|
false |
pathType | string |
|
false |
targetPort | string |
|
false |
termination | string |
TLSTerminationType dictates where the secure communication will stop TODO: Reconsider this type in v2 |
false |
tlsEnabled | boolean |
|
false |
tlsSecretName | string |
|
false |
ResourceRequirements describes the compute resource requirements.
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. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ |
false |
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 |
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 |
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 |
Name | Type | Description | Required |
---|---|---|---|
failureThreshold | integer |
Format: int32 |
false |
initialDelaySeconds | integer |
Format: int32 |
false |
periodSeconds | integer |
Format: int32 |
false |
scheme | string |
URIScheme identifies the scheme used for connection to a host for Get actions. Deprecated in favor of config.server.protocol. |
false |
successThreshold | integer |
Format: int32 |
false |
timeoutSeconds | integer |
Format: int32 |
false |
Name | Type | Description | Required |
---|---|---|---|
failureThreshold | integer |
Format: int32 |
false |
initialDelaySeconds | integer |
Format: int32 |
false |
periodSeconds | integer |
Format: int32 |
false |
scheme | string |
URIScheme identifies the scheme used for connection to a host for Get actions. Deprecated in favor of config.server.protocol. |
false |
successThreshold | integer |
Format: int32 |
false |
timeoutSeconds | integer |
Format: int32 |
false |
ResourceRequirements describes the compute resource requirements.
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. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ |
false |
GrafanaService provides a means to configure the service
Name | Type | Description | Required |
---|---|---|---|
annotations | map[string]string |
|
false |
clusterIP | string |
|
false |
labels | map[string]string |
|
false |
name | string |
|
false |
ports | []object |
|
false |
type | string |
Service Type string describes ingress methods for a service |
false |
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 field follows standard Kubernetes label syntax. Un-prefixed names are reserved for IANA standard service names (as per RFC-6335 and https://www.iana.org/assignments/service-names). Non-standard protocols should use prefixed names such as mycompany.com/my-custom-protocol. |
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 |
Name | Type | Description | Required |
---|---|---|---|
annotations | map[string]string |
|
false |
imagePullSecrets | []object |
|
false |
labels | map[string]string |
|
false |
skip | boolean |
|
false |
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. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? |
false |
GrafanaStatus defines the observed state of Grafana
Name | Type | Description | Required |
---|---|---|---|
dashboards | []object |
|
false |
failedPlugins | []object |
|
false |
installedPlugins | []object |
|
false |
message | string |
|
false |
phase | string |
|
false |
previousServiceName | string |
|
false |
GrafanaDashboardRef is used to keep a dashboard reference without having access to the dashboard struct itself
Name | Type | Description | Required |
---|---|---|---|
folderId | integer |
Format: int64 |
true |
folderName | string |
|
true |
hash | string |
|
true |
name | string |
|
true |
namespace | string |
|
true |
uid | string |
|
true |
GrafanaPlugin contains information about a single plugin
Name | Type | Description | Required |
---|---|---|---|
name | string |
|
true |
version | string |
|
true |
GrafanaPlugin contains information about a single plugin
Name | Type | Description | Required |
---|---|---|---|
name | string |
|
true |
version | string |
|
true |