VMCluster

operator.victoriametrics.com / v1beta1

apiVersion: operator.victoriametrics.com/v1beta1 kind: VMCluster 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

VMClusterSpec defines the desired state of VMCluster

clusterDomainName string

ClusterDomainName defines domain name suffix for in-cluster dns addresses aka .cluster.local used by vminsert and vmselect to build vmstorage address

clusterVersion string

ClusterVersion defines default images tag for all components. it can be overwritten with component specific image.tag value.

imagePullSecrets []object

ImagePullSecrets An optional list of references to secrets in the same namespace to use for pulling images from registries see https://kubernetes.io/docs/concepts/containers/images/#referring-to-an-imagepullsecrets-on-a-pod

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

license object

License allows to configure license key to be used for enterprise features. Using license key is supported starting from VictoriaMetrics v1.94.0. See [here](https://docs.victoriametrics.com/victoriametrics/enterprise/)

forceOffline boolean

Enforce offline verification of the license key.

key string

Enterprise license key. This flag is available only in [VictoriaMetrics enterprise](https://docs.victoriametrics.com/victoriametrics/enterprise/). To request a trial license, [go to](https://victoriametrics.com/products/enterprise/trial)

keyRef object

KeyRef is reference to secret with license key for enterprise features.

key string required

The key of the secret to select from. Must be a valid secret key.

name string

optional boolean

Specify whether the Secret or its key must be defined

reloadInterval string

Interval to be used for checking for license key changes. Note that this is only applicable when using KeyRef.

managedMetadata object

ManagedMetadata defines metadata that will be added to the all objects created by operator for the given CustomResource

annotations object

Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations

labels object

Labels Map of string keys and values that can be used to organize and categorize (scope and select) objects. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels

paused boolean

Paused If set to true all actions on the underlying managed objects are not going to be performed, except for delete actions.

replicationFactor integer

ReplicationFactor defines how many copies of data make among distinct storage nodes

format: int32

requestsLoadBalancer object

RequestsLoadBalancer configures load-balancing for vminsert and vmselect requests. It helps to evenly spread load across pods. Usually it's not possible with Kubernetes TCP-based services. See more [here](https://docs.victoriametrics.com/operator/resources/vmcluster/#requests-load-balancing)

disableInsertBalancing boolean

disableSelectBalancing boolean

enabled boolean

spec object

VMAuthLoadBalancerSpec defines configuration spec for VMAuth used as load-balancer for VMCluster component

retentionPeriod string

RetentionPeriod defines how long to retain stored metrics, specified as a duration (e.g., "1d", "1w", "1m"). Data with timestamps outside the RetentionPeriod is automatically deleted. The minimum allowed value is 1d, or 24h. The default value is 1 (one month). See [retention](https://docs.victoriametrics.com/victoriametrics/single-server-victoriametrics/#retention) docs for details.

pattern: ^[0-9]+(h|d|w|y)?$

serviceAccountName string

ServiceAccountName is the name of the ServiceAccount to use to run the VMSelect, VMStorage and VMInsert Pods.

useStrictSecurity boolean

UseStrictSecurity enables strict security mode for component it restricts disk writes access uses non-root user out of the box drops not needed security permissions

vminsert object

affinity object

Affinity If specified, the pod's scheduling constraints.

clusterNativeListenPort string

ClusterNativePort for multi-level cluster setup. More [details](https://docs.victoriametrics.com/victoriametrics/cluster-victoriametrics/#multi-level-cluster-setup)

componentVersion string

ComponentVersion defines default images tag for this component. it can be overwritten with component specific image.tag value.

configMaps []string

ConfigMaps is a list of ConfigMaps in the same namespace as the Application object, which shall be mounted into the Application container at /etc/vm/configs/CONFIGMAP_NAME folder

containers []object

Containers property allows to inject additions sidecars or to patch existing containers. It can be useful for proxies, backup, etc.

disableAutomountServiceAccountToken boolean

DisableAutomountServiceAccountToken whether to disable serviceAccount auto mount by Kubernetes (available from v0.54.0). Operator will conditionally create volumes and volumeMounts for containers if it requires k8s API access. For example, vmagent and vm-config-reloader requires k8s API access. Operator creates volumes with name: "kube-api-access", which can be used as volumeMount for extraContainers if needed. And also adds VolumeMounts at /var/run/secrets/kubernetes.io/serviceaccount.

disableSelfServiceScrape boolean

DisableSelfServiceScrape controls creation of VMServiceScrape by operator for the application. Has priority over `VM_DISABLESELFSERVICESCRAPECREATION` operator env variable

dnsConfig object

Specifies the DNS parameters of a pod. Parameters specified here will be merged to the generated DNS configuration based on DNSPolicy.

nameservers []string

A list of DNS name server IP addresses. This will be appended to the base nameservers generated from DNSPolicy. Duplicated nameservers will be removed.

options []object

A list of DNS resolver options. This will be merged with the base options generated from DNSPolicy. Duplicated entries will be removed. Resolution options given in Options will override those that appear in the base DNSPolicy.

name string

Name is this DNS resolver option's name. Required.

value string

Value is this DNS resolver option's value.

searches []string

A list of DNS search domains for host-name lookup. This will be appended to the base search paths generated from DNSPolicy. Duplicated search paths will be removed.

dnsPolicy string

DNSPolicy sets DNS policy for the pod

extraArgs object

ExtraArgs that will be passed to the application container for example remoteWrite.tmpDataPath: /tmp

extraEnvs []object

ExtraEnvs that will be passed to the application container

name string required

Name of the environment variable. May consist of any printable ASCII characters except '='.

value string

Variable references $(VAR_NAME) are expanded using the previously defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to "".

extraEnvsFrom []object

ExtraEnvsFrom defines source of env variables for the application container could either be secret or configmap

configMapRef object

The ConfigMap to select from

name string

optional boolean

Specify whether the ConfigMap must be defined

prefix string

Optional text to prepend to the name of each environment variable. May consist of any printable ASCII characters except '='.

secretRef object

The Secret to select from

name string

optional boolean

Specify whether the Secret must be defined

hostAliases []object

HostAliases provides mapping for ip and hostname, that would be propagated to pod, cannot be used with HostNetwork.

hostnames []string

Hostnames for the above IP address.

ip string required

IP address of the host file entry.

hostNetwork boolean

HostNetwork controls whether the pod may use the node network namespace

host_aliases []object

HostAliasesUnderScore provides mapping for ip and hostname, that would be propagated to pod, cannot be used with HostNetwork. Has Priority over hostAliases field

hostnames []string

Hostnames for the above IP address.

ip string required

IP address of the host file entry.

hpa object

HPA defines kubernetes PodAutoScaling configuration version 2.

image object

Image - docker image settings if no specified operator uses default version from operator config

pullPolicy string

PullPolicy describes how to pull docker image

repository string

Repository contains name of docker image + it's repository if needed

tag string

Tag contains desired docker image version

imagePullSecrets []object

name string

initContainers []object

InitContainers allows adding initContainers to the pod definition. Any errors during the execution of an initContainer will lead to a restart of the Pod. More info: https://kubernetes.io/docs/concepts/workloads/pods/init-containers/

insertPorts object

InsertPorts - additional listen ports for data ingestion.

graphitePort string

GraphitePort listen port

influxPort string

InfluxPort listen port

openTSDBHTTPPort string

OpenTSDBHTTPPort for http connections.

openTSDBPort string

OpenTSDBPort for tcp and udp listen

livenessProbe object

LivenessProbe that will be added to CR pod

logFormat string

LogFormat for VMInsert to be configured with. default or json

enum: default, json

logLevel string

LogLevel for VMInsert to be configured with.

enum: INFO, WARN, ERROR, FATAL, PANIC

minReadySeconds integer

MinReadySeconds defines a minimum number of seconds to wait before starting update next pod if previous in healthy state Has no effect for VLogs and VMSingle

format: int32

nodeSelector object

NodeSelector Define which Nodes the Pods are scheduled on.

paused boolean

Paused If set to true all actions on the underlying managed objects are not going to be performed, except for delete actions.

podDisruptionBudget object

PodDisruptionBudget created by operator

maxUnavailable string | integer

An eviction is allowed if at most "maxUnavailable" pods selected by "selector" are unavailable after the eviction, i.e. even in absence of the evicted pod. For example, one can prevent all voluntary evictions by specifying 0. This is a mutually exclusive setting with "minAvailable".

minAvailable string | integer

An eviction is allowed if at least "minAvailable" pods selected by "selector" will still be available after the eviction, i.e. even in the absence of the evicted pod. So for example you can prevent all voluntary evictions by specifying "100%".

selectorLabels object

replaces default labels selector generated by operator it's useful when you need to create custom budget

unhealthyPodEvictionPolicy string

UnhealthyPodEvictionPolicy defines the criteria for when unhealthy pods Valid policies are IfHealthyBudget and AlwaysAllow. If no policy is specified, the default behavior will be used, which corresponds to the IfHealthyBudget policy. Available from operator v0.64.0

enum: IfHealthyBudget, AlwaysAllow

podMetadata object

PodMetadata configures Labels and Annotations which are propagated to the VMInsert pods.

annotations object

labels object

Labels Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels

name string

Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names

port string

Port listen address

priorityClassName string

PriorityClassName class assigned to the Pods

readinessGates []object

ReadinessGates defines pod readiness gates

conditionType string required

ConditionType refers to a condition in the pod's condition list with matching type.

readinessProbe object

ReadinessProbe that will be added to CR pod

replicaCount integer

ReplicaCount is the expected size of the Application.

format: int32

resources object

Resources container resource request and limits, https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ if not defined default resources from operator config will be used

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/

revisionHistoryLimitCount integer

The number of old ReplicaSets to retain to allow rollback in deployment or maximum number of revisions that will be maintained in the Deployment revision history. Has no effect at StatefulSets Defaults to 10.

format: int32

rollingUpdate object

RollingUpdate - overrides deployment update params.

maxSurge string | integer

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.

maxUnavailable string | integer

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.

runtimeClassName string

RuntimeClassName - defines runtime class for kubernetes pod. https://kubernetes.io/docs/concepts/containers/runtime-class/

schedulerName string

SchedulerName - defines kubernetes scheduler name

secrets []string

Secrets is a list of Secrets in the same namespace as the Application object, which shall be mounted into the Application container at /etc/vm/secrets/SECRET_NAME folder

securityContext object

SecurityContext holds pod-level security attributes and common container settings. This defaults to the default PodSecurityContext.

serviceScrapeSpec object

ServiceScrapeSpec that will be added to vminsert VMServiceScrape spec

serviceSpec object

ServiceSpec that will be added to vminsert service spec

metadata object

EmbeddedObjectMetadata defines objectMeta for additional service.

annotations object

labels object

name string

spec object required

ServiceSpec describes the attributes that a user creates on a service. More info: https://kubernetes.io/docs/concepts/services-networking/service/

useAsDefault boolean

UseAsDefault applies changes from given service definition to the main object Service Changing from headless service to clusterIP or loadbalancer may break cross-component communication

startupProbe object

StartupProbe that will be added to CR pod

terminationGracePeriodSeconds integer

TerminationGracePeriodSeconds period for container graceful termination

format: int64

tolerations []object

Tolerations If specified, the pod's tolerations.

effect string

Effect indicates the taint effect to match. Empty means match all taint effects. When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute.

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.

operator string

Operator represents a key's relationship to the value. Valid operators are Exists, Equal, Lt, and Gt. Defaults to Equal. Exists is equivalent to wildcard for value, so that a pod can tolerate all taints of a particular category. Lt and Gt perform numeric comparisons (requires feature gate TaintTolerationComparisonOperators).

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

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.

topologySpreadConstraints []object

TopologySpreadConstraints embedded kubernetes pod configuration option, controls how pods are spread across your cluster among failure-domains such as regions, zones, nodes, and other user-defined topology domains https://kubernetes.io/docs/concepts/workloads/pods/pod-topology-spread-constraints/

updateStrategy string

UpdateStrategy - overrides default update strategy.

enum: Recreate, RollingUpdate

useDefaultResources boolean

UseDefaultResources controls resource settings By default, operator sets built-in resource requirements

useStrictSecurity boolean

UseStrictSecurity enables strict security mode for component it restricts disk writes access uses non-root user out of the box drops not needed security permissions

volumeMounts []object

VolumeMounts allows configuration of additional VolumeMounts on the output Deployment/StatefulSet definition. VolumeMounts specified will be appended to other VolumeMounts in the Application container

mountPath string required

Path within the container at which the volume should be mounted. Must not contain ':'.

mountPropagation string

mountPropagation determines how mounts are propagated from the host to container and the other way around. When not set, MountPropagationNone is used. This field is beta in 1.10. When RecursiveReadOnly is set to IfPossible or to Enabled, MountPropagation must be None or unspecified (which defaults to None).

name string required

This must match the Name of a Volume.

readOnly boolean

Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false.

recursiveReadOnly string

RecursiveReadOnly specifies whether read-only mounts should be handled recursively. If ReadOnly is false, this field has no meaning and must be unspecified. If ReadOnly is true, and this field is set to Disabled, the mount is not made recursively read-only. If this field is set to IfPossible, the mount is made recursively read-only, if it is supported by the container runtime. If this field is set to Enabled, the mount is made recursively read-only if it is supported by the container runtime, otherwise the pod will not be started and an error will be generated to indicate the reason. If this field is set to IfPossible or Enabled, MountPropagation must be set to None (or be unspecified, which defaults to None). If this field is not specified, it is treated as an equivalent of Disabled.

subPath string

Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root).

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.

volumes []object

Volumes allows configuration of additional volumes on the output Deployment/StatefulSet definition. Volumes specified will be appended to other volumes that are generated. / +optional

vpa object

Configures vertical pod autoscaling.

recommenders []object

Recommenders specifies custom VPA recommender names.

name string required

Name of the recommender responsible for generating recommendation for this object.

resourcePolicy object

ResourcePolicy controls how the autoscaler computes recommended resources per container.

containerPolicies []object

Per-container resource policies.

containerName string

Name of the container or DefaultContainerResourcePolicy, in which case the policy is used by the containers that don't have their own policy specified.

controlledResources []string

Specifies the type of recommendations that will be computed (and possibly applied) by VPA. If not specified, the default of [ResourceCPU, ResourceMemory] will be used.

controlledValues string

Specifies which resource values should be controlled. The default is "RequestsAndLimits".

enum: RequestsAndLimits, RequestsOnly

maxAllowed object

Specifies the maximum amount of resources that will be recommended for the container. The default is no maximum.

minAllowed object

Specifies the minimal amount of resources that will be recommended for the container. The default is no minimum.

mode string

Whether autoscaler is enabled for the container. The default is "Auto".

enum: Auto, Off

oomBumpUpRatio string | integer

oomBumpUpRatio is the ratio to increase memory when OOM is detected.

string pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$

oomMinBumpUp string | integer

oomMinBumpUp is the minimum increase in memory when OOM is detected.

string pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$

updatePolicy object

UpdatePolicy controls how the autoscaler applies changes to pod resources.

evictionRequirements []object

EvictionRequirements is a list of EvictionRequirements that need to evaluate to true in order for a Pod to be evicted. If more than one EvictionRequirement is specified, all of them need to be fulfilled to allow eviction.

changeRequirement string required

EvictionChangeRequirement refers to the relationship between the new target recommendation for a Pod and its current requests, what kind of change is necessary for the Pod to be evicted

enum: TargetHigherThanRequests, TargetLowerThanRequests

resources []string required

Resources is a list of one or more resources that the condition applies to. If more than one resource is given, the EvictionRequirement is fulfilled if at least one resource meets `changeRequirement`.

minReplicas integer

Minimal number of replicas which need to be alive for Updater to attempt pod eviction (pending other checks like PDB). Only positive values are allowed. Overrides global '--min-replicas' flag.

format: int32

updateMode string

Controls when autoscaler applies changes to the pod resources. The default is 'Recreate'.

enum: Off, Initial, Recreate, InPlaceOrRecreate, Auto

vmselect object

VMSelect defines configuration section for vmselect components of the victoria-metrics cluster

affinity object

Affinity If specified, the pod's scheduling constraints.

cacheMountPath string

CacheMountPath allows to add cache persistent for VMSelect, will use "/cache" as default if not specified.

claimTemplates []object

ClaimTemplates allows adding additional VolumeClaimTemplates for StatefulSet

clusterNativeListenPort string

ClusterNativePort for multi-level cluster setup. More [details](https://docs.victoriametrics.com/victoriametrics/cluster-victoriametrics/#multi-level-cluster-setup)

componentVersion string

ComponentVersion defines default images tag for this component. it can be overwritten with component specific image.tag value.

configMaps []string

ConfigMaps is a list of ConfigMaps in the same namespace as the Application object, which shall be mounted into the Application container at /etc/vm/configs/CONFIGMAP_NAME folder

containers []object

Containers property allows to inject additions sidecars or to patch existing containers. It can be useful for proxies, backup, etc.

disableAutomountServiceAccountToken boolean

disableSelfServiceScrape boolean

DisableSelfServiceScrape controls creation of VMServiceScrape by operator for the application. Has priority over `VM_DISABLESELFSERVICESCRAPECREATION` operator env variable

dnsConfig object

Specifies the DNS parameters of a pod. Parameters specified here will be merged to the generated DNS configuration based on DNSPolicy.

nameservers []string

A list of DNS name server IP addresses. This will be appended to the base nameservers generated from DNSPolicy. Duplicated nameservers will be removed.

options []object

name string

Name is this DNS resolver option's name. Required.

value string

Value is this DNS resolver option's value.

searches []string

A list of DNS search domains for host-name lookup. This will be appended to the base search paths generated from DNSPolicy. Duplicated search paths will be removed.

dnsPolicy string

DNSPolicy sets DNS policy for the pod

extraArgs object

ExtraArgs that will be passed to the application container for example remoteWrite.tmpDataPath: /tmp

extraEnvs []object

ExtraEnvs that will be passed to the application container

name string required

Name of the environment variable. May consist of any printable ASCII characters except '='.

value string

extraEnvsFrom []object

ExtraEnvsFrom defines source of env variables for the application container could either be secret or configmap

configMapRef object

The ConfigMap to select from

name string

optional boolean

Specify whether the ConfigMap must be defined

prefix string

Optional text to prepend to the name of each environment variable. May consist of any printable ASCII characters except '='.

secretRef object

The Secret to select from

name string

optional boolean

Specify whether the Secret must be defined

hostAliases []object

HostAliases provides mapping for ip and hostname, that would be propagated to pod, cannot be used with HostNetwork.

hostnames []string

Hostnames for the above IP address.

ip string required

IP address of the host file entry.

hostNetwork boolean

HostNetwork controls whether the pod may use the node network namespace

host_aliases []object

HostAliasesUnderScore provides mapping for ip and hostname, that would be propagated to pod, cannot be used with HostNetwork. Has Priority over hostAliases field

hostnames []string

Hostnames for the above IP address.

ip string required

IP address of the host file entry.

hpa object

Configures horizontal pod autoscaling. Note, enabling this option disables vmselect to vmselect communication. In most cases it's not an issue.

image object

Image - docker image settings if no specified operator uses default version from operator config

pullPolicy string

PullPolicy describes how to pull docker image

repository string

Repository contains name of docker image + it's repository if needed

tag string

Tag contains desired docker image version

imagePullSecrets []object

name string

initContainers []object

livenessProbe object

LivenessProbe that will be added to CR pod

logFormat string

LogFormat for VMSelect to be configured with. default or json

enum: default, json

logLevel string

LogLevel for VMSelect to be configured with.

enum: INFO, WARN, ERROR, FATAL, PANIC

minReadySeconds integer

MinReadySeconds defines a minimum number of seconds to wait before starting update next pod if previous in healthy state Has no effect for VLogs and VMSingle

format: int32

nodeSelector object

NodeSelector Define which Nodes the Pods are scheduled on.

paused boolean

Paused If set to true all actions on the underlying managed objects are not going to be performed, except for delete actions.

persistentVolumeClaimRetentionPolicy object

PersistentVolumeClaimRetentionPolicy allows configuration of PVC retention policy

whenDeleted string

WhenDeleted specifies what happens to PVCs created from StatefulSet VolumeClaimTemplates when the StatefulSet is deleted. The default policy of `Retain` causes PVCs to not be affected by StatefulSet deletion. The `Delete` policy causes those PVCs to be deleted.

whenScaled string

WhenScaled specifies what happens to PVCs created from StatefulSet VolumeClaimTemplates when the StatefulSet is scaled down. The default policy of `Retain` causes PVCs to not be affected by a scaledown. The `Delete` policy causes the associated PVCs for any excess pods above the replica count to be deleted.

podDisruptionBudget object

PodDisruptionBudget created by operator

maxUnavailable string | integer

minAvailable string | integer

selectorLabels object

replaces default labels selector generated by operator it's useful when you need to create custom budget

unhealthyPodEvictionPolicy string

enum: IfHealthyBudget, AlwaysAllow

podMetadata object

PodMetadata configures Labels and Annotations which are propagated to the VMSelect pods.

annotations object

labels object

name string

port string

Port listen address

priorityClassName string

PriorityClassName class assigned to the Pods

readinessGates []object

ReadinessGates defines pod readiness gates

conditionType string required

ConditionType refers to a condition in the pod's condition list with matching type.

readinessProbe object

ReadinessProbe that will be added to CR pod

replicaCount integer

ReplicaCount is the expected size of the Application.

format: int32

resources object

Resources container resource request and limits, https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ if not defined default resources from operator config will be used

claims []object

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

revisionHistoryLimitCount integer

format: int32

rollingUpdateStrategy string

RollingUpdateStrategy defines strategy for application updates Default is OnDelete, in this case operator handles update process Can be changed for RollingUpdate

rollingUpdateStrategyBehavior object

RollingUpdateStrategyBehavior defines customized behavior for rolling updates. It applies if the RollingUpdateStrategy is set to OnDelete, which is the default.

maxUnavailable string | integer

MaxUnavailable defines the maximum number of pods that can be unavailable during the update. It can be specified as an absolute number (e.g. 2) or a percentage of the total pods (e.g. "50%"). For example, if set to 100%, all pods will be upgraded at once, minimizing downtime when needed.

runtimeClassName string

RuntimeClassName - defines runtime class for kubernetes pod. https://kubernetes.io/docs/concepts/containers/runtime-class/

schedulerName string

SchedulerName - defines kubernetes scheduler name

secrets []string

Secrets is a list of Secrets in the same namespace as the Application object, which shall be mounted into the Application container at /etc/vm/secrets/SECRET_NAME folder

securityContext object

SecurityContext holds pod-level security attributes and common container settings. This defaults to the default PodSecurityContext.

serviceScrapeSpec object

ServiceScrapeSpec that will be added to vmselect VMServiceScrape spec

serviceSpec object

ServiceSpec that will be added to vmselect service spec

metadata object

EmbeddedObjectMetadata defines objectMeta for additional service.

annotations object

labels object

name string

spec object required

ServiceSpec describes the attributes that a user creates on a service. More info: https://kubernetes.io/docs/concepts/services-networking/service/

useAsDefault boolean

UseAsDefault applies changes from given service definition to the main object Service Changing from headless service to clusterIP or loadbalancer may break cross-component communication

startupProbe object

StartupProbe that will be added to CR pod

storage object

StorageSpec - add persistent volume claim for cacheMountPath its needed for persistent cache

emptyDir object

EmptyDirVolumeSource to be used by the Prometheus StatefulSets. If specified, used in place of any volumeClaimTemplate. More info: https://kubernetes.io/docs/concepts/storage/volumes/#emptydir

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

sizeLimit string | integer

sizeLimit is the total amount of local storage required for this EmptyDir volume. The size limit is also applicable for memory medium. The maximum usage on memory medium EmptyDir would be the minimum value between the SizeLimit specified here and the sum of memory limits of all containers in a pod. The default is nil which means that the limit is undefined. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir

string pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$

volumeClaimTemplate object

A PVC spec to be used by the StatefulSets/Deployments.

apiVersion string

kind string

metadata object

EmbeddedMetadata contains metadata relevant to an EmbeddedResource.

annotations object

labels object

name string

spec object

Spec defines the desired characteristics of a volume requested by a pod author. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims

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

dataSource object

dataSource field can be used to specify either: * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot) * An existing PVC (PersistentVolumeClaim) If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source. When the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef, and dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified. If the namespace is specified, then dataSourceRef will not be copied to dataSource.

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

dataSourceRef specifies the object from which to populate the volume with data, if a non-empty volume is desired. This may be any object from a non-empty API group (non core object) or a PersistentVolumeClaim object. When this field is specified, volume binding will only succeed if the type of the specified object matches some installed volume populator or dynamic provisioner. This field will replace the functionality of the dataSource field and as such if both fields are non-empty, they must have the same value. For backwards compatibility, when namespace isn't specified in dataSourceRef, both fields (dataSource and dataSourceRef) will be set to the same value automatically if one of them is empty and the other is non-empty. When namespace is specified in dataSourceRef, dataSource isn't set to the same value and must be empty. There are three important differences between dataSource and dataSourceRef: * While dataSource only allows two specific types of objects, dataSourceRef allows any non-core object, as well as PersistentVolumeClaim objects. * While dataSource ignores disallowed values (dropping them), dataSourceRef preserves all values, and generates an error if a disallowed value is specified. * While dataSource only allows local objects, dataSourceRef allows objects in any namespaces. (Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled. (Alpha) Using the namespace field of dataSourceRef requires the CrossNamespaceVolumeDataSource feature gate to be enabled.

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

namespace string

Namespace is the namespace of resource being referenced Note that when a namespace is specified, a gateway.networking.k8s.io/ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details. (Alpha) This field requires the CrossNamespaceVolumeDataSource feature gate to be enabled.

resources object

resources represents the minimum resources the volume should have. 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

limits object

Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

requests object

selector object

selector is a label query over volumes to consider for binding.

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

storageClassName is the name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1

volumeAttributesClassName string

volumeAttributesClassName may be used to set the VolumeAttributesClass used by this claim. If specified, the CSI driver will create or update the volume with the attributes defined in the corresponding VolumeAttributesClass. This has a different purpose than storageClassName, it can be changed after the claim is created. An empty string or nil value indicates that no VolumeAttributesClass will be applied to the claim. If the claim enters an Infeasible error state, this field can be reset to its previous value (including nil) to cancel the modification. If the resource referred to by volumeAttributesClass does not exist, this PersistentVolumeClaim will be set to a Pending state, as reflected by the modifyVolumeStatus field, until such as a resource exists. More info: https://kubernetes.io/docs/concepts/storage/volume-attributes-classes/

volumeMode string

volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec.

volumeName string

volumeName is the binding reference to the PersistentVolume backing this claim.

status object

Status represents the current information/status of a persistent volume claim. Read-only. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims

accessModes []string

accessModes contains the actual access modes the volume backing the PVC has. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1

allocatedResourceStatuses object

allocatedResourceStatuses stores status of resource being resized for the given PVC. Key names follow standard Kubernetes label syntax. Valid values are either: * Un-prefixed keys: - storage - the capacity of the volume. * Custom resources must use implementation-defined prefixed names such as "example.com/my-custom-resource" Apart from above values - keys that are unprefixed or have kubernetes.io prefix are considered reserved and hence may not be used. ClaimResourceStatus can be in any of following states: - ControllerResizeInProgress: State set when resize controller starts resizing the volume in control-plane. - ControllerResizeFailed: State set when resize has failed in resize controller with a terminal error. - NodeResizePending: State set when resize controller has finished resizing the volume but further resizing of volume is needed on the node. - NodeResizeInProgress: State set when kubelet starts resizing the volume. - NodeResizeFailed: State set when resizing has failed in kubelet with a terminal error. Transient errors don't set NodeResizeFailed. For example: if expanding a PVC for more capacity - this field can be one of the following states: - pvc.status.allocatedResourceStatus['storage'] = "ControllerResizeInProgress" - pvc.status.allocatedResourceStatus['storage'] = "ControllerResizeFailed" - pvc.status.allocatedResourceStatus['storage'] = "NodeResizePending" - pvc.status.allocatedResourceStatus['storage'] = "NodeResizeInProgress" - pvc.status.allocatedResourceStatus['storage'] = "NodeResizeFailed" When this field is not set, it means that no resize operation is in progress for the given PVC. A controller that receives PVC update with previously unknown resourceName or ClaimResourceStatus should ignore the update for the purpose it was designed. For example - a controller that only is responsible for resizing capacity of the volume, should ignore PVC updates that change other valid resources associated with PVC.

allocatedResources object

allocatedResources tracks the resources allocated to a PVC including its capacity. Key names follow standard Kubernetes label syntax. Valid values are either: * Un-prefixed keys: - storage - the capacity of the volume. * Custom resources must use implementation-defined prefixed names such as "example.com/my-custom-resource" Apart from above values - keys that are unprefixed or have kubernetes.io prefix are considered reserved and hence may not be used. Capacity reported here may be larger than the actual capacity when a volume expansion operation is requested. For storage quota, the larger value from allocatedResources and PVC.spec.resources is used. If allocatedResources is not set, PVC.spec.resources alone is used for quota calculation. If a volume expansion capacity request is lowered, allocatedResources is only lowered if there are no expansion operations in progress and if the actual volume capacity is equal or lower than the requested capacity. A controller that receives PVC update with previously unknown resourceName should ignore the update for the purpose it was designed. For example - a controller that only is responsible for resizing capacity of the volume, should ignore PVC updates that change other valid resources associated with PVC.

capacity object

capacity represents the actual resources of the underlying volume.

conditions []object

conditions is the current Condition of persistent volume claim. If underlying persistent volume is being resized then the Condition will be set to 'Resizing'.

lastProbeTime string

lastProbeTime is the time we probed the condition.

format: date-time

lastTransitionTime string

lastTransitionTime is the time the condition transitioned from one status to another.

format: date-time

message string

message is the human-readable message indicating details about last transition.

reason string

reason is a unique, this should be a short, machine understandable string that gives the reason for condition's last transition. If it reports "Resizing" that means the underlying persistent volume is being resized.

status string required

Status is the status of the condition. Can be True, False, Unknown. More info: https://kubernetes.io/docs/reference/kubernetes-api/config-and-storage-resources/persistent-volume-claim-v1/#:~:text=state%20of%20pvc-,conditions.status,-(string)%2C%20required

type string required

Type is the type of the condition. More info: https://kubernetes.io/docs/reference/kubernetes-api/config-and-storage-resources/persistent-volume-claim-v1/#:~:text=set%20to%20%27ResizeStarted%27.-,PersistentVolumeClaimCondition,-contains%20details%20about

currentVolumeAttributesClassName string

currentVolumeAttributesClassName is the current name of the VolumeAttributesClass the PVC is using. When unset, there is no VolumeAttributeClass applied to this PersistentVolumeClaim

modifyVolumeStatus object

ModifyVolumeStatus represents the status object of ControllerModifyVolume operation. When this is unset, there is no ModifyVolume operation being attempted.

status string required

status is the status of the ControllerModifyVolume operation. It can be in any of following states: - Pending Pending indicates that the PersistentVolumeClaim cannot be modified due to unmet requirements, such as the specified VolumeAttributesClass not existing. - InProgress InProgress indicates that the volume is being modified. - Infeasible Infeasible indicates that the request has been rejected as invalid by the CSI driver. To resolve the error, a valid VolumeAttributesClass needs to be specified. Note: New statuses can be added in the future. Consumers should check for unknown statuses and fail appropriately.

targetVolumeAttributesClassName string

targetVolumeAttributesClassName is the name of the VolumeAttributesClass the PVC currently being reconciled

phase string

phase represents the current phase of PersistentVolumeClaim.

terminationGracePeriodSeconds integer

TerminationGracePeriodSeconds period for container graceful termination

format: int64

tolerations []object

Tolerations If specified, the pod's tolerations.

effect string

Effect indicates the taint effect to match. Empty means match all taint effects. When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute.

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.

operator string

tolerationSeconds integer

format: int64

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.

topologySpreadConstraints []object

useDefaultResources boolean

UseDefaultResources controls resource settings By default, operator sets built-in resource requirements

useStrictSecurity boolean

UseStrictSecurity enables strict security mode for component it restricts disk writes access uses non-root user out of the box drops not needed security permissions

volumeMounts []object

mountPath string required

Path within the container at which the volume should be mounted. Must not contain ':'.

mountPropagation string

name string required

This must match the Name of a Volume.

readOnly boolean

Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false.

recursiveReadOnly string

subPath string

Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root).

subPathExpr string

volumes []object

Volumes allows configuration of additional volumes on the output Deployment/StatefulSet definition. Volumes specified will be appended to other volumes that are generated. / +optional

vpa object

Configures vertical pod autoscaling.

recommenders []object

Recommenders specifies custom VPA recommender names.

name string required

Name of the recommender responsible for generating recommendation for this object.

resourcePolicy object

ResourcePolicy controls how the autoscaler computes recommended resources per container.

containerPolicies []object

Per-container resource policies.

containerName string

Name of the container or DefaultContainerResourcePolicy, in which case the policy is used by the containers that don't have their own policy specified.

controlledResources []string

Specifies the type of recommendations that will be computed (and possibly applied) by VPA. If not specified, the default of [ResourceCPU, ResourceMemory] will be used.

controlledValues string

Specifies which resource values should be controlled. The default is "RequestsAndLimits".

enum: RequestsAndLimits, RequestsOnly

maxAllowed object

Specifies the maximum amount of resources that will be recommended for the container. The default is no maximum.

minAllowed object

Specifies the minimal amount of resources that will be recommended for the container. The default is no minimum.

mode string

Whether autoscaler is enabled for the container. The default is "Auto".

enum: Auto, Off

oomBumpUpRatio string | integer

oomBumpUpRatio is the ratio to increase memory when OOM is detected.

string pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$

oomMinBumpUp string | integer

oomMinBumpUp is the minimum increase in memory when OOM is detected.

string pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$

updatePolicy object

UpdatePolicy controls how the autoscaler applies changes to pod resources.

evictionRequirements []object

changeRequirement string required

EvictionChangeRequirement refers to the relationship between the new target recommendation for a Pod and its current requests, what kind of change is necessary for the Pod to be evicted

enum: TargetHigherThanRequests, TargetLowerThanRequests

resources []string required

minReplicas integer

Minimal number of replicas which need to be alive for Updater to attempt pod eviction (pending other checks like PDB). Only positive values are allowed. Overrides global '--min-replicas' flag.

format: int32

updateMode string

Controls when autoscaler applies changes to the pod resources. The default is 'Recreate'.

enum: Off, Initial, Recreate, InPlaceOrRecreate, Auto

vmstorage object

affinity object

Affinity If specified, the pod's scheduling constraints.

claimTemplates []object

ClaimTemplates allows adding additional VolumeClaimTemplates for StatefulSet

componentVersion string

ComponentVersion defines default images tag for this component. it can be overwritten with component specific image.tag value.

configMaps []string

ConfigMaps is a list of ConfigMaps in the same namespace as the Application object, which shall be mounted into the Application container at /etc/vm/configs/CONFIGMAP_NAME folder

containers []object

Containers property allows to inject additions sidecars or to patch existing containers. It can be useful for proxies, backup, etc.

disableAutomountServiceAccountToken boolean

disableSelfServiceScrape boolean

DisableSelfServiceScrape controls creation of VMServiceScrape by operator for the application. Has priority over `VM_DISABLESELFSERVICESCRAPECREATION` operator env variable

dnsConfig object

Specifies the DNS parameters of a pod. Parameters specified here will be merged to the generated DNS configuration based on DNSPolicy.

nameservers []string

A list of DNS name server IP addresses. This will be appended to the base nameservers generated from DNSPolicy. Duplicated nameservers will be removed.

options []object

name string

Name is this DNS resolver option's name. Required.

value string

Value is this DNS resolver option's value.

searches []string

A list of DNS search domains for host-name lookup. This will be appended to the base search paths generated from DNSPolicy. Duplicated search paths will be removed.

dnsPolicy string

DNSPolicy sets DNS policy for the pod

extraArgs object

ExtraArgs that will be passed to the application container for example remoteWrite.tmpDataPath: /tmp

extraEnvs []object

ExtraEnvs that will be passed to the application container

name string required

Name of the environment variable. May consist of any printable ASCII characters except '='.

value string

extraEnvsFrom []object

ExtraEnvsFrom defines source of env variables for the application container could either be secret or configmap

configMapRef object

The ConfigMap to select from

name string

optional boolean

Specify whether the ConfigMap must be defined

prefix string

Optional text to prepend to the name of each environment variable. May consist of any printable ASCII characters except '='.

secretRef object

The Secret to select from

name string

optional boolean

Specify whether the Secret must be defined

hostAliases []object

HostAliases provides mapping for ip and hostname, that would be propagated to pod, cannot be used with HostNetwork.

hostnames []string

Hostnames for the above IP address.

ip string required

IP address of the host file entry.

hostNetwork boolean

HostNetwork controls whether the pod may use the node network namespace

host_aliases []object

HostAliasesUnderScore provides mapping for ip and hostname, that would be propagated to pod, cannot be used with HostNetwork. Has Priority over hostAliases field

hostnames []string

Hostnames for the above IP address.

ip string required

IP address of the host file entry.

hpa object

Configures horizontal pod autoscaling. Note, downscaling is not supported.

behaviour object

HorizontalPodAutoscalerBehavior configures the scaling behavior of the target in both Up and Down directions (scaleUp and scaleDown fields respectively).

scaleDown object

scaleDown is scaling policy for scaling Down. If not set, the default value is to allow to scale down to minReplicas pods, with a 300 second stabilization window (i.e., the highest recommendation for the last 300sec is used).

policies []object

policies is a list of potential scaling polices which can be used during scaling. If not set, use the default values: - For scale up: allow doubling the number of pods, or an absolute change of 4 pods in a 15s window. - For scale down: allow all pods to be removed in a 15s window.

periodSeconds integer required

periodSeconds specifies the window of time for which the policy should hold true. PeriodSeconds must be greater than zero and less than or equal to 1800 (30 min).

format: int32

type string required

type is used to specify the scaling policy.

value integer required

value contains the amount of change which is permitted by the policy. It must be greater than zero

format: int32

selectPolicy string

selectPolicy is used to specify which policy should be used. If not set, the default value Max is used.

stabilizationWindowSeconds integer

stabilizationWindowSeconds is the number of seconds for which past recommendations should be considered while scaling up or scaling down. StabilizationWindowSeconds must be greater than or equal to zero and less than or equal to 3600 (one hour). If not set, use the default values: - For scale up: 0 (i.e. no stabilization is done). - For scale down: 300 (i.e. the stabilization window is 300 seconds long).

format: int32

tolerance string | integer

tolerance is the tolerance on the ratio between the current and desired metric value under which no updates are made to the desired number of replicas (e.g. 0.01 for 1%). Must be greater than or equal to zero. If not set, the default cluster-wide tolerance is applied (by default 10%). For example, if autoscaling is configured with a memory consumption target of 100Mi, and scale-down and scale-up tolerances of 5% and 1% respectively, scaling will be triggered when the actual consumption falls below 95Mi or exceeds 101Mi. This is an beta field and requires the HPAConfigurableTolerance feature gate to be enabled.

string pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$

scaleUp object

scaleUp is scaling policy for scaling Up. If not set, the default value is the higher of: * increase no more than 4 pods per 60 seconds * double the number of pods per 60 seconds No stabilization is used.

policies []object

periodSeconds integer required

periodSeconds specifies the window of time for which the policy should hold true. PeriodSeconds must be greater than zero and less than or equal to 1800 (30 min).

format: int32

type string required

type is used to specify the scaling policy.

value integer required

value contains the amount of change which is permitted by the policy. It must be greater than zero

format: int32

selectPolicy string

selectPolicy is used to specify which policy should be used. If not set, the default value Max is used.

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: int32

metrics []object

containerResource object

containerResource refers to a resource metric (such as those specified in requests and limits) known to Kubernetes describing a single container in each pod of the current scale target (e.g. CPU or memory). Such metrics are built in to Kubernetes, and have special scaling options on top of those available to normal per-pod metrics using the "pods" source.

container string required

container is the name of the container in the pods of the scaling target

name string required

name is the name of the resource in question.

target object required

target specifies the target value for the given metric

averageUtilization integer

averageUtilization is the target value of the average of the resource metric across all relevant pods, represented as a percentage of the requested value of the resource for the pods. Currently only valid for Resource metric source type

format: int32

averageValue string | integer

averageValue is the target value of the average of the metric across all relevant pods (as a quantity)

string pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$

type string required

type represents whether the metric type is Utilization, Value, or AverageValue

value string | integer

value is the target value of the metric (as a quantity).

string pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$

external object

external refers to a global metric that is not associated with any Kubernetes object. It allows autoscaling based on information coming from components running outside of cluster (for example length of queue in cloud messaging service, or QPS from loadbalancer running outside of cluster).

metric object required

metric identifies the target metric by name and selector

name string required

name is the name of the given metric

selector object

selector is the string-encoded form of a standard kubernetes label selector for the given metric When set, it is passed as an additional parameter to the metrics server for more specific metrics scoping. When unset, just the metricName will be used to gather metrics.

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

matchLabels object

target object required

target specifies the target value for the given metric

averageUtilization integer

format: int32

averageValue string | integer

averageValue is the target value of the average of the metric across all relevant pods (as a quantity)

string pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$

type string required

type represents whether the metric type is Utilization, Value, or AverageValue

value string | integer

value is the target value of the metric (as a quantity).

string pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$

object object

object refers to a metric describing a single kubernetes object (for example, hits-per-second on an Ingress object).

describedObject object required

describedObject specifies the descriptions of a object,such as kind,name apiVersion

apiVersion string

apiVersion is the API version of the referent

kind string required

kind is the kind of the referent; More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

name string required

name is the name of the referent; More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

metric object required

metric identifies the target metric by name and selector

name string required

name is the name of the given metric

selector object

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

matchLabels object

target object required

target specifies the target value for the given metric

averageUtilization integer

format: int32

averageValue string | integer

averageValue is the target value of the average of the metric across all relevant pods (as a quantity)

string pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$

type string required

type represents whether the metric type is Utilization, Value, or AverageValue

value string | integer

value is the target value of the metric (as a quantity).

string pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$

pods object

pods refers to a metric describing each pod in the current scale target (for example, transactions-processed-per-second). The values will be averaged together before being compared to the target value.

metric object required

metric identifies the target metric by name and selector

name string required

name is the name of the given metric

selector object

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

matchLabels object

target object required

target specifies the target value for the given metric

averageUtilization integer

format: int32

averageValue string | integer

averageValue is the target value of the average of the metric across all relevant pods (as a quantity)

string pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$

type string required

type represents whether the metric type is Utilization, Value, or AverageValue

value string | integer

value is the target value of the metric (as a quantity).

string pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$

resource object

resource refers to a resource metric (such as those specified in requests and limits) known to Kubernetes describing each pod in the current scale target (e.g. CPU or memory). Such metrics are built in to Kubernetes, and have special scaling options on top of those available to normal per-pod metrics using the "pods" source.

name string required

name is the name of the resource in question.

target object required

target specifies the target value for the given metric

averageUtilization integer

format: int32

averageValue string | integer

averageValue is the target value of the average of the metric across all relevant pods (as a quantity)

string pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$

type string required

type represents whether the metric type is Utilization, Value, or AverageValue

value string | integer

value is the target value of the metric (as a quantity).

string pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$

type string required

type is the type of metric source. It should be one of "ContainerResource", "External", "Object", "Pods" or "Resource", each mapping to a matching field in the object.

minReplicas integer

format: int32

image object

Image - docker image settings if no specified operator uses default version from operator config

pullPolicy string

PullPolicy describes how to pull docker image

repository string

Repository contains name of docker image + it's repository if needed

tag string

Tag contains desired docker image version

imagePullSecrets []object

name string

initContainers []object

livenessProbe object

LivenessProbe that will be added to CR pod

logFormat string

LogFormat for VMStorage to be configured with. default or json

enum: default, json

logLevel string

LogLevel for VMStorage to be configured with.

enum: INFO, WARN, ERROR, FATAL, PANIC

maintenanceInsertNodeIDs []integer

MaintenanceInsertNodeIDs - excludes given node ids from insert requests routing, must contain pod suffixes - for pod-0, id will be 0 and etc. lets say, you have pod-0, pod-1, pod-2, pod-3. to exclude pod-0 and pod-3 from insert routing, define nodeIDs: [0,3]. Useful at storage expanding, when you want to rebalance some data at cluster.

maintenanceSelectNodeIDs []integer

MaintenanceSelectNodeIDs - excludes given node ids from select requests routing, must contain pod suffixes - for pod-0, id will be 0 and etc.

minReadySeconds integer

MinReadySeconds defines a minimum number of seconds to wait before starting update next pod if previous in healthy state Has no effect for VLogs and VMSingle

format: int32

nodeSelector object

NodeSelector Define which Nodes the Pods are scheduled on.

paused boolean

Paused If set to true all actions on the underlying managed objects are not going to be performed, except for delete actions.

persistentVolumeClaimRetentionPolicy object

PersistentVolumeClaimRetentionPolicy allows configuration of PVC retention policy

whenDeleted string

whenScaled string

podDisruptionBudget object

PodDisruptionBudget created by operator

maxUnavailable string | integer

minAvailable string | integer

selectorLabels object

replaces default labels selector generated by operator it's useful when you need to create custom budget

unhealthyPodEvictionPolicy string

enum: IfHealthyBudget, AlwaysAllow

podMetadata object

PodMetadata configures Labels and Annotations which are propagated to the VMStorage pods.

annotations object

labels object

name string

port string

Port listen address

priorityClassName string

PriorityClassName class assigned to the Pods

readinessGates []object

ReadinessGates defines pod readiness gates

conditionType string required

ConditionType refers to a condition in the pod's condition list with matching type.

readinessProbe object

ReadinessProbe that will be added to CR pod

replicaCount integer

ReplicaCount is the expected size of the Application.

format: int32

resources object

Resources container resource request and limits, https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ if not defined default resources from operator config will be used

claims []object

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

revisionHistoryLimitCount integer

format: int32

rollingUpdateStrategy string

RollingUpdateStrategy defines strategy for application updates Default is OnDelete, in this case operator handles update process Can be changed for RollingUpdate

rollingUpdateStrategyBehavior object

RollingUpdateStrategyBehavior defines customized behavior for rolling updates. It applies if the RollingUpdateStrategy is set to OnDelete, which is the default.

maxUnavailable string | integer

runtimeClassName string

RuntimeClassName - defines runtime class for kubernetes pod. https://kubernetes.io/docs/concepts/containers/runtime-class/

schedulerName string

SchedulerName - defines kubernetes scheduler name

secrets []string

Secrets is a list of Secrets in the same namespace as the Application object, which shall be mounted into the Application container at /etc/vm/secrets/SECRET_NAME folder

securityContext object

SecurityContext holds pod-level security attributes and common container settings. This defaults to the default PodSecurityContext.

serviceScrapeSpec object

ServiceScrapeSpec that will be added to vmstorage VMServiceScrape spec

serviceSpec object

ServiceSpec that will be create additional service for vmstorage

metadata object

EmbeddedObjectMetadata defines objectMeta for additional service.

annotations object

labels object

name string

spec object required

ServiceSpec describes the attributes that a user creates on a service. More info: https://kubernetes.io/docs/concepts/services-networking/service/

useAsDefault boolean

UseAsDefault applies changes from given service definition to the main object Service Changing from headless service to clusterIP or loadbalancer may break cross-component communication

startupProbe object

StartupProbe that will be added to CR pod

storage object

Storage - add persistent volume for StorageDataPath its useful for persistent cache

emptyDir object

EmptyDirVolumeSource to be used by the Prometheus StatefulSets. If specified, used in place of any volumeClaimTemplate. More info: https://kubernetes.io/docs/concepts/storage/volumes/#emptydir

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

A PVC spec to be used by the StatefulSets/Deployments.

storageDataPath string

StorageDataPath - path to storage data

terminationGracePeriodSeconds integer

TerminationGracePeriodSeconds period for container graceful termination

format: int64

tolerations []object

Tolerations If specified, the pod's tolerations.

effect string

Effect indicates the taint effect to match. Empty means match all taint effects. When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute.

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.

operator string

tolerationSeconds integer

format: int64

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.

topologySpreadConstraints []object

useDefaultResources boolean

UseDefaultResources controls resource settings By default, operator sets built-in resource requirements

useStrictSecurity boolean

UseStrictSecurity enables strict security mode for component it restricts disk writes access uses non-root user out of the box drops not needed security permissions

vmBackup object

VMBackup configuration for backup

acceptEULA boolean

AcceptEULA accepts enterprise feature usage, must be set to true. otherwise backupmanager cannot be added to single/cluster version. https://victoriametrics.com/legal/esa/

concurrency integer

Defines number of concurrent workers. Higher concurrency may reduce backup duration (default 10)

format: int32

credentialsSecret object

CredentialsSecret is secret in the same namespace for access to remote storage The secret is mounted into /etc/vm/creds.

key string required

The key of the secret to select from. Must be a valid secret key.

name string

optional boolean

Specify whether the Secret or its key must be defined

customS3Endpoint string

Custom S3 endpoint for use with S3-compatible storages (e.g. MinIO). S3 is used if not set

destination string

Defines destination for backup

destinationDisableSuffixAdd boolean

DestinationDisableSuffixAdd - disables suffix adding for cluster version backups each vmstorage backup must have unique backup folder so operator adds POD_NAME as suffix for backup destination folder.

disableDaily boolean

Defines if daily backups disabled (default false)

disableHourly boolean

Defines if hourly backups disabled (default false)

disableMonthly boolean

Defines if monthly backups disabled (default false)

disableWeekly boolean

Defines if weekly backups disabled (default false)

extraArgs object

extra args like maxBytesPerSecond default 0

extraEnvs []object

name string required

Name of the environment variable. May consist of any printable ASCII characters except '='.

value string

valueFrom object

Source for the environment variable's value. Cannot be used if value is not empty.

configMapKeyRef object

Selects a key of a ConfigMap.

key string required

The key to select.

name string

optional boolean

Specify whether the ConfigMap or its key must be defined

fieldRef object

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.

apiVersion string

Version of the schema the FieldPath is written in terms of, defaults to "v1".

fieldPath string required

Path of the field to select in the specified API version.

fileKeyRef object

FileKeyRef selects a key of the env file. Requires the EnvFiles feature gate to be enabled.

key string required

The key within the env file. An invalid key will prevent the pod from starting. The keys defined within a source may consist of any printable ASCII characters except '='. During Alpha stage of the EnvFiles feature gate, the key size is limited to 128 characters.

optional boolean

Specify whether the file or its key must be defined. If the file or key does not exist, then the env var is not published. If optional is set to true and the specified key does not exist, the environment variable will not be set in the Pod's containers. If optional is set to false and the specified key does not exist, an error will be returned during Pod creation.

path string required

The path within the volume from which to select the file. Must be relative and may not contain the '..' path or start with '..'.

volumeName string required

The name of the volume mount containing the env file.

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.

containerName string

Container name: required for volumes, optional for env vars

divisor string | integer

Specifies the output format of the exposed resources, defaults to "1"

string pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$

resource string required

Required: resource to select

secretKeyRef object

Selects a key of a secret in the pod's namespace

key string required

The key of the secret to select from. Must be a valid secret key.

name string

optional boolean

Specify whether the Secret or its key must be defined

extraEnvsFrom []object

ExtraEnvsFrom defines source of env variables for the application container could either be secret or configmap

configMapRef object

The ConfigMap to select from

name string

optional boolean

Specify whether the ConfigMap must be defined

prefix string

Optional text to prepend to the name of each environment variable. May consist of any printable ASCII characters except '='.

secretRef object

The Secret to select from

name string

optional boolean

Specify whether the Secret must be defined

image object

Image - docker image settings for VMBackuper

pullPolicy string

PullPolicy describes how to pull docker image

repository string

Repository contains name of docker image + it's repository if needed

tag string

Tag contains desired docker image version

logFormat string

LogFormat for VMBackup to be configured with. default or json

enum: default, json

logLevel string

LogLevel for VMBackup to be configured with.

enum: INFO, WARN, ERROR, FATAL, PANIC

port string

Port for health check connections

resources object

Resources container resource request and limits, https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ if not defined default resources from operator config will be used

claims []object

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

restore object

Restore Allows to enable restore options for pod Read [more](https://docs.victoriametrics.com/victoriametrics/vmbackupmanager/#restore-commands)

onStart object

OnStart defines configuration for restore on pod start

enabled boolean

Enabled defines if restore on start enabled

snapshotCreateURL string

SnapshotCreateURL overwrites url for snapshot create

snapshotDeleteURL string

SnapshotDeleteURL overwrites url for snapshot delete

volumeMounts []object

VolumeMounts allows configuration of additional VolumeMounts on the output Deployment definition. VolumeMounts specified will be appended to other VolumeMounts in the vmbackupmanager container, that are generated as a result of StorageSpec objects.

mountPath string required

Path within the container at which the volume should be mounted. Must not contain ':'.

mountPropagation string

name string required

This must match the Name of a Volume.

readOnly boolean

Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false.

recursiveReadOnly string

subPath string

Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root).

subPathExpr string

vmInsertPort string

VMInsertPort for VMInsert connections

vmSelectPort string

VMSelectPort for VMSelect connections

volumeMounts []object

mountPath string required

Path within the container at which the volume should be mounted. Must not contain ':'.

mountPropagation string

name string required

This must match the Name of a Volume.

readOnly boolean

Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false.

recursiveReadOnly string

subPath string

Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root).

subPathExpr string

volumes []object

Volumes allows configuration of additional volumes on the output Deployment/StatefulSet definition. Volumes specified will be appended to other volumes that are generated. / +optional

vpa object

Configures vertical pod autoscaling.

recommenders []object

Recommenders specifies custom VPA recommender names.

name string required

Name of the recommender responsible for generating recommendation for this object.

resourcePolicy object

ResourcePolicy controls how the autoscaler computes recommended resources per container.

containerPolicies []object

Per-container resource policies.

containerName string

Name of the container or DefaultContainerResourcePolicy, in which case the policy is used by the containers that don't have their own policy specified.

controlledResources []string

Specifies the type of recommendations that will be computed (and possibly applied) by VPA. If not specified, the default of [ResourceCPU, ResourceMemory] will be used.

controlledValues string

Specifies which resource values should be controlled. The default is "RequestsAndLimits".

enum: RequestsAndLimits, RequestsOnly

maxAllowed object

Specifies the maximum amount of resources that will be recommended for the container. The default is no maximum.

minAllowed object

Specifies the minimal amount of resources that will be recommended for the container. The default is no minimum.

mode string

Whether autoscaler is enabled for the container. The default is "Auto".

enum: Auto, Off

oomBumpUpRatio string | integer

oomBumpUpRatio is the ratio to increase memory when OOM is detected.

string pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$

oomMinBumpUp string | integer

oomMinBumpUp is the minimum increase in memory when OOM is detected.

string pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$

updatePolicy object

UpdatePolicy controls how the autoscaler applies changes to pod resources.

evictionRequirements []object

changeRequirement string required

EvictionChangeRequirement refers to the relationship between the new target recommendation for a Pod and its current requests, what kind of change is necessary for the Pod to be evicted

enum: TargetHigherThanRequests, TargetLowerThanRequests

resources []string required

minReplicas integer

Minimal number of replicas which need to be alive for Updater to attempt pod eviction (pending other checks like PDB). Only positive values are allowed. Overrides global '--min-replicas' flag.

format: int32

updateMode string

Controls when autoscaler applies changes to the pod resources. The default is 'Recreate'.

enum: Off, Initial, Recreate, InPlaceOrRecreate, Auto

status object

VMClusterStatus defines the observed state of VMCluster

conditions []object

Known .status.conditions.type are: "Available", "Progressing", and "Degraded"

lastTransitionTime string required

lastTransitionTime is the last time the condition transitioned from one status to another.

format: date-time

lastUpdateTime string required

LastUpdateTime is the last time of given type update. This value is used for status TTL update and removal

format: date-time

message string

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: int64

minimum: 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.

minLength: 1

maxLength: 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 name.namespace.resource.victoriametrics.com/CamelCase.

maxLength: 316

lastAppliedSpec object

observedGeneration integer

ObservedGeneration defines current generation picked by operator for the reconcile

format: int64

reason string

Reason defines human readable error reason

updateStatus string

UpdateStatus defines a status for update rollout

No matches. Try .spec.clusterDomainName for an exact path