operator.v1beta1.vmAgent
"VMAgent - is a tiny but brave agent, which helps you collect metrics from various sources and stores them in VictoriaMetrics\nor any other Prometheus-compatible storage system that supports the remote_write protocol."
Index
fn new(name)obj metadatafn withAnnotations(annotations)fn withAnnotationsMixin(annotations)fn withClusterName(clusterName)fn withCreationTimestamp(creationTimestamp)fn withDeletionGracePeriodSeconds(deletionGracePeriodSeconds)fn withDeletionTimestamp(deletionTimestamp)fn withFinalizers(finalizers)fn withFinalizersMixin(finalizers)fn withGenerateName(generateName)fn withGeneration(generation)fn withLabels(labels)fn withLabelsMixin(labels)fn withName(name)fn withNamespace(namespace)fn withOwnerReferences(ownerReferences)fn withOwnerReferencesMixin(ownerReferences)fn withResourceVersion(resourceVersion)fn withSelfLink(selfLink)fn withUid(uid)
obj specfn withAffinity(affinity)fn withAffinityMixin(affinity)fn withClaimTemplates(claimTemplates)fn withClaimTemplatesMixin(claimTemplates)fn withConfigMaps(configMaps)fn withConfigMapsMixin(configMaps)fn withConfigReloaderExtraArgs(configReloaderExtraArgs)fn withConfigReloaderExtraArgsMixin(configReloaderExtraArgs)fn withConfigReloaderImageTag(configReloaderImageTag)fn withContainers(containers)fn withContainersMixin(containers)fn withDisableSelfServiceScrape(disableSelfServiceScrape)fn withDnsPolicy(dnsPolicy)fn withEnforcedNamespaceLabel(enforcedNamespaceLabel)fn withExternalLabels(externalLabels)fn withExternalLabelsMixin(externalLabels)fn withExtraArgs(extraArgs)fn withExtraArgsMixin(extraArgs)fn withExtraEnvs(extraEnvs)fn withExtraEnvsMixin(extraEnvs)fn withHostAliases(hostAliases)fn withHostAliasesMixin(hostAliases)fn withHostNetwork(hostNetwork)fn withHost_aliases(host_aliases)fn withHost_aliasesMixin(host_aliases)fn withIgnoreNamespaceSelectors(ignoreNamespaceSelectors)fn withImagePullSecrets(imagePullSecrets)fn withImagePullSecretsMixin(imagePullSecrets)fn withIngestOnlyMode(ingestOnlyMode)fn withInitContainers(initContainers)fn withInitContainersMixin(initContainers)fn withInlineRelabelConfig(inlineRelabelConfig)fn withInlineRelabelConfigMixin(inlineRelabelConfig)fn withInlineScrapeConfig(inlineScrapeConfig)fn withLivenessProbe(livenessProbe)fn withLivenessProbeMixin(livenessProbe)fn withLogFormat(logFormat)fn withLogLevel(logLevel)fn withMaxScrapeInterval(maxScrapeInterval)fn withMinReadySeconds(minReadySeconds)fn withMinScrapeInterval(minScrapeInterval)fn withNodeScrapeRelabelTemplate(nodeScrapeRelabelTemplate)fn withNodeScrapeRelabelTemplateMixin(nodeScrapeRelabelTemplate)fn withNodeSelector(nodeSelector)fn withNodeSelectorMixin(nodeSelector)fn withOverrideHonorLabels(overrideHonorLabels)fn withOverrideHonorTimestamps(overrideHonorTimestamps)fn withPaused(paused)fn withPodScrapeRelabelTemplate(podScrapeRelabelTemplate)fn withPodScrapeRelabelTemplateMixin(podScrapeRelabelTemplate)fn withPort(port)fn withPriorityClassName(priorityClassName)fn withProbeScrapeRelabelTemplate(probeScrapeRelabelTemplate)fn withProbeScrapeRelabelTemplateMixin(probeScrapeRelabelTemplate)fn withReadinessGates(readinessGates)fn withReadinessGatesMixin(readinessGates)fn withReadinessProbe(readinessProbe)fn withReadinessProbeMixin(readinessProbe)fn withRemoteWrite(remoteWrite)fn withRemoteWriteMixin(remoteWrite)fn withReplicaCount(replicaCount)fn withRevisionHistoryLimitCount(revisionHistoryLimitCount)fn withRuntimeClassName(runtimeClassName)fn withSchedulerName(schedulerName)fn withScrapeConfigRelabelTemplate(scrapeConfigRelabelTemplate)fn withScrapeConfigRelabelTemplateMixin(scrapeConfigRelabelTemplate)fn withScrapeInterval(scrapeInterval)fn withScrapeTimeout(scrapeTimeout)fn withSecrets(secrets)fn withSecretsMixin(secrets)fn withSecurityContext(securityContext)fn withSecurityContextMixin(securityContext)fn withSelectAllByDefault(selectAllByDefault)fn withServiceAccountName(serviceAccountName)fn withServiceScrapeRelabelTemplate(serviceScrapeRelabelTemplate)fn withServiceScrapeRelabelTemplateMixin(serviceScrapeRelabelTemplate)fn withServiceScrapeSpec(serviceScrapeSpec)fn withServiceScrapeSpecMixin(serviceScrapeSpec)fn withShardCount(shardCount)fn withStartupProbe(startupProbe)fn withStartupProbeMixin(startupProbe)fn withStatefulMode(statefulMode)fn withStatefulRollingUpdateStrategy(statefulRollingUpdateStrategy)fn withStaticScrapeRelabelTemplate(staticScrapeRelabelTemplate)fn withStaticScrapeRelabelTemplateMixin(staticScrapeRelabelTemplate)fn withTerminationGracePeriodSeconds(terminationGracePeriodSeconds)fn withTolerations(tolerations)fn withTolerationsMixin(tolerations)fn withTopologySpreadConstraints(topologySpreadConstraints)fn withTopologySpreadConstraintsMixin(topologySpreadConstraints)fn withUpdateStrategy(updateStrategy)fn withUseDefaultResources(useDefaultResources)fn withUseStrictSecurity(useStrictSecurity)fn withUseVMConfigReloader(useVMConfigReloader)fn withVmAgentExternalLabelName(vmAgentExternalLabelName)fn withVolumeMounts(volumeMounts)fn withVolumeMountsMixin(volumeMounts)fn withVolumes(volumes)fn withVolumesMixin(volumes)obj spec.aPIServerConfigfn withBearerToken(bearerToken)fn withBearerTokenFile(bearerTokenFile)fn withHost(host)obj spec.aPIServerConfig.authorizationobj spec.aPIServerConfig.basicAuthobj spec.aPIServerConfig.tlsConfig
obj spec.additionalScrapeConfigsobj spec.arbitraryFSAccessThroughSMsobj spec.claimTemplatesfn withApiVersion(apiVersion)fn withKind(kind)fn withMetadata(metadata)fn withMetadataMixin(metadata)obj spec.claimTemplates.specfn withAccessModes(accessModes)fn withAccessModesMixin(accessModes)fn withStorageClassName(storageClassName)fn withVolumeAttributesClassName(volumeAttributesClassName)fn withVolumeMode(volumeMode)fn withVolumeName(volumeName)obj spec.claimTemplates.spec.dataSourceobj spec.claimTemplates.spec.dataSourceRefobj spec.claimTemplates.spec.resourcesobj spec.claimTemplates.spec.selector
obj spec.configReloaderResourcesobj spec.dnsConfigobj spec.extraEnvsobj spec.hostAliasesobj spec.host_aliasesobj spec.imageobj spec.imagePullSecretsobj spec.inlineRelabelConfigfn withAction(action)fn withIf(If)fn withLabels(labels)fn withLabelsMixin(labels)fn withMatch(match)fn withModulus(modulus)fn withRegex(regex)fn withReplacement(replacement)fn withSeparator(separator)fn withSourceLabels(sourceLabels)fn withSourceLabelsMixin(sourceLabels)fn withSource_labels(source_labels)fn withSource_labelsMixin(source_labels)fn withTargetLabel(targetLabel)fn withTarget_label(target_label)
obj spec.insertPortsobj spec.licenseobj spec.nodeScrapeNamespaceSelectorobj spec.nodeScrapeRelabelTemplatefn withAction(action)fn withIf(If)fn withLabels(labels)fn withLabelsMixin(labels)fn withMatch(match)fn withModulus(modulus)fn withRegex(regex)fn withReplacement(replacement)fn withSeparator(separator)fn withSourceLabels(sourceLabels)fn withSourceLabelsMixin(sourceLabels)fn withSource_labels(source_labels)fn withSource_labelsMixin(source_labels)fn withTargetLabel(targetLabel)fn withTarget_label(target_label)
obj spec.nodeScrapeSelectorobj spec.podDisruptionBudgetobj spec.podMetadataobj spec.podScrapeNamespaceSelectorobj spec.podScrapeRelabelTemplatefn withAction(action)fn withIf(If)fn withLabels(labels)fn withLabelsMixin(labels)fn withMatch(match)fn withModulus(modulus)fn withRegex(regex)fn withReplacement(replacement)fn withSeparator(separator)fn withSourceLabels(sourceLabels)fn withSourceLabelsMixin(sourceLabels)fn withSource_labels(source_labels)fn withSource_labelsMixin(source_labels)fn withTargetLabel(targetLabel)fn withTarget_label(target_label)
obj spec.podScrapeSelectorobj spec.probeNamespaceSelectorobj spec.probeScrapeRelabelTemplatefn withAction(action)fn withIf(If)fn withLabels(labels)fn withLabelsMixin(labels)fn withMatch(match)fn withModulus(modulus)fn withRegex(regex)fn withReplacement(replacement)fn withSeparator(separator)fn withSourceLabels(sourceLabels)fn withSourceLabelsMixin(sourceLabels)fn withSource_labels(source_labels)fn withSource_labelsMixin(source_labels)fn withTargetLabel(targetLabel)fn withTarget_label(target_label)
obj spec.probeSelectorobj spec.readinessGatesobj spec.relabelConfigobj spec.remoteWritefn withForceVMProto(forceVMProto)fn withHeaders(headers)fn withHeadersMixin(headers)fn withInlineUrlRelabelConfig(inlineUrlRelabelConfig)fn withInlineUrlRelabelConfigMixin(inlineUrlRelabelConfig)fn withMaxDiskUsage(maxDiskUsage)fn withSendTimeout(sendTimeout)fn withUrl(url)obj spec.remoteWrite.basicAuthobj spec.remoteWrite.bearerTokenSecretobj spec.remoteWrite.inlineUrlRelabelConfigfn withAction(action)fn withIf(If)fn withLabels(labels)fn withLabelsMixin(labels)fn withMatch(match)fn withModulus(modulus)fn withRegex(regex)fn withReplacement(replacement)fn withSeparator(separator)fn withSourceLabels(sourceLabels)fn withSourceLabelsMixin(sourceLabels)fn withSource_labels(source_labels)fn withSource_labelsMixin(source_labels)fn withTargetLabel(targetLabel)fn withTarget_label(target_label)
obj spec.remoteWrite.oauth2obj spec.remoteWrite.streamAggrConfigfn withDedupInterval(dedupInterval)fn withDropInput(dropInput)fn withDropInputLabels(dropInputLabels)fn withDropInputLabelsMixin(dropInputLabels)fn withIgnoreFirstIntervals(ignoreFirstIntervals)fn withIgnoreOldSamples(ignoreOldSamples)fn withKeepInput(keepInput)fn withRules(rules)fn withRulesMixin(rules)obj spec.remoteWrite.streamAggrConfig.configmapobj spec.remoteWrite.streamAggrConfig.rulesfn withBy(by)fn withByMixin(by)fn withDedup_interval(dedup_interval)fn withDrop_input_labels(drop_input_labels)fn withDrop_input_labelsMixin(drop_input_labels)fn withFlush_on_shutdown(flush_on_shutdown)fn withIgnore_first_intervals(ignore_first_intervals)fn withIgnore_old_samples(ignore_old_samples)fn withInput_relabel_configs(input_relabel_configs)fn withInput_relabel_configsMixin(input_relabel_configs)fn withInterval(interval)fn withKeep_metric_names(keep_metric_names)fn withMatch(match)fn withNo_align_flush_to_interval(no_align_flush_to_interval)fn withOutput_relabel_configs(output_relabel_configs)fn withOutput_relabel_configsMixin(output_relabel_configs)fn withOutputs(outputs)fn withOutputsMixin(outputs)fn withStaleness_interval(staleness_interval)fn withWithout(without)fn withWithoutMixin(without)obj spec.remoteWrite.streamAggrConfig.rules.input_relabel_configsfn withAction(action)fn withIf(If)fn withLabels(labels)fn withLabelsMixin(labels)fn withMatch(match)fn withModulus(modulus)fn withRegex(regex)fn withReplacement(replacement)fn withSeparator(separator)fn withSourceLabels(sourceLabels)fn withSourceLabelsMixin(sourceLabels)fn withSource_labels(source_labels)fn withSource_labelsMixin(source_labels)fn withTargetLabel(targetLabel)fn withTarget_label(target_label)
obj spec.remoteWrite.streamAggrConfig.rules.output_relabel_configsfn withAction(action)fn withIf(If)fn withLabels(labels)fn withLabelsMixin(labels)fn withMatch(match)fn withModulus(modulus)fn withRegex(regex)fn withReplacement(replacement)fn withSeparator(separator)fn withSourceLabels(sourceLabels)fn withSourceLabelsMixin(sourceLabels)fn withSource_labels(source_labels)fn withSource_labelsMixin(source_labels)fn withTargetLabel(targetLabel)fn withTarget_label(target_label)
obj spec.remoteWrite.tlsConfigobj spec.remoteWrite.urlRelabelConfig
obj spec.remoteWriteSettingsobj spec.resourcesobj spec.rollingUpdateobj spec.scrapeConfigNamespaceSelectorobj spec.scrapeConfigRelabelTemplatefn withAction(action)fn withIf(If)fn withLabels(labels)fn withLabelsMixin(labels)fn withMatch(match)fn withModulus(modulus)fn withRegex(regex)fn withReplacement(replacement)fn withSeparator(separator)fn withSourceLabels(sourceLabels)fn withSourceLabelsMixin(sourceLabels)fn withSource_labels(source_labels)fn withSource_labelsMixin(source_labels)fn withTargetLabel(targetLabel)fn withTarget_label(target_label)
obj spec.scrapeConfigSelectorobj spec.serviceScrapeNamespaceSelectorobj spec.serviceScrapeRelabelTemplatefn withAction(action)fn withIf(If)fn withLabels(labels)fn withLabelsMixin(labels)fn withMatch(match)fn withModulus(modulus)fn withRegex(regex)fn withReplacement(replacement)fn withSeparator(separator)fn withSourceLabels(sourceLabels)fn withSourceLabelsMixin(sourceLabels)fn withSource_labels(source_labels)fn withSource_labelsMixin(source_labels)fn withTargetLabel(targetLabel)fn withTarget_label(target_label)
obj spec.serviceScrapeSelectorobj spec.serviceSpecobj spec.statefulStoragefn withDisableMountSubPath(disableMountSubPath)obj spec.statefulStorage.emptyDirobj spec.statefulStorage.volumeClaimTemplatefn withApiVersion(apiVersion)fn withKind(kind)obj spec.statefulStorage.volumeClaimTemplate.metadataobj spec.statefulStorage.volumeClaimTemplate.specfn withAccessModes(accessModes)fn withAccessModesMixin(accessModes)fn withStorageClassName(storageClassName)fn withVolumeAttributesClassName(volumeAttributesClassName)fn withVolumeMode(volumeMode)fn withVolumeName(volumeName)obj spec.statefulStorage.volumeClaimTemplate.spec.dataSourceobj spec.statefulStorage.volumeClaimTemplate.spec.dataSourceRefobj spec.statefulStorage.volumeClaimTemplate.spec.resourcesobj spec.statefulStorage.volumeClaimTemplate.spec.selector
obj spec.staticScrapeNamespaceSelectorobj spec.staticScrapeRelabelTemplatefn withAction(action)fn withIf(If)fn withLabels(labels)fn withLabelsMixin(labels)fn withMatch(match)fn withModulus(modulus)fn withRegex(regex)fn withReplacement(replacement)fn withSeparator(separator)fn withSourceLabels(sourceLabels)fn withSourceLabelsMixin(sourceLabels)fn withSource_labels(source_labels)fn withSource_labelsMixin(source_labels)fn withTargetLabel(targetLabel)fn withTarget_label(target_label)
obj spec.staticScrapeSelectorobj spec.streamAggrConfigfn withDedupInterval(dedupInterval)fn withDropInput(dropInput)fn withDropInputLabels(dropInputLabels)fn withDropInputLabelsMixin(dropInputLabels)fn withIgnoreFirstIntervals(ignoreFirstIntervals)fn withIgnoreOldSamples(ignoreOldSamples)fn withKeepInput(keepInput)fn withRules(rules)fn withRulesMixin(rules)obj spec.streamAggrConfig.configmapobj spec.streamAggrConfig.rulesfn withBy(by)fn withByMixin(by)fn withDedup_interval(dedup_interval)fn withDrop_input_labels(drop_input_labels)fn withDrop_input_labelsMixin(drop_input_labels)fn withFlush_on_shutdown(flush_on_shutdown)fn withIgnore_first_intervals(ignore_first_intervals)fn withIgnore_old_samples(ignore_old_samples)fn withInput_relabel_configs(input_relabel_configs)fn withInput_relabel_configsMixin(input_relabel_configs)fn withInterval(interval)fn withKeep_metric_names(keep_metric_names)fn withMatch(match)fn withNo_align_flush_to_interval(no_align_flush_to_interval)fn withOutput_relabel_configs(output_relabel_configs)fn withOutput_relabel_configsMixin(output_relabel_configs)fn withOutputs(outputs)fn withOutputsMixin(outputs)fn withStaleness_interval(staleness_interval)fn withWithout(without)fn withWithoutMixin(without)obj spec.streamAggrConfig.rules.input_relabel_configsfn withAction(action)fn withIf(If)fn withLabels(labels)fn withLabelsMixin(labels)fn withMatch(match)fn withModulus(modulus)fn withRegex(regex)fn withReplacement(replacement)fn withSeparator(separator)fn withSourceLabels(sourceLabels)fn withSourceLabelsMixin(sourceLabels)fn withSource_labels(source_labels)fn withSource_labelsMixin(source_labels)fn withTargetLabel(targetLabel)fn withTarget_label(target_label)
obj spec.streamAggrConfig.rules.output_relabel_configsfn withAction(action)fn withIf(If)fn withLabels(labels)fn withLabelsMixin(labels)fn withMatch(match)fn withModulus(modulus)fn withRegex(regex)fn withReplacement(replacement)fn withSeparator(separator)fn withSourceLabels(sourceLabels)fn withSourceLabelsMixin(sourceLabels)fn withSource_labels(source_labels)fn withSource_labelsMixin(source_labels)fn withTargetLabel(targetLabel)fn withTarget_label(target_label)
obj spec.tolerationsobj spec.volumeMounts
Fields
fn new
new(name)
new returns an instance of VMAgent
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
"VMAgentSpec defines the desired state of VMAgent"
fn spec.withAffinity
withAffinity(affinity)
"Affinity If specified, the pod's scheduling constraints."
fn spec.withAffinityMixin
withAffinityMixin(affinity)
"Affinity If specified, the pod's scheduling constraints."
Note: This function appends passed data to existing values
fn spec.withClaimTemplates
withClaimTemplates(claimTemplates)
"ClaimTemplates allows adding additional VolumeClaimTemplates for VMAgent in StatefulMode"
fn spec.withClaimTemplatesMixin
withClaimTemplatesMixin(claimTemplates)
"ClaimTemplates allows adding additional VolumeClaimTemplates for VMAgent in StatefulMode"
Note: This function appends passed data to existing values
fn spec.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.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.withConfigReloaderExtraArgs
withConfigReloaderExtraArgs(configReloaderExtraArgs)
"ConfigReloaderExtraArgs that will be passed to VMAuths config-reloader container\nfor example resyncInterval: \"30s\
fn spec.withConfigReloaderExtraArgsMixin
withConfigReloaderExtraArgsMixin(configReloaderExtraArgs)
"ConfigReloaderExtraArgs that will be passed to VMAuths config-reloader container\nfor example resyncInterval: \"30s\
Note: This function appends passed data to existing values
fn spec.withConfigReloaderImageTag
withConfigReloaderImageTag(configReloaderImageTag)
"ConfigReloaderImageTag defines image:tag for config-reloader container"
fn spec.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.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.withDisableSelfServiceScrape
withDisableSelfServiceScrape(disableSelfServiceScrape)
"DisableSelfServiceScrape controls creation of VMServiceScrape by operator\nfor the application.\nHas priority over VM_DISABLESELFSERVICESCRAPECREATION operator env variable"
fn spec.withDnsPolicy
withDnsPolicy(dnsPolicy)
"DNSPolicy sets DNS policy for the pod"
fn spec.withEnforcedNamespaceLabel
withEnforcedNamespaceLabel(enforcedNamespaceLabel)
"EnforcedNamespaceLabel enforces adding a namespace label of origin for each alert\nand metric that is user created. The label value will always be the namespace of the object that is\nbeing created."
fn spec.withExternalLabels
withExternalLabels(externalLabels)
"ExternalLabels The labels to add to any time series scraped by vmagent.\nit doesn't affect metrics ingested directly by push API's"
fn spec.withExternalLabelsMixin
withExternalLabelsMixin(externalLabels)
"ExternalLabels The labels to add to any time series scraped by vmagent.\nit doesn't affect metrics ingested directly by push API's"
Note: This function appends passed data to existing values
fn spec.withExtraArgs
withExtraArgs(extraArgs)
"ExtraArgs that will be passed to the application container\nfor example remoteWrite.tmpDataPath: /tmp"
fn spec.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.withExtraEnvs
withExtraEnvs(extraEnvs)
"ExtraEnvs that will be passed to the application container"
fn spec.withExtraEnvsMixin
withExtraEnvsMixin(extraEnvs)
"ExtraEnvs that will be passed to the application container"
Note: This function appends passed data to existing values
fn spec.withHostAliases
withHostAliases(hostAliases)
"HostAliases provides mapping for ip and hostname,\nthat would be propagated to pod,\ncannot be used with HostNetwork."
fn spec.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.withHostNetwork
withHostNetwork(hostNetwork)
"HostNetwork controls whether the pod may use the node network namespace"
fn spec.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.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.withIgnoreNamespaceSelectors
withIgnoreNamespaceSelectors(ignoreNamespaceSelectors)
"IgnoreNamespaceSelectors if set to true will ignore NamespaceSelector settings from\nscrape objects, and they will only discover endpoints\nwithin their current namespace. Defaults to false."
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.withIngestOnlyMode
withIngestOnlyMode(ingestOnlyMode)
"IngestOnlyMode switches vmagent into unmanaged mode\nit disables any config generation for scraping\nCurrently it prevents vmagent from managing tls and auth options for remote write"
fn spec.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.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.withInlineRelabelConfig
withInlineRelabelConfig(inlineRelabelConfig)
"InlineRelabelConfig - defines GlobalRelabelConfig for vmagent, can be defined directly at CRD."
fn spec.withInlineRelabelConfigMixin
withInlineRelabelConfigMixin(inlineRelabelConfig)
"InlineRelabelConfig - defines GlobalRelabelConfig for vmagent, can be defined directly at CRD."
Note: This function appends passed data to existing values
fn spec.withInlineScrapeConfig
withInlineScrapeConfig(inlineScrapeConfig)
"InlineScrapeConfig As scrape configs are appended, the user is responsible to make sure it\nis valid. Note that using this feature may expose the possibility to\nbreak upgrades of VMAgent. It is advised to review VMAgent release\nnotes to ensure that no incompatible scrape configs are going to break\nVMAgent after the upgrade.\nit should be defined as single yaml file.\ninlineScrapeConfig: |\n - job_name: \"prometheus\"\n static_configs:\n - targets: [\"localhost:9090\"]"
fn spec.withLivenessProbe
withLivenessProbe(livenessProbe)
"LivenessProbe that will be added CRD pod"
fn spec.withLivenessProbeMixin
withLivenessProbeMixin(livenessProbe)
"LivenessProbe that will be added CRD pod"
Note: This function appends passed data to existing values
fn spec.withLogFormat
withLogFormat(logFormat)
"LogFormat for VMAgent to be configured with."
fn spec.withLogLevel
withLogLevel(logLevel)
"LogLevel for VMAgent to be configured with.\nINFO, WARN, ERROR, FATAL, PANIC"
fn spec.withMaxScrapeInterval
withMaxScrapeInterval(maxScrapeInterval)
"MaxScrapeInterval allows limiting maximum scrape interval for VMServiceScrape, VMPodScrape and other scrapes\nIf interval is higher than defined limit, maxScrapeInterval will be used."
fn spec.withMinReadySeconds
withMinReadySeconds(minReadySeconds)
"MinReadySeconds defines a minim number os seconds to wait before starting update next pod\nif previous in healthy state\nHas no effect for VLogs and VMSingle"
fn spec.withMinScrapeInterval
withMinScrapeInterval(minScrapeInterval)
"MinScrapeInterval allows limiting minimal scrape interval for VMServiceScrape, VMPodScrape and other scrapes\nIf interval is lower than defined limit, minScrapeInterval will be used."
fn spec.withNodeScrapeRelabelTemplate
withNodeScrapeRelabelTemplate(nodeScrapeRelabelTemplate)
"NodeScrapeRelabelTemplate defines relabel config, that will be added to each VMNodeScrape.\nit's useful for adding specific labels to all targets"
fn spec.withNodeScrapeRelabelTemplateMixin
withNodeScrapeRelabelTemplateMixin(nodeScrapeRelabelTemplate)
"NodeScrapeRelabelTemplate defines relabel config, that will be added to each VMNodeScrape.\nit's useful for adding specific labels to all targets"
Note: This function appends passed data to existing values
fn spec.withNodeSelector
withNodeSelector(nodeSelector)
"NodeSelector Define which Nodes the Pods are scheduled on."
fn spec.withNodeSelectorMixin
withNodeSelectorMixin(nodeSelector)
"NodeSelector Define which Nodes the Pods are scheduled on."
Note: This function appends passed data to existing values
fn spec.withOverrideHonorLabels
withOverrideHonorLabels(overrideHonorLabels)
"OverrideHonorLabels if set to true overrides all user configured honor_labels.\nIf HonorLabels is set in scrape objects to true, this overrides honor_labels to false."
fn spec.withOverrideHonorTimestamps
withOverrideHonorTimestamps(overrideHonorTimestamps)
"OverrideHonorTimestamps allows to globally enforce honoring timestamps in all scrape configs."
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.withPodScrapeRelabelTemplate
withPodScrapeRelabelTemplate(podScrapeRelabelTemplate)
"PodScrapeRelabelTemplate defines relabel config, that will be added to each VMPodScrape.\nit's useful for adding specific labels to all targets"
fn spec.withPodScrapeRelabelTemplateMixin
withPodScrapeRelabelTemplateMixin(podScrapeRelabelTemplate)
"PodScrapeRelabelTemplate defines relabel config, that will be added to each VMPodScrape.\nit's useful for adding specific labels to all targets"
Note: This function appends passed data to existing values
fn spec.withPort
withPort(port)
"Port listen address"
fn spec.withPriorityClassName
withPriorityClassName(priorityClassName)
"PriorityClassName class assigned to the Pods"
fn spec.withProbeScrapeRelabelTemplate
withProbeScrapeRelabelTemplate(probeScrapeRelabelTemplate)
"ProbeScrapeRelabelTemplate defines relabel config, that will be added to each VMProbeScrape.\nit's useful for adding specific labels to all targets"
fn spec.withProbeScrapeRelabelTemplateMixin
withProbeScrapeRelabelTemplateMixin(probeScrapeRelabelTemplate)
"ProbeScrapeRelabelTemplate defines relabel config, that will be added to each VMProbeScrape.\nit's useful for adding specific labels to all targets"
Note: This function appends passed data to existing values
fn spec.withReadinessGates
withReadinessGates(readinessGates)
"ReadinessGates defines pod readiness gates"
fn spec.withReadinessGatesMixin
withReadinessGatesMixin(readinessGates)
"ReadinessGates defines pod readiness gates"
Note: This function appends passed data to existing values
fn spec.withReadinessProbe
withReadinessProbe(readinessProbe)
"ReadinessProbe that will be added CRD pod"
fn spec.withReadinessProbeMixin
withReadinessProbeMixin(readinessProbe)
"ReadinessProbe that will be added CRD pod"
Note: This function appends passed data to existing values
fn spec.withRemoteWrite
withRemoteWrite(remoteWrite)
"RemoteWrite list of victoria metrics /some other remote write system\nfor vm it must looks like: http://victoria-metrics-single:8429/api/v1/write\nor for cluster different url\nhttps://github.com/VictoriaMetrics/VictoriaMetrics/tree/master/app/vmagent#splitting-data-streams-among-multiple-systems"
fn spec.withRemoteWriteMixin
withRemoteWriteMixin(remoteWrite)
"RemoteWrite list of victoria metrics /some other remote write system\nfor vm it must looks like: http://victoria-metrics-single:8429/api/v1/write\nor for cluster different url\nhttps://github.com/VictoriaMetrics/VictoriaMetrics/tree/master/app/vmagent#splitting-data-streams-among-multiple-systems"
Note: This function appends passed data to existing values
fn spec.withReplicaCount
withReplicaCount(replicaCount)
"ReplicaCount is the expected size of the Application."
fn spec.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.withRuntimeClassName
withRuntimeClassName(runtimeClassName)
"RuntimeClassName - defines runtime class for kubernetes pod.\nhttps://kubernetes.io/docs/concepts/containers/runtime-class/"
fn spec.withSchedulerName
withSchedulerName(schedulerName)
"SchedulerName - defines kubernetes scheduler name"
fn spec.withScrapeConfigRelabelTemplate
withScrapeConfigRelabelTemplate(scrapeConfigRelabelTemplate)
"ScrapeConfigRelabelTemplate defines relabel config, that will be added to each VMScrapeConfig.\nit's useful for adding specific labels to all targets"
fn spec.withScrapeConfigRelabelTemplateMixin
withScrapeConfigRelabelTemplateMixin(scrapeConfigRelabelTemplate)
"ScrapeConfigRelabelTemplate defines relabel config, that will be added to each VMScrapeConfig.\nit's useful for adding specific labels to all targets"
Note: This function appends passed data to existing values
fn spec.withScrapeInterval
withScrapeInterval(scrapeInterval)
"ScrapeInterval defines how often scrape targets by default"
fn spec.withScrapeTimeout
withScrapeTimeout(scrapeTimeout)
"ScrapeTimeout defines global timeout for targets scrape"
fn spec.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.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.withSecurityContext
withSecurityContext(securityContext)
"SecurityContext holds pod-level security attributes and common container settings.\nThis defaults to the default PodSecurityContext."
fn spec.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.withSelectAllByDefault
withSelectAllByDefault(selectAllByDefault)
"SelectAllByDefault changes default behavior for empty CRD selectors, such ServiceScrapeSelector.\nwith selectAllByDefault: true and empty serviceScrapeSelector and ServiceScrapeNamespaceSelector\nOperator selects all exist serviceScrapes\nwith selectAllByDefault: false - selects nothing"
fn spec.withServiceAccountName
withServiceAccountName(serviceAccountName)
"ServiceAccountName is the name of the ServiceAccount to use to run the pods"
fn spec.withServiceScrapeRelabelTemplate
withServiceScrapeRelabelTemplate(serviceScrapeRelabelTemplate)
"ServiceScrapeRelabelTemplate defines relabel config, that will be added to each VMServiceScrape.\nit's useful for adding specific labels to all targets"
fn spec.withServiceScrapeRelabelTemplateMixin
withServiceScrapeRelabelTemplateMixin(serviceScrapeRelabelTemplate)
"ServiceScrapeRelabelTemplate defines relabel config, that will be added to each VMServiceScrape.\nit's useful for adding specific labels to all targets"
Note: This function appends passed data to existing values
fn spec.withServiceScrapeSpec
withServiceScrapeSpec(serviceScrapeSpec)
"ServiceScrapeSpec that will be added to vmagent VMServiceScrape spec"
fn spec.withServiceScrapeSpecMixin
withServiceScrapeSpecMixin(serviceScrapeSpec)
"ServiceScrapeSpec that will be added to vmagent VMServiceScrape spec"
Note: This function appends passed data to existing values
fn spec.withShardCount
withShardCount(shardCount)
"ShardCount - numbers of shards of VMAgent\nin this case operator will use 1 deployment/sts per shard with\nreplicas count according to spec.replicas,\nsee here"
fn spec.withStartupProbe
withStartupProbe(startupProbe)
"StartupProbe that will be added to CRD pod"
fn spec.withStartupProbeMixin
withStartupProbeMixin(startupProbe)
"StartupProbe that will be added to CRD pod"
Note: This function appends passed data to existing values
fn spec.withStatefulMode
withStatefulMode(statefulMode)
"StatefulMode enables StatefulSet for VMAgent instead of Deployment\nit allows using persistent storage for vmagent's persistentQueue"
fn spec.withStatefulRollingUpdateStrategy
withStatefulRollingUpdateStrategy(statefulRollingUpdateStrategy)
"StatefulRollingUpdateStrategy allows configuration for strategyType\nset it to RollingUpdate for disabling operator statefulSet rollingUpdate"
fn spec.withStaticScrapeRelabelTemplate
withStaticScrapeRelabelTemplate(staticScrapeRelabelTemplate)
"StaticScrapeRelabelTemplate defines relabel config, that will be added to each VMStaticScrape.\nit's useful for adding specific labels to all targets"
fn spec.withStaticScrapeRelabelTemplateMixin
withStaticScrapeRelabelTemplateMixin(staticScrapeRelabelTemplate)
"StaticScrapeRelabelTemplate defines relabel config, that will be added to each VMStaticScrape.\nit's useful for adding specific labels to all targets"
Note: This function appends passed data to existing values
fn spec.withTerminationGracePeriodSeconds
withTerminationGracePeriodSeconds(terminationGracePeriodSeconds)
"TerminationGracePeriodSeconds period for container graceful termination"
fn spec.withTolerations
withTolerations(tolerations)
"Tolerations If specified, the pod's tolerations."
fn spec.withTolerationsMixin
withTolerationsMixin(tolerations)
"Tolerations If specified, the pod's tolerations."
Note: This function appends passed data to existing values
fn spec.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.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.withUpdateStrategy
withUpdateStrategy(updateStrategy)
"UpdateStrategy - overrides default update strategy.\nworks only for deployments, statefulset always use OnDelete."
fn spec.withUseDefaultResources
withUseDefaultResources(useDefaultResources)
"UseDefaultResources controls resource settings\nBy default, operator sets built-in resource requirements"
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"
fn spec.withUseVMConfigReloader
withUseVMConfigReloader(useVMConfigReloader)
"UseVMConfigReloader replaces prometheus-like config-reloader\nwith vm one. It uses secrets watch instead of file watch\nwhich greatly increases speed of config updates"
fn spec.withVmAgentExternalLabelName
withVmAgentExternalLabelName(vmAgentExternalLabelName)
"VMAgentExternalLabelName Name of vmAgent external label used to denote vmAgent instance\nname. Defaults to the value of prometheus. External label will\n_not_ be added when value is set to empty string (\"\")."
fn spec.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.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.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.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.aPIServerConfig
"APIServerConfig allows specifying a host and auth methods to access apiserver.\nIf left empty, VMAgent is assumed to run inside of the cluster\nand will discover API servers automatically and use the pod's CA certificate\nand bearer token file at /var/run/secrets/kubernetes.io/serviceaccount/."
fn spec.aPIServerConfig.withBearerToken
withBearerToken(bearerToken)
"Bearer token for accessing apiserver."
fn spec.aPIServerConfig.withBearerTokenFile
withBearerTokenFile(bearerTokenFile)
"File to read bearer token for accessing apiserver."
fn spec.aPIServerConfig.withHost
withHost(host)
"Host of apiserver.\nA valid string consisting of a hostname or IP followed by an optional port number"
obj spec.aPIServerConfig.authorization
"Authorization configures generic authorization params"
fn spec.aPIServerConfig.authorization.withCredentialsFile
withCredentialsFile(credentialsFile)
"File with value for authorization"
fn spec.aPIServerConfig.authorization.withType
withType(type)
"Type of authorization, default to bearer"
obj spec.aPIServerConfig.authorization.credentials
"Reference to the secret with value for authorization"
fn spec.aPIServerConfig.authorization.credentials.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.aPIServerConfig.authorization.credentials.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.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop kubebuilder:default when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896."
fn spec.aPIServerConfig.authorization.credentials.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.aPIServerConfig.basicAuth
"BasicAuth allow an endpoint to authenticate over basic authentication"
fn spec.aPIServerConfig.basicAuth.withPassword_file
withPassword_file(password_file)
"PasswordFile defines path to password file at disk\nmust be pre-mounted"
obj spec.aPIServerConfig.basicAuth.password
"Password defines reference for secret with password value\nThe secret needs to be in the same namespace as scrape object"
fn spec.aPIServerConfig.basicAuth.password.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.aPIServerConfig.basicAuth.password.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.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop kubebuilder:default when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896."
fn spec.aPIServerConfig.basicAuth.password.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.aPIServerConfig.basicAuth.username
"Username defines reference for secret with username value\nThe secret needs to be in the same namespace as scrape object"
fn spec.aPIServerConfig.basicAuth.username.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.aPIServerConfig.basicAuth.username.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.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop kubebuilder:default when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896."
fn spec.aPIServerConfig.basicAuth.username.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.aPIServerConfig.tlsConfig
"TLSConfig Config to use for accessing apiserver."
fn spec.aPIServerConfig.tlsConfig.withCaFile
withCaFile(caFile)
"Path to the CA cert in the container to use for the targets."
fn spec.aPIServerConfig.tlsConfig.withCertFile
withCertFile(certFile)
"Path to the client cert file in the container for the targets."
fn spec.aPIServerConfig.tlsConfig.withInsecureSkipVerify
withInsecureSkipVerify(insecureSkipVerify)
"Disable target certificate validation."
fn spec.aPIServerConfig.tlsConfig.withKeyFile
withKeyFile(keyFile)
"Path to the client key file in the container for the targets."
fn spec.aPIServerConfig.tlsConfig.withServerName
withServerName(serverName)
"Used to verify the hostname for the targets."
obj spec.aPIServerConfig.tlsConfig.ca
"Stuct containing the CA cert to use for the targets."
obj spec.aPIServerConfig.tlsConfig.ca.configMap
"ConfigMap containing data to use for the targets."
fn spec.aPIServerConfig.tlsConfig.ca.configMap.withKey
withKey(key)
"The key to select."
fn spec.aPIServerConfig.tlsConfig.ca.configMap.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.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop kubebuilder:default when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896."
fn spec.aPIServerConfig.tlsConfig.ca.configMap.withOptional
withOptional(optional)
"Specify whether the ConfigMap or its key must be defined"
obj spec.aPIServerConfig.tlsConfig.ca.secret
"Secret containing data to use for the targets."
fn spec.aPIServerConfig.tlsConfig.ca.secret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.aPIServerConfig.tlsConfig.ca.secret.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.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop kubebuilder:default when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896."
fn spec.aPIServerConfig.tlsConfig.ca.secret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.aPIServerConfig.tlsConfig.cert
"Struct containing the client cert file for the targets."
obj spec.aPIServerConfig.tlsConfig.cert.configMap
"ConfigMap containing data to use for the targets."
fn spec.aPIServerConfig.tlsConfig.cert.configMap.withKey
withKey(key)
"The key to select."
fn spec.aPIServerConfig.tlsConfig.cert.configMap.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.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop kubebuilder:default when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896."
fn spec.aPIServerConfig.tlsConfig.cert.configMap.withOptional
withOptional(optional)
"Specify whether the ConfigMap or its key must be defined"
obj spec.aPIServerConfig.tlsConfig.cert.secret
"Secret containing data to use for the targets."
fn spec.aPIServerConfig.tlsConfig.cert.secret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.aPIServerConfig.tlsConfig.cert.secret.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.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop kubebuilder:default when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896."
fn spec.aPIServerConfig.tlsConfig.cert.secret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.aPIServerConfig.tlsConfig.keySecret
"Secret containing the client key file for the targets."
fn spec.aPIServerConfig.tlsConfig.keySecret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.aPIServerConfig.tlsConfig.keySecret.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.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop kubebuilder:default when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896."
fn spec.aPIServerConfig.tlsConfig.keySecret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.additionalScrapeConfigs
"AdditionalScrapeConfigs As scrape configs are appended, the user is responsible to make sure it\nis valid. Note that using this feature may expose the possibility to\nbreak upgrades of VMAgent. It is advised to review VMAgent release\nnotes to ensure that no incompatible scrape configs are going to break\nVMAgent after the upgrade."
fn spec.additionalScrapeConfigs.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.additionalScrapeConfigs.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.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop kubebuilder:default when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896."
fn spec.additionalScrapeConfigs.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.arbitraryFSAccessThroughSMs
"ArbitraryFSAccessThroughSMs configures whether configuration\nbased on EndpointAuth can access arbitrary files on the file system\nof the VMAgent container e.g. bearer token files, basic auth, tls certs"
fn spec.arbitraryFSAccessThroughSMs.withDeny
withDeny(deny)
obj spec.claimTemplates
"ClaimTemplates allows adding additional VolumeClaimTemplates for VMAgent in StatefulMode"
fn spec.claimTemplates.withApiVersion
withApiVersion(apiVersion)
"APIVersion defines the versioned schema of this representation of an object.\nServers should convert recognized schemas to the latest internal value, and\nmay reject unrecognized values.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources"
fn spec.claimTemplates.withKind
withKind(kind)
"Kind is a string value representing the REST resource this object represents.\nServers may infer this from the endpoint the client submits requests to.\nCannot be updated.\nIn CamelCase.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds"
fn spec.claimTemplates.withMetadata
withMetadata(metadata)
"Standard object's metadata.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata"
fn spec.claimTemplates.withMetadataMixin
withMetadataMixin(metadata)
"Standard object's metadata.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata"
Note: This function appends passed data to existing values
obj spec.claimTemplates.spec
"spec defines the desired characteristics of a volume requested by a pod author.\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims"
fn spec.claimTemplates.spec.withAccessModes
withAccessModes(accessModes)
"accessModes contains the desired access modes the volume should have.\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1"
fn spec.claimTemplates.spec.withAccessModesMixin
withAccessModesMixin(accessModes)
"accessModes contains the desired access modes the volume should have.\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1"
Note: This function appends passed data to existing values
fn spec.claimTemplates.spec.withStorageClassName
withStorageClassName(storageClassName)
"storageClassName is the name of the StorageClass required by the claim.\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1"
fn spec.claimTemplates.spec.withVolumeAttributesClassName
withVolumeAttributesClassName(volumeAttributesClassName)
"volumeAttributesClassName may be used to set the VolumeAttributesClass used by this claim.\nIf specified, the CSI driver will create or update the volume with the attributes defined\nin the corresponding VolumeAttributesClass. This has a different purpose than storageClassName,\nit can be changed after the claim is created. An empty string value means that no VolumeAttributesClass\nwill be applied to the claim but it's not allowed to reset this field to empty string once it is set.\nIf unspecified and the PersistentVolumeClaim is unbound, the default VolumeAttributesClass\nwill be set by the persistentvolume controller if it exists.\nIf the resource referred to by volumeAttributesClass does not exist, this PersistentVolumeClaim will be\nset to a Pending state, as reflected by the modifyVolumeStatus field, until such as a resource\nexists.\nMore info: https://kubernetes.io/docs/concepts/storage/volume-attributes-classes/\n(Alpha) Using this field requires the VolumeAttributesClass feature gate to be enabled."
fn spec.claimTemplates.spec.withVolumeMode
withVolumeMode(volumeMode)
"volumeMode defines what type of volume is required by the claim.\nValue of Filesystem is implied when not included in claim spec."
fn spec.claimTemplates.spec.withVolumeName
withVolumeName(volumeName)
"volumeName is the binding reference to the PersistentVolume backing this claim."
obj spec.claimTemplates.spec.dataSource
"dataSource field can be used to specify either:\n An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot)\n An existing PVC (PersistentVolumeClaim)\nIf the provisioner or an external controller can support the specified data source,\nit will create a new volume based on the contents of the specified data source.\nWhen the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef,\nand dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified.\nIf the namespace is specified, then dataSourceRef will not be copied to dataSource."
fn spec.claimTemplates.spec.dataSource.withApiGroup
withApiGroup(apiGroup)
"APIGroup is the group for the resource being referenced.\nIf APIGroup is not specified, the specified Kind must be in the core API group.\nFor any other third-party types, APIGroup is required."
fn spec.claimTemplates.spec.dataSource.withKind
withKind(kind)
"Kind is the type of resource being referenced"
fn spec.claimTemplates.spec.dataSource.withName
withName(name)
"Name is the name of resource being referenced"
obj spec.claimTemplates.spec.dataSourceRef
"dataSourceRef specifies the object from which to populate the volume with data, if a non-empty\nvolume is desired. This may be any object from a non-empty API group (non\ncore object) or a PersistentVolumeClaim object.\nWhen this field is specified, volume binding will only succeed if the type of\nthe specified object matches some installed volume populator or dynamic\nprovisioner.\nThis field will replace the functionality of the dataSource field and as such\nif both fields are non-empty, they must have the same value. For backwards\ncompatibility, when namespace isn't specified in dataSourceRef,\nboth fields (dataSource and dataSourceRef) will be set to the same\nvalue automatically if one of them is empty and the other is non-empty.\nWhen namespace is specified in dataSourceRef,\ndataSource isn't set to the same value and must be empty.\nThere are three important differences between dataSource and dataSourceRef:\n While dataSource only allows two specific types of objects, dataSourceRef\n allows any non-core object, as well as PersistentVolumeClaim objects.\n While dataSource ignores disallowed values (dropping them), dataSourceRef\n preserves all values, and generates an error if a disallowed value is\n specified.\n* While dataSource only allows local objects, dataSourceRef allows objects\n in any namespaces.\n(Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled.\n(Alpha) Using the namespace field of dataSourceRef requires the CrossNamespaceVolumeDataSource feature gate to be enabled."
fn spec.claimTemplates.spec.dataSourceRef.withApiGroup
withApiGroup(apiGroup)
"APIGroup is the group for the resource being referenced.\nIf APIGroup is not specified, the specified Kind must be in the core API group.\nFor any other third-party types, APIGroup is required."
fn spec.claimTemplates.spec.dataSourceRef.withKind
withKind(kind)
"Kind is the type of resource being referenced"
fn spec.claimTemplates.spec.dataSourceRef.withName
withName(name)
"Name is the name of resource being referenced"
fn spec.claimTemplates.spec.dataSourceRef.withNamespace
withNamespace(namespace)
"Namespace is the namespace of resource being referenced\nNote that when a namespace is specified, a gateway.networking.k8s.io/ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details.\n(Alpha) This field requires the CrossNamespaceVolumeDataSource feature gate to be enabled."
obj spec.claimTemplates.spec.resources
"resources represents the minimum resources the volume should have.\nIf RecoverVolumeExpansionFailure feature is enabled users are allowed to specify resource requirements\nthat are lower than previous value but must still be higher than capacity recorded in the\nstatus field of the claim.\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources"
fn spec.claimTemplates.spec.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.claimTemplates.spec.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.claimTemplates.spec.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.claimTemplates.spec.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.claimTemplates.spec.selector
"selector is a label query over volumes to consider for binding."
fn spec.claimTemplates.spec.selector.withMatchExpressions
withMatchExpressions(matchExpressions)
"matchExpressions is a list of label selector requirements. The requirements are ANDed."
fn spec.claimTemplates.spec.selector.withMatchExpressionsMixin
withMatchExpressionsMixin(matchExpressions)
"matchExpressions is a list of label selector requirements. The requirements are ANDed."
Note: This function appends passed data to existing values
fn spec.claimTemplates.spec.selector.withMatchLabels
withMatchLabels(matchLabels)
"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed."
fn spec.claimTemplates.spec.selector.withMatchLabelsMixin
withMatchLabelsMixin(matchLabels)
"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed."
Note: This function appends passed data to existing values
obj spec.claimTemplates.spec.selector.matchExpressions
"matchExpressions is a list of label selector requirements. The requirements are ANDed."
fn spec.claimTemplates.spec.selector.matchExpressions.withKey
withKey(key)
"key is the label key that the selector applies to."
fn spec.claimTemplates.spec.selector.matchExpressions.withOperator
withOperator(operator)
"operator represents a key's relationship to a set of values.\nValid operators are In, NotIn, Exists and DoesNotExist."
fn spec.claimTemplates.spec.selector.matchExpressions.withValues
withValues(values)
"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch."
fn spec.claimTemplates.spec.selector.matchExpressions.withValuesMixin
withValuesMixin(values)
"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch."
Note: This function appends passed data to existing values
obj spec.configReloaderResources
"ConfigReloaderResources config-reloader 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.configReloaderResources.withClaims
withClaims(claims)
"Claims lists the names of resources, defined in spec.resourceClaims,\nthat are used by this container.\n\n\nThis is an alpha field and requires enabling the\nDynamicResourceAllocation feature gate.\n\n\nThis field is immutable. It can only be set for containers."
fn spec.configReloaderResources.withClaimsMixin
withClaimsMixin(claims)
"Claims lists the names of resources, defined in spec.resourceClaims,\nthat are used by this container.\n\n\nThis is an alpha field and requires enabling the\nDynamicResourceAllocation feature gate.\n\n\nThis field is immutable. It can only be set for containers."
Note: This function appends passed data to existing values
fn spec.configReloaderResources.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.configReloaderResources.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.configReloaderResources.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.configReloaderResources.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.configReloaderResources.claims
"Claims lists the names of resources, defined in spec.resourceClaims,\nthat are used by this container.\n\n\nThis is an alpha field and requires enabling the\nDynamicResourceAllocation feature gate.\n\n\nThis field is immutable. It can only be set for containers."
fn spec.configReloaderResources.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."
obj spec.dnsConfig
"Specifies the DNS parameters of a pod.\nParameters specified here will be merged to the generated DNS\nconfiguration based on DNSPolicy."
fn spec.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.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.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.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.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.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.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.dnsConfig.options.withName
withName(name)
"Required."
fn spec.dnsConfig.options.withValue
withValue(value)
obj spec.extraEnvs
"ExtraEnvs that will be passed to the application container"
fn spec.extraEnvs.withName
withName(name)
"Name of the environment variable. Must be a C_IDENTIFIER."
fn spec.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.hostAliases
"HostAliases provides mapping for ip and hostname,\nthat would be propagated to pod,\ncannot be used with HostNetwork."
fn spec.hostAliases.withHostnames
withHostnames(hostnames)
"Hostnames for the above IP address."
fn spec.hostAliases.withHostnamesMixin
withHostnamesMixin(hostnames)
"Hostnames for the above IP address."
Note: This function appends passed data to existing values
fn spec.hostAliases.withIp
withIp(ip)
"IP address of the host file entry."
obj spec.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.host_aliases.withHostnames
withHostnames(hostnames)
"Hostnames for the above IP address."
fn spec.host_aliases.withHostnamesMixin
withHostnamesMixin(hostnames)
"Hostnames for the above IP address."
Note: This function appends passed data to existing values
fn spec.host_aliases.withIp
withIp(ip)
"IP address of the host file entry."
obj spec.image
"Image - docker image settings\nif no specified operator uses default version from operator config"
fn spec.image.withPullPolicy
withPullPolicy(pullPolicy)
"PullPolicy describes how to pull docker image"
fn spec.image.withRepository
withRepository(repository)
"Repository contains name of docker image + it's repository if needed"
fn spec.image.withTag
withTag(tag)
"Tag contains desired docker image version"
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.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop kubebuilder:default when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896."
obj spec.inlineRelabelConfig
"InlineRelabelConfig - defines GlobalRelabelConfig for vmagent, can be defined directly at CRD."
fn spec.inlineRelabelConfig.withAction
withAction(action)
"Action to perform based on regex matching. Default is 'replace'"
fn spec.inlineRelabelConfig.withIf
withIf(If)
"If represents metricsQL match expression (or list of expressions): '{name=~\"foo_.*\"}'"
fn spec.inlineRelabelConfig.withLabels
withLabels(labels)
"Labels is used together with Match for action: graphite"
fn spec.inlineRelabelConfig.withLabelsMixin
withLabelsMixin(labels)
"Labels is used together with Match for action: graphite"
Note: This function appends passed data to existing values
fn spec.inlineRelabelConfig.withMatch
withMatch(match)
"Match is used together with Labels for action: graphite"
fn spec.inlineRelabelConfig.withModulus
withModulus(modulus)
"Modulus to take of the hash of the source label values."
fn spec.inlineRelabelConfig.withRegex
withRegex(regex)
"Regular expression against which the extracted value is matched. Default is '(.*)'\nvictoriaMetrics supports multiline regex joined with |\nhttps://docs.victoriametrics.com/vmagent/#relabeling-enhancements"
fn spec.inlineRelabelConfig.withReplacement
withReplacement(replacement)
"Replacement value against which a regex replace is performed if the\nregular expression matches. Regex capture groups are available. Default is '$1'"
fn spec.inlineRelabelConfig.withSeparator
withSeparator(separator)
"Separator placed between concatenated source label values. default is ';'."
fn spec.inlineRelabelConfig.withSourceLabels
withSourceLabels(sourceLabels)
"The source labels select values from existing labels. Their content is concatenated\nusing the configured separator and matched against the configured regular expression\nfor the replace, keep, and drop actions."
fn spec.inlineRelabelConfig.withSourceLabelsMixin
withSourceLabelsMixin(sourceLabels)
"The source labels select values from existing labels. Their content is concatenated\nusing the configured separator and matched against the configured regular expression\nfor the replace, keep, and drop actions."
Note: This function appends passed data to existing values
fn spec.inlineRelabelConfig.withSource_labels
withSource_labels(source_labels)
"UnderScoreSourceLabels - additional form of source labels source_labels\nfor compatibility with original relabel config.\nif set both sourceLabels and source_labels, sourceLabels has priority.\nfor details https://github.com/VictoriaMetrics/operator/issues/131"
fn spec.inlineRelabelConfig.withSource_labelsMixin
withSource_labelsMixin(source_labels)
"UnderScoreSourceLabels - additional form of source labels source_labels\nfor compatibility with original relabel config.\nif set both sourceLabels and source_labels, sourceLabels has priority.\nfor details https://github.com/VictoriaMetrics/operator/issues/131"
Note: This function appends passed data to existing values
fn spec.inlineRelabelConfig.withTargetLabel
withTargetLabel(targetLabel)
"Label to which the resulting value is written in a replace action.\nIt is mandatory for replace actions. Regex capture groups are available."
fn spec.inlineRelabelConfig.withTarget_label
withTarget_label(target_label)
"UnderScoreTargetLabel - additional form of target label - target_label\nfor compatibility with original relabel config.\nif set both targetLabel and target_label, targetLabel has priority.\nfor details https://github.com/VictoriaMetrics/operator/issues/131"
obj spec.insertPorts
"InsertPorts - additional listen ports for data ingestion."
fn spec.insertPorts.withGraphitePort
withGraphitePort(graphitePort)
"GraphitePort listen port"
fn spec.insertPorts.withInfluxPort
withInfluxPort(influxPort)
"InfluxPort listen port"
fn spec.insertPorts.withOpenTSDBHTTPPort
withOpenTSDBHTTPPort(openTSDBHTTPPort)
"OpenTSDBHTTPPort for http connections."
fn spec.insertPorts.withOpenTSDBPort
withOpenTSDBPort(openTSDBPort)
"OpenTSDBPort for tcp and udp listen"
obj spec.license
"License allows to configure license key to be used for enterprise features.\nUsing license key is supported starting from VictoriaMetrics v1.94.0.\nSee here"
fn spec.license.withKey
withKey(key)
"Enterprise license key. This flag is available only in VictoriaMetrics enterprise.\nTo request a trial license, go to"
obj spec.license.keyRef
"KeyRef is reference to secret with license key for enterprise features."
fn spec.license.keyRef.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.license.keyRef.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.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop kubebuilder:default when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896."
fn spec.license.keyRef.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.nodeScrapeNamespaceSelector
"NodeScrapeNamespaceSelector defines Namespaces to be selected for VMNodeScrape discovery.\nWorks in combination with Selector.\nNamespaceSelector nil - only objects at VMAgent namespace.\nSelector nil - only objects at NamespaceSelector namespaces.\nIf both nil - behaviour controlled by selectAllByDefault"
fn spec.nodeScrapeNamespaceSelector.withMatchExpressions
withMatchExpressions(matchExpressions)
"matchExpressions is a list of label selector requirements. The requirements are ANDed."
fn spec.nodeScrapeNamespaceSelector.withMatchExpressionsMixin
withMatchExpressionsMixin(matchExpressions)
"matchExpressions is a list of label selector requirements. The requirements are ANDed."
Note: This function appends passed data to existing values
fn spec.nodeScrapeNamespaceSelector.withMatchLabels
withMatchLabels(matchLabels)
"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed."
fn spec.nodeScrapeNamespaceSelector.withMatchLabelsMixin
withMatchLabelsMixin(matchLabels)
"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed."
Note: This function appends passed data to existing values
obj spec.nodeScrapeNamespaceSelector.matchExpressions
"matchExpressions is a list of label selector requirements. The requirements are ANDed."
fn spec.nodeScrapeNamespaceSelector.matchExpressions.withKey
withKey(key)
"key is the label key that the selector applies to."
fn spec.nodeScrapeNamespaceSelector.matchExpressions.withOperator
withOperator(operator)
"operator represents a key's relationship to a set of values.\nValid operators are In, NotIn, Exists and DoesNotExist."
fn spec.nodeScrapeNamespaceSelector.matchExpressions.withValues
withValues(values)
"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch."
fn spec.nodeScrapeNamespaceSelector.matchExpressions.withValuesMixin
withValuesMixin(values)
"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch."
Note: This function appends passed data to existing values
obj spec.nodeScrapeRelabelTemplate
"NodeScrapeRelabelTemplate defines relabel config, that will be added to each VMNodeScrape.\nit's useful for adding specific labels to all targets"
fn spec.nodeScrapeRelabelTemplate.withAction
withAction(action)
"Action to perform based on regex matching. Default is 'replace'"
fn spec.nodeScrapeRelabelTemplate.withIf
withIf(If)
"If represents metricsQL match expression (or list of expressions): '{name=~\"foo_.*\"}'"
fn spec.nodeScrapeRelabelTemplate.withLabels
withLabels(labels)
"Labels is used together with Match for action: graphite"
fn spec.nodeScrapeRelabelTemplate.withLabelsMixin
withLabelsMixin(labels)
"Labels is used together with Match for action: graphite"
Note: This function appends passed data to existing values
fn spec.nodeScrapeRelabelTemplate.withMatch
withMatch(match)
"Match is used together with Labels for action: graphite"
fn spec.nodeScrapeRelabelTemplate.withModulus
withModulus(modulus)
"Modulus to take of the hash of the source label values."
fn spec.nodeScrapeRelabelTemplate.withRegex
withRegex(regex)
"Regular expression against which the extracted value is matched. Default is '(.*)'\nvictoriaMetrics supports multiline regex joined with |\nhttps://docs.victoriametrics.com/vmagent/#relabeling-enhancements"
fn spec.nodeScrapeRelabelTemplate.withReplacement
withReplacement(replacement)
"Replacement value against which a regex replace is performed if the\nregular expression matches. Regex capture groups are available. Default is '$1'"
fn spec.nodeScrapeRelabelTemplate.withSeparator
withSeparator(separator)
"Separator placed between concatenated source label values. default is ';'."
fn spec.nodeScrapeRelabelTemplate.withSourceLabels
withSourceLabels(sourceLabels)
"The source labels select values from existing labels. Their content is concatenated\nusing the configured separator and matched against the configured regular expression\nfor the replace, keep, and drop actions."
fn spec.nodeScrapeRelabelTemplate.withSourceLabelsMixin
withSourceLabelsMixin(sourceLabels)
"The source labels select values from existing labels. Their content is concatenated\nusing the configured separator and matched against the configured regular expression\nfor the replace, keep, and drop actions."
Note: This function appends passed data to existing values
fn spec.nodeScrapeRelabelTemplate.withSource_labels
withSource_labels(source_labels)
"UnderScoreSourceLabels - additional form of source labels source_labels\nfor compatibility with original relabel config.\nif set both sourceLabels and source_labels, sourceLabels has priority.\nfor details https://github.com/VictoriaMetrics/operator/issues/131"
fn spec.nodeScrapeRelabelTemplate.withSource_labelsMixin
withSource_labelsMixin(source_labels)
"UnderScoreSourceLabels - additional form of source labels source_labels\nfor compatibility with original relabel config.\nif set both sourceLabels and source_labels, sourceLabels has priority.\nfor details https://github.com/VictoriaMetrics/operator/issues/131"
Note: This function appends passed data to existing values
fn spec.nodeScrapeRelabelTemplate.withTargetLabel
withTargetLabel(targetLabel)
"Label to which the resulting value is written in a replace action.\nIt is mandatory for replace actions. Regex capture groups are available."
fn spec.nodeScrapeRelabelTemplate.withTarget_label
withTarget_label(target_label)
"UnderScoreTargetLabel - additional form of target label - target_label\nfor compatibility with original relabel config.\nif set both targetLabel and target_label, targetLabel has priority.\nfor details https://github.com/VictoriaMetrics/operator/issues/131"
obj spec.nodeScrapeSelector
"NodeScrapeSelector defines VMNodeScrape to be selected for scraping.\nWorks in combination with NamespaceSelector.\nNamespaceSelector nil - only objects at VMAgent namespace.\nSelector nil - only objects at NamespaceSelector namespaces.\nIf both nil - behaviour controlled by selectAllByDefault"
fn spec.nodeScrapeSelector.withMatchExpressions
withMatchExpressions(matchExpressions)
"matchExpressions is a list of label selector requirements. The requirements are ANDed."
fn spec.nodeScrapeSelector.withMatchExpressionsMixin
withMatchExpressionsMixin(matchExpressions)
"matchExpressions is a list of label selector requirements. The requirements are ANDed."
Note: This function appends passed data to existing values
fn spec.nodeScrapeSelector.withMatchLabels
withMatchLabels(matchLabels)
"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed."
fn spec.nodeScrapeSelector.withMatchLabelsMixin
withMatchLabelsMixin(matchLabels)
"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed."
Note: This function appends passed data to existing values
obj spec.nodeScrapeSelector.matchExpressions
"matchExpressions is a list of label selector requirements. The requirements are ANDed."
fn spec.nodeScrapeSelector.matchExpressions.withKey
withKey(key)
"key is the label key that the selector applies to."
fn spec.nodeScrapeSelector.matchExpressions.withOperator
withOperator(operator)
"operator represents a key's relationship to a set of values.\nValid operators are In, NotIn, Exists and DoesNotExist."
fn spec.nodeScrapeSelector.matchExpressions.withValues
withValues(values)
"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch."
fn spec.nodeScrapeSelector.matchExpressions.withValuesMixin
withValuesMixin(values)
"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch."
Note: This function appends passed data to existing values
obj spec.podDisruptionBudget
"PodDisruptionBudget created by operator"
fn spec.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.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.podDisruptionBudget.withSelectorLabels
withSelectorLabels(selectorLabels)
"replaces default labels selector generated by operator\nit's useful when you need to create custom budget"
fn spec.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.podMetadata
"PodMetadata configures Labels and Annotations which are propagated to the vmagent pods."
fn spec.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.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.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.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.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.podScrapeNamespaceSelector
"PodScrapeNamespaceSelector defines Namespaces to be selected for VMPodScrape discovery.\nWorks in combination with Selector.\nNamespaceSelector nil - only objects at VMAgent namespace.\nSelector nil - only objects at NamespaceSelector namespaces.\nIf both nil - behaviour controlled by selectAllByDefault"
fn spec.podScrapeNamespaceSelector.withMatchExpressions
withMatchExpressions(matchExpressions)
"matchExpressions is a list of label selector requirements. The requirements are ANDed."
fn spec.podScrapeNamespaceSelector.withMatchExpressionsMixin
withMatchExpressionsMixin(matchExpressions)
"matchExpressions is a list of label selector requirements. The requirements are ANDed."
Note: This function appends passed data to existing values
fn spec.podScrapeNamespaceSelector.withMatchLabels
withMatchLabels(matchLabels)
"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed."
fn spec.podScrapeNamespaceSelector.withMatchLabelsMixin
withMatchLabelsMixin(matchLabels)
"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed."
Note: This function appends passed data to existing values
obj spec.podScrapeNamespaceSelector.matchExpressions
"matchExpressions is a list of label selector requirements. The requirements are ANDed."
fn spec.podScrapeNamespaceSelector.matchExpressions.withKey
withKey(key)
"key is the label key that the selector applies to."
fn spec.podScrapeNamespaceSelector.matchExpressions.withOperator
withOperator(operator)
"operator represents a key's relationship to a set of values.\nValid operators are In, NotIn, Exists and DoesNotExist."
fn spec.podScrapeNamespaceSelector.matchExpressions.withValues
withValues(values)
"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch."
fn spec.podScrapeNamespaceSelector.matchExpressions.withValuesMixin
withValuesMixin(values)
"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch."
Note: This function appends passed data to existing values
obj spec.podScrapeRelabelTemplate
"PodScrapeRelabelTemplate defines relabel config, that will be added to each VMPodScrape.\nit's useful for adding specific labels to all targets"
fn spec.podScrapeRelabelTemplate.withAction
withAction(action)
"Action to perform based on regex matching. Default is 'replace'"
fn spec.podScrapeRelabelTemplate.withIf
withIf(If)
"If represents metricsQL match expression (or list of expressions): '{name=~\"foo_.*\"}'"
fn spec.podScrapeRelabelTemplate.withLabels
withLabels(labels)
"Labels is used together with Match for action: graphite"
fn spec.podScrapeRelabelTemplate.withLabelsMixin
withLabelsMixin(labels)
"Labels is used together with Match for action: graphite"
Note: This function appends passed data to existing values
fn spec.podScrapeRelabelTemplate.withMatch
withMatch(match)
"Match is used together with Labels for action: graphite"
fn spec.podScrapeRelabelTemplate.withModulus
withModulus(modulus)
"Modulus to take of the hash of the source label values."
fn spec.podScrapeRelabelTemplate.withRegex
withRegex(regex)
"Regular expression against which the extracted value is matched. Default is '(.*)'\nvictoriaMetrics supports multiline regex joined with |\nhttps://docs.victoriametrics.com/vmagent/#relabeling-enhancements"
fn spec.podScrapeRelabelTemplate.withReplacement
withReplacement(replacement)
"Replacement value against which a regex replace is performed if the\nregular expression matches. Regex capture groups are available. Default is '$1'"
fn spec.podScrapeRelabelTemplate.withSeparator
withSeparator(separator)
"Separator placed between concatenated source label values. default is ';'."
fn spec.podScrapeRelabelTemplate.withSourceLabels
withSourceLabels(sourceLabels)
"The source labels select values from existing labels. Their content is concatenated\nusing the configured separator and matched against the configured regular expression\nfor the replace, keep, and drop actions."
fn spec.podScrapeRelabelTemplate.withSourceLabelsMixin
withSourceLabelsMixin(sourceLabels)
"The source labels select values from existing labels. Their content is concatenated\nusing the configured separator and matched against the configured regular expression\nfor the replace, keep, and drop actions."
Note: This function appends passed data to existing values
fn spec.podScrapeRelabelTemplate.withSource_labels
withSource_labels(source_labels)
"UnderScoreSourceLabels - additional form of source labels source_labels\nfor compatibility with original relabel config.\nif set both sourceLabels and source_labels, sourceLabels has priority.\nfor details https://github.com/VictoriaMetrics/operator/issues/131"
fn spec.podScrapeRelabelTemplate.withSource_labelsMixin
withSource_labelsMixin(source_labels)
"UnderScoreSourceLabels - additional form of source labels source_labels\nfor compatibility with original relabel config.\nif set both sourceLabels and source_labels, sourceLabels has priority.\nfor details https://github.com/VictoriaMetrics/operator/issues/131"
Note: This function appends passed data to existing values
fn spec.podScrapeRelabelTemplate.withTargetLabel
withTargetLabel(targetLabel)
"Label to which the resulting value is written in a replace action.\nIt is mandatory for replace actions. Regex capture groups are available."
fn spec.podScrapeRelabelTemplate.withTarget_label
withTarget_label(target_label)
"UnderScoreTargetLabel - additional form of target label - target_label\nfor compatibility with original relabel config.\nif set both targetLabel and target_label, targetLabel has priority.\nfor details https://github.com/VictoriaMetrics/operator/issues/131"
obj spec.podScrapeSelector
"PodScrapeSelector defines PodScrapes to be selected for target discovery.\nWorks in combination with NamespaceSelector.\nNamespaceSelector nil - only objects at VMAgent namespace.\nSelector nil - only objects at NamespaceSelector namespaces.\nIf both nil - behaviour controlled by selectAllByDefault"
fn spec.podScrapeSelector.withMatchExpressions
withMatchExpressions(matchExpressions)
"matchExpressions is a list of label selector requirements. The requirements are ANDed."
fn spec.podScrapeSelector.withMatchExpressionsMixin
withMatchExpressionsMixin(matchExpressions)
"matchExpressions is a list of label selector requirements. The requirements are ANDed."
Note: This function appends passed data to existing values
fn spec.podScrapeSelector.withMatchLabels
withMatchLabels(matchLabels)
"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed."
fn spec.podScrapeSelector.withMatchLabelsMixin
withMatchLabelsMixin(matchLabels)
"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed."
Note: This function appends passed data to existing values
obj spec.podScrapeSelector.matchExpressions
"matchExpressions is a list of label selector requirements. The requirements are ANDed."
fn spec.podScrapeSelector.matchExpressions.withKey
withKey(key)
"key is the label key that the selector applies to."
fn spec.podScrapeSelector.matchExpressions.withOperator
withOperator(operator)
"operator represents a key's relationship to a set of values.\nValid operators are In, NotIn, Exists and DoesNotExist."
fn spec.podScrapeSelector.matchExpressions.withValues
withValues(values)
"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch."
fn spec.podScrapeSelector.matchExpressions.withValuesMixin
withValuesMixin(values)
"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch."
Note: This function appends passed data to existing values
obj spec.probeNamespaceSelector
"ProbeNamespaceSelector defines Namespaces to be selected for VMProbe discovery.\nWorks in combination with Selector.\nNamespaceSelector nil - only objects at VMAgent namespace.\nSelector nil - only objects at NamespaceSelector namespaces.\nIf both nil - behaviour controlled by selectAllByDefault"
fn spec.probeNamespaceSelector.withMatchExpressions
withMatchExpressions(matchExpressions)
"matchExpressions is a list of label selector requirements. The requirements are ANDed."
fn spec.probeNamespaceSelector.withMatchExpressionsMixin
withMatchExpressionsMixin(matchExpressions)
"matchExpressions is a list of label selector requirements. The requirements are ANDed."
Note: This function appends passed data to existing values
fn spec.probeNamespaceSelector.withMatchLabels
withMatchLabels(matchLabels)
"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed."
fn spec.probeNamespaceSelector.withMatchLabelsMixin
withMatchLabelsMixin(matchLabels)
"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed."
Note: This function appends passed data to existing values
obj spec.probeNamespaceSelector.matchExpressions
"matchExpressions is a list of label selector requirements. The requirements are ANDed."
fn spec.probeNamespaceSelector.matchExpressions.withKey
withKey(key)
"key is the label key that the selector applies to."
fn spec.probeNamespaceSelector.matchExpressions.withOperator
withOperator(operator)
"operator represents a key's relationship to a set of values.\nValid operators are In, NotIn, Exists and DoesNotExist."
fn spec.probeNamespaceSelector.matchExpressions.withValues
withValues(values)
"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch."
fn spec.probeNamespaceSelector.matchExpressions.withValuesMixin
withValuesMixin(values)
"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch."
Note: This function appends passed data to existing values
obj spec.probeScrapeRelabelTemplate
"ProbeScrapeRelabelTemplate defines relabel config, that will be added to each VMProbeScrape.\nit's useful for adding specific labels to all targets"
fn spec.probeScrapeRelabelTemplate.withAction
withAction(action)
"Action to perform based on regex matching. Default is 'replace'"
fn spec.probeScrapeRelabelTemplate.withIf
withIf(If)
"If represents metricsQL match expression (or list of expressions): '{name=~\"foo_.*\"}'"
fn spec.probeScrapeRelabelTemplate.withLabels
withLabels(labels)
"Labels is used together with Match for action: graphite"
fn spec.probeScrapeRelabelTemplate.withLabelsMixin
withLabelsMixin(labels)
"Labels is used together with Match for action: graphite"
Note: This function appends passed data to existing values
fn spec.probeScrapeRelabelTemplate.withMatch
withMatch(match)
"Match is used together with Labels for action: graphite"
fn spec.probeScrapeRelabelTemplate.withModulus
withModulus(modulus)
"Modulus to take of the hash of the source label values."
fn spec.probeScrapeRelabelTemplate.withRegex
withRegex(regex)
"Regular expression against which the extracted value is matched. Default is '(.*)'\nvictoriaMetrics supports multiline regex joined with |\nhttps://docs.victoriametrics.com/vmagent/#relabeling-enhancements"
fn spec.probeScrapeRelabelTemplate.withReplacement
withReplacement(replacement)
"Replacement value against which a regex replace is performed if the\nregular expression matches. Regex capture groups are available. Default is '$1'"
fn spec.probeScrapeRelabelTemplate.withSeparator
withSeparator(separator)
"Separator placed between concatenated source label values. default is ';'."
fn spec.probeScrapeRelabelTemplate.withSourceLabels
withSourceLabels(sourceLabels)
"The source labels select values from existing labels. Their content is concatenated\nusing the configured separator and matched against the configured regular expression\nfor the replace, keep, and drop actions."
fn spec.probeScrapeRelabelTemplate.withSourceLabelsMixin
withSourceLabelsMixin(sourceLabels)
"The source labels select values from existing labels. Their content is concatenated\nusing the configured separator and matched against the configured regular expression\nfor the replace, keep, and drop actions."
Note: This function appends passed data to existing values
fn spec.probeScrapeRelabelTemplate.withSource_labels
withSource_labels(source_labels)
"UnderScoreSourceLabels - additional form of source labels source_labels\nfor compatibility with original relabel config.\nif set both sourceLabels and source_labels, sourceLabels has priority.\nfor details https://github.com/VictoriaMetrics/operator/issues/131"
fn spec.probeScrapeRelabelTemplate.withSource_labelsMixin
withSource_labelsMixin(source_labels)
"UnderScoreSourceLabels - additional form of source labels source_labels\nfor compatibility with original relabel config.\nif set both sourceLabels and source_labels, sourceLabels has priority.\nfor details https://github.com/VictoriaMetrics/operator/issues/131"
Note: This function appends passed data to existing values
fn spec.probeScrapeRelabelTemplate.withTargetLabel
withTargetLabel(targetLabel)
"Label to which the resulting value is written in a replace action.\nIt is mandatory for replace actions. Regex capture groups are available."
fn spec.probeScrapeRelabelTemplate.withTarget_label
withTarget_label(target_label)
"UnderScoreTargetLabel - additional form of target label - target_label\nfor compatibility with original relabel config.\nif set both targetLabel and target_label, targetLabel has priority.\nfor details https://github.com/VictoriaMetrics/operator/issues/131"
obj spec.probeSelector
"ProbeSelector defines VMProbe to be selected for target probing.\nWorks in combination with NamespaceSelector.\nNamespaceSelector nil - only objects at VMAgent namespace.\nSelector nil - only objects at NamespaceSelector namespaces.\nIf both nil - behaviour controlled by selectAllByDefault"
fn spec.probeSelector.withMatchExpressions
withMatchExpressions(matchExpressions)
"matchExpressions is a list of label selector requirements. The requirements are ANDed."
fn spec.probeSelector.withMatchExpressionsMixin
withMatchExpressionsMixin(matchExpressions)
"matchExpressions is a list of label selector requirements. The requirements are ANDed."
Note: This function appends passed data to existing values
fn spec.probeSelector.withMatchLabels
withMatchLabels(matchLabels)
"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed."
fn spec.probeSelector.withMatchLabelsMixin
withMatchLabelsMixin(matchLabels)
"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed."
Note: This function appends passed data to existing values
obj spec.probeSelector.matchExpressions
"matchExpressions is a list of label selector requirements. The requirements are ANDed."
fn spec.probeSelector.matchExpressions.withKey
withKey(key)
"key is the label key that the selector applies to."
fn spec.probeSelector.matchExpressions.withOperator
withOperator(operator)
"operator represents a key's relationship to a set of values.\nValid operators are In, NotIn, Exists and DoesNotExist."
fn spec.probeSelector.matchExpressions.withValues
withValues(values)
"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch."
fn spec.probeSelector.matchExpressions.withValuesMixin
withValuesMixin(values)
"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch."
Note: This function appends passed data to existing values
obj spec.readinessGates
"ReadinessGates defines pod readiness gates"
fn spec.readinessGates.withConditionType
withConditionType(conditionType)
"ConditionType refers to a condition in the pod's condition list with matching type."
obj spec.relabelConfig
"RelabelConfig ConfigMap with global relabel config -remoteWrite.relabelConfig\nThis relabeling is applied to all the collected metrics before sending them to remote storage."
fn spec.relabelConfig.withKey
withKey(key)
"The key to select."
fn spec.relabelConfig.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.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop kubebuilder:default when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896."
fn spec.relabelConfig.withOptional
withOptional(optional)
"Specify whether the ConfigMap or its key must be defined"
obj spec.remoteWrite
"RemoteWrite list of victoria metrics /some other remote write system\nfor vm it must looks like: http://victoria-metrics-single:8429/api/v1/write\nor for cluster different url\nhttps://github.com/VictoriaMetrics/VictoriaMetrics/tree/master/app/vmagent#splitting-data-streams-among-multiple-systems"
fn spec.remoteWrite.withForceVMProto
withForceVMProto(forceVMProto)
"ForceVMProto forces using VictoriaMetrics protocol for sending data to -remoteWrite.url"
fn spec.remoteWrite.withHeaders
withHeaders(headers)
"Headers allow configuring custom http headers\nMust be in form of semicolon separated header with value\ne.g.\nheaderName: headerValue\nvmagent supports since 1.79.0 version"
fn spec.remoteWrite.withHeadersMixin
withHeadersMixin(headers)
"Headers allow configuring custom http headers\nMust be in form of semicolon separated header with value\ne.g.\nheaderName: headerValue\nvmagent supports since 1.79.0 version"
Note: This function appends passed data to existing values
fn spec.remoteWrite.withInlineUrlRelabelConfig
withInlineUrlRelabelConfig(inlineUrlRelabelConfig)
"InlineUrlRelabelConfig defines relabeling config for remoteWriteURL, it can be defined at crd spec."
fn spec.remoteWrite.withInlineUrlRelabelConfigMixin
withInlineUrlRelabelConfigMixin(inlineUrlRelabelConfig)
"InlineUrlRelabelConfig defines relabeling config for remoteWriteURL, it can be defined at crd spec."
Note: This function appends passed data to existing values
fn spec.remoteWrite.withMaxDiskUsage
withMaxDiskUsage(maxDiskUsage)
"MaxDiskUsage defines the maximum file-based buffer size in bytes for -remoteWrite.url"
fn spec.remoteWrite.withSendTimeout
withSendTimeout(sendTimeout)
"Timeout for sending a single block of data to -remoteWrite.url (default 1m0s)"
fn spec.remoteWrite.withUrl
withUrl(url)
"URL of the endpoint to send samples to."
obj spec.remoteWrite.basicAuth
"BasicAuth allow an endpoint to authenticate over basic authentication"
fn spec.remoteWrite.basicAuth.withPassword_file
withPassword_file(password_file)
"PasswordFile defines path to password file at disk\nmust be pre-mounted"
obj spec.remoteWrite.basicAuth.password
"Password defines reference for secret with password value\nThe secret needs to be in the same namespace as scrape object"
fn spec.remoteWrite.basicAuth.password.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.remoteWrite.basicAuth.password.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.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop kubebuilder:default when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896."
fn spec.remoteWrite.basicAuth.password.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.remoteWrite.basicAuth.username
"Username defines reference for secret with username value\nThe secret needs to be in the same namespace as scrape object"
fn spec.remoteWrite.basicAuth.username.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.remoteWrite.basicAuth.username.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.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop kubebuilder:default when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896."
fn spec.remoteWrite.basicAuth.username.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.remoteWrite.bearerTokenSecret
"Optional bearer auth token to use for -remoteWrite.url"
fn spec.remoteWrite.bearerTokenSecret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.remoteWrite.bearerTokenSecret.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.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop kubebuilder:default when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896."
fn spec.remoteWrite.bearerTokenSecret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.remoteWrite.inlineUrlRelabelConfig
"InlineUrlRelabelConfig defines relabeling config for remoteWriteURL, it can be defined at crd spec."
fn spec.remoteWrite.inlineUrlRelabelConfig.withAction
withAction(action)
"Action to perform based on regex matching. Default is 'replace'"
fn spec.remoteWrite.inlineUrlRelabelConfig.withIf
withIf(If)
"If represents metricsQL match expression (or list of expressions): '{name=~\"foo_.*\"}'"
fn spec.remoteWrite.inlineUrlRelabelConfig.withLabels
withLabels(labels)
"Labels is used together with Match for action: graphite"
fn spec.remoteWrite.inlineUrlRelabelConfig.withLabelsMixin
withLabelsMixin(labels)
"Labels is used together with Match for action: graphite"
Note: This function appends passed data to existing values
fn spec.remoteWrite.inlineUrlRelabelConfig.withMatch
withMatch(match)
"Match is used together with Labels for action: graphite"
fn spec.remoteWrite.inlineUrlRelabelConfig.withModulus
withModulus(modulus)
"Modulus to take of the hash of the source label values."
fn spec.remoteWrite.inlineUrlRelabelConfig.withRegex
withRegex(regex)
"Regular expression against which the extracted value is matched. Default is '(.*)'\nvictoriaMetrics supports multiline regex joined with |\nhttps://docs.victoriametrics.com/vmagent/#relabeling-enhancements"
fn spec.remoteWrite.inlineUrlRelabelConfig.withReplacement
withReplacement(replacement)
"Replacement value against which a regex replace is performed if the\nregular expression matches. Regex capture groups are available. Default is '$1'"
fn spec.remoteWrite.inlineUrlRelabelConfig.withSeparator
withSeparator(separator)
"Separator placed between concatenated source label values. default is ';'."
fn spec.remoteWrite.inlineUrlRelabelConfig.withSourceLabels
withSourceLabels(sourceLabels)
"The source labels select values from existing labels. Their content is concatenated\nusing the configured separator and matched against the configured regular expression\nfor the replace, keep, and drop actions."
fn spec.remoteWrite.inlineUrlRelabelConfig.withSourceLabelsMixin
withSourceLabelsMixin(sourceLabels)
"The source labels select values from existing labels. Their content is concatenated\nusing the configured separator and matched against the configured regular expression\nfor the replace, keep, and drop actions."
Note: This function appends passed data to existing values
fn spec.remoteWrite.inlineUrlRelabelConfig.withSource_labels
withSource_labels(source_labels)
"UnderScoreSourceLabels - additional form of source labels source_labels\nfor compatibility with original relabel config.\nif set both sourceLabels and source_labels, sourceLabels has priority.\nfor details https://github.com/VictoriaMetrics/operator/issues/131"
fn spec.remoteWrite.inlineUrlRelabelConfig.withSource_labelsMixin
withSource_labelsMixin(source_labels)
"UnderScoreSourceLabels - additional form of source labels source_labels\nfor compatibility with original relabel config.\nif set both sourceLabels and source_labels, sourceLabels has priority.\nfor details https://github.com/VictoriaMetrics/operator/issues/131"
Note: This function appends passed data to existing values
fn spec.remoteWrite.inlineUrlRelabelConfig.withTargetLabel
withTargetLabel(targetLabel)
"Label to which the resulting value is written in a replace action.\nIt is mandatory for replace actions. Regex capture groups are available."
fn spec.remoteWrite.inlineUrlRelabelConfig.withTarget_label
withTarget_label(target_label)
"UnderScoreTargetLabel - additional form of target label - target_label\nfor compatibility with original relabel config.\nif set both targetLabel and target_label, targetLabel has priority.\nfor details https://github.com/VictoriaMetrics/operator/issues/131"
obj spec.remoteWrite.oauth2
"OAuth2 defines auth configuration"
fn spec.remoteWrite.oauth2.withClient_secret_file
withClient_secret_file(client_secret_file)
"ClientSecretFile defines path for client secret file."
fn spec.remoteWrite.oauth2.withEndpoint_params
withEndpoint_params(endpoint_params)
"Parameters to append to the token URL"
fn spec.remoteWrite.oauth2.withEndpoint_paramsMixin
withEndpoint_paramsMixin(endpoint_params)
"Parameters to append to the token URL"
Note: This function appends passed data to existing values
fn spec.remoteWrite.oauth2.withScopes
withScopes(scopes)
"OAuth2 scopes used for the token request"
fn spec.remoteWrite.oauth2.withScopesMixin
withScopesMixin(scopes)
"OAuth2 scopes used for the token request"
Note: This function appends passed data to existing values
fn spec.remoteWrite.oauth2.withToken_url
withToken_url(token_url)
"The URL to fetch the token from"
obj spec.remoteWrite.oauth2.client_id
"The secret or configmap containing the OAuth2 client id"
obj spec.remoteWrite.oauth2.client_id.configMap
"ConfigMap containing data to use for the targets."
fn spec.remoteWrite.oauth2.client_id.configMap.withKey
withKey(key)
"The key to select."
fn spec.remoteWrite.oauth2.client_id.configMap.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.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop kubebuilder:default when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896."
fn spec.remoteWrite.oauth2.client_id.configMap.withOptional
withOptional(optional)
"Specify whether the ConfigMap or its key must be defined"
obj spec.remoteWrite.oauth2.client_id.secret
"Secret containing data to use for the targets."
fn spec.remoteWrite.oauth2.client_id.secret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.remoteWrite.oauth2.client_id.secret.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.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop kubebuilder:default when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896."
fn spec.remoteWrite.oauth2.client_id.secret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.remoteWrite.oauth2.client_secret
"The secret containing the OAuth2 client secret"
fn spec.remoteWrite.oauth2.client_secret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.remoteWrite.oauth2.client_secret.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.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop kubebuilder:default when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896."
fn spec.remoteWrite.oauth2.client_secret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.remoteWrite.streamAggrConfig
"StreamAggrConfig defines stream aggregation configuration for VMAgent for -remoteWrite.url"
fn spec.remoteWrite.streamAggrConfig.withDedupInterval
withDedupInterval(dedupInterval)
"Allows setting different de-duplication intervals per each configured remote storage"
fn spec.remoteWrite.streamAggrConfig.withDropInput
withDropInput(dropInput)
"Allow drop all the input samples after the aggregation"
fn spec.remoteWrite.streamAggrConfig.withDropInputLabels
withDropInputLabels(dropInputLabels)
"labels to drop from samples for aggregator before stream de-duplication and aggregation"
fn spec.remoteWrite.streamAggrConfig.withDropInputLabelsMixin
withDropInputLabelsMixin(dropInputLabels)
"labels to drop from samples for aggregator before stream de-duplication and aggregation"
Note: This function appends passed data to existing values
fn spec.remoteWrite.streamAggrConfig.withIgnoreFirstIntervals
withIgnoreFirstIntervals(ignoreFirstIntervals)
"IgnoreFirstIntervals instructs to ignore first interval"
fn spec.remoteWrite.streamAggrConfig.withIgnoreOldSamples
withIgnoreOldSamples(ignoreOldSamples)
"IgnoreOldSamples instructs to ignore samples with old timestamps outside the current aggregation interval."
fn spec.remoteWrite.streamAggrConfig.withKeepInput
withKeepInput(keepInput)
"Allows writing both raw and aggregate data"
fn spec.remoteWrite.streamAggrConfig.withRules
withRules(rules)
"Stream aggregation rules"
fn spec.remoteWrite.streamAggrConfig.withRulesMixin
withRulesMixin(rules)
"Stream aggregation rules"
Note: This function appends passed data to existing values
obj spec.remoteWrite.streamAggrConfig.configmap
"ConfigMap with stream aggregation rules"
fn spec.remoteWrite.streamAggrConfig.configmap.withKey
withKey(key)
"The key to select."
fn spec.remoteWrite.streamAggrConfig.configmap.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.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop kubebuilder:default when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896."
fn spec.remoteWrite.streamAggrConfig.configmap.withOptional
withOptional(optional)
"Specify whether the ConfigMap or its key must be defined"
obj spec.remoteWrite.streamAggrConfig.rules
"Stream aggregation rules"
fn spec.remoteWrite.streamAggrConfig.rules.withBy
withBy(by)
"By is an optional list of labels for grouping input series.\n\n\nSee also Without.\n\n\nIf neither By nor Without are set, then the Outputs are calculated\nindividually per each input time series."
fn spec.remoteWrite.streamAggrConfig.rules.withByMixin
withByMixin(by)
"By is an optional list of labels for grouping input series.\n\n\nSee also Without.\n\n\nIf neither By nor Without are set, then the Outputs are calculated\nindividually per each input time series."
Note: This function appends passed data to existing values
fn spec.remoteWrite.streamAggrConfig.rules.withDedup_interval
withDedup_interval(dedup_interval)
"DedupInterval is an optional interval for deduplication."
fn spec.remoteWrite.streamAggrConfig.rules.withDrop_input_labels
withDrop_input_labels(drop_input_labels)
"DropInputLabels is an optional list with labels, which must be dropped before further processing of input samples.\n\n\nLabels are dropped before de-duplication and aggregation."
fn spec.remoteWrite.streamAggrConfig.rules.withDrop_input_labelsMixin
withDrop_input_labelsMixin(drop_input_labels)
"DropInputLabels is an optional list with labels, which must be dropped before further processing of input samples.\n\n\nLabels are dropped before de-duplication and aggregation."
Note: This function appends passed data to existing values
fn spec.remoteWrite.streamAggrConfig.rules.withFlush_on_shutdown
withFlush_on_shutdown(flush_on_shutdown)
"FlushOnShutdown defines whether to flush the aggregation state on process termination\nor config reload. Is false by default.\nIt is not recommended changing this setting, unless unfinished aggregations states\nare preferred to missing data points."
fn spec.remoteWrite.streamAggrConfig.rules.withIgnore_first_intervals
withIgnore_first_intervals(ignore_first_intervals)
fn spec.remoteWrite.streamAggrConfig.rules.withIgnore_old_samples
withIgnore_old_samples(ignore_old_samples)
"IgnoreOldSamples instructs to ignore samples with old timestamps outside the current aggregation interval."
fn spec.remoteWrite.streamAggrConfig.rules.withInput_relabel_configs
withInput_relabel_configs(input_relabel_configs)
"InputRelabelConfigs is an optional relabeling rules, which are applied on the input\nbefore aggregation."
fn spec.remoteWrite.streamAggrConfig.rules.withInput_relabel_configsMixin
withInput_relabel_configsMixin(input_relabel_configs)
"InputRelabelConfigs is an optional relabeling rules, which are applied on the input\nbefore aggregation."
Note: This function appends passed data to existing values
fn spec.remoteWrite.streamAggrConfig.rules.withInterval
withInterval(interval)
"Interval is the interval between aggregations."
fn spec.remoteWrite.streamAggrConfig.rules.withKeep_metric_names
withKeep_metric_names(keep_metric_names)
"KeepMetricNames instructs to leave metric names as is for the output time series without adding any suffix."
fn spec.remoteWrite.streamAggrConfig.rules.withMatch
withMatch(match)
"Match is a label selector (or list of label selectors) for filtering time series for the given selector.\n\n\nIf the match isn't set, then all the input time series are processed."
fn spec.remoteWrite.streamAggrConfig.rules.withNo_align_flush_to_interval
withNo_align_flush_to_interval(no_align_flush_to_interval)
"NoAlignFlushToInterval disables aligning of flushes to multiples of Interval.\nBy default flushes are aligned to Interval."
fn spec.remoteWrite.streamAggrConfig.rules.withOutput_relabel_configs
withOutput_relabel_configs(output_relabel_configs)
"OutputRelabelConfigs is an optional relabeling rules, which are applied\non the aggregated output before being sent to remote storage."
fn spec.remoteWrite.streamAggrConfig.rules.withOutput_relabel_configsMixin
withOutput_relabel_configsMixin(output_relabel_configs)
"OutputRelabelConfigs is an optional relabeling rules, which are applied\non the aggregated output before being sent to remote storage."
Note: This function appends passed data to existing values
fn spec.remoteWrite.streamAggrConfig.rules.withOutputs
withOutputs(outputs)
"Outputs is a list of output aggregate functions to produce.\n\n\nThe following names are allowed:\n\n\n- total - aggregates input counters\n- increase - counts the increase over input counters\n- count_series - counts the input series\n- count_samples - counts the input samples\n- sum_samples - sums the input samples\n- last - the last biggest sample value\n- min - the minimum sample value\n- max - the maximum sample value\n- avg - the average value across all the samples\n- stddev - standard deviation across all the samples\n- stdvar - standard variance across all the samples\n- histogram_bucket - creates VictoriaMetrics histogram for input samples\n- quantiles(phi1, ..., phiN) - quantiles' estimation for phi in the range [0..1]\n\n\nThe output time series will have the following names:\n\n\n input_name:aggr_
fn spec.remoteWrite.streamAggrConfig.rules.withOutputsMixin
withOutputsMixin(outputs)
"Outputs is a list of output aggregate functions to produce.\n\n\nThe following names are allowed:\n\n\n- total - aggregates input counters\n- increase - counts the increase over input counters\n- count_series - counts the input series\n- count_samples - counts the input samples\n- sum_samples - sums the input samples\n- last - the last biggest sample value\n- min - the minimum sample value\n- max - the maximum sample value\n- avg - the average value across all the samples\n- stddev - standard deviation across all the samples\n- stdvar - standard variance across all the samples\n- histogram_bucket - creates VictoriaMetrics histogram for input samples\n- quantiles(phi1, ..., phiN) - quantiles' estimation for phi in the range [0..1]\n\n\nThe output time series will have the following names:\n\n\n input_name:aggr_
Note: This function appends passed data to existing values
fn spec.remoteWrite.streamAggrConfig.rules.withStaleness_interval
withStaleness_interval(staleness_interval)
"Staleness interval is interval after which the series state will be reset if no samples have been sent during it.\nThe parameter is only relevant for outputs: total, total_prometheus, increase, increase_prometheus and histogram_bucket."
fn spec.remoteWrite.streamAggrConfig.rules.withWithout
withWithout(without)
"Without is an optional list of labels, which must be excluded when grouping input series.\n\n\nSee also By.\n\n\nIf neither By nor Without are set, then the Outputs are calculated\nindividually per each input time series."
fn spec.remoteWrite.streamAggrConfig.rules.withWithoutMixin
withWithoutMixin(without)
"Without is an optional list of labels, which must be excluded when grouping input series.\n\n\nSee also By.\n\n\nIf neither By nor Without are set, then the Outputs are calculated\nindividually per each input time series."
Note: This function appends passed data to existing values
obj spec.remoteWrite.streamAggrConfig.rules.input_relabel_configs
"InputRelabelConfigs is an optional relabeling rules, which are applied on the input\nbefore aggregation."
fn spec.remoteWrite.streamAggrConfig.rules.input_relabel_configs.withAction
withAction(action)
"Action to perform based on regex matching. Default is 'replace'"
fn spec.remoteWrite.streamAggrConfig.rules.input_relabel_configs.withIf
withIf(If)
"If represents metricsQL match expression (or list of expressions): '{name=~\"foo_.*\"}'"
fn spec.remoteWrite.streamAggrConfig.rules.input_relabel_configs.withLabels
withLabels(labels)
"Labels is used together with Match for action: graphite"
fn spec.remoteWrite.streamAggrConfig.rules.input_relabel_configs.withLabelsMixin
withLabelsMixin(labels)
"Labels is used together with Match for action: graphite"
Note: This function appends passed data to existing values
fn spec.remoteWrite.streamAggrConfig.rules.input_relabel_configs.withMatch
withMatch(match)
"Match is used together with Labels for action: graphite"
fn spec.remoteWrite.streamAggrConfig.rules.input_relabel_configs.withModulus
withModulus(modulus)
"Modulus to take of the hash of the source label values."
fn spec.remoteWrite.streamAggrConfig.rules.input_relabel_configs.withRegex
withRegex(regex)
"Regular expression against which the extracted value is matched. Default is '(.*)'\nvictoriaMetrics supports multiline regex joined with |\nhttps://docs.victoriametrics.com/vmagent/#relabeling-enhancements"
fn spec.remoteWrite.streamAggrConfig.rules.input_relabel_configs.withReplacement
withReplacement(replacement)
"Replacement value against which a regex replace is performed if the\nregular expression matches. Regex capture groups are available. Default is '$1'"
fn spec.remoteWrite.streamAggrConfig.rules.input_relabel_configs.withSeparator
withSeparator(separator)
"Separator placed between concatenated source label values. default is ';'."
fn spec.remoteWrite.streamAggrConfig.rules.input_relabel_configs.withSourceLabels
withSourceLabels(sourceLabels)
"The source labels select values from existing labels. Their content is concatenated\nusing the configured separator and matched against the configured regular expression\nfor the replace, keep, and drop actions."
fn spec.remoteWrite.streamAggrConfig.rules.input_relabel_configs.withSourceLabelsMixin
withSourceLabelsMixin(sourceLabels)
"The source labels select values from existing labels. Their content is concatenated\nusing the configured separator and matched against the configured regular expression\nfor the replace, keep, and drop actions."
Note: This function appends passed data to existing values
fn spec.remoteWrite.streamAggrConfig.rules.input_relabel_configs.withSource_labels
withSource_labels(source_labels)
"UnderScoreSourceLabels - additional form of source labels source_labels\nfor compatibility with original relabel config.\nif set both sourceLabels and source_labels, sourceLabels has priority.\nfor details https://github.com/VictoriaMetrics/operator/issues/131"
fn spec.remoteWrite.streamAggrConfig.rules.input_relabel_configs.withSource_labelsMixin
withSource_labelsMixin(source_labels)
"UnderScoreSourceLabels - additional form of source labels source_labels\nfor compatibility with original relabel config.\nif set both sourceLabels and source_labels, sourceLabels has priority.\nfor details https://github.com/VictoriaMetrics/operator/issues/131"
Note: This function appends passed data to existing values
fn spec.remoteWrite.streamAggrConfig.rules.input_relabel_configs.withTargetLabel
withTargetLabel(targetLabel)
"Label to which the resulting value is written in a replace action.\nIt is mandatory for replace actions. Regex capture groups are available."
fn spec.remoteWrite.streamAggrConfig.rules.input_relabel_configs.withTarget_label
withTarget_label(target_label)
"UnderScoreTargetLabel - additional form of target label - target_label\nfor compatibility with original relabel config.\nif set both targetLabel and target_label, targetLabel has priority.\nfor details https://github.com/VictoriaMetrics/operator/issues/131"
obj spec.remoteWrite.streamAggrConfig.rules.output_relabel_configs
"OutputRelabelConfigs is an optional relabeling rules, which are applied\non the aggregated output before being sent to remote storage."
fn spec.remoteWrite.streamAggrConfig.rules.output_relabel_configs.withAction
withAction(action)
"Action to perform based on regex matching. Default is 'replace'"
fn spec.remoteWrite.streamAggrConfig.rules.output_relabel_configs.withIf
withIf(If)
"If represents metricsQL match expression (or list of expressions): '{name=~\"foo_.*\"}'"
fn spec.remoteWrite.streamAggrConfig.rules.output_relabel_configs.withLabels
withLabels(labels)
"Labels is used together with Match for action: graphite"
fn spec.remoteWrite.streamAggrConfig.rules.output_relabel_configs.withLabelsMixin
withLabelsMixin(labels)
"Labels is used together with Match for action: graphite"
Note: This function appends passed data to existing values
fn spec.remoteWrite.streamAggrConfig.rules.output_relabel_configs.withMatch
withMatch(match)
"Match is used together with Labels for action: graphite"
fn spec.remoteWrite.streamAggrConfig.rules.output_relabel_configs.withModulus
withModulus(modulus)
"Modulus to take of the hash of the source label values."
fn spec.remoteWrite.streamAggrConfig.rules.output_relabel_configs.withRegex
withRegex(regex)
"Regular expression against which the extracted value is matched. Default is '(.*)'\nvictoriaMetrics supports multiline regex joined with |\nhttps://docs.victoriametrics.com/vmagent/#relabeling-enhancements"
fn spec.remoteWrite.streamAggrConfig.rules.output_relabel_configs.withReplacement
withReplacement(replacement)
"Replacement value against which a regex replace is performed if the\nregular expression matches. Regex capture groups are available. Default is '$1'"
fn spec.remoteWrite.streamAggrConfig.rules.output_relabel_configs.withSeparator
withSeparator(separator)
"Separator placed between concatenated source label values. default is ';'."
fn spec.remoteWrite.streamAggrConfig.rules.output_relabel_configs.withSourceLabels
withSourceLabels(sourceLabels)
"The source labels select values from existing labels. Their content is concatenated\nusing the configured separator and matched against the configured regular expression\nfor the replace, keep, and drop actions."
fn spec.remoteWrite.streamAggrConfig.rules.output_relabel_configs.withSourceLabelsMixin
withSourceLabelsMixin(sourceLabels)
"The source labels select values from existing labels. Their content is concatenated\nusing the configured separator and matched against the configured regular expression\nfor the replace, keep, and drop actions."
Note: This function appends passed data to existing values
fn spec.remoteWrite.streamAggrConfig.rules.output_relabel_configs.withSource_labels
withSource_labels(source_labels)
"UnderScoreSourceLabels - additional form of source labels source_labels\nfor compatibility with original relabel config.\nif set both sourceLabels and source_labels, sourceLabels has priority.\nfor details https://github.com/VictoriaMetrics/operator/issues/131"
fn spec.remoteWrite.streamAggrConfig.rules.output_relabel_configs.withSource_labelsMixin
withSource_labelsMixin(source_labels)
"UnderScoreSourceLabels - additional form of source labels source_labels\nfor compatibility with original relabel config.\nif set both sourceLabels and source_labels, sourceLabels has priority.\nfor details https://github.com/VictoriaMetrics/operator/issues/131"
Note: This function appends passed data to existing values
fn spec.remoteWrite.streamAggrConfig.rules.output_relabel_configs.withTargetLabel
withTargetLabel(targetLabel)
"Label to which the resulting value is written in a replace action.\nIt is mandatory for replace actions. Regex capture groups are available."
fn spec.remoteWrite.streamAggrConfig.rules.output_relabel_configs.withTarget_label
withTarget_label(target_label)
"UnderScoreTargetLabel - additional form of target label - target_label\nfor compatibility with original relabel config.\nif set both targetLabel and target_label, targetLabel has priority.\nfor details https://github.com/VictoriaMetrics/operator/issues/131"
obj spec.remoteWrite.tlsConfig
"TLSConfig describes tls configuration for remote write target"
fn spec.remoteWrite.tlsConfig.withCaFile
withCaFile(caFile)
"Path to the CA cert in the container to use for the targets."
fn spec.remoteWrite.tlsConfig.withCertFile
withCertFile(certFile)
"Path to the client cert file in the container for the targets."
fn spec.remoteWrite.tlsConfig.withInsecureSkipVerify
withInsecureSkipVerify(insecureSkipVerify)
"Disable target certificate validation."
fn spec.remoteWrite.tlsConfig.withKeyFile
withKeyFile(keyFile)
"Path to the client key file in the container for the targets."
fn spec.remoteWrite.tlsConfig.withServerName
withServerName(serverName)
"Used to verify the hostname for the targets."
obj spec.remoteWrite.tlsConfig.ca
"Stuct containing the CA cert to use for the targets."
obj spec.remoteWrite.tlsConfig.ca.configMap
"ConfigMap containing data to use for the targets."
fn spec.remoteWrite.tlsConfig.ca.configMap.withKey
withKey(key)
"The key to select."
fn spec.remoteWrite.tlsConfig.ca.configMap.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.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop kubebuilder:default when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896."
fn spec.remoteWrite.tlsConfig.ca.configMap.withOptional
withOptional(optional)
"Specify whether the ConfigMap or its key must be defined"
obj spec.remoteWrite.tlsConfig.ca.secret
"Secret containing data to use for the targets."
fn spec.remoteWrite.tlsConfig.ca.secret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.remoteWrite.tlsConfig.ca.secret.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.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop kubebuilder:default when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896."
fn spec.remoteWrite.tlsConfig.ca.secret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.remoteWrite.tlsConfig.cert
"Struct containing the client cert file for the targets."
obj spec.remoteWrite.tlsConfig.cert.configMap
"ConfigMap containing data to use for the targets."
fn spec.remoteWrite.tlsConfig.cert.configMap.withKey
withKey(key)
"The key to select."
fn spec.remoteWrite.tlsConfig.cert.configMap.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.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop kubebuilder:default when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896."
fn spec.remoteWrite.tlsConfig.cert.configMap.withOptional
withOptional(optional)
"Specify whether the ConfigMap or its key must be defined"
obj spec.remoteWrite.tlsConfig.cert.secret
"Secret containing data to use for the targets."
fn spec.remoteWrite.tlsConfig.cert.secret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.remoteWrite.tlsConfig.cert.secret.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.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop kubebuilder:default when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896."
fn spec.remoteWrite.tlsConfig.cert.secret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.remoteWrite.tlsConfig.keySecret
"Secret containing the client key file for the targets."
fn spec.remoteWrite.tlsConfig.keySecret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.remoteWrite.tlsConfig.keySecret.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.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop kubebuilder:default when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896."
fn spec.remoteWrite.tlsConfig.keySecret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.remoteWrite.urlRelabelConfig
"ConfigMap with relabeling config which is applied to metrics before sending them to the corresponding -remoteWrite.url"
fn spec.remoteWrite.urlRelabelConfig.withKey
withKey(key)
"The key to select."
fn spec.remoteWrite.urlRelabelConfig.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.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop kubebuilder:default when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896."
fn spec.remoteWrite.urlRelabelConfig.withOptional
withOptional(optional)
"Specify whether the ConfigMap or its key must be defined"
obj spec.remoteWriteSettings
"RemoteWriteSettings defines global settings for all remoteWrite urls."
fn spec.remoteWriteSettings.withFlushInterval
withFlushInterval(flushInterval)
"Interval for flushing the data to remote storage. (default 1s)"
fn spec.remoteWriteSettings.withLabel
withLabel(label)
"Labels in the form 'name=value' to add to all the metrics before sending them. This overrides the label if it already exists."
fn spec.remoteWriteSettings.withLabelMixin
withLabelMixin(label)
"Labels in the form 'name=value' to add to all the metrics before sending them. This overrides the label if it already exists."
Note: This function appends passed data to existing values
fn spec.remoteWriteSettings.withMaxBlockSize
withMaxBlockSize(maxBlockSize)
"The maximum size in bytes of unpacked request to send to remote storage"
fn spec.remoteWriteSettings.withMaxDiskUsagePerURL
withMaxDiskUsagePerURL(maxDiskUsagePerURL)
"The maximum file-based buffer size in bytes at -remoteWrite.tmpDataPath"
fn spec.remoteWriteSettings.withQueues
withQueues(queues)
"The number of concurrent queues"
fn spec.remoteWriteSettings.withShowURL
withShowURL(showURL)
"Whether to show -remoteWrite.url in the exported metrics. It is hidden by default, since it can contain sensitive auth info"
fn spec.remoteWriteSettings.withTmpDataPath
withTmpDataPath(tmpDataPath)
"Path to directory where temporary data for remote write component is stored (default vmagent-remotewrite-data)"
fn spec.remoteWriteSettings.withUseMultiTenantMode
withUseMultiTenantMode(useMultiTenantMode)
"Configures vmagent accepting data via the same multitenant endpoints as vminsert at VictoriaMetrics cluster does,\nsee here.\nit's global setting and affects all remote storage configurations"
obj spec.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.resources.withClaims
withClaims(claims)
"Claims lists the names of resources, defined in spec.resourceClaims,\nthat are used by this container.\n\n\nThis is an alpha field and requires enabling the\nDynamicResourceAllocation feature gate.\n\n\nThis field is immutable. It can only be set for containers."
fn spec.resources.withClaimsMixin
withClaimsMixin(claims)
"Claims lists the names of resources, defined in spec.resourceClaims,\nthat are used by this container.\n\n\nThis is an alpha field and requires enabling the\nDynamicResourceAllocation feature gate.\n\n\nThis field is immutable. It can only be set for containers."
Note: This function appends passed data to existing values
fn spec.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.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.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.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.resources.claims
"Claims lists the names of resources, defined in spec.resourceClaims,\nthat are used by this container.\n\n\nThis is an alpha field and requires enabling the\nDynamicResourceAllocation feature gate.\n\n\nThis field is immutable. It can only be set for containers."
fn spec.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."
obj spec.rollingUpdate
"RollingUpdate - overrides deployment update params."
fn spec.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.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.scrapeConfigNamespaceSelector
"ScrapeConfigNamespaceSelector defines Namespaces to be selected for VMScrapeConfig discovery.\nWorks in combination with Selector.\nNamespaceSelector nil - only objects at VMAgent namespace.\nSelector nil - only objects at NamespaceSelector namespaces.\nIf both nil - behaviour controlled by selectAllByDefault"
fn spec.scrapeConfigNamespaceSelector.withMatchExpressions
withMatchExpressions(matchExpressions)
"matchExpressions is a list of label selector requirements. The requirements are ANDed."
fn spec.scrapeConfigNamespaceSelector.withMatchExpressionsMixin
withMatchExpressionsMixin(matchExpressions)
"matchExpressions is a list of label selector requirements. The requirements are ANDed."
Note: This function appends passed data to existing values
fn spec.scrapeConfigNamespaceSelector.withMatchLabels
withMatchLabels(matchLabels)
"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed."
fn spec.scrapeConfigNamespaceSelector.withMatchLabelsMixin
withMatchLabelsMixin(matchLabels)
"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed."
Note: This function appends passed data to existing values
obj spec.scrapeConfigNamespaceSelector.matchExpressions
"matchExpressions is a list of label selector requirements. The requirements are ANDed."
fn spec.scrapeConfigNamespaceSelector.matchExpressions.withKey
withKey(key)
"key is the label key that the selector applies to."
fn spec.scrapeConfigNamespaceSelector.matchExpressions.withOperator
withOperator(operator)
"operator represents a key's relationship to a set of values.\nValid operators are In, NotIn, Exists and DoesNotExist."
fn spec.scrapeConfigNamespaceSelector.matchExpressions.withValues
withValues(values)
"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch."
fn spec.scrapeConfigNamespaceSelector.matchExpressions.withValuesMixin
withValuesMixin(values)
"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch."
Note: This function appends passed data to existing values
obj spec.scrapeConfigRelabelTemplate
"ScrapeConfigRelabelTemplate defines relabel config, that will be added to each VMScrapeConfig.\nit's useful for adding specific labels to all targets"
fn spec.scrapeConfigRelabelTemplate.withAction
withAction(action)
"Action to perform based on regex matching. Default is 'replace'"
fn spec.scrapeConfigRelabelTemplate.withIf
withIf(If)
"If represents metricsQL match expression (or list of expressions): '{name=~\"foo_.*\"}'"
fn spec.scrapeConfigRelabelTemplate.withLabels
withLabels(labels)
"Labels is used together with Match for action: graphite"
fn spec.scrapeConfigRelabelTemplate.withLabelsMixin
withLabelsMixin(labels)
"Labels is used together with Match for action: graphite"
Note: This function appends passed data to existing values
fn spec.scrapeConfigRelabelTemplate.withMatch
withMatch(match)
"Match is used together with Labels for action: graphite"
fn spec.scrapeConfigRelabelTemplate.withModulus
withModulus(modulus)
"Modulus to take of the hash of the source label values."
fn spec.scrapeConfigRelabelTemplate.withRegex
withRegex(regex)
"Regular expression against which the extracted value is matched. Default is '(.*)'\nvictoriaMetrics supports multiline regex joined with |\nhttps://docs.victoriametrics.com/vmagent/#relabeling-enhancements"
fn spec.scrapeConfigRelabelTemplate.withReplacement
withReplacement(replacement)
"Replacement value against which a regex replace is performed if the\nregular expression matches. Regex capture groups are available. Default is '$1'"
fn spec.scrapeConfigRelabelTemplate.withSeparator
withSeparator(separator)
"Separator placed between concatenated source label values. default is ';'."
fn spec.scrapeConfigRelabelTemplate.withSourceLabels
withSourceLabels(sourceLabels)
"The source labels select values from existing labels. Their content is concatenated\nusing the configured separator and matched against the configured regular expression\nfor the replace, keep, and drop actions."
fn spec.scrapeConfigRelabelTemplate.withSourceLabelsMixin
withSourceLabelsMixin(sourceLabels)
"The source labels select values from existing labels. Their content is concatenated\nusing the configured separator and matched against the configured regular expression\nfor the replace, keep, and drop actions."
Note: This function appends passed data to existing values
fn spec.scrapeConfigRelabelTemplate.withSource_labels
withSource_labels(source_labels)
"UnderScoreSourceLabels - additional form of source labels source_labels\nfor compatibility with original relabel config.\nif set both sourceLabels and source_labels, sourceLabels has priority.\nfor details https://github.com/VictoriaMetrics/operator/issues/131"
fn spec.scrapeConfigRelabelTemplate.withSource_labelsMixin
withSource_labelsMixin(source_labels)
"UnderScoreSourceLabels - additional form of source labels source_labels\nfor compatibility with original relabel config.\nif set both sourceLabels and source_labels, sourceLabels has priority.\nfor details https://github.com/VictoriaMetrics/operator/issues/131"
Note: This function appends passed data to existing values
fn spec.scrapeConfigRelabelTemplate.withTargetLabel
withTargetLabel(targetLabel)
"Label to which the resulting value is written in a replace action.\nIt is mandatory for replace actions. Regex capture groups are available."
fn spec.scrapeConfigRelabelTemplate.withTarget_label
withTarget_label(target_label)
"UnderScoreTargetLabel - additional form of target label - target_label\nfor compatibility with original relabel config.\nif set both targetLabel and target_label, targetLabel has priority.\nfor details https://github.com/VictoriaMetrics/operator/issues/131"
obj spec.scrapeConfigSelector
"ScrapeConfigSelector defines VMScrapeConfig to be selected for target discovery.\nWorks in combination with NamespaceSelector."
fn spec.scrapeConfigSelector.withMatchExpressions
withMatchExpressions(matchExpressions)
"matchExpressions is a list of label selector requirements. The requirements are ANDed."
fn spec.scrapeConfigSelector.withMatchExpressionsMixin
withMatchExpressionsMixin(matchExpressions)
"matchExpressions is a list of label selector requirements. The requirements are ANDed."
Note: This function appends passed data to existing values
fn spec.scrapeConfigSelector.withMatchLabels
withMatchLabels(matchLabels)
"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed."
fn spec.scrapeConfigSelector.withMatchLabelsMixin
withMatchLabelsMixin(matchLabels)
"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed."
Note: This function appends passed data to existing values
obj spec.scrapeConfigSelector.matchExpressions
"matchExpressions is a list of label selector requirements. The requirements are ANDed."
fn spec.scrapeConfigSelector.matchExpressions.withKey
withKey(key)
"key is the label key that the selector applies to."
fn spec.scrapeConfigSelector.matchExpressions.withOperator
withOperator(operator)
"operator represents a key's relationship to a set of values.\nValid operators are In, NotIn, Exists and DoesNotExist."
fn spec.scrapeConfigSelector.matchExpressions.withValues
withValues(values)
"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch."
fn spec.scrapeConfigSelector.matchExpressions.withValuesMixin
withValuesMixin(values)
"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch."
Note: This function appends passed data to existing values
obj spec.serviceScrapeNamespaceSelector
"ServiceScrapeNamespaceSelector Namespaces to be selected for VMServiceScrape discovery.\nWorks in combination with Selector.\nNamespaceSelector nil - only objects at VMAgent namespace.\nSelector nil - only objects at NamespaceSelector namespaces.\nIf both nil - behaviour controlled by selectAllByDefault"
fn spec.serviceScrapeNamespaceSelector.withMatchExpressions
withMatchExpressions(matchExpressions)
"matchExpressions is a list of label selector requirements. The requirements are ANDed."
fn spec.serviceScrapeNamespaceSelector.withMatchExpressionsMixin
withMatchExpressionsMixin(matchExpressions)
"matchExpressions is a list of label selector requirements. The requirements are ANDed."
Note: This function appends passed data to existing values
fn spec.serviceScrapeNamespaceSelector.withMatchLabels
withMatchLabels(matchLabels)
"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed."
fn spec.serviceScrapeNamespaceSelector.withMatchLabelsMixin
withMatchLabelsMixin(matchLabels)
"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed."
Note: This function appends passed data to existing values
obj spec.serviceScrapeNamespaceSelector.matchExpressions
"matchExpressions is a list of label selector requirements. The requirements are ANDed."
fn spec.serviceScrapeNamespaceSelector.matchExpressions.withKey
withKey(key)
"key is the label key that the selector applies to."
fn spec.serviceScrapeNamespaceSelector.matchExpressions.withOperator
withOperator(operator)
"operator represents a key's relationship to a set of values.\nValid operators are In, NotIn, Exists and DoesNotExist."
fn spec.serviceScrapeNamespaceSelector.matchExpressions.withValues
withValues(values)
"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch."
fn spec.serviceScrapeNamespaceSelector.matchExpressions.withValuesMixin
withValuesMixin(values)
"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch."
Note: This function appends passed data to existing values
obj spec.serviceScrapeRelabelTemplate
"ServiceScrapeRelabelTemplate defines relabel config, that will be added to each VMServiceScrape.\nit's useful for adding specific labels to all targets"
fn spec.serviceScrapeRelabelTemplate.withAction
withAction(action)
"Action to perform based on regex matching. Default is 'replace'"
fn spec.serviceScrapeRelabelTemplate.withIf
withIf(If)
"If represents metricsQL match expression (or list of expressions): '{name=~\"foo_.*\"}'"
fn spec.serviceScrapeRelabelTemplate.withLabels
withLabels(labels)
"Labels is used together with Match for action: graphite"
fn spec.serviceScrapeRelabelTemplate.withLabelsMixin
withLabelsMixin(labels)
"Labels is used together with Match for action: graphite"
Note: This function appends passed data to existing values
fn spec.serviceScrapeRelabelTemplate.withMatch
withMatch(match)
"Match is used together with Labels for action: graphite"
fn spec.serviceScrapeRelabelTemplate.withModulus
withModulus(modulus)
"Modulus to take of the hash of the source label values."
fn spec.serviceScrapeRelabelTemplate.withRegex
withRegex(regex)
"Regular expression against which the extracted value is matched. Default is '(.*)'\nvictoriaMetrics supports multiline regex joined with |\nhttps://docs.victoriametrics.com/vmagent/#relabeling-enhancements"
fn spec.serviceScrapeRelabelTemplate.withReplacement
withReplacement(replacement)
"Replacement value against which a regex replace is performed if the\nregular expression matches. Regex capture groups are available. Default is '$1'"
fn spec.serviceScrapeRelabelTemplate.withSeparator
withSeparator(separator)
"Separator placed between concatenated source label values. default is ';'."
fn spec.serviceScrapeRelabelTemplate.withSourceLabels
withSourceLabels(sourceLabels)
"The source labels select values from existing labels. Their content is concatenated\nusing the configured separator and matched against the configured regular expression\nfor the replace, keep, and drop actions."
fn spec.serviceScrapeRelabelTemplate.withSourceLabelsMixin
withSourceLabelsMixin(sourceLabels)
"The source labels select values from existing labels. Their content is concatenated\nusing the configured separator and matched against the configured regular expression\nfor the replace, keep, and drop actions."
Note: This function appends passed data to existing values
fn spec.serviceScrapeRelabelTemplate.withSource_labels
withSource_labels(source_labels)
"UnderScoreSourceLabels - additional form of source labels source_labels\nfor compatibility with original relabel config.\nif set both sourceLabels and source_labels, sourceLabels has priority.\nfor details https://github.com/VictoriaMetrics/operator/issues/131"
fn spec.serviceScrapeRelabelTemplate.withSource_labelsMixin
withSource_labelsMixin(source_labels)
"UnderScoreSourceLabels - additional form of source labels source_labels\nfor compatibility with original relabel config.\nif set both sourceLabels and source_labels, sourceLabels has priority.\nfor details https://github.com/VictoriaMetrics/operator/issues/131"
Note: This function appends passed data to existing values
fn spec.serviceScrapeRelabelTemplate.withTargetLabel
withTargetLabel(targetLabel)
"Label to which the resulting value is written in a replace action.\nIt is mandatory for replace actions. Regex capture groups are available."
fn spec.serviceScrapeRelabelTemplate.withTarget_label
withTarget_label(target_label)
"UnderScoreTargetLabel - additional form of target label - target_label\nfor compatibility with original relabel config.\nif set both targetLabel and target_label, targetLabel has priority.\nfor details https://github.com/VictoriaMetrics/operator/issues/131"
obj spec.serviceScrapeSelector
"ServiceScrapeSelector defines ServiceScrapes to be selected for target discovery.\nWorks in combination with NamespaceSelector.\nNamespaceSelector nil - only objects at VMAgent namespace.\nSelector nil - only objects at NamespaceSelector namespaces.\nIf both nil - behaviour controlled by selectAllByDefault"
fn spec.serviceScrapeSelector.withMatchExpressions
withMatchExpressions(matchExpressions)
"matchExpressions is a list of label selector requirements. The requirements are ANDed."
fn spec.serviceScrapeSelector.withMatchExpressionsMixin
withMatchExpressionsMixin(matchExpressions)
"matchExpressions is a list of label selector requirements. The requirements are ANDed."
Note: This function appends passed data to existing values
fn spec.serviceScrapeSelector.withMatchLabels
withMatchLabels(matchLabels)
"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed."
fn spec.serviceScrapeSelector.withMatchLabelsMixin
withMatchLabelsMixin(matchLabels)
"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed."
Note: This function appends passed data to existing values
obj spec.serviceScrapeSelector.matchExpressions
"matchExpressions is a list of label selector requirements. The requirements are ANDed."
fn spec.serviceScrapeSelector.matchExpressions.withKey
withKey(key)
"key is the label key that the selector applies to."
fn spec.serviceScrapeSelector.matchExpressions.withOperator
withOperator(operator)
"operator represents a key's relationship to a set of values.\nValid operators are In, NotIn, Exists and DoesNotExist."
fn spec.serviceScrapeSelector.matchExpressions.withValues
withValues(values)
"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch."
fn spec.serviceScrapeSelector.matchExpressions.withValuesMixin
withValuesMixin(values)
"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch."
Note: This function appends passed data to existing values
obj spec.serviceSpec
"ServiceSpec that will be added to vmagent service spec"
fn spec.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.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.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.serviceSpec.metadata
"EmbeddedObjectMetadata defines objectMeta for additional service."
fn spec.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.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.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.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.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.statefulStorage
"StatefulStorage configures storage for StatefulSet"
fn spec.statefulStorage.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."
obj spec.statefulStorage.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.statefulStorage.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.statefulStorage.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.statefulStorage.volumeClaimTemplate
"A PVC spec to be used by the VMAlertManager StatefulSets."
fn spec.statefulStorage.volumeClaimTemplate.withApiVersion
withApiVersion(apiVersion)
"APIVersion defines the versioned schema of this representation of an object.\nServers should convert recognized schemas to the latest internal value, and\nmay reject unrecognized values.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources"
fn spec.statefulStorage.volumeClaimTemplate.withKind
withKind(kind)
"Kind is a string value representing the REST resource this object represents.\nServers may infer this from the endpoint the client submits requests to.\nCannot be updated.\nIn CamelCase.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds"
obj spec.statefulStorage.volumeClaimTemplate.metadata
"EmbeddedMetadata contains metadata relevant to an EmbeddedResource."
fn spec.statefulStorage.volumeClaimTemplate.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.statefulStorage.volumeClaimTemplate.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.statefulStorage.volumeClaimTemplate.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.statefulStorage.volumeClaimTemplate.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.statefulStorage.volumeClaimTemplate.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.statefulStorage.volumeClaimTemplate.spec
"Spec defines the desired characteristics of a volume requested by a pod author.\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims"
fn spec.statefulStorage.volumeClaimTemplate.spec.withAccessModes
withAccessModes(accessModes)
"accessModes contains the desired access modes the volume should have.\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1"
fn spec.statefulStorage.volumeClaimTemplate.spec.withAccessModesMixin
withAccessModesMixin(accessModes)
"accessModes contains the desired access modes the volume should have.\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1"
Note: This function appends passed data to existing values
fn spec.statefulStorage.volumeClaimTemplate.spec.withStorageClassName
withStorageClassName(storageClassName)
"storageClassName is the name of the StorageClass required by the claim.\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1"
fn spec.statefulStorage.volumeClaimTemplate.spec.withVolumeAttributesClassName
withVolumeAttributesClassName(volumeAttributesClassName)
"volumeAttributesClassName may be used to set the VolumeAttributesClass used by this claim.\nIf specified, the CSI driver will create or update the volume with the attributes defined\nin the corresponding VolumeAttributesClass. This has a different purpose than storageClassName,\nit can be changed after the claim is created. An empty string value means that no VolumeAttributesClass\nwill be applied to the claim but it's not allowed to reset this field to empty string once it is set.\nIf unspecified and the PersistentVolumeClaim is unbound, the default VolumeAttributesClass\nwill be set by the persistentvolume controller if it exists.\nIf the resource referred to by volumeAttributesClass does not exist, this PersistentVolumeClaim will be\nset to a Pending state, as reflected by the modifyVolumeStatus field, until such as a resource\nexists.\nMore info: https://kubernetes.io/docs/concepts/storage/volume-attributes-classes/\n(Alpha) Using this field requires the VolumeAttributesClass feature gate to be enabled."
fn spec.statefulStorage.volumeClaimTemplate.spec.withVolumeMode
withVolumeMode(volumeMode)
"volumeMode defines what type of volume is required by the claim.\nValue of Filesystem is implied when not included in claim spec."
fn spec.statefulStorage.volumeClaimTemplate.spec.withVolumeName
withVolumeName(volumeName)
"volumeName is the binding reference to the PersistentVolume backing this claim."
obj spec.statefulStorage.volumeClaimTemplate.spec.dataSource
"dataSource field can be used to specify either:\n An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot)\n An existing PVC (PersistentVolumeClaim)\nIf the provisioner or an external controller can support the specified data source,\nit will create a new volume based on the contents of the specified data source.\nWhen the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef,\nand dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified.\nIf the namespace is specified, then dataSourceRef will not be copied to dataSource."
fn spec.statefulStorage.volumeClaimTemplate.spec.dataSource.withApiGroup
withApiGroup(apiGroup)
"APIGroup is the group for the resource being referenced.\nIf APIGroup is not specified, the specified Kind must be in the core API group.\nFor any other third-party types, APIGroup is required."
fn spec.statefulStorage.volumeClaimTemplate.spec.dataSource.withKind
withKind(kind)
"Kind is the type of resource being referenced"
fn spec.statefulStorage.volumeClaimTemplate.spec.dataSource.withName
withName(name)
"Name is the name of resource being referenced"
obj spec.statefulStorage.volumeClaimTemplate.spec.dataSourceRef
"dataSourceRef specifies the object from which to populate the volume with data, if a non-empty\nvolume is desired. This may be any object from a non-empty API group (non\ncore object) or a PersistentVolumeClaim object.\nWhen this field is specified, volume binding will only succeed if the type of\nthe specified object matches some installed volume populator or dynamic\nprovisioner.\nThis field will replace the functionality of the dataSource field and as such\nif both fields are non-empty, they must have the same value. For backwards\ncompatibility, when namespace isn't specified in dataSourceRef,\nboth fields (dataSource and dataSourceRef) will be set to the same\nvalue automatically if one of them is empty and the other is non-empty.\nWhen namespace is specified in dataSourceRef,\ndataSource isn't set to the same value and must be empty.\nThere are three important differences between dataSource and dataSourceRef:\n While dataSource only allows two specific types of objects, dataSourceRef\n allows any non-core object, as well as PersistentVolumeClaim objects.\n While dataSource ignores disallowed values (dropping them), dataSourceRef\n preserves all values, and generates an error if a disallowed value is\n specified.\n* While dataSource only allows local objects, dataSourceRef allows objects\n in any namespaces.\n(Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled.\n(Alpha) Using the namespace field of dataSourceRef requires the CrossNamespaceVolumeDataSource feature gate to be enabled."
fn spec.statefulStorage.volumeClaimTemplate.spec.dataSourceRef.withApiGroup
withApiGroup(apiGroup)
"APIGroup is the group for the resource being referenced.\nIf APIGroup is not specified, the specified Kind must be in the core API group.\nFor any other third-party types, APIGroup is required."
fn spec.statefulStorage.volumeClaimTemplate.spec.dataSourceRef.withKind
withKind(kind)
"Kind is the type of resource being referenced"
fn spec.statefulStorage.volumeClaimTemplate.spec.dataSourceRef.withName
withName(name)
"Name is the name of resource being referenced"
fn spec.statefulStorage.volumeClaimTemplate.spec.dataSourceRef.withNamespace
withNamespace(namespace)
"Namespace is the namespace of resource being referenced\nNote that when a namespace is specified, a gateway.networking.k8s.io/ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details.\n(Alpha) This field requires the CrossNamespaceVolumeDataSource feature gate to be enabled."
obj spec.statefulStorage.volumeClaimTemplate.spec.resources
"resources represents the minimum resources the volume should have.\nIf RecoverVolumeExpansionFailure feature is enabled users are allowed to specify resource requirements\nthat are lower than previous value but must still be higher than capacity recorded in the\nstatus field of the claim.\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources"
fn spec.statefulStorage.volumeClaimTemplate.spec.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.statefulStorage.volumeClaimTemplate.spec.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.statefulStorage.volumeClaimTemplate.spec.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.statefulStorage.volumeClaimTemplate.spec.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.statefulStorage.volumeClaimTemplate.spec.selector
"selector is a label query over volumes to consider for binding."
fn spec.statefulStorage.volumeClaimTemplate.spec.selector.withMatchExpressions
withMatchExpressions(matchExpressions)
"matchExpressions is a list of label selector requirements. The requirements are ANDed."
fn spec.statefulStorage.volumeClaimTemplate.spec.selector.withMatchExpressionsMixin
withMatchExpressionsMixin(matchExpressions)
"matchExpressions is a list of label selector requirements. The requirements are ANDed."
Note: This function appends passed data to existing values
fn spec.statefulStorage.volumeClaimTemplate.spec.selector.withMatchLabels
withMatchLabels(matchLabels)
"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed."
fn spec.statefulStorage.volumeClaimTemplate.spec.selector.withMatchLabelsMixin
withMatchLabelsMixin(matchLabels)
"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed."
Note: This function appends passed data to existing values
obj spec.statefulStorage.volumeClaimTemplate.spec.selector.matchExpressions
"matchExpressions is a list of label selector requirements. The requirements are ANDed."
fn spec.statefulStorage.volumeClaimTemplate.spec.selector.matchExpressions.withKey
withKey(key)
"key is the label key that the selector applies to."
fn spec.statefulStorage.volumeClaimTemplate.spec.selector.matchExpressions.withOperator
withOperator(operator)
"operator represents a key's relationship to a set of values.\nValid operators are In, NotIn, Exists and DoesNotExist."
fn spec.statefulStorage.volumeClaimTemplate.spec.selector.matchExpressions.withValues
withValues(values)
"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch."
fn spec.statefulStorage.volumeClaimTemplate.spec.selector.matchExpressions.withValuesMixin
withValuesMixin(values)
"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch."
Note: This function appends passed data to existing values
obj spec.staticScrapeNamespaceSelector
"StaticScrapeNamespaceSelector defines Namespaces to be selected for VMStaticScrape discovery.\nWorks in combination with NamespaceSelector.\nNamespaceSelector nil - only objects at VMAgent namespace.\nSelector nil - only objects at NamespaceSelector namespaces.\nIf both nil - behaviour controlled by selectAllByDefault"
fn spec.staticScrapeNamespaceSelector.withMatchExpressions
withMatchExpressions(matchExpressions)
"matchExpressions is a list of label selector requirements. The requirements are ANDed."
fn spec.staticScrapeNamespaceSelector.withMatchExpressionsMixin
withMatchExpressionsMixin(matchExpressions)
"matchExpressions is a list of label selector requirements. The requirements are ANDed."
Note: This function appends passed data to existing values
fn spec.staticScrapeNamespaceSelector.withMatchLabels
withMatchLabels(matchLabels)
"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed."
fn spec.staticScrapeNamespaceSelector.withMatchLabelsMixin
withMatchLabelsMixin(matchLabels)
"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed."
Note: This function appends passed data to existing values
obj spec.staticScrapeNamespaceSelector.matchExpressions
"matchExpressions is a list of label selector requirements. The requirements are ANDed."
fn spec.staticScrapeNamespaceSelector.matchExpressions.withKey
withKey(key)
"key is the label key that the selector applies to."
fn spec.staticScrapeNamespaceSelector.matchExpressions.withOperator
withOperator(operator)
"operator represents a key's relationship to a set of values.\nValid operators are In, NotIn, Exists and DoesNotExist."
fn spec.staticScrapeNamespaceSelector.matchExpressions.withValues
withValues(values)
"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch."
fn spec.staticScrapeNamespaceSelector.matchExpressions.withValuesMixin
withValuesMixin(values)
"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch."
Note: This function appends passed data to existing values
obj spec.staticScrapeRelabelTemplate
"StaticScrapeRelabelTemplate defines relabel config, that will be added to each VMStaticScrape.\nit's useful for adding specific labels to all targets"
fn spec.staticScrapeRelabelTemplate.withAction
withAction(action)
"Action to perform based on regex matching. Default is 'replace'"
fn spec.staticScrapeRelabelTemplate.withIf
withIf(If)
"If represents metricsQL match expression (or list of expressions): '{name=~\"foo_.*\"}'"
fn spec.staticScrapeRelabelTemplate.withLabels
withLabels(labels)
"Labels is used together with Match for action: graphite"
fn spec.staticScrapeRelabelTemplate.withLabelsMixin
withLabelsMixin(labels)
"Labels is used together with Match for action: graphite"
Note: This function appends passed data to existing values
fn spec.staticScrapeRelabelTemplate.withMatch
withMatch(match)
"Match is used together with Labels for action: graphite"
fn spec.staticScrapeRelabelTemplate.withModulus
withModulus(modulus)
"Modulus to take of the hash of the source label values."
fn spec.staticScrapeRelabelTemplate.withRegex
withRegex(regex)
"Regular expression against which the extracted value is matched. Default is '(.*)'\nvictoriaMetrics supports multiline regex joined with |\nhttps://docs.victoriametrics.com/vmagent/#relabeling-enhancements"
fn spec.staticScrapeRelabelTemplate.withReplacement
withReplacement(replacement)
"Replacement value against which a regex replace is performed if the\nregular expression matches. Regex capture groups are available. Default is '$1'"
fn spec.staticScrapeRelabelTemplate.withSeparator
withSeparator(separator)
"Separator placed between concatenated source label values. default is ';'."
fn spec.staticScrapeRelabelTemplate.withSourceLabels
withSourceLabels(sourceLabels)
"The source labels select values from existing labels. Their content is concatenated\nusing the configured separator and matched against the configured regular expression\nfor the replace, keep, and drop actions."
fn spec.staticScrapeRelabelTemplate.withSourceLabelsMixin
withSourceLabelsMixin(sourceLabels)
"The source labels select values from existing labels. Their content is concatenated\nusing the configured separator and matched against the configured regular expression\nfor the replace, keep, and drop actions."
Note: This function appends passed data to existing values
fn spec.staticScrapeRelabelTemplate.withSource_labels
withSource_labels(source_labels)
"UnderScoreSourceLabels - additional form of source labels source_labels\nfor compatibility with original relabel config.\nif set both sourceLabels and source_labels, sourceLabels has priority.\nfor details https://github.com/VictoriaMetrics/operator/issues/131"
fn spec.staticScrapeRelabelTemplate.withSource_labelsMixin
withSource_labelsMixin(source_labels)
"UnderScoreSourceLabels - additional form of source labels source_labels\nfor compatibility with original relabel config.\nif set both sourceLabels and source_labels, sourceLabels has priority.\nfor details https://github.com/VictoriaMetrics/operator/issues/131"
Note: This function appends passed data to existing values
fn spec.staticScrapeRelabelTemplate.withTargetLabel
withTargetLabel(targetLabel)
"Label to which the resulting value is written in a replace action.\nIt is mandatory for replace actions. Regex capture groups are available."
fn spec.staticScrapeRelabelTemplate.withTarget_label
withTarget_label(target_label)
"UnderScoreTargetLabel - additional form of target label - target_label\nfor compatibility with original relabel config.\nif set both targetLabel and target_label, targetLabel has priority.\nfor details https://github.com/VictoriaMetrics/operator/issues/131"
obj spec.staticScrapeSelector
"StaticScrapeSelector defines PodScrapes to be selected for target discovery.\nWorks in combination with NamespaceSelector.\nIf both nil - match everything.\nNamespaceSelector nil - only objects at VMAgent namespace.\nSelector nil - only objects at NamespaceSelector namespaces."
fn spec.staticScrapeSelector.withMatchExpressions
withMatchExpressions(matchExpressions)
"matchExpressions is a list of label selector requirements. The requirements are ANDed."
fn spec.staticScrapeSelector.withMatchExpressionsMixin
withMatchExpressionsMixin(matchExpressions)
"matchExpressions is a list of label selector requirements. The requirements are ANDed."
Note: This function appends passed data to existing values
fn spec.staticScrapeSelector.withMatchLabels
withMatchLabels(matchLabels)
"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed."
fn spec.staticScrapeSelector.withMatchLabelsMixin
withMatchLabelsMixin(matchLabels)
"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed."
Note: This function appends passed data to existing values
obj spec.staticScrapeSelector.matchExpressions
"matchExpressions is a list of label selector requirements. The requirements are ANDed."
fn spec.staticScrapeSelector.matchExpressions.withKey
withKey(key)
"key is the label key that the selector applies to."
fn spec.staticScrapeSelector.matchExpressions.withOperator
withOperator(operator)
"operator represents a key's relationship to a set of values.\nValid operators are In, NotIn, Exists and DoesNotExist."
fn spec.staticScrapeSelector.matchExpressions.withValues
withValues(values)
"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch."
fn spec.staticScrapeSelector.matchExpressions.withValuesMixin
withValuesMixin(values)
"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch."
Note: This function appends passed data to existing values
obj spec.streamAggrConfig
"StreamAggrConfig defines global stream aggregation configuration for VMAgent"
fn spec.streamAggrConfig.withDedupInterval
withDedupInterval(dedupInterval)
"Allows setting different de-duplication intervals per each configured remote storage"
fn spec.streamAggrConfig.withDropInput
withDropInput(dropInput)
"Allow drop all the input samples after the aggregation"
fn spec.streamAggrConfig.withDropInputLabels
withDropInputLabels(dropInputLabels)
"labels to drop from samples for aggregator before stream de-duplication and aggregation"
fn spec.streamAggrConfig.withDropInputLabelsMixin
withDropInputLabelsMixin(dropInputLabels)
"labels to drop from samples for aggregator before stream de-duplication and aggregation"
Note: This function appends passed data to existing values
fn spec.streamAggrConfig.withIgnoreFirstIntervals
withIgnoreFirstIntervals(ignoreFirstIntervals)
"IgnoreFirstIntervals instructs to ignore first interval"
fn spec.streamAggrConfig.withIgnoreOldSamples
withIgnoreOldSamples(ignoreOldSamples)
"IgnoreOldSamples instructs to ignore samples with old timestamps outside the current aggregation interval."
fn spec.streamAggrConfig.withKeepInput
withKeepInput(keepInput)
"Allows writing both raw and aggregate data"
fn spec.streamAggrConfig.withRules
withRules(rules)
"Stream aggregation rules"
fn spec.streamAggrConfig.withRulesMixin
withRulesMixin(rules)
"Stream aggregation rules"
Note: This function appends passed data to existing values
obj spec.streamAggrConfig.configmap
"ConfigMap with stream aggregation rules"
fn spec.streamAggrConfig.configmap.withKey
withKey(key)
"The key to select."
fn spec.streamAggrConfig.configmap.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.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop kubebuilder:default when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896."
fn spec.streamAggrConfig.configmap.withOptional
withOptional(optional)
"Specify whether the ConfigMap or its key must be defined"
obj spec.streamAggrConfig.rules
"Stream aggregation rules"
fn spec.streamAggrConfig.rules.withBy
withBy(by)
"By is an optional list of labels for grouping input series.\n\n\nSee also Without.\n\n\nIf neither By nor Without are set, then the Outputs are calculated\nindividually per each input time series."
fn spec.streamAggrConfig.rules.withByMixin
withByMixin(by)
"By is an optional list of labels for grouping input series.\n\n\nSee also Without.\n\n\nIf neither By nor Without are set, then the Outputs are calculated\nindividually per each input time series."
Note: This function appends passed data to existing values
fn spec.streamAggrConfig.rules.withDedup_interval
withDedup_interval(dedup_interval)
"DedupInterval is an optional interval for deduplication."
fn spec.streamAggrConfig.rules.withDrop_input_labels
withDrop_input_labels(drop_input_labels)
"DropInputLabels is an optional list with labels, which must be dropped before further processing of input samples.\n\n\nLabels are dropped before de-duplication and aggregation."
fn spec.streamAggrConfig.rules.withDrop_input_labelsMixin
withDrop_input_labelsMixin(drop_input_labels)
"DropInputLabels is an optional list with labels, which must be dropped before further processing of input samples.\n\n\nLabels are dropped before de-duplication and aggregation."
Note: This function appends passed data to existing values
fn spec.streamAggrConfig.rules.withFlush_on_shutdown
withFlush_on_shutdown(flush_on_shutdown)
"FlushOnShutdown defines whether to flush the aggregation state on process termination\nor config reload. Is false by default.\nIt is not recommended changing this setting, unless unfinished aggregations states\nare preferred to missing data points."
fn spec.streamAggrConfig.rules.withIgnore_first_intervals
withIgnore_first_intervals(ignore_first_intervals)
fn spec.streamAggrConfig.rules.withIgnore_old_samples
withIgnore_old_samples(ignore_old_samples)
"IgnoreOldSamples instructs to ignore samples with old timestamps outside the current aggregation interval."
fn spec.streamAggrConfig.rules.withInput_relabel_configs
withInput_relabel_configs(input_relabel_configs)
"InputRelabelConfigs is an optional relabeling rules, which are applied on the input\nbefore aggregation."
fn spec.streamAggrConfig.rules.withInput_relabel_configsMixin
withInput_relabel_configsMixin(input_relabel_configs)
"InputRelabelConfigs is an optional relabeling rules, which are applied on the input\nbefore aggregation."
Note: This function appends passed data to existing values
fn spec.streamAggrConfig.rules.withInterval
withInterval(interval)
"Interval is the interval between aggregations."
fn spec.streamAggrConfig.rules.withKeep_metric_names
withKeep_metric_names(keep_metric_names)
"KeepMetricNames instructs to leave metric names as is for the output time series without adding any suffix."
fn spec.streamAggrConfig.rules.withMatch
withMatch(match)
"Match is a label selector (or list of label selectors) for filtering time series for the given selector.\n\n\nIf the match isn't set, then all the input time series are processed."
fn spec.streamAggrConfig.rules.withNo_align_flush_to_interval
withNo_align_flush_to_interval(no_align_flush_to_interval)
"NoAlignFlushToInterval disables aligning of flushes to multiples of Interval.\nBy default flushes are aligned to Interval."
fn spec.streamAggrConfig.rules.withOutput_relabel_configs
withOutput_relabel_configs(output_relabel_configs)
"OutputRelabelConfigs is an optional relabeling rules, which are applied\non the aggregated output before being sent to remote storage."
fn spec.streamAggrConfig.rules.withOutput_relabel_configsMixin
withOutput_relabel_configsMixin(output_relabel_configs)
"OutputRelabelConfigs is an optional relabeling rules, which are applied\non the aggregated output before being sent to remote storage."
Note: This function appends passed data to existing values
fn spec.streamAggrConfig.rules.withOutputs
withOutputs(outputs)
"Outputs is a list of output aggregate functions to produce.\n\n\nThe following names are allowed:\n\n\n- total - aggregates input counters\n- increase - counts the increase over input counters\n- count_series - counts the input series\n- count_samples - counts the input samples\n- sum_samples - sums the input samples\n- last - the last biggest sample value\n- min - the minimum sample value\n- max - the maximum sample value\n- avg - the average value across all the samples\n- stddev - standard deviation across all the samples\n- stdvar - standard variance across all the samples\n- histogram_bucket - creates VictoriaMetrics histogram for input samples\n- quantiles(phi1, ..., phiN) - quantiles' estimation for phi in the range [0..1]\n\n\nThe output time series will have the following names:\n\n\n input_name:aggr_
fn spec.streamAggrConfig.rules.withOutputsMixin
withOutputsMixin(outputs)
"Outputs is a list of output aggregate functions to produce.\n\n\nThe following names are allowed:\n\n\n- total - aggregates input counters\n- increase - counts the increase over input counters\n- count_series - counts the input series\n- count_samples - counts the input samples\n- sum_samples - sums the input samples\n- last - the last biggest sample value\n- min - the minimum sample value\n- max - the maximum sample value\n- avg - the average value across all the samples\n- stddev - standard deviation across all the samples\n- stdvar - standard variance across all the samples\n- histogram_bucket - creates VictoriaMetrics histogram for input samples\n- quantiles(phi1, ..., phiN) - quantiles' estimation for phi in the range [0..1]\n\n\nThe output time series will have the following names:\n\n\n input_name:aggr_
Note: This function appends passed data to existing values
fn spec.streamAggrConfig.rules.withStaleness_interval
withStaleness_interval(staleness_interval)
"Staleness interval is interval after which the series state will be reset if no samples have been sent during it.\nThe parameter is only relevant for outputs: total, total_prometheus, increase, increase_prometheus and histogram_bucket."
fn spec.streamAggrConfig.rules.withWithout
withWithout(without)
"Without is an optional list of labels, which must be excluded when grouping input series.\n\n\nSee also By.\n\n\nIf neither By nor Without are set, then the Outputs are calculated\nindividually per each input time series."
fn spec.streamAggrConfig.rules.withWithoutMixin
withWithoutMixin(without)
"Without is an optional list of labels, which must be excluded when grouping input series.\n\n\nSee also By.\n\n\nIf neither By nor Without are set, then the Outputs are calculated\nindividually per each input time series."
Note: This function appends passed data to existing values
obj spec.streamAggrConfig.rules.input_relabel_configs
"InputRelabelConfigs is an optional relabeling rules, which are applied on the input\nbefore aggregation."
fn spec.streamAggrConfig.rules.input_relabel_configs.withAction
withAction(action)
"Action to perform based on regex matching. Default is 'replace'"
fn spec.streamAggrConfig.rules.input_relabel_configs.withIf
withIf(If)
"If represents metricsQL match expression (or list of expressions): '{name=~\"foo_.*\"}'"
fn spec.streamAggrConfig.rules.input_relabel_configs.withLabels
withLabels(labels)
"Labels is used together with Match for action: graphite"
fn spec.streamAggrConfig.rules.input_relabel_configs.withLabelsMixin
withLabelsMixin(labels)
"Labels is used together with Match for action: graphite"
Note: This function appends passed data to existing values
fn spec.streamAggrConfig.rules.input_relabel_configs.withMatch
withMatch(match)
"Match is used together with Labels for action: graphite"
fn spec.streamAggrConfig.rules.input_relabel_configs.withModulus
withModulus(modulus)
"Modulus to take of the hash of the source label values."
fn spec.streamAggrConfig.rules.input_relabel_configs.withRegex
withRegex(regex)
"Regular expression against which the extracted value is matched. Default is '(.*)'\nvictoriaMetrics supports multiline regex joined with |\nhttps://docs.victoriametrics.com/vmagent/#relabeling-enhancements"
fn spec.streamAggrConfig.rules.input_relabel_configs.withReplacement
withReplacement(replacement)
"Replacement value against which a regex replace is performed if the\nregular expression matches. Regex capture groups are available. Default is '$1'"
fn spec.streamAggrConfig.rules.input_relabel_configs.withSeparator
withSeparator(separator)
"Separator placed between concatenated source label values. default is ';'."
fn spec.streamAggrConfig.rules.input_relabel_configs.withSourceLabels
withSourceLabels(sourceLabels)
"The source labels select values from existing labels. Their content is concatenated\nusing the configured separator and matched against the configured regular expression\nfor the replace, keep, and drop actions."
fn spec.streamAggrConfig.rules.input_relabel_configs.withSourceLabelsMixin
withSourceLabelsMixin(sourceLabels)
"The source labels select values from existing labels. Their content is concatenated\nusing the configured separator and matched against the configured regular expression\nfor the replace, keep, and drop actions."
Note: This function appends passed data to existing values
fn spec.streamAggrConfig.rules.input_relabel_configs.withSource_labels
withSource_labels(source_labels)
"UnderScoreSourceLabels - additional form of source labels source_labels\nfor compatibility with original relabel config.\nif set both sourceLabels and source_labels, sourceLabels has priority.\nfor details https://github.com/VictoriaMetrics/operator/issues/131"
fn spec.streamAggrConfig.rules.input_relabel_configs.withSource_labelsMixin
withSource_labelsMixin(source_labels)
"UnderScoreSourceLabels - additional form of source labels source_labels\nfor compatibility with original relabel config.\nif set both sourceLabels and source_labels, sourceLabels has priority.\nfor details https://github.com/VictoriaMetrics/operator/issues/131"
Note: This function appends passed data to existing values
fn spec.streamAggrConfig.rules.input_relabel_configs.withTargetLabel
withTargetLabel(targetLabel)
"Label to which the resulting value is written in a replace action.\nIt is mandatory for replace actions. Regex capture groups are available."
fn spec.streamAggrConfig.rules.input_relabel_configs.withTarget_label
withTarget_label(target_label)
"UnderScoreTargetLabel - additional form of target label - target_label\nfor compatibility with original relabel config.\nif set both targetLabel and target_label, targetLabel has priority.\nfor details https://github.com/VictoriaMetrics/operator/issues/131"
obj spec.streamAggrConfig.rules.output_relabel_configs
"OutputRelabelConfigs is an optional relabeling rules, which are applied\non the aggregated output before being sent to remote storage."
fn spec.streamAggrConfig.rules.output_relabel_configs.withAction
withAction(action)
"Action to perform based on regex matching. Default is 'replace'"
fn spec.streamAggrConfig.rules.output_relabel_configs.withIf
withIf(If)
"If represents metricsQL match expression (or list of expressions): '{name=~\"foo_.*\"}'"
fn spec.streamAggrConfig.rules.output_relabel_configs.withLabels
withLabels(labels)
"Labels is used together with Match for action: graphite"
fn spec.streamAggrConfig.rules.output_relabel_configs.withLabelsMixin
withLabelsMixin(labels)
"Labels is used together with Match for action: graphite"
Note: This function appends passed data to existing values
fn spec.streamAggrConfig.rules.output_relabel_configs.withMatch
withMatch(match)
"Match is used together with Labels for action: graphite"
fn spec.streamAggrConfig.rules.output_relabel_configs.withModulus
withModulus(modulus)
"Modulus to take of the hash of the source label values."
fn spec.streamAggrConfig.rules.output_relabel_configs.withRegex
withRegex(regex)
"Regular expression against which the extracted value is matched. Default is '(.*)'\nvictoriaMetrics supports multiline regex joined with |\nhttps://docs.victoriametrics.com/vmagent/#relabeling-enhancements"
fn spec.streamAggrConfig.rules.output_relabel_configs.withReplacement
withReplacement(replacement)
"Replacement value against which a regex replace is performed if the\nregular expression matches. Regex capture groups are available. Default is '$1'"
fn spec.streamAggrConfig.rules.output_relabel_configs.withSeparator
withSeparator(separator)
"Separator placed between concatenated source label values. default is ';'."
fn spec.streamAggrConfig.rules.output_relabel_configs.withSourceLabels
withSourceLabels(sourceLabels)
"The source labels select values from existing labels. Their content is concatenated\nusing the configured separator and matched against the configured regular expression\nfor the replace, keep, and drop actions."
fn spec.streamAggrConfig.rules.output_relabel_configs.withSourceLabelsMixin
withSourceLabelsMixin(sourceLabels)
"The source labels select values from existing labels. Their content is concatenated\nusing the configured separator and matched against the configured regular expression\nfor the replace, keep, and drop actions."
Note: This function appends passed data to existing values
fn spec.streamAggrConfig.rules.output_relabel_configs.withSource_labels
withSource_labels(source_labels)
"UnderScoreSourceLabels - additional form of source labels source_labels\nfor compatibility with original relabel config.\nif set both sourceLabels and source_labels, sourceLabels has priority.\nfor details https://github.com/VictoriaMetrics/operator/issues/131"
fn spec.streamAggrConfig.rules.output_relabel_configs.withSource_labelsMixin
withSource_labelsMixin(source_labels)
"UnderScoreSourceLabels - additional form of source labels source_labels\nfor compatibility with original relabel config.\nif set both sourceLabels and source_labels, sourceLabels has priority.\nfor details https://github.com/VictoriaMetrics/operator/issues/131"
Note: This function appends passed data to existing values
fn spec.streamAggrConfig.rules.output_relabel_configs.withTargetLabel
withTargetLabel(targetLabel)
"Label to which the resulting value is written in a replace action.\nIt is mandatory for replace actions. Regex capture groups are available."
fn spec.streamAggrConfig.rules.output_relabel_configs.withTarget_label
withTarget_label(target_label)
"UnderScoreTargetLabel - additional form of target label - target_label\nfor compatibility with original relabel config.\nif set both targetLabel and target_label, targetLabel has priority.\nfor details https://github.com/VictoriaMetrics/operator/issues/131"
obj spec.tolerations
"Tolerations If specified, the pod's tolerations."
fn spec.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.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.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.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.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.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.volumeMounts.withMountPath
withMountPath(mountPath)
"Path within the container at which the volume should be mounted. Must\nnot contain ':'."
fn spec.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.volumeMounts.withName
withName(name)
"This must match the Name of a Volume."
fn spec.volumeMounts.withReadOnly
withReadOnly(readOnly)
"Mounted read-only if true, read-write otherwise (false or unspecified).\nDefaults to false."
fn spec.volumeMounts.withRecursiveReadOnly
withRecursiveReadOnly(recursiveReadOnly)
"RecursiveReadOnly specifies whether read-only mounts should be handled\nrecursively.\n\n\nIf ReadOnly is false, this field has no meaning and must be unspecified.\n\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\n\nIf this field is set to IfPossible or Enabled, MountPropagation must be set to\nNone (or be unspecified, which defaults to None).\n\n\nIf this field is not specified, it is treated as an equivalent of Disabled."
fn spec.volumeMounts.withSubPath
withSubPath(subPath)
"Path within the volume from which the container's volume should be mounted.\nDefaults to \"\" (volume's root)."
fn spec.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."