Grafana
grafana.integreatly.org / v1beta1
apiVersion: grafana.integreatly.org/v1beta1
kind: Grafana
metadata:
name: example
apiVersion
string
APIVersion defines the versioned schema of this representation of an object.
Servers should convert recognized schemas to the latest internal value, and
may reject unrecognized values.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
kind
string
Kind is a string value representing the REST resource this object represents.
Servers may infer this from the endpoint the client submits requests to.
Cannot be updated.
In CamelCase.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
metadata
object
spec object required
GrafanaSpec defines the desired state of Grafana
client object
Client defines how the grafana-operator talks to the grafana instance.
headers
object
Custom HTTP headers to use when interacting with this Grafana.
preferIngress
boolean
If the operator should send it's request through the grafana instances ingress object instead of through the service.
timeout
integer
tls object
TLS Configuration used to talk with the grafana instance.
certSecretRef object
Use a secret as a reference to give TLS Certificate information
name
string
name is unique within a namespace to reference a secret resource.
namespace
string
namespace defines the space within which the secret name must be unique.
insecureSkipVerify
boolean
Disable the CA check of the server
config
object
Config defines how your grafana ini file should looks like.
deployment object
Deployment sets how the deployment object should look like with your grafana instance, contains a number of defaults.
metadata object
annotations
object
labels
object
spec object
minReadySeconds
integer
format:
int32
paused
boolean
progressDeadlineSeconds
integer
format:
int32
replicas
integer
format:
int32
revisionHistoryLimit
integer
format:
int32selector object
matchExpressions []object
key
string required
operator
string required
values
[]string
matchLabels
object
strategy object
rollingUpdate object
maxSurge
string | integer
maxUnavailable
string | integer
type
string
template object
metadata object
annotations
object
labels
object
spec object
activeDeadlineSeconds
integer
format:
int64affinity object
nodeAffinity object
preferredDuringSchedulingIgnoredDuringExecution []object
preference object required
matchExpressions []object
key
string required
operator
string required
values
[]string
matchFields []object
key
string required
operator
string required
values
[]string
weight
integer required
format:
int32requiredDuringSchedulingIgnoredDuringExecution object
nodeSelectorTerms []object required
matchExpressions []object
key
string required
operator
string required
values
[]string
matchFields []object
key
string required
operator
string required
values
[]string
podAffinity object
preferredDuringSchedulingIgnoredDuringExecution []object
podAffinityTerm object required
labelSelector object
matchExpressions []object
key
string required
operator
string required
values
[]string
matchLabels
object
matchLabelKeys
[]string
mismatchLabelKeys
[]string
namespaceSelector object
matchExpressions []object
key
string required
operator
string required
values
[]string
matchLabels
object
namespaces
[]string
topologyKey
string required
weight
integer required
format:
int32requiredDuringSchedulingIgnoredDuringExecution []object
labelSelector object
matchExpressions []object
key
string required
operator
string required
values
[]string
matchLabels
object
matchLabelKeys
[]string
mismatchLabelKeys
[]string
namespaceSelector object
matchExpressions []object
key
string required
operator
string required
values
[]string
matchLabels
object
namespaces
[]string
topologyKey
string required
podAntiAffinity object
preferredDuringSchedulingIgnoredDuringExecution []object
podAffinityTerm object required
labelSelector object
matchExpressions []object
key
string required
operator
string required
values
[]string
matchLabels
object
matchLabelKeys
[]string
mismatchLabelKeys
[]string
namespaceSelector object
matchExpressions []object
key
string required
operator
string required
values
[]string
matchLabels
object
namespaces
[]string
topologyKey
string required
weight
integer required
format:
int32requiredDuringSchedulingIgnoredDuringExecution []object
labelSelector object
matchExpressions []object
key
string required
operator
string required
values
[]string
matchLabels
object
matchLabelKeys
[]string
mismatchLabelKeys
[]string
namespaceSelector object
matchExpressions []object
key
string required
operator
string required
values
[]string
matchLabels
object
namespaces
[]string
topologyKey
string required
automountServiceAccountToken
boolean
containers []object
args
[]string
command
[]string
env []object
name
string required
value
string
valueFrom object
configMapKeyRef object
key
string required
name
string
optional
boolean
fieldRef object
apiVersion
string
fieldPath
string required
fileKeyRef object
key
string required
optional
boolean
path
string required
volumeName
string required
resourceFieldRef object
containerName
string
divisor
string | integer
string pattern:
^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
resource
string required
secretKeyRef object
key
string required
name
string
optional
boolean
envFrom []object
configMapRef object
name
string
optional
boolean
prefix
string
secretRef object
name
string
optional
boolean
image
string
imagePullPolicy
string
lifecycle object
postStart object
exec object
command
[]string
httpGet object
host
string
httpHeaders []object
name
string required
value
string required
path
string
port
string | integer required
scheme
string
sleep object
seconds
integer required
format:
int64tcpSocket object
host
string
port
string | integer required
preStop object
exec object
command
[]string
httpGet object
host
string
httpHeaders []object
name
string required
value
string required
path
string
port
string | integer required
scheme
string
sleep object
seconds
integer required
format:
int64tcpSocket object
host
string
port
string | integer required
stopSignal
string
livenessProbe object
exec object
command
[]string
failureThreshold
integer
format:
int32grpc object
port
integer required
format:
int32
service
string
httpGet object
host
string
httpHeaders []object
name
string required
value
string required
path
string
port
string | integer required
scheme
string
initialDelaySeconds
integer
format:
int32
periodSeconds
integer
format:
int32
successThreshold
integer
format:
int32tcpSocket object
host
string
port
string | integer required
terminationGracePeriodSeconds
integer
format:
int64
timeoutSeconds
integer
format:
int32
name
string required
ports []object
containerPort
integer required
format:
int32
hostIP
string
hostPort
integer
format:
int32
name
string
protocol
string
readinessProbe object
exec object
command
[]string
failureThreshold
integer
format:
int32grpc object
port
integer required
format:
int32
service
string
httpGet object
host
string
httpHeaders []object
name
string required
value
string required
path
string
port
string | integer required
scheme
string
initialDelaySeconds
integer
format:
int32
periodSeconds
integer
format:
int32
successThreshold
integer
format:
int32tcpSocket object
host
string
port
string | integer required
terminationGracePeriodSeconds
integer
format:
int64
timeoutSeconds
integer
format:
int32resizePolicy []object
resourceName
string required
restartPolicy
string required
resources object
claims []object
name
string required
request
string
limits
object
requests
object
restartPolicy
string
restartPolicyRules []object
action
string required
exitCodes object
operator
string required
values
[]integer
securityContext object
allowPrivilegeEscalation
boolean
appArmorProfile object
localhostProfile
string
type
string required
capabilities object
add
[]string
drop
[]string
privileged
boolean
procMount
string
readOnlyRootFilesystem
boolean
runAsGroup
integer
format:
int64
runAsNonRoot
boolean
runAsUser
integer
format:
int64seLinuxOptions object
level
string
role
string
type
string
user
string
seccompProfile object
localhostProfile
string
type
string required
windowsOptions object
gmsaCredentialSpec
string
gmsaCredentialSpecName
string
hostProcess
boolean
runAsUserName
string
startupProbe object
exec object
command
[]string
failureThreshold
integer
format:
int32grpc object
port
integer required
format:
int32
service
string
httpGet object
host
string
httpHeaders []object
name
string required
value
string required
path
string
port
string | integer required
scheme
string
initialDelaySeconds
integer
format:
int32
periodSeconds
integer
format:
int32
successThreshold
integer
format:
int32tcpSocket object
host
string
port
string | integer required
terminationGracePeriodSeconds
integer
format:
int64
timeoutSeconds
integer
format:
int32
stdin
boolean
stdinOnce
boolean
terminationMessagePath
string
terminationMessagePolicy
string
tty
boolean
volumeDevices []object
devicePath
string required
name
string required
volumeMounts []object
mountPath
string required
mountPropagation
string
name
string required
readOnly
boolean
recursiveReadOnly
string
subPath
string
subPathExpr
string
workingDir
string
dnsConfig object
nameservers
[]string
options []object
name
string
value
string
searches
[]string
dnsPolicy
string
enableServiceLinks
boolean
ephemeralContainers []object
args
[]string
command
[]string
env []object
name
string required
value
string
valueFrom object
configMapKeyRef object
key
string required
name
string
optional
boolean
fieldRef object
apiVersion
string
fieldPath
string required
fileKeyRef object
key
string required
optional
boolean
path
string required
volumeName
string required
resourceFieldRef object
containerName
string
divisor
string | integer
string pattern:
^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
resource
string required
secretKeyRef object
key
string required
name
string
optional
boolean
envFrom []object
configMapRef object
name
string
optional
boolean
prefix
string
secretRef object
name
string
optional
boolean
image
string
imagePullPolicy
string
lifecycle object
postStart object
exec object
command
[]string
httpGet object
host
string
httpHeaders []object
name
string required
value
string required
path
string
port
string | integer required
scheme
string
sleep object
seconds
integer required
format:
int64tcpSocket object
host
string
port
string | integer required
preStop object
exec object
command
[]string
httpGet object
host
string
httpHeaders []object
name
string required
value
string required
path
string
port
string | integer required
scheme
string
sleep object
seconds
integer required
format:
int64tcpSocket object
host
string
port
string | integer required
stopSignal
string
livenessProbe object
exec object
command
[]string
failureThreshold
integer
format:
int32grpc object
port
integer required
format:
int32
service
string
httpGet object
host
string
httpHeaders []object
name
string required
value
string required
path
string
port
string | integer required
scheme
string
initialDelaySeconds
integer
format:
int32
periodSeconds
integer
format:
int32
successThreshold
integer
format:
int32tcpSocket object
host
string
port
string | integer required
terminationGracePeriodSeconds
integer
format:
int64
timeoutSeconds
integer
format:
int32
name
string required
ports []object
containerPort
integer required
format:
int32
hostIP
string
hostPort
integer
format:
int32
name
string
protocol
string
readinessProbe object
exec object
command
[]string
failureThreshold
integer
format:
int32grpc object
port
integer required
format:
int32
service
string
httpGet object
host
string
httpHeaders []object
name
string required
value
string required
path
string
port
string | integer required
scheme
string
initialDelaySeconds
integer
format:
int32
periodSeconds
integer
format:
int32
successThreshold
integer
format:
int32tcpSocket object
host
string
port
string | integer required
terminationGracePeriodSeconds
integer
format:
int64
timeoutSeconds
integer
format:
int32resizePolicy []object
resourceName
string required
restartPolicy
string required
resources object
claims []object
name
string required
request
string
limits
object
requests
object
restartPolicy
string
restartPolicyRules []object
action
string required
exitCodes object
operator
string required
values
[]integer
securityContext object
allowPrivilegeEscalation
boolean
appArmorProfile object
localhostProfile
string
type
string required
capabilities object
add
[]string
drop
[]string
privileged
boolean
procMount
string
readOnlyRootFilesystem
boolean
runAsGroup
integer
format:
int64
runAsNonRoot
boolean
runAsUser
integer
format:
int64seLinuxOptions object
level
string
role
string
type
string
user
string
seccompProfile object
localhostProfile
string
type
string required
windowsOptions object
gmsaCredentialSpec
string
gmsaCredentialSpecName
string
hostProcess
boolean
runAsUserName
string
startupProbe object
exec object
command
[]string
failureThreshold
integer
format:
int32grpc object
port
integer required
format:
int32
service
string
httpGet object
host
string
httpHeaders []object
name
string required
value
string required
path
string
port
string | integer required
scheme
string
initialDelaySeconds
integer
format:
int32
periodSeconds
integer
format:
int32
successThreshold
integer
format:
int32tcpSocket object
host
string
port
string | integer required
terminationGracePeriodSeconds
integer
format:
int64
timeoutSeconds
integer
format:
int32
stdin
boolean
stdinOnce
boolean
targetContainerName
string
terminationMessagePath
string
terminationMessagePolicy
string
tty
boolean
volumeDevices []object
devicePath
string required
name
string required
volumeMounts []object
mountPath
string required
mountPropagation
string
name
string required
readOnly
boolean
recursiveReadOnly
string
subPath
string
subPathExpr
string
workingDir
string
hostAliases []object
hostnames
[]string
ip
string required
hostIPC
boolean
hostNetwork
boolean
hostPID
boolean
hostUsers
boolean
hostname
string
imagePullSecrets []object
name
string
initContainers []object
args
[]string
command
[]string
env []object
name
string required
value
string
valueFrom object
configMapKeyRef object
key
string required
name
string
optional
boolean
fieldRef object
apiVersion
string
fieldPath
string required
fileKeyRef object
key
string required
optional
boolean
path
string required
volumeName
string required
resourceFieldRef object
containerName
string
divisor
string | integer
string pattern:
^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
resource
string required
secretKeyRef object
key
string required
name
string
optional
boolean
envFrom []object
configMapRef object
name
string
optional
boolean
prefix
string
secretRef object
name
string
optional
boolean
image
string
imagePullPolicy
string
lifecycle object
postStart object
exec object
command
[]string
httpGet object
host
string
httpHeaders []object
name
string required
value
string required
path
string
port
string | integer required
scheme
string
sleep object
seconds
integer required
format:
int64tcpSocket object
host
string
port
string | integer required
preStop object
exec object
command
[]string
httpGet object
host
string
httpHeaders []object
name
string required
value
string required
path
string
port
string | integer required
scheme
string
sleep object
seconds
integer required
format:
int64tcpSocket object
host
string
port
string | integer required
stopSignal
string
livenessProbe object
exec object
command
[]string
failureThreshold
integer
format:
int32grpc object
port
integer required
format:
int32
service
string
httpGet object
host
string
httpHeaders []object
name
string required
value
string required
path
string
port
string | integer required
scheme
string
initialDelaySeconds
integer
format:
int32
periodSeconds
integer
format:
int32
successThreshold
integer
format:
int32tcpSocket object
host
string
port
string | integer required
terminationGracePeriodSeconds
integer
format:
int64
timeoutSeconds
integer
format:
int32
name
string required
ports []object
containerPort
integer required
format:
int32
hostIP
string
hostPort
integer
format:
int32
name
string
protocol
string
readinessProbe object
exec object
command
[]string
failureThreshold
integer
format:
int32grpc object
port
integer required
format:
int32
service
string
httpGet object
host
string
httpHeaders []object
name
string required
value
string required
path
string
port
string | integer required
scheme
string
initialDelaySeconds
integer
format:
int32
periodSeconds
integer
format:
int32
successThreshold
integer
format:
int32tcpSocket object
host
string
port
string | integer required
terminationGracePeriodSeconds
integer
format:
int64
timeoutSeconds
integer
format:
int32resizePolicy []object
resourceName
string required
restartPolicy
string required
resources object
claims []object
name
string required
request
string
limits
object
requests
object
restartPolicy
string
restartPolicyRules []object
action
string required
exitCodes object
operator
string required
values
[]integer
securityContext object
allowPrivilegeEscalation
boolean
appArmorProfile object
localhostProfile
string
type
string required
capabilities object
add
[]string
drop
[]string
privileged
boolean
procMount
string
readOnlyRootFilesystem
boolean
runAsGroup
integer
format:
int64
runAsNonRoot
boolean
runAsUser
integer
format:
int64seLinuxOptions object
level
string
role
string
type
string
user
string
seccompProfile object
localhostProfile
string
type
string required
windowsOptions object
gmsaCredentialSpec
string
gmsaCredentialSpecName
string
hostProcess
boolean
runAsUserName
string
startupProbe object
exec object
command
[]string
failureThreshold
integer
format:
int32grpc object
port
integer required
format:
int32
service
string
httpGet object
host
string
httpHeaders []object
name
string required
value
string required
path
string
port
string | integer required
scheme
string
initialDelaySeconds
integer
format:
int32
periodSeconds
integer
format:
int32
successThreshold
integer
format:
int32tcpSocket object
host
string
port
string | integer required
terminationGracePeriodSeconds
integer
format:
int64
timeoutSeconds
integer
format:
int32
stdin
boolean
stdinOnce
boolean
terminationMessagePath
string
terminationMessagePolicy
string
tty
boolean
volumeDevices []object
devicePath
string required
name
string required
volumeMounts []object
mountPath
string required
mountPropagation
string
name
string required
readOnly
boolean
recursiveReadOnly
string
subPath
string
subPathExpr
string
workingDir
string
nodeName
string
nodeSelector
object
os object
name
string required
overhead
object
preemptionPolicy
string
priority
integer
format:
int32
priorityClassName
string
readinessGates []object
conditionType
string required
restartPolicy
string
runtimeClassName
string
schedulerName
string
securityContext object
appArmorProfile object
localhostProfile
string
type
string required
fsGroup
integer
format:
int64
fsGroupChangePolicy
string
runAsGroup
integer
format:
int64
runAsNonRoot
boolean
runAsUser
integer
format:
int64
seLinuxChangePolicy
string
seLinuxOptions object
level
string
role
string
type
string
user
string
seccompProfile object
localhostProfile
string
type
string required
supplementalGroups
[]integer
supplementalGroupsPolicy
string
sysctls []object
name
string required
value
string required
windowsOptions object
gmsaCredentialSpec
string
gmsaCredentialSpecName
string
hostProcess
boolean
runAsUserName
string
serviceAccount
string
serviceAccountName
string
setHostnameAsFQDN
boolean
shareProcessNamespace
boolean
subdomain
string
terminationGracePeriodSeconds
integer
format:
int64tolerations []object
effect
string
key
string
operator
string
tolerationSeconds
integer
format:
int64
value
string
topologySpreadConstraints []object
labelSelector object
matchExpressions []object
key
string required
operator
string required
values
[]string
matchLabels
object
matchLabelKeys
[]string
maxSkew
integer required
format:
int32
minDomains
integer
format:
int32
nodeAffinityPolicy
string
nodeTaintsPolicy
string
topologyKey
string required
whenUnsatisfiable
string required
volumes []object
awsElasticBlockStore object
fsType
string
partition
integer
format:
int32
readOnly
boolean
volumeID
string required
azureDisk object
cachingMode
string
diskName
string required
diskURI
string required
fsType
string
kind
string
readOnly
boolean
azureFile object
readOnly
boolean
secretName
string required
shareName
string required
cephfs object
monitors
[]string required
path
string
readOnly
boolean
secretFile
string
secretRef object
name
string
user
string
cinder object
fsType
string
readOnly
boolean
secretRef object
name
string
volumeID
string required
configMap object
defaultMode
integer
format:
int32items []object
key
string required
mode
integer
format:
int32
path
string required
name
string
optional
boolean
csi object
driver
string required
fsType
string
nodePublishSecretRef object
name
string
readOnly
boolean
volumeAttributes
object
downwardAPI object
defaultMode
integer
format:
int32items []object
fieldRef object
apiVersion
string
fieldPath
string required
mode
integer
format:
int32
path
string required
resourceFieldRef object
containerName
string
divisor
string | integer
string pattern:
^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
resource
string required
emptyDir object
medium
string
sizeLimit
string | integer
string pattern:
^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ephemeral object
volumeClaimTemplate object
metadata
object
spec object required
accessModes
[]string
dataSource object
apiGroup
string
kind
string required
name
string required
dataSourceRef object
apiGroup
string
kind
string required
name
string required
namespace
string
resources object
limits
object
requests
object
selector object
matchExpressions []object
key
string required
operator
string required
values
[]string
matchLabels
object
storageClassName
string
volumeAttributesClassName
string
volumeMode
string
volumeName
string
fc object
fsType
string
lun
integer
format:
int32
readOnly
boolean
targetWWNs
[]string
wwids
[]string
flexVolume object
driver
string required
fsType
string
options
object
readOnly
boolean
secretRef object
name
string
flocker object
datasetName
string
datasetUUID
string
gcePersistentDisk object
fsType
string
partition
integer
format:
int32
pdName
string required
readOnly
boolean
gitRepo object
directory
string
repository
string required
revision
string
glusterfs object
endpoints
string required
path
string required
readOnly
boolean
hostPath object
path
string required
type
string
image object
pullPolicy
string
reference
string
iscsi object
chapAuthDiscovery
boolean
chapAuthSession
boolean
fsType
string
initiatorName
string
iqn
string required
iscsiInterface
string
lun
integer required
format:
int32
portals
[]string
readOnly
boolean
secretRef object
name
string
targetPortal
string required
name
string required
nfs object
path
string required
readOnly
boolean
server
string required
persistentVolumeClaim object
claimName
string required
readOnly
boolean
photonPersistentDisk object
fsType
string
pdID
string required
portworxVolume object
fsType
string
readOnly
boolean
volumeID
string required
projected object
defaultMode
integer
format:
int32sources []object
clusterTrustBundle object
labelSelector object
matchExpressions []object
key
string required
operator
string required
values
[]string
matchLabels
object
name
string
optional
boolean
path
string required
signerName
string
configMap object
items []object
key
string required
mode
integer
format:
int32
path
string required
name
string
optional
boolean
downwardAPI object
items []object
fieldRef object
apiVersion
string
fieldPath
string required
mode
integer
format:
int32
path
string required
resourceFieldRef object
containerName
string
divisor
string | integer
string pattern:
^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
resource
string required
podCertificate object
certificateChainPath
string
credentialBundlePath
string
keyPath
string
keyType
string required
maxExpirationSeconds
integer
format:
int32
signerName
string required
secret object
items []object
key
string required
mode
integer
format:
int32
path
string required
name
string
optional
boolean
serviceAccountToken object
audience
string
expirationSeconds
integer
format:
int64
path
string required
quobyte object
group
string
readOnly
boolean
registry
string required
tenant
string
user
string
volume
string required
rbd object
fsType
string
image
string required
keyring
string
monitors
[]string required
pool
string
readOnly
boolean
secretRef object
name
string
user
string
scaleIO object
fsType
string
gateway
string required
protectionDomain
string
readOnly
boolean
secretRef object required
name
string
sslEnabled
boolean
storageMode
string
storagePool
string
system
string required
volumeName
string
secret object
defaultMode
integer
format:
int32items []object
key
string required
mode
integer
format:
int32
path
string required
optional
boolean
secretName
string
storageos object
fsType
string
readOnly
boolean
secretRef object
name
string
volumeName
string
volumeNamespace
string
vsphereVolume object
fsType
string
storagePolicyID
string
storagePolicyName
string
volumePath
string required
disableDefaultAdminSecret
boolean
DisableDefaultAdminSecret prevents operator from creating default admin-credentials secret
disableDefaultSecurityContext
string
DisableDefaultSecurityContext prevents the operator from populating securityContext on deployments
enum:
Pod, Container, Allexternal object
External enables you to configure external grafana instances that is not managed by the operator.
adminPassword object
AdminPassword key to talk to the external grafana instance.
key
string required
The key of the secret to select from. Must be a valid secret key.
name
string
Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional
boolean
Specify whether the Secret or its key must be defined
adminUser object
AdminUser key to talk to the external grafana instance.
key
string required
The key of the secret to select from. Must be a valid secret key.
name
string
Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional
boolean
Specify whether the Secret or its key must be defined
apiKey object
The API key to talk to the external grafana instance, you need to define ether apiKey or adminUser/adminPassword.
key
string required
The key of the secret to select from. Must be a valid secret key.
name
string
Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional
boolean
Specify whether the Secret or its key must be defined
tls object
DEPRECATED, use top level `tls` instead.
certSecretRef object
Use a secret as a reference to give TLS Certificate information
name
string
name is unique within a namespace to reference a secret resource.
namespace
string
namespace defines the space within which the secret name must be unique.
insecureSkipVerify
boolean
Disable the CA check of the server
url
string required
URL of the external grafana instance you want to manage.
ingress object
Ingress sets how the ingress object should look like with your grafana instance.
metadata object
ObjectMeta contains only a [subset of the fields included in k8s.io/apimachinery/pkg/apis/meta/v1.ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.27/#objectmeta-v1-meta).
annotations
object
labels
object
spec object
IngressSpec describes the Ingress the user wishes to exist.
defaultBackend object
defaultBackend is the backend that should handle requests that don't
match any rule. If Rules are not specified, DefaultBackend must be specified.
If DefaultBackend is not set, the handling of requests that do not match any
of the rules will be up to the Ingress controller.
resource object
resource is an ObjectRef to another Kubernetes resource in the namespace
of the Ingress object. If resource is specified, a service.Name and
service.Port must not be specified.
This is a mutually exclusive setting with "Service".
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.
kind
string required
Kind is the type of resource being referenced
name
string required
Name is the name of resource being referenced
service object
service references a service as a backend.
This is a mutually exclusive setting with "Resource".
name
string required
name is the referenced service. The service must exist in
the same namespace as the Ingress object.
port object
port of the referenced service. A port name or port number
is required for a IngressServiceBackend.
name
string
name is the name of the port on the Service.
This is a mutually exclusive setting with "Number".
number
integer
number is the numerical port number (e.g. 80) on the Service.
This is a mutually exclusive setting with "Name".
format:
int32
ingressClassName
string
ingressClassName is the name of an IngressClass cluster resource. Ingress
controller implementations use this field to know whether they should be
serving this Ingress resource, by a transitive connection
(controller -> IngressClass -> Ingress resource). Although the
`kubernetes.io/ingress.class` annotation (simple constant name) was never
formally defined, it was widely supported by Ingress controllers to create
a direct binding between Ingress controller and Ingress resources. Newly
created Ingress resources should prefer using the field. However, even
though the annotation is officially deprecated, for backwards compatibility
reasons, ingress controllers should still honor that annotation if present.
rules []object
rules is a list of host rules used to configure the Ingress. If unspecified,
or no rule matches, all traffic is sent to the default backend.
host
string
host is the fully qualified domain name of a network host, as defined by RFC 3986.
Note the following deviations from the "host" part of the
URI as defined in RFC 3986:
1. IPs are not allowed. Currently an IngressRuleValue can only apply to
the IP in the Spec of the parent Ingress.
2. The `:` delimiter is not respected because ports are not allowed.
Currently the port of an Ingress is implicitly :80 for http and
:443 for https.
Both these may change in the future.
Incoming requests are matched against the host before the
IngressRuleValue. If the host is unspecified, the Ingress routes all
traffic based on the specified IngressRuleValue.
host can be "precise" which is a domain name without the terminating dot of
a network host (e.g. "foo.bar.com") or "wildcard", which is a domain name
prefixed with a single wildcard label (e.g. "*.foo.com").
The wildcard character '*' must appear by itself as the first DNS label and
matches only a single label. You cannot have a wildcard label by itself (e.g. Host == "*").
Requests will be matched against the Host field in the following way:
1. If host is precise, the request matches this rule if the http host header is equal to Host.
2. If host is a wildcard, then the request matches this rule if the http host header
is to equal to the suffix (removing the first label) of the wildcard rule.
http object
HTTPIngressRuleValue is a list of http selectors pointing to backends.
In the example: http://<host>/<path>?<searchpart> -> backend where
where parts of the url correspond to RFC 3986, this resource will be used
to match against everything after the last '/' and before the first '?'
or '#'.
paths []object required
paths is a collection of paths that map requests to backends.
backend object required
backend defines the referenced service endpoint to which the traffic
will be forwarded to.
resource object
resource is an ObjectRef to another Kubernetes resource in the namespace
of the Ingress object. If resource is specified, a service.Name and
service.Port must not be specified.
This is a mutually exclusive setting with "Service".
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.
kind
string required
Kind is the type of resource being referenced
name
string required
Name is the name of resource being referenced
service object
service references a service as a backend.
This is a mutually exclusive setting with "Resource".
name
string required
name is the referenced service. The service must exist in
the same namespace as the Ingress object.
port object
port of the referenced service. A port name or port number
is required for a IngressServiceBackend.
name
string
name is the name of the port on the Service.
This is a mutually exclusive setting with "Number".
number
integer
number is the numerical port number (e.g. 80) on the Service.
This is a mutually exclusive setting with "Name".
format:
int32
path
string
path is matched against the path of an incoming request. Currently it can
contain characters disallowed from the conventional "path" part of a URL
as defined by RFC 3986. Paths must begin with a '/' and must be present
when using PathType with value "Exact" or "Prefix".
pathType
string required
pathType determines the interpretation of the path matching. PathType can
be one of the following values:
* Exact: Matches the URL path exactly.
* Prefix: Matches based on a URL path prefix split by '/'. Matching is
done on a path element by element basis. A path element refers is the
list of labels in the path split by the '/' separator. A request is a
match for path p if every p is an element-wise prefix of p of the
request path. Note that if the last element of the path is a substring
of the last element in request path, it is not a match (e.g. /foo/bar
matches /foo/bar/baz, but does not match /foo/barbaz).
* ImplementationSpecific: Interpretation of the Path matching is up to
the IngressClass. Implementations can treat this as a separate PathType
or treat it identically to Prefix or Exact path types.
Implementations are required to support all path types.
tls []object
tls represents the TLS configuration. Currently the Ingress only supports a
single TLS port, 443. If multiple members of this list specify different hosts,
they will be multiplexed on the same port according to the hostname specified
through the SNI TLS extension, if the ingress controller fulfilling the
ingress supports SNI.
hosts
[]string
hosts is a list of hosts included in the TLS certificate. The values in
this list must match the name/s used in the tlsSecret. Defaults to the
wildcard host setting for the loadbalancer controller fulfilling this
Ingress, if left unspecified.
secretName
string
secretName is the name of the secret used to terminate TLS traffic on
port 443. Field is left optional to allow TLS routing based on SNI
hostname alone. If the SNI host in a listener conflicts with the "Host"
header field used by an IngressRule, the SNI host is used for termination
and value of the "Host" header is used for routing.
jsonnet object
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.
matchExpressions []object
matchExpressions is a list of label selector requirements. The requirements are ANDed.
key
string required
key is the label key that the selector applies to.
operator
string required
operator represents a key's relationship to a set of values.
Valid operators are In, NotIn, Exists and DoesNotExist.
values
[]string
values is an array of string values. If the operator is In or NotIn,
the values array must be non-empty. If the operator is Exists or DoesNotExist,
the values array must be empty. This array is replaced during a strategic
merge patch.
matchLabels
object
matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels
map is equivalent to an element of matchExpressions, whose key field is "key", the
operator is "In", and the values array contains only "value". The requirements are ANDed.
persistentVolumeClaim object
PersistentVolumeClaim creates a PVC if you need to attach one to your grafana instance.
metadata object
ObjectMeta contains only a [subset of the fields included in k8s.io/apimachinery/pkg/apis/meta/v1.ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.27/#objectmeta-v1-meta).
annotations
object
labels
object
spec object
accessModes
[]string
dataSource object
TypedLocalObjectReference contains enough information to let you locate the
typed referenced object inside the same namespace.
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.
kind
string required
Kind is the type of resource being referenced
name
string required
Name is the name of resource being referenced
dataSourceRef object
TypedLocalObjectReference contains enough information to let you locate the
typed referenced object inside the same namespace.
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.
kind
string required
Kind is the type of resource being referenced
name
string required
Name is the name of resource being referenced
resources object
ResourceRequirements describes the compute resource requirements.
claims []object
Claims lists the names of resources, defined in spec.resourceClaims,
that are used by this container.
This field depends on the
DynamicResourceAllocation feature gate.
This field is immutable. It can only be set for containers.
name
string required
Name must match the name of one entry in pod.spec.resourceClaims of
the Pod where this field is used. It makes that resource available
inside a container.
request
string
Request is the name chosen for a request in the referenced claim.
If empty, everything from the claim is made available, otherwise
only the result of this request.
limits
object
Limits describes the maximum amount of compute resources allowed.
More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
requests
object
Requests describes the minimum amount of compute resources required.
If Requests is omitted for a container, it defaults to Limits if that is explicitly specified,
otherwise to an implementation-defined value. Requests cannot exceed Limits.
More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
selector object
A label selector is a label query over a set of resources. The result of matchLabels and
matchExpressions are ANDed. An empty label selector matches all objects. A null
label selector matches no objects.
matchExpressions []object
matchExpressions is a list of label selector requirements. The requirements are ANDed.
key
string required
key is the label key that the selector applies to.
operator
string required
operator represents a key's relationship to a set of values.
Valid operators are In, NotIn, Exists and DoesNotExist.
values
[]string
values is an array of string values. If the operator is In or NotIn,
the values array must be non-empty. If the operator is Exists or DoesNotExist,
the values array must be empty. This array is replaced during a strategic
merge patch.
matchLabels
object
matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels
map is equivalent to an element of matchExpressions, whose key field is "key", the
operator is "In", and the values array contains only "value". The requirements are ANDed.
storageClassName
string
volumeMode
string
PersistentVolumeMode describes how a volume is intended to be consumed, either Block or Filesystem.
volumeName
string
VolumeName is the binding reference to the PersistentVolume backing this claim.
preferences object
Preferences holds the Grafana Preferences settings
homeDashboardUid
string
route object
Route sets how the ingress object should look like with your grafana instance, this only works in Openshift.
metadata object
ObjectMeta contains only a [subset of the fields included in k8s.io/apimachinery/pkg/apis/meta/v1.ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.27/#objectmeta-v1-meta).
annotations
object
labels
object
spec object
alternateBackends []object
kind
string required
The kind of target that the route is referring to. Currently, only 'Service' is allowed
enum:
Service,
name
string required
name of the service/target that is being referred to. e.g. name of the service
minLength:
1
weight
integer
weight as an integer between 0 and 256, default 100, that specifies the target's relative weight
against other target reference objects. 0 suppresses requests to this backend.
format:
int32minimum:
0maximum:
256
host
string
path
string
port object
RoutePort defines a port mapping from a router to an endpoint in the service endpoints.
targetPort
string | integer required
The target port on pods selected by the service this route points to.
If this is a string, it will be looked up as a named port in the target
endpoints port list. Required
subdomain
string
tls object
TLSConfig defines config used to secure a route and provide termination
caCertificate
string
caCertificate provides the cert authority certificate contents
certificate
string
certificate provides certificate contents. This should be a single serving certificate, not a certificate
chain. Do not include a CA certificate.
destinationCACertificate
string
destinationCACertificate provides the contents of the ca certificate of the final destination. When using reencrypt
termination this file should be provided in order to have routers use it for health checks on the secure connection.
If this field is not specified, the router may provide its own destination CA and perform hostname validation using
the short service name (service.namespace.svc), which allows infrastructure generated certificates to automatically
verify.
externalCertificate object
externalCertificate provides certificate contents as a secret reference.
This should be a single serving certificate, not a certificate
chain. Do not include a CA certificate. The secret referenced should
be present in the same namespace as that of the Route.
Forbidden when `certificate` is set.
The router service account needs to be granted with read-only access to this secret,
please refer to openshift docs for additional details.
name
string
name of the referent.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
insecureEdgeTerminationPolicy
string
insecureEdgeTerminationPolicy indicates the desired behavior for insecure connections to a route. While
each router may make its own decisions on which ports to expose, this is normally port 80.
If a route does not specify insecureEdgeTerminationPolicy, then the default behavior is "None".
* Allow - traffic is sent to the server on the insecure port (edge/reencrypt terminations only).
* None - no traffic is allowed on the insecure port (default).
* Redirect - clients are redirected to the secure port.
enum:
Allow, None, Redirect,
key
string
key provides key file contents
termination
string required
termination indicates termination type.
* edge - TLS termination is done by the router and http is used to communicate with the backend (default)
* passthrough - Traffic is sent straight to the destination without the router providing TLS termination
* reencrypt - TLS termination is done by the router and https is used to communicate with the backend
Note: passthrough termination is incompatible with httpHeader actions
enum:
edge, reencrypt, passthroughto object
RouteTargetReference specifies the target that resolve into endpoints. Only the 'Service'
kind is allowed. Use 'weight' field to emphasize one over others.
kind
string required
The kind of target that the route is referring to. Currently, only 'Service' is allowed
enum:
Service,
name
string required
name of the service/target that is being referred to. e.g. name of the service
minLength:
1
weight
integer
weight as an integer between 0 and 256, default 100, that specifies the target's relative weight
against other target reference objects. 0 suppresses requests to this backend.
format:
int32minimum:
0maximum:
256
wildcardPolicy
string
WildcardPolicyType indicates the type of wildcard support needed by routes.
service object
Service sets how the service object should look like with your grafana instance, contains a number of defaults.
metadata object
ObjectMeta contains only a [subset of the fields included in k8s.io/apimachinery/pkg/apis/meta/v1.ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.27/#objectmeta-v1-meta).
annotations
object
labels
object
spec object
ServiceSpec describes the attributes that a user creates on a service.
allocateLoadBalancerNodePorts
boolean
allocateLoadBalancerNodePorts defines if NodePorts will be automatically
allocated for services with type LoadBalancer. Default is "true". It
may be set to "false" if the cluster load-balancer does not rely on
NodePorts. If the caller requests specific NodePorts (by specifying a
value), those requests will be respected, regardless of this field.
This field may only be set for services with type LoadBalancer and will
be cleared if the type is changed to any other type.
clusterIP
string
clusterIP is the IP address of the service and is usually assigned
randomly. If an address is specified manually, is in-range (as per
system configuration), and is not in use, it will be allocated to the
service; otherwise creation of the service will fail. This field may not
be changed through updates unless the type field is also being changed
to ExternalName (which requires this field to be blank) or the type
field is being changed from ExternalName (in which case this field may
optionally be specified, as describe above). Valid values are "None",
empty string (""), or a valid IP address. Setting this to "None" makes a
"headless service" (no virtual IP), which is useful when direct endpoint
connections are preferred and proxying is not required. Only applies to
types ClusterIP, NodePort, and LoadBalancer. If this field is specified
when creating a Service of type ExternalName, creation will fail. This
field will be wiped when updating a Service to type ExternalName.
More info: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies
clusterIPs
[]string
ClusterIPs is a list of IP addresses assigned to this service, and are
usually assigned randomly. If an address is specified manually, is
in-range (as per system configuration), and is not in use, it will be
allocated to the service; otherwise creation of the service will fail.
This field may not be changed through updates unless the type field is
also being changed to ExternalName (which requires this field to be
empty) or the type field is being changed from ExternalName (in which
case this field may optionally be specified, as describe above). Valid
values are "None", empty string (""), or a valid IP address. Setting
this to "None" makes a "headless service" (no virtual IP), which is
useful when direct endpoint connections are preferred and proxying is
not required. Only applies to types ClusterIP, NodePort, and
LoadBalancer. If this field is specified when creating a Service of type
ExternalName, creation will fail. This field will be wiped when updating
a Service to type ExternalName. If this field is not specified, it will
be initialized from the clusterIP field. If this field is specified,
clients must ensure that clusterIPs[0] and clusterIP have the same
value.
This field may hold a maximum of two entries (dual-stack IPs, in either order).
These IPs must correspond to the values of the ipFamilies field. Both
clusterIPs and ipFamilies are governed by the ipFamilyPolicy field.
More info: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies
externalIPs
[]string
externalIPs is a list of IP addresses for which nodes in the cluster
will also accept traffic for this service. These IPs are not managed by
Kubernetes. The user is responsible for ensuring that traffic arrives
at a node with this IP. A common example is external load-balancers
that are not part of the Kubernetes system.
externalName
string
externalName is the external reference that discovery mechanisms will
return as an alias for this service (e.g. a DNS CNAME record). No
proxying will be involved. Must be a lowercase RFC-1123 hostname
(https://tools.ietf.org/html/rfc1123) and requires `type` to be "ExternalName".
externalTrafficPolicy
string
externalTrafficPolicy describes how nodes distribute service traffic they
receive on one of the Service's "externally-facing" addresses (NodePorts,
ExternalIPs, and LoadBalancer IPs). If set to "Local", the proxy will configure
the service in a way that assumes that external load balancers will take care
of balancing the service traffic between nodes, and so each node will deliver
traffic only to the node-local endpoints of the service, without masquerading
the client source IP. (Traffic mistakenly sent to a node with no endpoints will
be dropped.) The default value, "Cluster", uses the standard behavior of
routing to all endpoints evenly (possibly modified by topology and other
features). Note that traffic sent to an External IP or LoadBalancer IP from
within the cluster will always get "Cluster" semantics, but clients sending to
a NodePort from within the cluster may need to take traffic policy into account
when picking a node.
healthCheckNodePort
integer
healthCheckNodePort specifies the healthcheck nodePort for the service.
This only applies when type is set to LoadBalancer and
externalTrafficPolicy is set to Local. If a value is specified, is
in-range, and is not in use, it will be used. If not specified, a value
will be automatically allocated. External systems (e.g. load-balancers)
can use this port to determine if a given node holds endpoints for this
service or not. If this field is specified when creating a Service
which does not need it, creation will fail. This field will be wiped
when updating a Service to no longer need it (e.g. changing type).
This field cannot be updated once set.
format:
int32
internalTrafficPolicy
string
InternalTrafficPolicy describes how nodes distribute service traffic they
receive on the ClusterIP. If set to "Local", the proxy will assume that pods
only want to talk to endpoints of the service on the same node as the pod,
dropping the traffic if there are no local endpoints. The default value,
"Cluster", uses the standard behavior of routing to all endpoints evenly
(possibly modified by topology and other features).
ipFamilies
[]string
IPFamilies is a list of IP families (e.g. IPv4, IPv6) assigned to this
service. This field is usually assigned automatically based on cluster
configuration and the ipFamilyPolicy field. If this field is specified
manually, the requested family is available in the cluster,
and ipFamilyPolicy allows it, it will be used; otherwise creation of
the service will fail. This field is conditionally mutable: it allows
for adding or removing a secondary IP family, but it does not allow
changing the primary IP family of the Service. Valid values are "IPv4"
and "IPv6". This field only applies to Services of types ClusterIP,
NodePort, and LoadBalancer, and does apply to "headless" services.
This field will be wiped when updating a Service to type ExternalName.
This field may hold a maximum of two entries (dual-stack families, in
either order). These families must correspond to the values of the
clusterIPs field, if specified. Both clusterIPs and ipFamilies are
governed by the ipFamilyPolicy field.
ipFamilyPolicy
string
IPFamilyPolicy represents the dual-stack-ness requested or required by
this Service. If there is no value provided, then this field will be set
to SingleStack. Services can be "SingleStack" (a single IP family),
"PreferDualStack" (two IP families on dual-stack configured clusters or
a single IP family on single-stack clusters), or "RequireDualStack"
(two IP families on dual-stack configured clusters, otherwise fail). The
ipFamilies and clusterIPs fields depend on the value of this field. This
field will be wiped when updating a service to type ExternalName.
loadBalancerClass
string
loadBalancerClass is the class of the load balancer implementation this Service belongs to.
If specified, the value of this field must be a label-style identifier, with an optional prefix,
e.g. "internal-vip" or "example.com/internal-vip". Unprefixed names are reserved for end-users.
This field can only be set when the Service type is 'LoadBalancer'. If not set, the default load
balancer implementation is used, today this is typically done through the cloud provider integration,
but should apply for any default implementation. If set, it is assumed that a load balancer
implementation is watching for Services with a matching class. Any default load balancer
implementation (e.g. cloud providers) should ignore Services that set this field.
This field can only be set when creating or updating a Service to type 'LoadBalancer'.
Once set, it can not be changed. This field will be wiped when a service is updated to a non 'LoadBalancer' type.
loadBalancerIP
string
Only applies to Service Type: LoadBalancer.
This feature depends on whether the underlying cloud-provider supports specifying
the loadBalancerIP when a load balancer is created.
This field will be ignored if the cloud-provider does not support the feature.
Deprecated: This field was under-specified and its meaning varies across implementations.
Using it is non-portable and it may not support dual-stack.
Users are encouraged to use implementation-specific annotations when available.
loadBalancerSourceRanges
[]string
If specified and supported by the platform, this will restrict traffic through the cloud-provider
load-balancer will be restricted to the specified client IPs. This field will be ignored if the
cloud-provider does not support the feature."
More info: https://kubernetes.io/docs/tasks/access-application-cluster/create-external-load-balancer/
ports []object
The list of ports that are exposed by this service.
More info: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies
appProtocol
string
The application protocol for this port.
This is used as a hint for implementations to offer richer behavior for protocols that they understand.
This field follows standard Kubernetes label syntax.
Valid values are either:
* Un-prefixed protocol names - reserved for IANA standard service names (as per
RFC-6335 and https://www.iana.org/assignments/service-names).
* Kubernetes-defined prefixed names:
* 'kubernetes.io/h2c' - HTTP/2 prior knowledge over cleartext as described in https://www.rfc-editor.org/rfc/rfc9113.html#name-starting-http-2-with-prior-
* 'kubernetes.io/ws' - WebSocket over cleartext as described in https://www.rfc-editor.org/rfc/rfc6455
* 'kubernetes.io/wss' - WebSocket over TLS as described in https://www.rfc-editor.org/rfc/rfc6455
* Other protocols should use implementation-defined prefixed names such as
mycompany.com/my-custom-protocol.
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.
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
port
integer required
The port that will be exposed by this service.
format:
int32
protocol
string
The IP protocol for this port. Supports "TCP", "UDP", and "SCTP".
Default is TCP.
targetPort
string | integer
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
publishNotReadyAddresses
boolean
publishNotReadyAddresses indicates that any agent which deals with endpoints for this
Service should disregard any indications of ready/not-ready.
The primary use case for setting this field is for a StatefulSet's Headless Service to
propagate SRV DNS records for its Pods for the purpose of peer discovery.
The Kubernetes controllers that generate Endpoints and EndpointSlice resources for
Services interpret this to mean that all endpoints are considered "ready" even if the
Pods themselves are not. Agents which consume only Kubernetes generated endpoints
through the Endpoints or EndpointSlice resources can safely assume this behavior.
selector
object
Route service traffic to pods with label keys and values matching this
selector. If empty or not present, the service is assumed to have an
external process managing its endpoints, which Kubernetes will not
modify. Only applies to types ClusterIP, NodePort, and LoadBalancer.
Ignored if type is ExternalName.
More info: https://kubernetes.io/docs/concepts/services-networking/service/
sessionAffinity
string
Supports "ClientIP" and "None". Used to maintain session affinity.
Enable client IP based session affinity.
Must be ClientIP or None.
Defaults to None.
More info: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies
sessionAffinityConfig object
sessionAffinityConfig contains the configurations of session affinity.
clientIP object
clientIP contains the configurations of Client IP based session affinity.
timeoutSeconds
integer
timeoutSeconds specifies the seconds of ClientIP type session sticky time.
The value must be >0 && <=86400(for 1 day) if ServiceAffinity == "ClientIP".
Default value is 10800(for 3 hours).
format:
int32
trafficDistribution
string
TrafficDistribution offers a way to express preferences for how traffic
is distributed to Service endpoints. Implementations can use this field
as a hint, but are not required to guarantee strict adherence. If the
field is not set, the implementation will apply its default routing
strategy. If set to "PreferClose", implementations should prioritize
endpoints that are in the same zone.
type
string
type determines how the Service is exposed. Defaults to ClusterIP. Valid
options are ExternalName, ClusterIP, NodePort, and LoadBalancer.
"ClusterIP" allocates a cluster-internal IP address for load-balancing
to endpoints. Endpoints are determined by the selector or if that is not
specified, by manual construction of an Endpoints object or
EndpointSlice objects. If clusterIP is "None", no virtual IP is
allocated and the endpoints are published as a set of endpoints rather
than a virtual IP.
"NodePort" builds on ClusterIP and allocates a port on every node which
routes to the same endpoints as the clusterIP.
"LoadBalancer" builds on NodePort and creates an external load-balancer
(if supported in the current cloud) which routes to the same endpoints
as the clusterIP.
"ExternalName" aliases this service to the specified externalName.
Several other fields do not apply to ExternalName services.
More info: https://kubernetes.io/docs/concepts/services-networking/service/#publishing-services-service-types
serviceAccount object
ServiceAccount sets how the ServiceAccount object should look like with your grafana instance, contains a number of defaults.
automountServiceAccountToken
boolean
imagePullSecrets []object
name
string
Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
metadata object
ObjectMeta contains only a [subset of the fields included in k8s.io/apimachinery/pkg/apis/meta/v1.ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.27/#objectmeta-v1-meta).
annotations
object
labels
object
secrets []object
apiVersion
string
API version of the referent.
fieldPath
string
If referring to a piece of an object instead of an entire object, this string
should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2].
For example, if the object reference is to a container within a pod, this would take on a value like:
"spec.containers{name}" (where "name" refers to the name of the container that triggered
the event) or if no container name is specified "spec.containers[2]" (container with
index 2 in this pod). This syntax is chosen only to have some well-defined way of
referencing a part of an object.
kind
string
Kind of the referent.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
name
string
Name of the referent.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
namespace
string
Namespace of the referent.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/
resourceVersion
string
Specific resourceVersion to which this reference is made, if any.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency
uid
string
UID of the referent.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids
suspend
boolean
Suspend pauses reconciliation of owned resources like deployments, Services, Etc. upon changes
version
string
Version specifies the version of Grafana to use for this deployment. It follows the same format as the docker.io/grafana/grafana tags
status object
GrafanaStatus defines the observed state of Grafana
adminUrl
string
alertRuleGroups
[]string
conditions []object
lastTransitionTime
string required
lastTransitionTime is the last time the condition transitioned from one status to another.
This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.
format:
date-time
message
string required
message is a human readable message indicating details about the transition.
This may be an empty string.
maxLength:
32768
observedGeneration
integer
observedGeneration represents the .metadata.generation that the condition was set based upon.
For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date
with respect to the current state of the instance.
format:
int64minimum:
0
reason
string required
reason contains a programmatic identifier indicating the reason for the condition's last transition.
Producers of specific condition types may define expected values and meanings for this field,
and whether the values are considered a guaranteed API.
The value should be a CamelCase string.
This field may not be empty.
pattern:
^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$minLength:
1maxLength:
1024
status
string required
status of the condition, one of True, False, Unknown.
enum:
True, False, Unknown
type
string required
type of condition in CamelCase or in foo.example.com/CamelCase.
pattern:
^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$maxLength:
316
contactPoints
[]string
dashboards
[]string
datasources
[]string
folders
[]string
lastMessage
string
libraryPanels
[]string
muteTimings
[]string
notificationTemplates
[]string
serviceaccounts
[]string
stage
string
stageStatus
string
version
string
No matches. Try .spec.client for an exact path