operator.v1.vtCluster

"VTCluster is fast, cost-effective and scalable traces database."

Index

fn new(name)
obj metadata
obj spec

Fields

fn new

new(name)

new returns an instance of VTCluster

obj metadata

"ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create."

fn metadata.withAnnotations

withAnnotations(annotations)

"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: http://kubernetes.io/docs/user-guide/annotations"

fn metadata.withAnnotationsMixin

withAnnotationsMixin(annotations)

"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: http://kubernetes.io/docs/user-guide/annotations"

Note: This function appends passed data to existing values

fn metadata.withClusterName

withClusterName(clusterName)

"The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request."

fn metadata.withCreationTimestamp

withCreationTimestamp(creationTimestamp)

"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers."

fn metadata.withDeletionGracePeriodSeconds

withDeletionGracePeriodSeconds(deletionGracePeriodSeconds)

"Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only."

fn metadata.withDeletionTimestamp

withDeletionTimestamp(deletionTimestamp)

"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers."

fn metadata.withFinalizers

withFinalizers(finalizers)

"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list."

fn metadata.withFinalizersMixin

withFinalizersMixin(finalizers)

"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list."

Note: This function appends passed data to existing values

fn metadata.withGenerateName

withGenerateName(generateName)

"GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.\n\nIf this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).\n\nApplied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency"

fn metadata.withGeneration

withGeneration(generation)

"A sequence number representing a specific generation of the desired state. Populated by the system. Read-only."

fn metadata.withLabels

withLabels(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: http://kubernetes.io/docs/user-guide/labels"

fn metadata.withLabelsMixin

withLabelsMixin(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: http://kubernetes.io/docs/user-guide/labels"

Note: This function appends passed data to existing values

fn metadata.withName

withName(name)

"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: http://kubernetes.io/docs/user-guide/identifiers#names"

fn metadata.withNamespace

withNamespace(namespace)

"Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the \"default\" namespace, but \"default\" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.\n\nMust be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces"

fn metadata.withOwnerReferences

withOwnerReferences(ownerReferences)

"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller."

fn metadata.withOwnerReferencesMixin

withOwnerReferencesMixin(ownerReferences)

"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller."

Note: This function appends passed data to existing values

fn metadata.withResourceVersion

withResourceVersion(resourceVersion)

"An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.\n\nPopulated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency"

fn metadata.withSelfLink

withSelfLink(selfLink)

"SelfLink is a URL representing this object. Populated by the system. Read-only.\n\nDEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release."

fn metadata.withUid

withUid(uid)

"UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.\n\nPopulated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids"

obj spec

"VTClusterSpec defines the desired state of VTCluster"

fn spec.withClusterDomainName

withClusterDomainName(clusterDomainName)

"ClusterDomainName defines domain name suffix for in-cluster dns addresses\naka .cluster.local\nused by vtinsert and vtselect to build vtstorage address"

fn spec.withClusterVersion

withClusterVersion(clusterVersion)

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

fn spec.withImagePullSecrets

withImagePullSecrets(imagePullSecrets)

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

fn spec.withImagePullSecretsMixin

withImagePullSecretsMixin(imagePullSecrets)

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

Note: This function appends passed data to existing values

fn spec.withPaused

withPaused(paused)

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

fn spec.withServiceAccountName

withServiceAccountName(serviceAccountName)

"ServiceAccountName is the name of the ServiceAccount to use to run the\nVTSelect, VTInsert and VTStorage Pods."

fn spec.withUseStrictSecurity

withUseStrictSecurity(useStrictSecurity)

"UseStrictSecurity enables strict security mode for component\nit restricts disk writes access\nuses non-root user out of the box\ndrops not needed security permissions"

obj spec.imagePullSecrets

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

fn spec.imagePullSecrets.withName

withName(name)

"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

obj spec.insert

"VTInsert defines vtinsert component configuration at victoria-traces cluster"

fn spec.insert.withAffinity

withAffinity(affinity)

"Affinity If specified, the pod's scheduling constraints."

fn spec.insert.withAffinityMixin

withAffinityMixin(affinity)

"Affinity If specified, the pod's scheduling constraints."

Note: This function appends passed data to existing values

fn spec.insert.withConfigMaps

withConfigMaps(configMaps)

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

fn spec.insert.withConfigMapsMixin

withConfigMapsMixin(configMaps)

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

Note: This function appends passed data to existing values

fn spec.insert.withContainers

withContainers(containers)

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

fn spec.insert.withContainersMixin

withContainersMixin(containers)

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

Note: This function appends passed data to existing values

fn spec.insert.withDisableAutomountServiceAccountToken

withDisableAutomountServiceAccountToken(disableAutomountServiceAccountToken)

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

fn spec.insert.withDisableSelfServiceScrape

withDisableSelfServiceScrape(disableSelfServiceScrape)

"DisableSelfServiceScrape controls creation of VMServiceScrape by operator\nfor the application.\nHas priority over VM_DISABLESELFSERVICESCRAPECREATION operator env variable"

fn spec.insert.withDnsPolicy

withDnsPolicy(dnsPolicy)

"DNSPolicy sets DNS policy for the pod"

fn spec.insert.withExtraArgs

withExtraArgs(extraArgs)

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

fn spec.insert.withExtraArgsMixin

withExtraArgsMixin(extraArgs)

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

Note: This function appends passed data to existing values

fn spec.insert.withExtraEnvs

withExtraEnvs(extraEnvs)

"ExtraEnvs that will be passed to the application container"

fn spec.insert.withExtraEnvsFrom

withExtraEnvsFrom(extraEnvsFrom)

"ExtraEnvsFrom defines source of env variables for the application container\ncould either be secret or configmap"

fn spec.insert.withExtraEnvsFromMixin

withExtraEnvsFromMixin(extraEnvsFrom)

"ExtraEnvsFrom defines source of env variables for the application container\ncould either be secret or configmap"

Note: This function appends passed data to existing values

fn spec.insert.withExtraEnvsMixin

withExtraEnvsMixin(extraEnvs)

"ExtraEnvs that will be passed to the application container"

Note: This function appends passed data to existing values

fn spec.insert.withHostAliases

withHostAliases(hostAliases)

"HostAliases provides mapping for ip and hostname,\nthat would be propagated to pod,\ncannot be used with HostNetwork."

fn spec.insert.withHostAliasesMixin

withHostAliasesMixin(hostAliases)

"HostAliases provides mapping for ip and hostname,\nthat would be propagated to pod,\ncannot be used with HostNetwork."

Note: This function appends passed data to existing values

fn spec.insert.withHostNetwork

withHostNetwork(hostNetwork)

"HostNetwork controls whether the pod may use the node network namespace"

fn spec.insert.withHost_aliases

withHost_aliases(host_aliases)

"HostAliasesUnderScore provides mapping for ip and hostname,\nthat would be propagated to pod,\ncannot be used with HostNetwork.\nHas Priority over hostAliases field"

fn spec.insert.withHost_aliasesMixin

withHost_aliasesMixin(host_aliases)

"HostAliasesUnderScore provides mapping for ip and hostname,\nthat would be propagated to pod,\ncannot be used with HostNetwork.\nHas Priority over hostAliases field"

Note: This function appends passed data to existing values

fn spec.insert.withHpa

withHpa(hpa)

"Configures horizontal pod autoscaling."

fn spec.insert.withHpaMixin

withHpaMixin(hpa)

"Configures horizontal pod autoscaling."

Note: This function appends passed data to existing values

fn spec.insert.withImagePullSecrets

withImagePullSecrets(imagePullSecrets)

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

fn spec.insert.withImagePullSecretsMixin

withImagePullSecretsMixin(imagePullSecrets)

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

Note: This function appends passed data to existing values

fn spec.insert.withInitContainers

withInitContainers(initContainers)

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

fn spec.insert.withInitContainersMixin

withInitContainersMixin(initContainers)

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

Note: This function appends passed data to existing values

fn spec.insert.withLivenessProbe

withLivenessProbe(livenessProbe)

"LivenessProbe that will be added CRD pod"

fn spec.insert.withLivenessProbeMixin

withLivenessProbeMixin(livenessProbe)

"LivenessProbe that will be added CRD pod"

Note: This function appends passed data to existing values

fn spec.insert.withLogFormat

withLogFormat(logFormat)

"LogFormat for VTSelect to be configured with.\ndefault or json"

fn spec.insert.withLogLevel

withLogLevel(logLevel)

"LogLevel for VTSelect to be configured with."

fn spec.insert.withMinReadySeconds

withMinReadySeconds(minReadySeconds)

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

fn spec.insert.withNodeSelector

withNodeSelector(nodeSelector)

"NodeSelector Define which Nodes the Pods are scheduled on."

fn spec.insert.withNodeSelectorMixin

withNodeSelectorMixin(nodeSelector)

"NodeSelector Define which Nodes the Pods are scheduled on."

Note: This function appends passed data to existing values

fn spec.insert.withPaused

withPaused(paused)

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

fn spec.insert.withPort

withPort(port)

"Port listen address"

fn spec.insert.withPriorityClassName

withPriorityClassName(priorityClassName)

"PriorityClassName class assigned to the Pods"

fn spec.insert.withReadinessGates

withReadinessGates(readinessGates)

"ReadinessGates defines pod readiness gates"

fn spec.insert.withReadinessGatesMixin

withReadinessGatesMixin(readinessGates)

"ReadinessGates defines pod readiness gates"

Note: This function appends passed data to existing values

fn spec.insert.withReadinessProbe

withReadinessProbe(readinessProbe)

"ReadinessProbe that will be added CRD pod"

fn spec.insert.withReadinessProbeMixin

withReadinessProbeMixin(readinessProbe)

"ReadinessProbe that will be added CRD pod"

Note: This function appends passed data to existing values

fn spec.insert.withReplicaCount

withReplicaCount(replicaCount)

"ReplicaCount is the expected size of the Application."

fn spec.insert.withRevisionHistoryLimitCount

withRevisionHistoryLimitCount(revisionHistoryLimitCount)

"The number of old ReplicaSets to retain to allow rollback in deployment or\nmaximum number of revisions that will be maintained in the Deployment revision history.\nHas no effect at StatefulSets\nDefaults to 10."

fn spec.insert.withRuntimeClassName

withRuntimeClassName(runtimeClassName)

"RuntimeClassName - defines runtime class for kubernetes pod.\nhttps://kubernetes.io/docs/concepts/containers/runtime-class/"

fn spec.insert.withSchedulerName

withSchedulerName(schedulerName)

"SchedulerName - defines kubernetes scheduler name"

fn spec.insert.withSecrets

withSecrets(secrets)

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

fn spec.insert.withSecretsMixin

withSecretsMixin(secrets)

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

Note: This function appends passed data to existing values

fn spec.insert.withSecurityContext

withSecurityContext(securityContext)

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

fn spec.insert.withSecurityContextMixin

withSecurityContextMixin(securityContext)

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

Note: This function appends passed data to existing values

fn spec.insert.withServiceScrapeSpec

withServiceScrapeSpec(serviceScrapeSpec)

"ServiceScrapeSpec that will be added to vtselect VMServiceScrape spec"

fn spec.insert.withServiceScrapeSpecMixin

withServiceScrapeSpecMixin(serviceScrapeSpec)

"ServiceScrapeSpec that will be added to vtselect VMServiceScrape spec"

Note: This function appends passed data to existing values

fn spec.insert.withStartupProbe

withStartupProbe(startupProbe)

"StartupProbe that will be added to CRD pod"

fn spec.insert.withStartupProbeMixin

withStartupProbeMixin(startupProbe)

"StartupProbe that will be added to CRD pod"

Note: This function appends passed data to existing values

fn spec.insert.withTerminationGracePeriodSeconds

withTerminationGracePeriodSeconds(terminationGracePeriodSeconds)

"TerminationGracePeriodSeconds period for container graceful termination"

fn spec.insert.withTolerations

withTolerations(tolerations)

"Tolerations If specified, the pod's tolerations."

fn spec.insert.withTolerationsMixin

withTolerationsMixin(tolerations)

"Tolerations If specified, the pod's tolerations."

Note: This function appends passed data to existing values

fn spec.insert.withTopologySpreadConstraints

withTopologySpreadConstraints(topologySpreadConstraints)

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

fn spec.insert.withTopologySpreadConstraintsMixin

withTopologySpreadConstraintsMixin(topologySpreadConstraints)

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

Note: This function appends passed data to existing values

fn spec.insert.withUpdateStrategy

withUpdateStrategy(updateStrategy)

"UpdateStrategy - overrides default update strategy."

fn spec.insert.withUseDefaultResources

withUseDefaultResources(useDefaultResources)

"UseDefaultResources controls resource settings\nBy default, operator sets built-in resource requirements"

fn spec.insert.withUseStrictSecurity

withUseStrictSecurity(useStrictSecurity)

"UseStrictSecurity enables strict security mode for component\nit restricts disk writes access\nuses non-root user out of the box\ndrops not needed security permissions"

fn spec.insert.withVolumeMounts

withVolumeMounts(volumeMounts)

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

fn spec.insert.withVolumeMountsMixin

withVolumeMountsMixin(volumeMounts)

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

Note: This function appends passed data to existing values

fn spec.insert.withVolumes

withVolumes(volumes)

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

fn spec.insert.withVolumesMixin

withVolumesMixin(volumes)

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

Note: This function appends passed data to existing values

obj spec.insert.dnsConfig

"Specifies the DNS parameters of a pod.\nParameters specified here will be merged to the generated DNS\nconfiguration based on DNSPolicy."

fn spec.insert.dnsConfig.withNameservers

withNameservers(nameservers)

"A list of DNS name server IP addresses.\nThis will be appended to the base nameservers generated from DNSPolicy.\nDuplicated nameservers will be removed."

fn spec.insert.dnsConfig.withNameserversMixin

withNameserversMixin(nameservers)

"A list of DNS name server IP addresses.\nThis will be appended to the base nameservers generated from DNSPolicy.\nDuplicated nameservers will be removed."

Note: This function appends passed data to existing values

fn spec.insert.dnsConfig.withOptions

withOptions(options)

"A list of DNS resolver options.\nThis will be merged with the base options generated from DNSPolicy.\nDuplicated entries will be removed. Resolution options given in Options\nwill override those that appear in the base DNSPolicy."

fn spec.insert.dnsConfig.withOptionsMixin

withOptionsMixin(options)

"A list of DNS resolver options.\nThis will be merged with the base options generated from DNSPolicy.\nDuplicated entries will be removed. Resolution options given in Options\nwill override those that appear in the base DNSPolicy."

Note: This function appends passed data to existing values

fn spec.insert.dnsConfig.withSearches

withSearches(searches)

"A list of DNS search domains for host-name lookup.\nThis will be appended to the base search paths generated from DNSPolicy.\nDuplicated search paths will be removed."

fn spec.insert.dnsConfig.withSearchesMixin

withSearchesMixin(searches)

"A list of DNS search domains for host-name lookup.\nThis will be appended to the base search paths generated from DNSPolicy.\nDuplicated search paths will be removed."

Note: This function appends passed data to existing values

obj spec.insert.dnsConfig.options

"A list of DNS resolver options.\nThis will be merged with the base options generated from DNSPolicy.\nDuplicated entries will be removed. Resolution options given in Options\nwill override those that appear in the base DNSPolicy."

fn spec.insert.dnsConfig.options.withName

withName(name)

"Name is this DNS resolver option's name.\nRequired."

fn spec.insert.dnsConfig.options.withValue

withValue(value)

"Value is this DNS resolver option's value."

obj spec.insert.extraEnvs

"ExtraEnvs that will be passed to the application container"

fn spec.insert.extraEnvs.withName

withName(name)

"Name of the environment variable. Must be a C_IDENTIFIER."

fn spec.insert.extraEnvs.withValue

withValue(value)

"Variable references $(VAR_NAME) are expanded\nusing the previously defined environment variables in the container and\nany service environment variables. If a variable cannot be resolved,\nthe reference in the input string will be unchanged. Double $$ are reduced\nto a single $, which allows for escaping the $(VAR_NAME) syntax: i.e.\n\"$$(VAR_NAME)\" will produce the string literal \"$(VAR_NAME)\".\nEscaped references will never be expanded, regardless of whether the variable\nexists or not.\nDefaults to \"\"."

obj spec.insert.extraEnvsFrom

"ExtraEnvsFrom defines source of env variables for the application container\ncould either be secret or configmap"

fn spec.insert.extraEnvsFrom.withPrefix

withPrefix(prefix)

"An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER."

obj spec.insert.extraEnvsFrom.configMapRef

"The ConfigMap to select from"

fn spec.insert.extraEnvsFrom.configMapRef.withName

withName(name)

"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn spec.insert.extraEnvsFrom.configMapRef.withOptional

withOptional(optional)

"Specify whether the ConfigMap must be defined"

obj spec.insert.extraEnvsFrom.secretRef

"The Secret to select from"

fn spec.insert.extraEnvsFrom.secretRef.withName

withName(name)

"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn spec.insert.extraEnvsFrom.secretRef.withOptional

withOptional(optional)

"Specify whether the Secret must be defined"

obj spec.insert.hostAliases

"HostAliases provides mapping for ip and hostname,\nthat would be propagated to pod,\ncannot be used with HostNetwork."

fn spec.insert.hostAliases.withHostnames

withHostnames(hostnames)

"Hostnames for the above IP address."

fn spec.insert.hostAliases.withHostnamesMixin

withHostnamesMixin(hostnames)

"Hostnames for the above IP address."

Note: This function appends passed data to existing values

fn spec.insert.hostAliases.withIp

withIp(ip)

"IP address of the host file entry."

obj spec.insert.host_aliases

"HostAliasesUnderScore provides mapping for ip and hostname,\nthat would be propagated to pod,\ncannot be used with HostNetwork.\nHas Priority over hostAliases field"

fn spec.insert.host_aliases.withHostnames

withHostnames(hostnames)

"Hostnames for the above IP address."

fn spec.insert.host_aliases.withHostnamesMixin

withHostnamesMixin(hostnames)

"Hostnames for the above IP address."

Note: This function appends passed data to existing values

fn spec.insert.host_aliases.withIp

withIp(ip)

"IP address of the host file entry."

obj spec.insert.image

"Image - docker image settings\nif no specified operator uses default version from operator config"

fn spec.insert.image.withPullPolicy

withPullPolicy(pullPolicy)

"PullPolicy describes how to pull docker image"

fn spec.insert.image.withRepository

withRepository(repository)

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

fn spec.insert.image.withTag

withTag(tag)

"Tag contains desired docker image version"

obj spec.insert.imagePullSecrets

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

fn spec.insert.imagePullSecrets.withName

withName(name)

"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

obj spec.insert.podDisruptionBudget

"PodDisruptionBudget created by operator"

fn spec.insert.podDisruptionBudget.withMaxUnavailable

withMaxUnavailable(maxUnavailable)

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

fn spec.insert.podDisruptionBudget.withMinAvailable

withMinAvailable(minAvailable)

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

fn spec.insert.podDisruptionBudget.withSelectorLabels

withSelectorLabels(selectorLabels)

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

fn spec.insert.podDisruptionBudget.withSelectorLabelsMixin

withSelectorLabelsMixin(selectorLabels)

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

Note: This function appends passed data to existing values

obj spec.insert.podMetadata

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

fn spec.insert.podMetadata.withAnnotations

withAnnotations(annotations)

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

fn spec.insert.podMetadata.withAnnotationsMixin

withAnnotationsMixin(annotations)

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

Note: This function appends passed data to existing values

fn spec.insert.podMetadata.withLabels

withLabels(labels)

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

fn spec.insert.podMetadata.withLabelsMixin

withLabelsMixin(labels)

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

Note: This function appends passed data to existing values

fn spec.insert.podMetadata.withName

withName(name)

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

obj spec.insert.readinessGates

"ReadinessGates defines pod readiness gates"

fn spec.insert.readinessGates.withConditionType

withConditionType(conditionType)

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

obj spec.insert.resources

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

fn spec.insert.resources.withClaims

withClaims(claims)

"Claims lists the names of resources, defined in spec.resourceClaims,\nthat are used by this container.\n\nThis is an alpha field and requires enabling the\nDynamicResourceAllocation feature gate.\n\nThis field is immutable. It can only be set for containers."

fn spec.insert.resources.withClaimsMixin

withClaimsMixin(claims)

"Claims lists the names of resources, defined in spec.resourceClaims,\nthat are used by this container.\n\nThis is an alpha field and requires enabling the\nDynamicResourceAllocation feature gate.\n\nThis field is immutable. It can only be set for containers."

Note: This function appends passed data to existing values

fn spec.insert.resources.withLimits

withLimits(limits)

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

fn spec.insert.resources.withLimitsMixin

withLimitsMixin(limits)

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

Note: This function appends passed data to existing values

fn spec.insert.resources.withRequests

withRequests(requests)

"Requests describes the minimum amount of compute resources required.\nIf Requests is omitted for a container, it defaults to Limits if that is explicitly specified,\notherwise to an implementation-defined value. Requests cannot exceed Limits.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"

fn spec.insert.resources.withRequestsMixin

withRequestsMixin(requests)

"Requests describes the minimum amount of compute resources required.\nIf Requests is omitted for a container, it defaults to Limits if that is explicitly specified,\notherwise to an implementation-defined value. Requests cannot exceed Limits.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"

Note: This function appends passed data to existing values

obj spec.insert.resources.claims

"Claims lists the names of resources, defined in spec.resourceClaims,\nthat are used by this container.\n\nThis is an alpha field and requires enabling the\nDynamicResourceAllocation feature gate.\n\nThis field is immutable. It can only be set for containers."

fn spec.insert.resources.claims.withName

withName(name)

"Name must match the name of one entry in pod.spec.resourceClaims of\nthe Pod where this field is used. It makes that resource available\ninside a container."

fn spec.insert.resources.claims.withRequest

withRequest(request)

"Request is the name chosen for a request in the referenced claim.\nIf empty, everything from the claim is made available, otherwise\nonly the result of this request."

obj spec.insert.rollingUpdate

"RollingUpdate - overrides deployment update params."

fn spec.insert.rollingUpdate.withMaxSurge

withMaxSurge(maxSurge)

"The maximum number of pods that can be scheduled above the desired number of\npods.\nValue can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%).\nThis can not be 0 if MaxUnavailable is 0.\nAbsolute number is calculated from percentage by rounding up.\nDefaults to 25%.\nExample: when this is set to 30%, the new ReplicaSet can be scaled up immediately when\nthe rolling update starts, such that the total number of old and new pods do not exceed\n130% of desired pods. Once old pods have been killed,\nnew ReplicaSet can be scaled up further, ensuring that total number of pods running\nat any time during the update is at most 130% of desired pods."

fn spec.insert.rollingUpdate.withMaxUnavailable

withMaxUnavailable(maxUnavailable)

"The maximum number of pods that can be unavailable during the update.\nValue can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%).\nAbsolute number is calculated from percentage by rounding down.\nThis can not be 0 if MaxSurge is 0.\nDefaults to 25%.\nExample: when this is set to 30%, the old ReplicaSet can be scaled down to 70% of desired pods\nimmediately when the rolling update starts. Once new pods are ready, old ReplicaSet\ncan be scaled down further, followed by scaling up the new ReplicaSet, ensuring\nthat the total number of pods available at all times during the update is at\nleast 70% of desired pods."

obj spec.insert.serviceSpec

"ServiceSpec that will be added to vtselect service spec"

fn spec.insert.serviceSpec.withSpec

withSpec(spec)

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

fn spec.insert.serviceSpec.withSpecMixin

withSpecMixin(spec)

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

Note: This function appends passed data to existing values

fn spec.insert.serviceSpec.withUseAsDefault

withUseAsDefault(useAsDefault)

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

obj spec.insert.serviceSpec.metadata

"EmbeddedObjectMetadata defines objectMeta for additional service."

fn spec.insert.serviceSpec.metadata.withAnnotations

withAnnotations(annotations)

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

fn spec.insert.serviceSpec.metadata.withAnnotationsMixin

withAnnotationsMixin(annotations)

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

Note: This function appends passed data to existing values

fn spec.insert.serviceSpec.metadata.withLabels

withLabels(labels)

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

fn spec.insert.serviceSpec.metadata.withLabelsMixin

withLabelsMixin(labels)

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

Note: This function appends passed data to existing values

fn spec.insert.serviceSpec.metadata.withName

withName(name)

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

obj spec.insert.tolerations

"Tolerations If specified, the pod's tolerations."

fn spec.insert.tolerations.withEffect

withEffect(effect)

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

fn spec.insert.tolerations.withKey

withKey(key)

"Key is the taint key that the toleration applies to. Empty means match all taint keys.\nIf the key is empty, operator must be Exists; this combination means to match all values and all keys."

fn spec.insert.tolerations.withOperator

withOperator(operator)

"Operator represents a key's relationship to the value.\nValid operators are Exists and Equal. Defaults to Equal.\nExists is equivalent to wildcard for value, so that a pod can\ntolerate all taints of a particular category."

fn spec.insert.tolerations.withTolerationSeconds

withTolerationSeconds(tolerationSeconds)

"TolerationSeconds represents the period of time the toleration (which must be\nof effect NoExecute, otherwise this field is ignored) tolerates the taint. By default,\nit is not set, which means tolerate the taint forever (do not evict). Zero and\nnegative values will be treated as 0 (evict immediately) by the system."

fn spec.insert.tolerations.withValue

withValue(value)

"Value is the taint value the toleration matches to.\nIf the operator is Exists, the value should be empty, otherwise just a regular string."

obj spec.insert.volumeMounts

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

fn spec.insert.volumeMounts.withMountPath

withMountPath(mountPath)

"Path within the container at which the volume should be mounted. Must\nnot contain ':'."

fn spec.insert.volumeMounts.withMountPropagation

withMountPropagation(mountPropagation)

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

fn spec.insert.volumeMounts.withName

withName(name)

"This must match the Name of a Volume."

fn spec.insert.volumeMounts.withReadOnly

withReadOnly(readOnly)

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

fn spec.insert.volumeMounts.withRecursiveReadOnly

withRecursiveReadOnly(recursiveReadOnly)

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

fn spec.insert.volumeMounts.withSubPath

withSubPath(subPath)

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

fn spec.insert.volumeMounts.withSubPathExpr

withSubPathExpr(subPathExpr)

"Expanded path within the volume from which the container's volume should be mounted.\nBehaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment.\nDefaults to \"\" (volume's root).\nSubPathExpr and SubPath are mutually exclusive."

obj spec.managedMetadata

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

fn spec.managedMetadata.withAnnotations

withAnnotations(annotations)

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

fn spec.managedMetadata.withAnnotationsMixin

withAnnotationsMixin(annotations)

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

Note: This function appends passed data to existing values

fn spec.managedMetadata.withLabels

withLabels(labels)

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

fn spec.managedMetadata.withLabelsMixin

withLabelsMixin(labels)

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

Note: This function appends passed data to existing values

obj spec.requestsLoadBalancer

"RequestsLoadBalancer configures load-balancing for vtinsert and vtselect requests.\nIt helps to evenly spread load across pods.\nUsually it's not possible with Kubernetes TCP-based services."

fn spec.requestsLoadBalancer.withDisableInsertBalancing

withDisableInsertBalancing(disableInsertBalancing)

fn spec.requestsLoadBalancer.withDisableSelectBalancing

withDisableSelectBalancing(disableSelectBalancing)

fn spec.requestsLoadBalancer.withEnabled

withEnabled(enabled)

fn spec.requestsLoadBalancer.withSpec

withSpec(spec)

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

fn spec.requestsLoadBalancer.withSpecMixin

withSpecMixin(spec)

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

Note: This function appends passed data to existing values

obj spec.select

"VTSelect defines vtselect component configuration at victoria-traces cluster"

fn spec.select.withAffinity

withAffinity(affinity)

"Affinity If specified, the pod's scheduling constraints."

fn spec.select.withAffinityMixin

withAffinityMixin(affinity)

"Affinity If specified, the pod's scheduling constraints."

Note: This function appends passed data to existing values

fn spec.select.withConfigMaps

withConfigMaps(configMaps)

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

fn spec.select.withConfigMapsMixin

withConfigMapsMixin(configMaps)

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

Note: This function appends passed data to existing values

fn spec.select.withContainers

withContainers(containers)

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

fn spec.select.withContainersMixin

withContainersMixin(containers)

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

Note: This function appends passed data to existing values

fn spec.select.withDisableAutomountServiceAccountToken

withDisableAutomountServiceAccountToken(disableAutomountServiceAccountToken)

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

fn spec.select.withDisableSelfServiceScrape

withDisableSelfServiceScrape(disableSelfServiceScrape)

"DisableSelfServiceScrape controls creation of VMServiceScrape by operator\nfor the application.\nHas priority over VM_DISABLESELFSERVICESCRAPECREATION operator env variable"

fn spec.select.withDnsPolicy

withDnsPolicy(dnsPolicy)

"DNSPolicy sets DNS policy for the pod"

fn spec.select.withExtraArgs

withExtraArgs(extraArgs)

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

fn spec.select.withExtraArgsMixin

withExtraArgsMixin(extraArgs)

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

Note: This function appends passed data to existing values

fn spec.select.withExtraEnvs

withExtraEnvs(extraEnvs)

"ExtraEnvs that will be passed to the application container"

fn spec.select.withExtraEnvsFrom

withExtraEnvsFrom(extraEnvsFrom)

"ExtraEnvsFrom defines source of env variables for the application container\ncould either be secret or configmap"

fn spec.select.withExtraEnvsFromMixin

withExtraEnvsFromMixin(extraEnvsFrom)

"ExtraEnvsFrom defines source of env variables for the application container\ncould either be secret or configmap"

Note: This function appends passed data to existing values

fn spec.select.withExtraEnvsMixin

withExtraEnvsMixin(extraEnvs)

"ExtraEnvs that will be passed to the application container"

Note: This function appends passed data to existing values

fn spec.select.withHostAliases

withHostAliases(hostAliases)

"HostAliases provides mapping for ip and hostname,\nthat would be propagated to pod,\ncannot be used with HostNetwork."

fn spec.select.withHostAliasesMixin

withHostAliasesMixin(hostAliases)

"HostAliases provides mapping for ip and hostname,\nthat would be propagated to pod,\ncannot be used with HostNetwork."

Note: This function appends passed data to existing values

fn spec.select.withHostNetwork

withHostNetwork(hostNetwork)

"HostNetwork controls whether the pod may use the node network namespace"

fn spec.select.withHost_aliases

withHost_aliases(host_aliases)

"HostAliasesUnderScore provides mapping for ip and hostname,\nthat would be propagated to pod,\ncannot be used with HostNetwork.\nHas Priority over hostAliases field"

fn spec.select.withHost_aliasesMixin

withHost_aliasesMixin(host_aliases)

"HostAliasesUnderScore provides mapping for ip and hostname,\nthat would be propagated to pod,\ncannot be used with HostNetwork.\nHas Priority over hostAliases field"

Note: This function appends passed data to existing values

fn spec.select.withHpa

withHpa(hpa)

"Configures horizontal pod autoscaling."

fn spec.select.withHpaMixin

withHpaMixin(hpa)

"Configures horizontal pod autoscaling."

Note: This function appends passed data to existing values

fn spec.select.withImagePullSecrets

withImagePullSecrets(imagePullSecrets)

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

fn spec.select.withImagePullSecretsMixin

withImagePullSecretsMixin(imagePullSecrets)

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

Note: This function appends passed data to existing values

fn spec.select.withInitContainers

withInitContainers(initContainers)

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

fn spec.select.withInitContainersMixin

withInitContainersMixin(initContainers)

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

Note: This function appends passed data to existing values

fn spec.select.withLivenessProbe

withLivenessProbe(livenessProbe)

"LivenessProbe that will be added CRD pod"

fn spec.select.withLivenessProbeMixin

withLivenessProbeMixin(livenessProbe)

"LivenessProbe that will be added CRD pod"

Note: This function appends passed data to existing values

fn spec.select.withLogFormat

withLogFormat(logFormat)

"LogFormat for VTSelect to be configured with.\ndefault or json"

fn spec.select.withLogLevel

withLogLevel(logLevel)

"LogLevel for VTSelect to be configured with."

fn spec.select.withMinReadySeconds

withMinReadySeconds(minReadySeconds)

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

fn spec.select.withNodeSelector

withNodeSelector(nodeSelector)

"NodeSelector Define which Nodes the Pods are scheduled on."

fn spec.select.withNodeSelectorMixin

withNodeSelectorMixin(nodeSelector)

"NodeSelector Define which Nodes the Pods are scheduled on."

Note: This function appends passed data to existing values

fn spec.select.withPaused

withPaused(paused)

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

fn spec.select.withPort

withPort(port)

"Port listen address"

fn spec.select.withPriorityClassName

withPriorityClassName(priorityClassName)

"PriorityClassName class assigned to the Pods"

fn spec.select.withReadinessGates

withReadinessGates(readinessGates)

"ReadinessGates defines pod readiness gates"

fn spec.select.withReadinessGatesMixin

withReadinessGatesMixin(readinessGates)

"ReadinessGates defines pod readiness gates"

Note: This function appends passed data to existing values

fn spec.select.withReadinessProbe

withReadinessProbe(readinessProbe)

"ReadinessProbe that will be added CRD pod"

fn spec.select.withReadinessProbeMixin

withReadinessProbeMixin(readinessProbe)

"ReadinessProbe that will be added CRD pod"

Note: This function appends passed data to existing values

fn spec.select.withReplicaCount

withReplicaCount(replicaCount)

"ReplicaCount is the expected size of the Application."

fn spec.select.withRevisionHistoryLimitCount

withRevisionHistoryLimitCount(revisionHistoryLimitCount)

"The number of old ReplicaSets to retain to allow rollback in deployment or\nmaximum number of revisions that will be maintained in the Deployment revision history.\nHas no effect at StatefulSets\nDefaults to 10."

fn spec.select.withRuntimeClassName

withRuntimeClassName(runtimeClassName)

"RuntimeClassName - defines runtime class for kubernetes pod.\nhttps://kubernetes.io/docs/concepts/containers/runtime-class/"

fn spec.select.withSchedulerName

withSchedulerName(schedulerName)

"SchedulerName - defines kubernetes scheduler name"

fn spec.select.withSecrets

withSecrets(secrets)

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

fn spec.select.withSecretsMixin

withSecretsMixin(secrets)

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

Note: This function appends passed data to existing values

fn spec.select.withSecurityContext

withSecurityContext(securityContext)

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

fn spec.select.withSecurityContextMixin

withSecurityContextMixin(securityContext)

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

Note: This function appends passed data to existing values

fn spec.select.withServiceScrapeSpec

withServiceScrapeSpec(serviceScrapeSpec)

"ServiceScrapeSpec that will be added to vtselect VMServiceScrape spec"

fn spec.select.withServiceScrapeSpecMixin

withServiceScrapeSpecMixin(serviceScrapeSpec)

"ServiceScrapeSpec that will be added to vtselect VMServiceScrape spec"

Note: This function appends passed data to existing values

fn spec.select.withStartupProbe

withStartupProbe(startupProbe)

"StartupProbe that will be added to CRD pod"

fn spec.select.withStartupProbeMixin

withStartupProbeMixin(startupProbe)

"StartupProbe that will be added to CRD pod"

Note: This function appends passed data to existing values

fn spec.select.withTerminationGracePeriodSeconds

withTerminationGracePeriodSeconds(terminationGracePeriodSeconds)

"TerminationGracePeriodSeconds period for container graceful termination"

fn spec.select.withTolerations

withTolerations(tolerations)

"Tolerations If specified, the pod's tolerations."

fn spec.select.withTolerationsMixin

withTolerationsMixin(tolerations)

"Tolerations If specified, the pod's tolerations."

Note: This function appends passed data to existing values

fn spec.select.withTopologySpreadConstraints

withTopologySpreadConstraints(topologySpreadConstraints)

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

fn spec.select.withTopologySpreadConstraintsMixin

withTopologySpreadConstraintsMixin(topologySpreadConstraints)

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

Note: This function appends passed data to existing values

fn spec.select.withUpdateStrategy

withUpdateStrategy(updateStrategy)

"UpdateStrategy - overrides default update strategy."

fn spec.select.withUseDefaultResources

withUseDefaultResources(useDefaultResources)

"UseDefaultResources controls resource settings\nBy default, operator sets built-in resource requirements"

fn spec.select.withUseStrictSecurity

withUseStrictSecurity(useStrictSecurity)

"UseStrictSecurity enables strict security mode for component\nit restricts disk writes access\nuses non-root user out of the box\ndrops not needed security permissions"

fn spec.select.withVolumeMounts

withVolumeMounts(volumeMounts)

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

fn spec.select.withVolumeMountsMixin

withVolumeMountsMixin(volumeMounts)

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

Note: This function appends passed data to existing values

fn spec.select.withVolumes

withVolumes(volumes)

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

fn spec.select.withVolumesMixin

withVolumesMixin(volumes)

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

Note: This function appends passed data to existing values

obj spec.select.dnsConfig

"Specifies the DNS parameters of a pod.\nParameters specified here will be merged to the generated DNS\nconfiguration based on DNSPolicy."

fn spec.select.dnsConfig.withNameservers

withNameservers(nameservers)

"A list of DNS name server IP addresses.\nThis will be appended to the base nameservers generated from DNSPolicy.\nDuplicated nameservers will be removed."

fn spec.select.dnsConfig.withNameserversMixin

withNameserversMixin(nameservers)

"A list of DNS name server IP addresses.\nThis will be appended to the base nameservers generated from DNSPolicy.\nDuplicated nameservers will be removed."

Note: This function appends passed data to existing values

fn spec.select.dnsConfig.withOptions

withOptions(options)

"A list of DNS resolver options.\nThis will be merged with the base options generated from DNSPolicy.\nDuplicated entries will be removed. Resolution options given in Options\nwill override those that appear in the base DNSPolicy."

fn spec.select.dnsConfig.withOptionsMixin

withOptionsMixin(options)

"A list of DNS resolver options.\nThis will be merged with the base options generated from DNSPolicy.\nDuplicated entries will be removed. Resolution options given in Options\nwill override those that appear in the base DNSPolicy."

Note: This function appends passed data to existing values

fn spec.select.dnsConfig.withSearches

withSearches(searches)

"A list of DNS search domains for host-name lookup.\nThis will be appended to the base search paths generated from DNSPolicy.\nDuplicated search paths will be removed."

fn spec.select.dnsConfig.withSearchesMixin

withSearchesMixin(searches)

"A list of DNS search domains for host-name lookup.\nThis will be appended to the base search paths generated from DNSPolicy.\nDuplicated search paths will be removed."

Note: This function appends passed data to existing values

obj spec.select.dnsConfig.options

"A list of DNS resolver options.\nThis will be merged with the base options generated from DNSPolicy.\nDuplicated entries will be removed. Resolution options given in Options\nwill override those that appear in the base DNSPolicy."

fn spec.select.dnsConfig.options.withName

withName(name)

"Name is this DNS resolver option's name.\nRequired."

fn spec.select.dnsConfig.options.withValue

withValue(value)

"Value is this DNS resolver option's value."

obj spec.select.extraEnvs

"ExtraEnvs that will be passed to the application container"

fn spec.select.extraEnvs.withName

withName(name)

"Name of the environment variable. Must be a C_IDENTIFIER."

fn spec.select.extraEnvs.withValue

withValue(value)

"Variable references $(VAR_NAME) are expanded\nusing the previously defined environment variables in the container and\nany service environment variables. If a variable cannot be resolved,\nthe reference in the input string will be unchanged. Double $$ are reduced\nto a single $, which allows for escaping the $(VAR_NAME) syntax: i.e.\n\"$$(VAR_NAME)\" will produce the string literal \"$(VAR_NAME)\".\nEscaped references will never be expanded, regardless of whether the variable\nexists or not.\nDefaults to \"\"."

obj spec.select.extraEnvsFrom

"ExtraEnvsFrom defines source of env variables for the application container\ncould either be secret or configmap"

fn spec.select.extraEnvsFrom.withPrefix

withPrefix(prefix)

"An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER."

obj spec.select.extraEnvsFrom.configMapRef

"The ConfigMap to select from"

fn spec.select.extraEnvsFrom.configMapRef.withName

withName(name)

"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn spec.select.extraEnvsFrom.configMapRef.withOptional

withOptional(optional)

"Specify whether the ConfigMap must be defined"

obj spec.select.extraEnvsFrom.secretRef

"The Secret to select from"

fn spec.select.extraEnvsFrom.secretRef.withName

withName(name)

"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn spec.select.extraEnvsFrom.secretRef.withOptional

withOptional(optional)

"Specify whether the Secret must be defined"

obj spec.select.hostAliases

"HostAliases provides mapping for ip and hostname,\nthat would be propagated to pod,\ncannot be used with HostNetwork."

fn spec.select.hostAliases.withHostnames

withHostnames(hostnames)

"Hostnames for the above IP address."

fn spec.select.hostAliases.withHostnamesMixin

withHostnamesMixin(hostnames)

"Hostnames for the above IP address."

Note: This function appends passed data to existing values

fn spec.select.hostAliases.withIp

withIp(ip)

"IP address of the host file entry."

obj spec.select.host_aliases

"HostAliasesUnderScore provides mapping for ip and hostname,\nthat would be propagated to pod,\ncannot be used with HostNetwork.\nHas Priority over hostAliases field"

fn spec.select.host_aliases.withHostnames

withHostnames(hostnames)

"Hostnames for the above IP address."

fn spec.select.host_aliases.withHostnamesMixin

withHostnamesMixin(hostnames)

"Hostnames for the above IP address."

Note: This function appends passed data to existing values

fn spec.select.host_aliases.withIp

withIp(ip)

"IP address of the host file entry."

obj spec.select.image

"Image - docker image settings\nif no specified operator uses default version from operator config"

fn spec.select.image.withPullPolicy

withPullPolicy(pullPolicy)

"PullPolicy describes how to pull docker image"

fn spec.select.image.withRepository

withRepository(repository)

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

fn spec.select.image.withTag

withTag(tag)

"Tag contains desired docker image version"

obj spec.select.imagePullSecrets

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

fn spec.select.imagePullSecrets.withName

withName(name)

"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

obj spec.select.podDisruptionBudget

"PodDisruptionBudget created by operator"

fn spec.select.podDisruptionBudget.withMaxUnavailable

withMaxUnavailable(maxUnavailable)

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

fn spec.select.podDisruptionBudget.withMinAvailable

withMinAvailable(minAvailable)

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

fn spec.select.podDisruptionBudget.withSelectorLabels

withSelectorLabels(selectorLabels)

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

fn spec.select.podDisruptionBudget.withSelectorLabelsMixin

withSelectorLabelsMixin(selectorLabels)

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

Note: This function appends passed data to existing values

obj spec.select.podMetadata

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

fn spec.select.podMetadata.withAnnotations

withAnnotations(annotations)

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

fn spec.select.podMetadata.withAnnotationsMixin

withAnnotationsMixin(annotations)

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

Note: This function appends passed data to existing values

fn spec.select.podMetadata.withLabels

withLabels(labels)

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

fn spec.select.podMetadata.withLabelsMixin

withLabelsMixin(labels)

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

Note: This function appends passed data to existing values

fn spec.select.podMetadata.withName

withName(name)

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

obj spec.select.readinessGates

"ReadinessGates defines pod readiness gates"

fn spec.select.readinessGates.withConditionType

withConditionType(conditionType)

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

obj spec.select.resources

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

fn spec.select.resources.withClaims

withClaims(claims)

"Claims lists the names of resources, defined in spec.resourceClaims,\nthat are used by this container.\n\nThis is an alpha field and requires enabling the\nDynamicResourceAllocation feature gate.\n\nThis field is immutable. It can only be set for containers."

fn spec.select.resources.withClaimsMixin

withClaimsMixin(claims)

"Claims lists the names of resources, defined in spec.resourceClaims,\nthat are used by this container.\n\nThis is an alpha field and requires enabling the\nDynamicResourceAllocation feature gate.\n\nThis field is immutable. It can only be set for containers."

Note: This function appends passed data to existing values

fn spec.select.resources.withLimits

withLimits(limits)

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

fn spec.select.resources.withLimitsMixin

withLimitsMixin(limits)

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

Note: This function appends passed data to existing values

fn spec.select.resources.withRequests

withRequests(requests)

"Requests describes the minimum amount of compute resources required.\nIf Requests is omitted for a container, it defaults to Limits if that is explicitly specified,\notherwise to an implementation-defined value. Requests cannot exceed Limits.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"

fn spec.select.resources.withRequestsMixin

withRequestsMixin(requests)

"Requests describes the minimum amount of compute resources required.\nIf Requests is omitted for a container, it defaults to Limits if that is explicitly specified,\notherwise to an implementation-defined value. Requests cannot exceed Limits.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"

Note: This function appends passed data to existing values

obj spec.select.resources.claims

"Claims lists the names of resources, defined in spec.resourceClaims,\nthat are used by this container.\n\nThis is an alpha field and requires enabling the\nDynamicResourceAllocation feature gate.\n\nThis field is immutable. It can only be set for containers."

fn spec.select.resources.claims.withName

withName(name)

"Name must match the name of one entry in pod.spec.resourceClaims of\nthe Pod where this field is used. It makes that resource available\ninside a container."

fn spec.select.resources.claims.withRequest

withRequest(request)

"Request is the name chosen for a request in the referenced claim.\nIf empty, everything from the claim is made available, otherwise\nonly the result of this request."

obj spec.select.rollingUpdate

"RollingUpdate - overrides deployment update params."

fn spec.select.rollingUpdate.withMaxSurge

withMaxSurge(maxSurge)

"The maximum number of pods that can be scheduled above the desired number of\npods.\nValue can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%).\nThis can not be 0 if MaxUnavailable is 0.\nAbsolute number is calculated from percentage by rounding up.\nDefaults to 25%.\nExample: when this is set to 30%, the new ReplicaSet can be scaled up immediately when\nthe rolling update starts, such that the total number of old and new pods do not exceed\n130% of desired pods. Once old pods have been killed,\nnew ReplicaSet can be scaled up further, ensuring that total number of pods running\nat any time during the update is at most 130% of desired pods."

fn spec.select.rollingUpdate.withMaxUnavailable

withMaxUnavailable(maxUnavailable)

"The maximum number of pods that can be unavailable during the update.\nValue can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%).\nAbsolute number is calculated from percentage by rounding down.\nThis can not be 0 if MaxSurge is 0.\nDefaults to 25%.\nExample: when this is set to 30%, the old ReplicaSet can be scaled down to 70% of desired pods\nimmediately when the rolling update starts. Once new pods are ready, old ReplicaSet\ncan be scaled down further, followed by scaling up the new ReplicaSet, ensuring\nthat the total number of pods available at all times during the update is at\nleast 70% of desired pods."

obj spec.select.serviceSpec

"ServiceSpec that will be added to vtselect service spec"

fn spec.select.serviceSpec.withSpec

withSpec(spec)

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

fn spec.select.serviceSpec.withSpecMixin

withSpecMixin(spec)

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

Note: This function appends passed data to existing values

fn spec.select.serviceSpec.withUseAsDefault

withUseAsDefault(useAsDefault)

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

obj spec.select.serviceSpec.metadata

"EmbeddedObjectMetadata defines objectMeta for additional service."

fn spec.select.serviceSpec.metadata.withAnnotations

withAnnotations(annotations)

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

fn spec.select.serviceSpec.metadata.withAnnotationsMixin

withAnnotationsMixin(annotations)

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

Note: This function appends passed data to existing values

fn spec.select.serviceSpec.metadata.withLabels

withLabels(labels)

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

fn spec.select.serviceSpec.metadata.withLabelsMixin

withLabelsMixin(labels)

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

Note: This function appends passed data to existing values

fn spec.select.serviceSpec.metadata.withName

withName(name)

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

obj spec.select.tolerations

"Tolerations If specified, the pod's tolerations."

fn spec.select.tolerations.withEffect

withEffect(effect)

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

fn spec.select.tolerations.withKey

withKey(key)

"Key is the taint key that the toleration applies to. Empty means match all taint keys.\nIf the key is empty, operator must be Exists; this combination means to match all values and all keys."

fn spec.select.tolerations.withOperator

withOperator(operator)

"Operator represents a key's relationship to the value.\nValid operators are Exists and Equal. Defaults to Equal.\nExists is equivalent to wildcard for value, so that a pod can\ntolerate all taints of a particular category."

fn spec.select.tolerations.withTolerationSeconds

withTolerationSeconds(tolerationSeconds)

"TolerationSeconds represents the period of time the toleration (which must be\nof effect NoExecute, otherwise this field is ignored) tolerates the taint. By default,\nit is not set, which means tolerate the taint forever (do not evict). Zero and\nnegative values will be treated as 0 (evict immediately) by the system."

fn spec.select.tolerations.withValue

withValue(value)

"Value is the taint value the toleration matches to.\nIf the operator is Exists, the value should be empty, otherwise just a regular string."

obj spec.select.volumeMounts

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

fn spec.select.volumeMounts.withMountPath

withMountPath(mountPath)

"Path within the container at which the volume should be mounted. Must\nnot contain ':'."

fn spec.select.volumeMounts.withMountPropagation

withMountPropagation(mountPropagation)

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

fn spec.select.volumeMounts.withName

withName(name)

"This must match the Name of a Volume."

fn spec.select.volumeMounts.withReadOnly

withReadOnly(readOnly)

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

fn spec.select.volumeMounts.withRecursiveReadOnly

withRecursiveReadOnly(recursiveReadOnly)

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

fn spec.select.volumeMounts.withSubPath

withSubPath(subPath)

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

fn spec.select.volumeMounts.withSubPathExpr

withSubPathExpr(subPathExpr)

"Expanded path within the volume from which the container's volume should be mounted.\nBehaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment.\nDefaults to \"\" (volume's root).\nSubPathExpr and SubPath are mutually exclusive."

obj spec.storage

"VTStorage defines vtstorage component configuration at victoria-traces cluster"

fn spec.storage.withAffinity

withAffinity(affinity)

"Affinity If specified, the pod's scheduling constraints."

fn spec.storage.withAffinityMixin

withAffinityMixin(affinity)

"Affinity If specified, the pod's scheduling constraints."

Note: This function appends passed data to existing values

fn spec.storage.withClaimTemplates

withClaimTemplates(claimTemplates)

"ClaimTemplates allows adding additional VolumeClaimTemplates for StatefulSet"

fn spec.storage.withClaimTemplatesMixin

withClaimTemplatesMixin(claimTemplates)

"ClaimTemplates allows adding additional VolumeClaimTemplates for StatefulSet"

Note: This function appends passed data to existing values

fn spec.storage.withConfigMaps

withConfigMaps(configMaps)

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

fn spec.storage.withConfigMapsMixin

withConfigMapsMixin(configMaps)

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

Note: This function appends passed data to existing values

fn spec.storage.withContainers

withContainers(containers)

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

fn spec.storage.withContainersMixin

withContainersMixin(containers)

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

Note: This function appends passed data to existing values

fn spec.storage.withDisableAutomountServiceAccountToken

withDisableAutomountServiceAccountToken(disableAutomountServiceAccountToken)

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

fn spec.storage.withDisableSelfServiceScrape

withDisableSelfServiceScrape(disableSelfServiceScrape)

"DisableSelfServiceScrape controls creation of VMServiceScrape by operator\nfor the application.\nHas priority over VM_DISABLESELFSERVICESCRAPECREATION operator env variable"

fn spec.storage.withDnsPolicy

withDnsPolicy(dnsPolicy)

"DNSPolicy sets DNS policy for the pod"

fn spec.storage.withExtraArgs

withExtraArgs(extraArgs)

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

fn spec.storage.withExtraArgsMixin

withExtraArgsMixin(extraArgs)

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

Note: This function appends passed data to existing values

fn spec.storage.withExtraEnvs

withExtraEnvs(extraEnvs)

"ExtraEnvs that will be passed to the application container"

fn spec.storage.withExtraEnvsFrom

withExtraEnvsFrom(extraEnvsFrom)

"ExtraEnvsFrom defines source of env variables for the application container\ncould either be secret or configmap"

fn spec.storage.withExtraEnvsFromMixin

withExtraEnvsFromMixin(extraEnvsFrom)

"ExtraEnvsFrom defines source of env variables for the application container\ncould either be secret or configmap"

Note: This function appends passed data to existing values

fn spec.storage.withExtraEnvsMixin

withExtraEnvsMixin(extraEnvs)

"ExtraEnvs that will be passed to the application container"

Note: This function appends passed data to existing values

fn spec.storage.withFutureRetention

withFutureRetention(futureRetention)

"FutureRetention for the stored traces\nLog entries with timestamps bigger than now+futureRetention are rejected during data ingestion\nsee https://docs.victoriametrics.com/victoriatraces/#configure-and-run-victoriatraces"

fn spec.storage.withHostAliases

withHostAliases(hostAliases)

"HostAliases provides mapping for ip and hostname,\nthat would be propagated to pod,\ncannot be used with HostNetwork."

fn spec.storage.withHostAliasesMixin

withHostAliasesMixin(hostAliases)

"HostAliases provides mapping for ip and hostname,\nthat would be propagated to pod,\ncannot be used with HostNetwork."

Note: This function appends passed data to existing values

fn spec.storage.withHostNetwork

withHostNetwork(hostNetwork)

"HostNetwork controls whether the pod may use the node network namespace"

fn spec.storage.withHost_aliases

withHost_aliases(host_aliases)

"HostAliasesUnderScore provides mapping for ip and hostname,\nthat would be propagated to pod,\ncannot be used with HostNetwork.\nHas Priority over hostAliases field"

fn spec.storage.withHost_aliasesMixin

withHost_aliasesMixin(host_aliases)

"HostAliasesUnderScore provides mapping for ip and hostname,\nthat would be propagated to pod,\ncannot be used with HostNetwork.\nHas Priority over hostAliases field"

Note: This function appends passed data to existing values

fn spec.storage.withImagePullSecrets

withImagePullSecrets(imagePullSecrets)

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

fn spec.storage.withImagePullSecretsMixin

withImagePullSecretsMixin(imagePullSecrets)

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

Note: This function appends passed data to existing values

fn spec.storage.withInitContainers

withInitContainers(initContainers)

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

fn spec.storage.withInitContainersMixin

withInitContainersMixin(initContainers)

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

Note: This function appends passed data to existing values

fn spec.storage.withLivenessProbe

withLivenessProbe(livenessProbe)

"LivenessProbe that will be added CRD pod"

fn spec.storage.withLivenessProbeMixin

withLivenessProbeMixin(livenessProbe)

"LivenessProbe that will be added CRD pod"

Note: This function appends passed data to existing values

fn spec.storage.withLogFormat

withLogFormat(logFormat)

"LogFormat for VTStorage to be configured with.\ndefault or json"

fn spec.storage.withLogIngestedRows

withLogIngestedRows(logIngestedRows)

"Whether to log all the ingested log entries; this can be useful for debugging of data ingestion\nsee https://docs.victoriametrics.com/victoriatraces/#configure-and-run-victoriatraces"

fn spec.storage.withLogLevel

withLogLevel(logLevel)

"LogLevel for VTStorage to be configured with."

fn spec.storage.withLogNewStreams

withLogNewStreams(logNewStreams)

"LogNewStreams Whether to log creation of new streams; this can be useful for debugging of high cardinality issues with log streams\nsee https://docs.victoriametrics.com/victoriatraces/#configure-and-run-victoriatraces"

fn spec.storage.withMaintenanceInsertNodeIDs

withMaintenanceInsertNodeIDs(maintenanceInsertNodeIDs)

"MaintenanceInsertNodeIDs - excludes given node ids from insert requests routing, must contain pod suffixes - for pod-0, id will be 0 and etc.\nlets 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].\nUseful at storage expanding, when you want to rebalance some data at cluster."

fn spec.storage.withMaintenanceInsertNodeIDsMixin

withMaintenanceInsertNodeIDsMixin(maintenanceInsertNodeIDs)

"MaintenanceInsertNodeIDs - excludes given node ids from insert requests routing, must contain pod suffixes - for pod-0, id will be 0 and etc.\nlets 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].\nUseful at storage expanding, when you want to rebalance some data at cluster."

Note: This function appends passed data to existing values

fn spec.storage.withMaintenanceSelectNodeIDs

withMaintenanceSelectNodeIDs(maintenanceSelectNodeIDs)

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

fn spec.storage.withMaintenanceSelectNodeIDsMixin

withMaintenanceSelectNodeIDsMixin(maintenanceSelectNodeIDs)

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

Note: This function appends passed data to existing values

fn spec.storage.withMinReadySeconds

withMinReadySeconds(minReadySeconds)

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

fn spec.storage.withNodeSelector

withNodeSelector(nodeSelector)

"NodeSelector Define which Nodes the Pods are scheduled on."

fn spec.storage.withNodeSelectorMixin

withNodeSelectorMixin(nodeSelector)

"NodeSelector Define which Nodes the Pods are scheduled on."

Note: This function appends passed data to existing values

fn spec.storage.withPaused

withPaused(paused)

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

fn spec.storage.withPort

withPort(port)

"Port listen address"

fn spec.storage.withPriorityClassName

withPriorityClassName(priorityClassName)

"PriorityClassName class assigned to the Pods"

fn spec.storage.withReadinessGates

withReadinessGates(readinessGates)

"ReadinessGates defines pod readiness gates"

fn spec.storage.withReadinessGatesMixin

withReadinessGatesMixin(readinessGates)

"ReadinessGates defines pod readiness gates"

Note: This function appends passed data to existing values

fn spec.storage.withReadinessProbe

withReadinessProbe(readinessProbe)

"ReadinessProbe that will be added CRD pod"

fn spec.storage.withReadinessProbeMixin

withReadinessProbeMixin(readinessProbe)

"ReadinessProbe that will be added CRD pod"

Note: This function appends passed data to existing values

fn spec.storage.withReplicaCount

withReplicaCount(replicaCount)

"ReplicaCount is the expected size of the Application."

fn spec.storage.withRetentionMaxDiskSpaceUsageBytes

withRetentionMaxDiskSpaceUsageBytes(retentionMaxDiskSpaceUsageBytes)

"RetentionMaxDiskSpaceUsageBytes for the stored traces\nVictoriaTraces keeps at least two last days of data in order to guarantee that the traces for the last day can be returned in queries.\nThis means that the total disk space usage may exceed the -retention.maxDiskSpaceUsageBytes,\nif the size of the last two days of data exceeds the -retention.maxDiskSpaceUsageBytes.\nhttps://docs.victoriametrics.com/victoriatraces/#configure-and-run-victoriatraces"

fn spec.storage.withRetentionPeriod

withRetentionPeriod(retentionPeriod)

"RetentionPeriod for the stored traces\nhttps://docs.victoriametrics.com/victoriatraces/#configure-and-run-victoriatraces"

fn spec.storage.withRevisionHistoryLimitCount

withRevisionHistoryLimitCount(revisionHistoryLimitCount)

"The number of old ReplicaSets to retain to allow rollback in deployment or\nmaximum number of revisions that will be maintained in the Deployment revision history.\nHas no effect at StatefulSets\nDefaults to 10."

fn spec.storage.withRollingUpdateStrategy

withRollingUpdateStrategy(rollingUpdateStrategy)

"RollingUpdateStrategy defines strategy for application updates\nDefault is OnDelete, in this case operator handles update process\nCan be changed for RollingUpdate"

fn spec.storage.withRuntimeClassName

withRuntimeClassName(runtimeClassName)

"RuntimeClassName - defines runtime class for kubernetes pod.\nhttps://kubernetes.io/docs/concepts/containers/runtime-class/"

fn spec.storage.withSchedulerName

withSchedulerName(schedulerName)

"SchedulerName - defines kubernetes scheduler name"

fn spec.storage.withSecrets

withSecrets(secrets)

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

fn spec.storage.withSecretsMixin

withSecretsMixin(secrets)

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

Note: This function appends passed data to existing values

fn spec.storage.withSecurityContext

withSecurityContext(securityContext)

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

fn spec.storage.withSecurityContextMixin

withSecurityContextMixin(securityContext)

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

Note: This function appends passed data to existing values

fn spec.storage.withServiceScrapeSpec

withServiceScrapeSpec(serviceScrapeSpec)

"ServiceScrapeSpec that will be added to vtselect VMServiceScrape spec"

fn spec.storage.withServiceScrapeSpecMixin

withServiceScrapeSpecMixin(serviceScrapeSpec)

"ServiceScrapeSpec that will be added to vtselect VMServiceScrape spec"

Note: This function appends passed data to existing values

fn spec.storage.withStartupProbe

withStartupProbe(startupProbe)

"StartupProbe that will be added to CRD pod"

fn spec.storage.withStartupProbeMixin

withStartupProbeMixin(startupProbe)

"StartupProbe that will be added to CRD pod"

Note: This function appends passed data to existing values

fn spec.storage.withStorageDataPath

withStorageDataPath(storageDataPath)

"StorageDataPath - path to storage data"

fn spec.storage.withTerminationGracePeriodSeconds

withTerminationGracePeriodSeconds(terminationGracePeriodSeconds)

"TerminationGracePeriodSeconds period for container graceful termination"

fn spec.storage.withTolerations

withTolerations(tolerations)

"Tolerations If specified, the pod's tolerations."

fn spec.storage.withTolerationsMixin

withTolerationsMixin(tolerations)

"Tolerations If specified, the pod's tolerations."

Note: This function appends passed data to existing values

fn spec.storage.withTopologySpreadConstraints

withTopologySpreadConstraints(topologySpreadConstraints)

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

fn spec.storage.withTopologySpreadConstraintsMixin

withTopologySpreadConstraintsMixin(topologySpreadConstraints)

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

Note: This function appends passed data to existing values

fn spec.storage.withUseDefaultResources

withUseDefaultResources(useDefaultResources)

"UseDefaultResources controls resource settings\nBy default, operator sets built-in resource requirements"

fn spec.storage.withUseStrictSecurity

withUseStrictSecurity(useStrictSecurity)

"UseStrictSecurity enables strict security mode for component\nit restricts disk writes access\nuses non-root user out of the box\ndrops not needed security permissions"

fn spec.storage.withVolumeMounts

withVolumeMounts(volumeMounts)

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

fn spec.storage.withVolumeMountsMixin

withVolumeMountsMixin(volumeMounts)

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

Note: This function appends passed data to existing values

fn spec.storage.withVolumes

withVolumes(volumes)

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

fn spec.storage.withVolumesMixin

withVolumesMixin(volumes)

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

Note: This function appends passed data to existing values

obj spec.storage.dnsConfig

"Specifies the DNS parameters of a pod.\nParameters specified here will be merged to the generated DNS\nconfiguration based on DNSPolicy."

fn spec.storage.dnsConfig.withNameservers

withNameservers(nameservers)

"A list of DNS name server IP addresses.\nThis will be appended to the base nameservers generated from DNSPolicy.\nDuplicated nameservers will be removed."

fn spec.storage.dnsConfig.withNameserversMixin

withNameserversMixin(nameservers)

"A list of DNS name server IP addresses.\nThis will be appended to the base nameservers generated from DNSPolicy.\nDuplicated nameservers will be removed."

Note: This function appends passed data to existing values

fn spec.storage.dnsConfig.withOptions

withOptions(options)

"A list of DNS resolver options.\nThis will be merged with the base options generated from DNSPolicy.\nDuplicated entries will be removed. Resolution options given in Options\nwill override those that appear in the base DNSPolicy."

fn spec.storage.dnsConfig.withOptionsMixin

withOptionsMixin(options)

"A list of DNS resolver options.\nThis will be merged with the base options generated from DNSPolicy.\nDuplicated entries will be removed. Resolution options given in Options\nwill override those that appear in the base DNSPolicy."

Note: This function appends passed data to existing values

fn spec.storage.dnsConfig.withSearches

withSearches(searches)

"A list of DNS search domains for host-name lookup.\nThis will be appended to the base search paths generated from DNSPolicy.\nDuplicated search paths will be removed."

fn spec.storage.dnsConfig.withSearchesMixin

withSearchesMixin(searches)

"A list of DNS search domains for host-name lookup.\nThis will be appended to the base search paths generated from DNSPolicy.\nDuplicated search paths will be removed."

Note: This function appends passed data to existing values

obj spec.storage.dnsConfig.options

"A list of DNS resolver options.\nThis will be merged with the base options generated from DNSPolicy.\nDuplicated entries will be removed. Resolution options given in Options\nwill override those that appear in the base DNSPolicy."

fn spec.storage.dnsConfig.options.withName

withName(name)

"Name is this DNS resolver option's name.\nRequired."

fn spec.storage.dnsConfig.options.withValue

withValue(value)

"Value is this DNS resolver option's value."

obj spec.storage.extraEnvs

"ExtraEnvs that will be passed to the application container"

fn spec.storage.extraEnvs.withName

withName(name)

"Name of the environment variable. Must be a C_IDENTIFIER."

fn spec.storage.extraEnvs.withValue

withValue(value)

"Variable references $(VAR_NAME) are expanded\nusing the previously defined environment variables in the container and\nany service environment variables. If a variable cannot be resolved,\nthe reference in the input string will be unchanged. Double $$ are reduced\nto a single $, which allows for escaping the $(VAR_NAME) syntax: i.e.\n\"$$(VAR_NAME)\" will produce the string literal \"$(VAR_NAME)\".\nEscaped references will never be expanded, regardless of whether the variable\nexists or not.\nDefaults to \"\"."

obj spec.storage.extraEnvsFrom

"ExtraEnvsFrom defines source of env variables for the application container\ncould either be secret or configmap"

fn spec.storage.extraEnvsFrom.withPrefix

withPrefix(prefix)

"An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER."

obj spec.storage.extraEnvsFrom.configMapRef

"The ConfigMap to select from"

fn spec.storage.extraEnvsFrom.configMapRef.withName

withName(name)

"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn spec.storage.extraEnvsFrom.configMapRef.withOptional

withOptional(optional)

"Specify whether the ConfigMap must be defined"

obj spec.storage.extraEnvsFrom.secretRef

"The Secret to select from"

fn spec.storage.extraEnvsFrom.secretRef.withName

withName(name)

"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn spec.storage.extraEnvsFrom.secretRef.withOptional

withOptional(optional)

"Specify whether the Secret must be defined"

obj spec.storage.hostAliases

"HostAliases provides mapping for ip and hostname,\nthat would be propagated to pod,\ncannot be used with HostNetwork."

fn spec.storage.hostAliases.withHostnames

withHostnames(hostnames)

"Hostnames for the above IP address."

fn spec.storage.hostAliases.withHostnamesMixin

withHostnamesMixin(hostnames)

"Hostnames for the above IP address."

Note: This function appends passed data to existing values

fn spec.storage.hostAliases.withIp

withIp(ip)

"IP address of the host file entry."

obj spec.storage.host_aliases

"HostAliasesUnderScore provides mapping for ip and hostname,\nthat would be propagated to pod,\ncannot be used with HostNetwork.\nHas Priority over hostAliases field"

fn spec.storage.host_aliases.withHostnames

withHostnames(hostnames)

"Hostnames for the above IP address."

fn spec.storage.host_aliases.withHostnamesMixin

withHostnamesMixin(hostnames)

"Hostnames for the above IP address."

Note: This function appends passed data to existing values

fn spec.storage.host_aliases.withIp

withIp(ip)

"IP address of the host file entry."

obj spec.storage.image

"Image - docker image settings\nif no specified operator uses default version from operator config"

fn spec.storage.image.withPullPolicy

withPullPolicy(pullPolicy)

"PullPolicy describes how to pull docker image"

fn spec.storage.image.withRepository

withRepository(repository)

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

fn spec.storage.image.withTag

withTag(tag)

"Tag contains desired docker image version"

obj spec.storage.imagePullSecrets

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

fn spec.storage.imagePullSecrets.withName

withName(name)

"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

obj spec.storage.persistentVolumeClaimRetentionPolicy

"PersistentVolumeClaimRetentionPolicy allows configuration of PVC retention policy"

fn spec.storage.persistentVolumeClaimRetentionPolicy.withWhenDeleted

withWhenDeleted(whenDeleted)

"WhenDeleted specifies what happens to PVCs created from StatefulSet\nVolumeClaimTemplates when the StatefulSet is deleted. The default policy\nof Retain causes PVCs to not be affected by StatefulSet deletion. The\nDelete policy causes those PVCs to be deleted."

fn spec.storage.persistentVolumeClaimRetentionPolicy.withWhenScaled

withWhenScaled(whenScaled)

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

obj spec.storage.podDisruptionBudget

"PodDisruptionBudget created by operator"

fn spec.storage.podDisruptionBudget.withMaxUnavailable

withMaxUnavailable(maxUnavailable)

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

fn spec.storage.podDisruptionBudget.withMinAvailable

withMinAvailable(minAvailable)

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

fn spec.storage.podDisruptionBudget.withSelectorLabels

withSelectorLabels(selectorLabels)

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

fn spec.storage.podDisruptionBudget.withSelectorLabelsMixin

withSelectorLabelsMixin(selectorLabels)

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

Note: This function appends passed data to existing values

obj spec.storage.podMetadata

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

fn spec.storage.podMetadata.withAnnotations

withAnnotations(annotations)

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

fn spec.storage.podMetadata.withAnnotationsMixin

withAnnotationsMixin(annotations)

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

Note: This function appends passed data to existing values

fn spec.storage.podMetadata.withLabels

withLabels(labels)

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

fn spec.storage.podMetadata.withLabelsMixin

withLabelsMixin(labels)

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

Note: This function appends passed data to existing values

fn spec.storage.podMetadata.withName

withName(name)

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

obj spec.storage.readinessGates

"ReadinessGates defines pod readiness gates"

fn spec.storage.readinessGates.withConditionType

withConditionType(conditionType)

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

obj spec.storage.resources

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

fn spec.storage.resources.withClaims

withClaims(claims)

"Claims lists the names of resources, defined in spec.resourceClaims,\nthat are used by this container.\n\nThis is an alpha field and requires enabling the\nDynamicResourceAllocation feature gate.\n\nThis field is immutable. It can only be set for containers."

fn spec.storage.resources.withClaimsMixin

withClaimsMixin(claims)

"Claims lists the names of resources, defined in spec.resourceClaims,\nthat are used by this container.\n\nThis is an alpha field and requires enabling the\nDynamicResourceAllocation feature gate.\n\nThis field is immutable. It can only be set for containers."

Note: This function appends passed data to existing values

fn spec.storage.resources.withLimits

withLimits(limits)

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

fn spec.storage.resources.withLimitsMixin

withLimitsMixin(limits)

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

Note: This function appends passed data to existing values

fn spec.storage.resources.withRequests

withRequests(requests)

"Requests describes the minimum amount of compute resources required.\nIf Requests is omitted for a container, it defaults to Limits if that is explicitly specified,\notherwise to an implementation-defined value. Requests cannot exceed Limits.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"

fn spec.storage.resources.withRequestsMixin

withRequestsMixin(requests)

"Requests describes the minimum amount of compute resources required.\nIf Requests is omitted for a container, it defaults to Limits if that is explicitly specified,\notherwise to an implementation-defined value. Requests cannot exceed Limits.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"

Note: This function appends passed data to existing values

obj spec.storage.resources.claims

"Claims lists the names of resources, defined in spec.resourceClaims,\nthat are used by this container.\n\nThis is an alpha field and requires enabling the\nDynamicResourceAllocation feature gate.\n\nThis field is immutable. It can only be set for containers."

fn spec.storage.resources.claims.withName

withName(name)

"Name must match the name of one entry in pod.spec.resourceClaims of\nthe Pod where this field is used. It makes that resource available\ninside a container."

fn spec.storage.resources.claims.withRequest

withRequest(request)

"Request is the name chosen for a request in the referenced claim.\nIf empty, everything from the claim is made available, otherwise\nonly the result of this request."

obj spec.storage.rollingUpdateStrategyBehavior

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

fn spec.storage.rollingUpdateStrategyBehavior.withMaxUnavailable

withMaxUnavailable(maxUnavailable)

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

obj spec.storage.serviceSpec

"ServiceSpec that will be added to vtselect service spec"

fn spec.storage.serviceSpec.withSpec

withSpec(spec)

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

fn spec.storage.serviceSpec.withSpecMixin

withSpecMixin(spec)

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

Note: This function appends passed data to existing values

fn spec.storage.serviceSpec.withUseAsDefault

withUseAsDefault(useAsDefault)

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

obj spec.storage.serviceSpec.metadata

"EmbeddedObjectMetadata defines objectMeta for additional service."

fn spec.storage.serviceSpec.metadata.withAnnotations

withAnnotations(annotations)

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

fn spec.storage.serviceSpec.metadata.withAnnotationsMixin

withAnnotationsMixin(annotations)

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

Note: This function appends passed data to existing values

fn spec.storage.serviceSpec.metadata.withLabels

withLabels(labels)

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

fn spec.storage.serviceSpec.metadata.withLabelsMixin

withLabelsMixin(labels)

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

Note: This function appends passed data to existing values

fn spec.storage.serviceSpec.metadata.withName

withName(name)

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

obj spec.storage.storage

"Storage configures persistent volume for VTStorage"

fn spec.storage.storage.withDisableMountSubPath

withDisableMountSubPath(disableMountSubPath)

"Deprecated: subPath usage will be disabled by default in a future release, this option will become unnecessary.\nDisableMountSubPath allows to remove any subPath usage in volume mounts."

fn spec.storage.storage.withVolumeClaimTemplate

withVolumeClaimTemplate(volumeClaimTemplate)

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

fn spec.storage.storage.withVolumeClaimTemplateMixin

withVolumeClaimTemplateMixin(volumeClaimTemplate)

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

Note: This function appends passed data to existing values

obj spec.storage.storage.emptyDir

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

fn spec.storage.storage.emptyDir.withMedium

withMedium(medium)

"medium represents what type of storage medium should back this directory.\nThe default is \"\" which means to use the node's default medium.\nMust be an empty string (default) or Memory.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir"

fn spec.storage.storage.emptyDir.withSizeLimit

withSizeLimit(sizeLimit)

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

obj spec.storage.tolerations

"Tolerations If specified, the pod's tolerations."

fn spec.storage.tolerations.withEffect

withEffect(effect)

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

fn spec.storage.tolerations.withKey

withKey(key)

"Key is the taint key that the toleration applies to. Empty means match all taint keys.\nIf the key is empty, operator must be Exists; this combination means to match all values and all keys."

fn spec.storage.tolerations.withOperator

withOperator(operator)

"Operator represents a key's relationship to the value.\nValid operators are Exists and Equal. Defaults to Equal.\nExists is equivalent to wildcard for value, so that a pod can\ntolerate all taints of a particular category."

fn spec.storage.tolerations.withTolerationSeconds

withTolerationSeconds(tolerationSeconds)

"TolerationSeconds represents the period of time the toleration (which must be\nof effect NoExecute, otherwise this field is ignored) tolerates the taint. By default,\nit is not set, which means tolerate the taint forever (do not evict). Zero and\nnegative values will be treated as 0 (evict immediately) by the system."

fn spec.storage.tolerations.withValue

withValue(value)

"Value is the taint value the toleration matches to.\nIf the operator is Exists, the value should be empty, otherwise just a regular string."

obj spec.storage.volumeMounts

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

fn spec.storage.volumeMounts.withMountPath

withMountPath(mountPath)

"Path within the container at which the volume should be mounted. Must\nnot contain ':'."

fn spec.storage.volumeMounts.withMountPropagation

withMountPropagation(mountPropagation)

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

fn spec.storage.volumeMounts.withName

withName(name)

"This must match the Name of a Volume."

fn spec.storage.volumeMounts.withReadOnly

withReadOnly(readOnly)

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

fn spec.storage.volumeMounts.withRecursiveReadOnly

withRecursiveReadOnly(recursiveReadOnly)

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

fn spec.storage.volumeMounts.withSubPath

withSubPath(subPath)

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

fn spec.storage.volumeMounts.withSubPathExpr

withSubPathExpr(subPathExpr)

"Expanded path within the volume from which the container's volume should be mounted.\nBehaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment.\nDefaults to \"\" (volume's root).\nSubPathExpr and SubPath are mutually exclusive."