VMCluster
operator.victoriametrics.com / v1beta1
apiVersion: operator.victoriametrics.com/v1beta1
kind: VMCluster
metadata:
name: example
apiVersion
string
kind
string
metadata
object
spec object required
clusterDomainName
string
clusterVersion
string
discovery object
enabled
boolean required
filter
string
interval
string
pattern:
^[0-9]+(s|m|h)$downsampling object
dedupInterval
string
rules []object
filter
string
periods []object required
interval
string required
offset
string required
imagePullSecrets []object
name
string
license object
forceOffline
boolean
key
string
keyRef object
key
string required
name
string
optional
boolean
reloadInterval
string
managedMetadata object
annotations
object
labels
object
paused
boolean
replicationFactor
integer
format:
int32requestsLoadBalancer object
disableInsertBalancing
boolean
disableSelectBalancing
boolean
enabled
boolean
spec
object
retentionPeriod
string
pattern:
^[0-9]+(h|d|w|y)?$
serviceAccountName
string
useStrictSecurity
boolean
vminsert object
affinity
object
clusterNativeListenPort
string
componentVersion
string
configMaps
[]string
containers
[]object
disableAutomountServiceAccountToken
boolean
disableSelfServiceScrape
boolean
discovery object
enabled
boolean required
filter
string
interval
string
pattern:
^[0-9]+(s|m|h)$dnsConfig object
nameservers
[]string
options []object
name
string
value
string
searches
[]string
dnsPolicy
string
enableServiceLinks
boolean
extraArgs
object
extraEnvs []object
name
string required
value
string
extraEnvsFrom []object
configMapRef object
name
string
optional
boolean
prefix
string
secretRef object
name
string
optional
boolean
hostAliases []object
hostnames
[]string
ip
string required
hostNetwork
boolean
host_aliases []object
hostnames
[]string
ip
string required
hpa
object
image object
pullPolicy
string
repository
string
tag
string
imagePullSecrets []object
name
string
initContainers
[]object
insertPorts object
graphitePort
string
influxPort
string
openTSDBHTTPPort
string
openTSDBPort
string
livenessProbe
object
logFormat
string
enum:
default, json
logLevel
string
enum:
INFO, WARN, ERROR, FATAL, PANIC
minReadySeconds
integer
format:
int32
nodeSelector
object
paused
boolean
podDisruptionBudget object
maxUnavailable
string | integer
minAvailable
string | integer
selectorLabels
object
unhealthyPodEvictionPolicy
string
enum:
IfHealthyBudget, AlwaysAllowpodMetadata object
annotations
object
labels
object
name
string
port
string
preStopSleepSeconds
integer
format:
int32
priorityClassName
string
readinessGates []object
conditionType
string required
readinessProbe
object
replicaCount
integer
format:
int32resources object
claims []object
name
string required
request
string
limits
object
requests
object
revisionHistoryLimitCount
integer
format:
int32rollingUpdate object
maxSurge
string | integer
maxUnavailable
string | integer
runtimeClassName
string
schedulerName
string
secrets
[]string
securityContext
object
serviceScrapeSpec
object
serviceSpec object
metadata object
annotations
object
labels
object
name
string
spec
object required
useAsDefault
boolean
startupProbe
object
terminationGracePeriodSeconds
integer
format:
int64tolerations []object
effect
string
key
string
operator
string
tolerationSeconds
integer
format:
int64
value
string
topologySpreadConstraints
[]object
updateStrategy
string
enum:
Recreate, RollingUpdate
useDefaultResources
boolean
useStrictSecurity
boolean
volumeMounts []object
mountPath
string required
mountPropagation
string
name
string required
readOnly
boolean
recursiveReadOnly
string
subPath
string
subPathExpr
string
volumes
[]object
vpa object
recommenders []object
name
string required
resourcePolicy object
containerPolicies []object
containerName
string
controlledResources
[]string
controlledValues
string
enum:
RequestsAndLimits, RequestsOnly
maxAllowed
object
memoryAggregationIntervalCount
integer
format:
int64minimum:
1
memoryAggregationIntervalSeconds
integer
format:
int32minimum:
1
minAllowed
object
mode
string
enum:
Auto, Off
oomBumpUpRatio
string | integer
string pattern:
^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
oomMinBumpUp
string | integer
string pattern:
^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$startupBoost object
cpu object
durationSeconds
integer
format:
int32
factor
integer
format:
int32
quantity
string | integer
string pattern:
^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
type
string required
enum:
Factor, QuantityupdatePolicy object
evictAfterOOMSeconds
integer
format:
int32minimum:
1evictionRequirements []object
changeRequirement
string required
enum:
TargetHigherThanRequests, TargetLowerThanRequests
resources
[]string required
minReplicas
integer
format:
int32
updateMode
string
enum:
Off, Initial, Recreate, InPlaceOrRecreate, InPlace, Autovmselect object
affinity
object
cacheMountPath
string
claimTemplates
[]object
clusterNativeListenPort
string
componentVersion
string
configMaps
[]string
containers
[]object
disableAutomountServiceAccountToken
boolean
disableSelfServiceScrape
boolean
discovery object
enabled
boolean required
filter
string
interval
string
pattern:
^[0-9]+(s|m|h)$dnsConfig object
nameservers
[]string
options []object
name
string
value
string
searches
[]string
dnsPolicy
string
enableServiceLinks
boolean
extraArgs
object
extraEnvs []object
name
string required
value
string
extraEnvsFrom []object
configMapRef object
name
string
optional
boolean
prefix
string
secretRef object
name
string
optional
boolean
hostAliases []object
hostnames
[]string
ip
string required
hostNetwork
boolean
host_aliases []object
hostnames
[]string
ip
string required
hpa
object
image object
pullPolicy
string
repository
string
tag
string
imagePullSecrets []object
name
string
initContainers
[]object
livenessProbe
object
logFormat
string
enum:
default, json
logLevel
string
enum:
INFO, WARN, ERROR, FATAL, PANIC
minReadySeconds
integer
format:
int32
nodeSelector
object
paused
boolean
persistentVolumeClaimRetentionPolicy object
whenDeleted
string
whenScaled
string
podDisruptionBudget object
maxUnavailable
string | integer
minAvailable
string | integer
selectorLabels
object
unhealthyPodEvictionPolicy
string
enum:
IfHealthyBudget, AlwaysAllowpodMetadata object
annotations
object
labels
object
name
string
port
string
preStopSleepSeconds
integer
format:
int32
priorityClassName
string
readinessGates []object
conditionType
string required
readinessProbe
object
replicaCount
integer
format:
int32resources object
claims []object
name
string required
request
string
limits
object
requests
object
revisionHistoryLimitCount
integer
format:
int32
rollingUpdateStrategy
string
rollingUpdateStrategyBehavior object
maxUnavailable
string | integer
runtimeClassName
string
schedulerName
string
secrets
[]string
securityContext
object
serviceScrapeSpec
object
serviceSpec object
metadata object
annotations
object
labels
object
name
string
spec
object required
useAsDefault
boolean
startupProbe
object
storage object
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]+))))?$volumeClaimTemplate object
apiVersion
string
kind
string
metadata object
annotations
object
labels
object
name
string
spec object
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
status object
accessModes
[]string
allocatedResourceStatuses
object
allocatedResources
object
capacity
object
conditions []object
lastProbeTime
string
format:
date-time
lastTransitionTime
string
format:
date-time
message
string
reason
string
status
string required
type
string required
currentVolumeAttributesClassName
string
modifyVolumeStatus object
status
string required
targetVolumeAttributesClassName
string
phase
string
terminationGracePeriodSeconds
integer
format:
int64tolerations []object
effect
string
key
string
operator
string
tolerationSeconds
integer
format:
int64
value
string
topologySpreadConstraints
[]object
useDefaultResources
boolean
useStrictSecurity
boolean
volumeMounts []object
mountPath
string required
mountPropagation
string
name
string required
readOnly
boolean
recursiveReadOnly
string
subPath
string
subPathExpr
string
volumes
[]object
vpa object
recommenders []object
name
string required
resourcePolicy object
containerPolicies []object
containerName
string
controlledResources
[]string
controlledValues
string
enum:
RequestsAndLimits, RequestsOnly
maxAllowed
object
memoryAggregationIntervalCount
integer
format:
int64minimum:
1
memoryAggregationIntervalSeconds
integer
format:
int32minimum:
1
minAllowed
object
mode
string
enum:
Auto, Off
oomBumpUpRatio
string | integer
string pattern:
^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
oomMinBumpUp
string | integer
string pattern:
^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$startupBoost object
cpu object
durationSeconds
integer
format:
int32
factor
integer
format:
int32
quantity
string | integer
string pattern:
^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
type
string required
enum:
Factor, QuantityupdatePolicy object
evictAfterOOMSeconds
integer
format:
int32minimum:
1evictionRequirements []object
changeRequirement
string required
enum:
TargetHigherThanRequests, TargetLowerThanRequests
resources
[]string required
minReplicas
integer
format:
int32
updateMode
string
enum:
Off, Initial, Recreate, InPlaceOrRecreate, InPlace, Autovmstorage object
affinity
object
claimTemplates
[]object
componentVersion
string
configMaps
[]string
containers
[]object
disableAutomountServiceAccountToken
boolean
disableSelfServiceScrape
boolean
dnsConfig object
nameservers
[]string
options []object
name
string
value
string
searches
[]string
dnsPolicy
string
enableServiceLinks
boolean
extraArgs
object
extraEnvs []object
name
string required
value
string
extraEnvsFrom []object
configMapRef object
name
string
optional
boolean
prefix
string
secretRef object
name
string
optional
boolean
hostAliases []object
hostnames
[]string
ip
string required
hostNetwork
boolean
host_aliases []object
hostnames
[]string
ip
string required
hpa object
behaviour object
scaleDown object
policies []object
periodSeconds
integer required
format:
int32
type
string required
value
integer required
format:
int32
selectPolicy
string
stabilizationWindowSeconds
integer
format:
int32
tolerance
string | integer
string pattern:
^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$scaleUp object
policies []object
periodSeconds
integer required
format:
int32
type
string required
value
integer required
format:
int32
selectPolicy
string
stabilizationWindowSeconds
integer
format:
int32
tolerance
string | integer
string pattern:
^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
maxReplicas
integer
format:
int32metrics []object
containerResource object
container
string required
name
string required
target object required
averageUtilization
integer
format:
int32
averageValue
string | integer
string pattern:
^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
type
string required
value
string | integer
string pattern:
^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$external object
metric object required
name
string required
selector object
matchExpressions []object
key
string required
operator
string required
values
[]string
matchLabels
object
target object required
averageUtilization
integer
format:
int32
averageValue
string | integer
string pattern:
^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
type
string required
value
string | integer
string pattern:
^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$object object
describedObject object required
apiVersion
string
kind
string required
name
string required
metric object required
name
string required
selector object
matchExpressions []object
key
string required
operator
string required
values
[]string
matchLabels
object
target object required
averageUtilization
integer
format:
int32
averageValue
string | integer
string pattern:
^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
type
string required
value
string | integer
string pattern:
^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$pods object
metric object required
name
string required
selector object
matchExpressions []object
key
string required
operator
string required
values
[]string
matchLabels
object
target object required
averageUtilization
integer
format:
int32
averageValue
string | integer
string pattern:
^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
type
string required
value
string | integer
string pattern:
^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$resource object
name
string required
target object required
averageUtilization
integer
format:
int32
averageValue
string | integer
string pattern:
^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
type
string required
value
string | integer
string pattern:
^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
type
string required
minReplicas
integer
format:
int32image object
pullPolicy
string
repository
string
tag
string
imagePullSecrets []object
name
string
initContainers
[]object
livenessProbe
object
logFormat
string
enum:
default, json
logLevel
string
enum:
INFO, WARN, ERROR, FATAL, PANIC
maintenanceInsertNodeIDs
[]integer
maintenanceSelectNodeIDs
[]integer
minReadySeconds
integer
format:
int32
nodeSelector
object
paused
boolean
persistentVolumeClaimRetentionPolicy object
whenDeleted
string
whenScaled
string
podDisruptionBudget object
maxUnavailable
string | integer
minAvailable
string | integer
selectorLabels
object
unhealthyPodEvictionPolicy
string
enum:
IfHealthyBudget, AlwaysAllowpodMetadata object
annotations
object
labels
object
name
string
port
string
preStopSleepSeconds
integer
format:
int32
priorityClassName
string
readinessGates []object
conditionType
string required
readinessProbe
object
replicaCount
integer
format:
int32resources object
claims []object
name
string required
request
string
limits
object
requests
object
retentionFilters []object
filter
string required
retention
string required
revisionHistoryLimitCount
integer
format:
int32
rollingUpdateStrategy
string
rollingUpdateStrategyBehavior object
maxUnavailable
string | integer
runtimeClassName
string
schedulerName
string
secrets
[]string
securityContext
object
serviceScrapeSpec
object
serviceSpec object
metadata object
annotations
object
labels
object
name
string
spec
object required
useAsDefault
boolean
startupProbe
object
storage object
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]+))))?$
volumeClaimTemplate
object
storageDataPath
string
terminationGracePeriodSeconds
integer
format:
int64tolerations []object
effect
string
key
string
operator
string
tolerationSeconds
integer
format:
int64
value
string
topologySpreadConstraints
[]object
useDefaultResources
boolean
useStrictSecurity
boolean
vmBackup object
acceptEULA
boolean
concurrency
integer
format:
int32credentialsSecret object
key
string required
name
string
optional
boolean
customS3Endpoint
string
destination
string
destinationDisableSuffixAdd
boolean
disableDaily
boolean
disableHourly
boolean
disableMonthly
boolean
disableWeekly
boolean
extraArgs
object
extraEnvs []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
extraEnvsFrom []object
configMapRef object
name
string
optional
boolean
prefix
string
secretRef object
name
string
optional
boolean
image object
pullPolicy
string
repository
string
tag
string
logFormat
string
enum:
default, json
logLevel
string
enum:
INFO, WARN, ERROR, FATAL, PANIC
port
string
resources object
claims []object
name
string required
request
string
limits
object
requests
object
restore object
onStart object
enabled
boolean
snapshotCreateURL
string
snapshotDeleteURL
string
volumeMounts []object
mountPath
string required
mountPropagation
string
name
string required
readOnly
boolean
recursiveReadOnly
string
subPath
string
subPathExpr
string
vmInsertPort
string
vmSelectPort
string
volumeMounts []object
mountPath
string required
mountPropagation
string
name
string required
readOnly
boolean
recursiveReadOnly
string
subPath
string
subPathExpr
string
volumes
[]object
vpa object
recommenders []object
name
string required
resourcePolicy object
containerPolicies []object
containerName
string
controlledResources
[]string
controlledValues
string
enum:
RequestsAndLimits, RequestsOnly
maxAllowed
object
memoryAggregationIntervalCount
integer
format:
int64minimum:
1
memoryAggregationIntervalSeconds
integer
format:
int32minimum:
1
minAllowed
object
mode
string
enum:
Auto, Off
oomBumpUpRatio
string | integer
string pattern:
^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
oomMinBumpUp
string | integer
string pattern:
^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$startupBoost object
cpu object
durationSeconds
integer
format:
int32
factor
integer
format:
int32
quantity
string | integer
string pattern:
^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
type
string required
enum:
Factor, QuantityupdatePolicy object
evictAfterOOMSeconds
integer
format:
int32minimum:
1evictionRequirements []object
changeRequirement
string required
enum:
TargetHigherThanRequests, TargetLowerThanRequests
resources
[]string required
minReplicas
integer
format:
int32
updateMode
string
enum:
Off, Initial, Recreate, InPlaceOrRecreate, InPlace, Autostatus object
conditions []object
lastTransitionTime
string required
format:
date-time
lastUpdateTime
string required
format:
date-time
message
string
maxLength:
32768
observedGeneration
integer
format:
int64minimum:
0
reason
string required
minLength:
1maxLength:
1024
status
string required
enum:
True, False, Unknown
type
string required
maxLength:
316
lastAppliedSpec
object
observedGeneration
integer
format:
int64
reason
string
updateStatus
string
No matches. Try .spec.clusterDomainName for an exact path