operator.v1beta1.vmAlert

"VMAlert executes a list of given alerting or recording rules against configured address."

Index

fn new(name)
obj metadata
obj spec

Fields

fn new

new(name)

new returns an instance of VMAlert

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

"VMAlertSpec defines the desired state of VMAlert"

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.withConfigMaps

withConfigMaps(configMaps)

"ConfigMaps is a list of ConfigMaps in the same namespace as the VMAlert\nobject, which shall be mounted into the VMAlert Pods.\nThe ConfigMaps are mounted into /etc/vm/configs/."

fn spec.withConfigMapsMixin

withConfigMapsMixin(configMaps)

"ConfigMaps is a list of ConfigMaps in the same namespace as the VMAlert\nobject, which shall be mounted into the VMAlert Pods.\nThe ConfigMaps are mounted into /etc/vm/configs/."

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.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.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.withEvaluationInterval

withEvaluationInterval(evaluationInterval)

"EvaluationInterval defines how often to evaluate rules by default"

fn spec.withExternalLabels

withExternalLabels(externalLabels)

"ExternalLabels in the form 'name: value' to add to all generated recording rules and alerts."

fn spec.withExternalLabelsMixin

withExternalLabelsMixin(externalLabels)

"ExternalLabels in the form 'name: value' to add to all generated recording rules and alerts."

Note: This function appends passed data to existing values

fn spec.withExtraArgs

withExtraArgs(extraArgs)

"ExtraArgs that will be passed to VMAlert pod\nfor example -remoteWrite.tmpDataPath=/tmp"

fn spec.withExtraArgsMixin

withExtraArgsMixin(extraArgs)

"ExtraArgs that will be passed to VMAlert pod\nfor example -remoteWrite.tmpDataPath=/tmp"

Note: This function appends passed data to existing values

fn spec.withExtraEnvs

withExtraEnvs(extraEnvs)

"ExtraEnvs that will be added to VMAlert pod"

fn spec.withExtraEnvsMixin

withExtraEnvsMixin(extraEnvs)

"ExtraEnvs that will be added to VMAlert pod"

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.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.withInitContainers

withInitContainers(initContainers)

"InitContainers allows adding initContainers to the pod definition. Those can be used to e.g.\nfetch secrets for injection into the VMAlert configuration from external sources. Any\nerrors during the execution of an initContainer will lead to a restart of the Pod. More info: https://kubernetes.io/docs/concepts/workloads/pods/init-containers/\nUsing initContainers for any use case other then secret fetching is entirely outside the scope\nof what the maintainers will support and by doing so, you accept that this behaviour may break\nat any time without notice."

fn spec.withInitContainersMixin

withInitContainersMixin(initContainers)

"InitContainers allows adding initContainers to the pod definition. Those can be used to e.g.\nfetch secrets for injection into the VMAlert configuration from external sources. Any\nerrors during the execution of an initContainer will lead to a restart of the Pod. More info: https://kubernetes.io/docs/concepts/workloads/pods/init-containers/\nUsing initContainers for any use case other then secret fetching is entirely outside the scope\nof what the maintainers will support and by doing so, you accept that this behaviour may break\nat any time without notice."

Note: This function appends passed data to existing values

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 VMAlert to be configured with.\ndefault or json"

fn spec.withLogLevel

withLogLevel(logLevel)

"LogLevel for VMAlert to be configured with."

fn spec.withMinReadySeconds

withMinReadySeconds(minReadySeconds)

"MinReadySeconds defines a minim number os seconds to wait before starting update next pod\nif previous in healthy state"

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.withNotifiers

withNotifiers(notifiers)

"Notifiers prometheus alertmanager endpoints. Required at least one of notifier or notifiers when there are alerting rules. e.g. http://127.0.0.1:9093\nIf specified both notifier and notifiers, notifier will be added as last element to notifiers.\nonly one of notifier options could be chosen: notifierConfigRef or notifiers + notifier"

fn spec.withNotifiersMixin

withNotifiersMixin(notifiers)

"Notifiers prometheus alertmanager endpoints. Required at least one of notifier or notifiers when there are alerting rules. e.g. http://127.0.0.1:9093\nIf specified both notifier and notifiers, notifier will be added as last element to notifiers.\nonly one of notifier options could be chosen: notifierConfigRef or notifiers + notifier"

Note: This function appends passed data to existing values

fn spec.withPaused

withPaused(paused)

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

fn spec.withPort

withPort(port)

"Port for listen"

fn spec.withPriorityClassName

withPriorityClassName(priorityClassName)

"Priority class assigned to the Pods"

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.withReplicaCount

withReplicaCount(replicaCount)

"ReplicaCount is the expected size of the VMAlert cluster. The controller will\neventually make the size of the running cluster equal to the expected\nsize."

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 StatefulSet's revision history.\nDefaults to 10."

fn spec.withRulePath

withRulePath(rulePath)

"RulePath to the file with alert rules.\nSupports patterns. Flag can be specified multiple times.\nExamples:\n-rule /path/to/file. Path to a single file with alerting rules\n-rule dir/.yaml -rule /.yaml. Relative path to all .yaml files in folder,\nabsolute path to all .yaml files in root.\nby default operator adds /etc/vmalert/configs/base/vmalert.yaml"

fn spec.withRulePathMixin

withRulePathMixin(rulePath)

"RulePath to the file with alert rules.\nSupports patterns. Flag can be specified multiple times.\nExamples:\n-rule /path/to/file. Path to a single file with alerting rules\n-rule dir/.yaml -rule /.yaml. Relative path to all .yaml files in folder,\nabsolute path to all .yaml files in root.\nby default operator adds /etc/vmalert/configs/base/vmalert.yaml"

Note: This function appends passed data to existing values

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.withSecrets

withSecrets(secrets)

"Secrets is a list of Secrets in the same namespace as the VMAlert\nobject, which shall be mounted into the VMAlert Pods.\nThe Secrets are mounted into /etc/vm/secrets/."

fn spec.withSecretsMixin

withSecretsMixin(secrets)

"Secrets is a list of Secrets in the same namespace as the VMAlert\nobject, which shall be mounted into the VMAlert Pods.\nThe Secrets are mounted into /etc/vm/secrets/."

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 RuleSelector.\nwith selectAllByDefault: true and empty serviceScrapeSelector and RuleNamespaceSelector\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\nVMAlert Pods."

fn spec.withServiceScrapeSpec

withServiceScrapeSpec(serviceScrapeSpec)

"ServiceScrapeSpec that will be added to vmalert VMServiceScrape spec"

fn spec.withServiceScrapeSpecMixin

withServiceScrapeSpecMixin(serviceScrapeSpec)

"ServiceScrapeSpec that will be added to vmalert VMServiceScrape spec"

Note: This function appends passed data to existing values

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.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."

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.withVolumeMounts

withVolumeMounts(volumeMounts)

"VolumeMounts allows configuration of additional VolumeMounts on the output Deployment definition.\nVolumeMounts specified will be appended to other VolumeMounts in the VMAlert container,\nthat are generated as a result of StorageSpec objects."

fn spec.withVolumeMountsMixin

withVolumeMountsMixin(volumeMounts)

"VolumeMounts allows configuration of additional VolumeMounts on the output Deployment definition.\nVolumeMounts specified will be appended to other VolumeMounts in the VMAlert container,\nthat are generated as a result of StorageSpec objects."

Note: This function appends passed data to existing values

fn spec.withVolumes

withVolumes(volumes)

"Volumes allows configuration of additional volumes on the output Deployment definition.\nVolumes specified will be appended to other volumes that are generated as a result of\nStorageSpec objects."

fn spec.withVolumesMixin

withVolumesMixin(volumes)

"Volumes allows configuration of additional volumes on the output Deployment definition.\nVolumes specified will be appended to other volumes that are generated as a result of\nStorageSpec objects."

Note: This function appends passed data to existing values

obj spec.datasource

"Datasource Victoria Metrics or VMSelect url. Required parameter. e.g. http://127.0.0.1:8428"

fn spec.datasource.withBearerTokenFile

withBearerTokenFile(bearerTokenFile)

"Path to bearer token file"

fn spec.datasource.withHeaders

withHeaders(headers)

"Headers allow configuring custom http headers\nMust be in form of semicolon separated header with value\ne.g.\nheaderName:headerValue\nvmalert supports it since 1.79.0 version"

fn spec.datasource.withHeadersMixin

withHeadersMixin(headers)

"Headers allow configuring custom http headers\nMust be in form of semicolon separated header with value\ne.g.\nheaderName:headerValue\nvmalert supports it since 1.79.0 version"

Note: This function appends passed data to existing values

fn spec.datasource.withOauth2

withOauth2(oauth2)

"OAuth2 defines OAuth2 configuration"

fn spec.datasource.withOauth2Mixin

withOauth2Mixin(oauth2)

"OAuth2 defines OAuth2 configuration"

Note: This function appends passed data to existing values

fn spec.datasource.withTlsConfig

withTlsConfig(tlsConfig)

"TLSConfig specifies TLSConfig configuration parameters."

fn spec.datasource.withTlsConfigMixin

withTlsConfigMixin(tlsConfig)

"TLSConfig specifies TLSConfig configuration parameters."

Note: This function appends passed data to existing values

fn spec.datasource.withUrl

withUrl(url)

"Victoria Metrics or VMSelect url. Required parameter. E.g. http://127.0.0.1:8428"

obj spec.datasource.basicAuth

"BasicAuth allow an endpoint to authenticate over basic authentication"

fn spec.datasource.basicAuth.withPassword_file

withPassword_file(password_file)

"PasswordFile defines path to password file at disk\nmust be pre-mounted"

obj spec.datasource.basicAuth.password

"Password defines reference for secret with password value\nThe secret needs to be in the same namespace as scrape object"

fn spec.datasource.basicAuth.password.withKey

withKey(key)

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

fn spec.datasource.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.datasource.basicAuth.password.withOptional

withOptional(optional)

"Specify whether the Secret or its key must be defined"

obj spec.datasource.basicAuth.username

"Username defines reference for secret with username value\nThe secret needs to be in the same namespace as scrape object"

fn spec.datasource.basicAuth.username.withKey

withKey(key)

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

fn spec.datasource.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.datasource.basicAuth.username.withOptional

withOptional(optional)

"Specify whether the Secret or its key must be defined"

obj spec.datasource.bearerTokenSecret

"Optional bearer auth token to use for -remoteWrite.url"

fn spec.datasource.bearerTokenSecret.withKey

withKey(key)

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

fn spec.datasource.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.datasource.bearerTokenSecret.withOptional

withOptional(optional)

"Specify whether the Secret or its key must be defined"

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 added to VMAlert pod"

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.image

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

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.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.notifier

"Notifier prometheus alertmanager endpoint spec. Required at least one of notifier or notifiers when there are alerting rules. e.g. http://127.0.0.1:9093\nIf specified both notifier and notifiers, notifier will be added as last element to notifiers.\nonly one of notifier options could be chosen: notifierConfigRef or notifiers + notifier"

fn spec.notifier.withBearerTokenFile

withBearerTokenFile(bearerTokenFile)

"Path to bearer token file"

fn spec.notifier.withHeaders

withHeaders(headers)

"Headers allow configuring custom http headers\nMust be in form of semicolon separated header with value\ne.g.\nheaderName:headerValue\nvmalert supports it since 1.79.0 version"

fn spec.notifier.withHeadersMixin

withHeadersMixin(headers)

"Headers allow configuring custom http headers\nMust be in form of semicolon separated header with value\ne.g.\nheaderName:headerValue\nvmalert supports it since 1.79.0 version"

Note: This function appends passed data to existing values

fn spec.notifier.withOauth2

withOauth2(oauth2)

"OAuth2 defines OAuth2 configuration"

fn spec.notifier.withOauth2Mixin

withOauth2Mixin(oauth2)

"OAuth2 defines OAuth2 configuration"

Note: This function appends passed data to existing values

fn spec.notifier.withTlsConfig

withTlsConfig(tlsConfig)

"TLSConfig specifies TLSConfig configuration parameters."

fn spec.notifier.withTlsConfigMixin

withTlsConfigMixin(tlsConfig)

"TLSConfig specifies TLSConfig configuration parameters."

Note: This function appends passed data to existing values

fn spec.notifier.withUrl

withUrl(url)

"AlertManager url. E.g. http://127.0.0.1:9093"

obj spec.notifier.basicAuth

"BasicAuth allow an endpoint to authenticate over basic authentication"

fn spec.notifier.basicAuth.withPassword_file

withPassword_file(password_file)

"PasswordFile defines path to password file at disk\nmust be pre-mounted"

obj spec.notifier.basicAuth.password

"Password defines reference for secret with password value\nThe secret needs to be in the same namespace as scrape object"

fn spec.notifier.basicAuth.password.withKey

withKey(key)

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

fn spec.notifier.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.notifier.basicAuth.password.withOptional

withOptional(optional)

"Specify whether the Secret or its key must be defined"

obj spec.notifier.basicAuth.username

"Username defines reference for secret with username value\nThe secret needs to be in the same namespace as scrape object"

fn spec.notifier.basicAuth.username.withKey

withKey(key)

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

fn spec.notifier.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.notifier.basicAuth.username.withOptional

withOptional(optional)

"Specify whether the Secret or its key must be defined"

obj spec.notifier.bearerTokenSecret

"Optional bearer auth token to use for -remoteWrite.url"

fn spec.notifier.bearerTokenSecret.withKey

withKey(key)

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

fn spec.notifier.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.notifier.bearerTokenSecret.withOptional

withOptional(optional)

"Specify whether the Secret or its key must be defined"

obj spec.notifier.selector

"Selector allows service discovery for alertmanager\nin this case all matched vmalertmanager replicas will be added into vmalert notifier.url\nas statefulset pod.fqdn"

obj spec.notifier.selector.labelSelector

"A label selector is a label query over a set of resources. The result of matchLabels and\nmatchExpressions are ANDed. An empty label selector matches all objects. A null\nlabel selector matches no objects."

fn spec.notifier.selector.labelSelector.withMatchExpressions

withMatchExpressions(matchExpressions)

"matchExpressions is a list of label selector requirements. The requirements are ANDed."

fn spec.notifier.selector.labelSelector.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.notifier.selector.labelSelector.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.notifier.selector.labelSelector.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.notifier.selector.labelSelector.matchExpressions

"matchExpressions is a list of label selector requirements. The requirements are ANDed."

fn spec.notifier.selector.labelSelector.matchExpressions.withKey

withKey(key)

"key is the label key that the selector applies to."

fn spec.notifier.selector.labelSelector.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.notifier.selector.labelSelector.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.notifier.selector.labelSelector.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.notifier.selector.namespaceSelector

"NamespaceSelector is a selector for selecting either all namespaces or a\nlist of namespaces."

fn spec.notifier.selector.namespaceSelector.withAny

withAny(any)

"Boolean describing whether all namespaces are selected in contrast to a\nlist restricting them."

fn spec.notifier.selector.namespaceSelector.withMatchNames

withMatchNames(matchNames)

"List of namespace names."

fn spec.notifier.selector.namespaceSelector.withMatchNamesMixin

withMatchNamesMixin(matchNames)

"List of namespace names."

Note: This function appends passed data to existing values

obj spec.notifierConfigRef

"NotifierConfigRef reference for secret with notifier configuration for vmalert\nonly one of notifier options could be chosen: notifierConfigRef or notifiers + notifier"

fn spec.notifierConfigRef.withKey

withKey(key)

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

fn spec.notifierConfigRef.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.notifierConfigRef.withOptional

withOptional(optional)

"Specify whether the Secret or its key must be defined"

obj spec.notifiers

"Notifiers prometheus alertmanager endpoints. Required at least one of notifier or notifiers when there are alerting rules. e.g. http://127.0.0.1:9093\nIf specified both notifier and notifiers, notifier will be added as last element to notifiers.\nonly one of notifier options could be chosen: notifierConfigRef or notifiers + notifier"

fn spec.notifiers.withBearerTokenFile

withBearerTokenFile(bearerTokenFile)

"Path to bearer token file"

fn spec.notifiers.withHeaders

withHeaders(headers)

"Headers allow configuring custom http headers\nMust be in form of semicolon separated header with value\ne.g.\nheaderName:headerValue\nvmalert supports it since 1.79.0 version"

fn spec.notifiers.withHeadersMixin

withHeadersMixin(headers)

"Headers allow configuring custom http headers\nMust be in form of semicolon separated header with value\ne.g.\nheaderName:headerValue\nvmalert supports it since 1.79.0 version"

Note: This function appends passed data to existing values

fn spec.notifiers.withOauth2

withOauth2(oauth2)

"OAuth2 defines OAuth2 configuration"

fn spec.notifiers.withOauth2Mixin

withOauth2Mixin(oauth2)

"OAuth2 defines OAuth2 configuration"

Note: This function appends passed data to existing values

fn spec.notifiers.withTlsConfig

withTlsConfig(tlsConfig)

"TLSConfig specifies TLSConfig configuration parameters."

fn spec.notifiers.withTlsConfigMixin

withTlsConfigMixin(tlsConfig)

"TLSConfig specifies TLSConfig configuration parameters."

Note: This function appends passed data to existing values

fn spec.notifiers.withUrl

withUrl(url)

"AlertManager url. E.g. http://127.0.0.1:9093"

obj spec.notifiers.basicAuth

"BasicAuth allow an endpoint to authenticate over basic authentication"

fn spec.notifiers.basicAuth.withPassword_file

withPassword_file(password_file)

"PasswordFile defines path to password file at disk\nmust be pre-mounted"

obj spec.notifiers.basicAuth.password

"Password defines reference for secret with password value\nThe secret needs to be in the same namespace as scrape object"

fn spec.notifiers.basicAuth.password.withKey

withKey(key)

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

fn spec.notifiers.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.notifiers.basicAuth.password.withOptional

withOptional(optional)

"Specify whether the Secret or its key must be defined"

obj spec.notifiers.basicAuth.username

"Username defines reference for secret with username value\nThe secret needs to be in the same namespace as scrape object"

fn spec.notifiers.basicAuth.username.withKey

withKey(key)

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

fn spec.notifiers.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.notifiers.basicAuth.username.withOptional

withOptional(optional)

"Specify whether the Secret or its key must be defined"

obj spec.notifiers.bearerTokenSecret

"Optional bearer auth token to use for -remoteWrite.url"

fn spec.notifiers.bearerTokenSecret.withKey

withKey(key)

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

fn spec.notifiers.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.notifiers.bearerTokenSecret.withOptional

withOptional(optional)

"Specify whether the Secret or its key must be defined"

obj spec.notifiers.selector

"Selector allows service discovery for alertmanager\nin this case all matched vmalertmanager replicas will be added into vmalert notifier.url\nas statefulset pod.fqdn"

obj spec.notifiers.selector.labelSelector

"A label selector is a label query over a set of resources. The result of matchLabels and\nmatchExpressions are ANDed. An empty label selector matches all objects. A null\nlabel selector matches no objects."

fn spec.notifiers.selector.labelSelector.withMatchExpressions

withMatchExpressions(matchExpressions)

"matchExpressions is a list of label selector requirements. The requirements are ANDed."

fn spec.notifiers.selector.labelSelector.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.notifiers.selector.labelSelector.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.notifiers.selector.labelSelector.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.notifiers.selector.labelSelector.matchExpressions

"matchExpressions is a list of label selector requirements. The requirements are ANDed."

fn spec.notifiers.selector.labelSelector.matchExpressions.withKey

withKey(key)

"key is the label key that the selector applies to."

fn spec.notifiers.selector.labelSelector.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.notifiers.selector.labelSelector.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.notifiers.selector.labelSelector.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.notifiers.selector.namespaceSelector

"NamespaceSelector is a selector for selecting either all namespaces or a\nlist of namespaces."

fn spec.notifiers.selector.namespaceSelector.withAny

withAny(any)

"Boolean describing whether all namespaces are selected in contrast to a\nlist restricting them."

fn spec.notifiers.selector.namespaceSelector.withMatchNames

withMatchNames(matchNames)

"List of namespace names."

fn spec.notifiers.selector.namespaceSelector.withMatchNamesMixin

withMatchNamesMixin(matchNames)

"List of namespace names."

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 VMAlert 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.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.remoteRead

"RemoteRead Optional URL to read vmalert state (persisted via RemoteWrite)\nThis configuration only makes sense if alerts state has been successfully\npersisted (via RemoteWrite) before.\nsee -remoteRead.url docs in vmalerts for details.\nE.g. http://127.0.0.1:8428"

fn spec.remoteRead.withBearerTokenFile

withBearerTokenFile(bearerTokenFile)

"Path to bearer token file"

fn spec.remoteRead.withHeaders

withHeaders(headers)

"Headers allow configuring custom http headers\nMust be in form of semicolon separated header with value\ne.g.\nheaderName:headerValue\nvmalert supports it since 1.79.0 version"

fn spec.remoteRead.withHeadersMixin

withHeadersMixin(headers)

"Headers allow configuring custom http headers\nMust be in form of semicolon separated header with value\ne.g.\nheaderName:headerValue\nvmalert supports it since 1.79.0 version"

Note: This function appends passed data to existing values

fn spec.remoteRead.withLookback

withLookback(lookback)

"Lookback defines how far to look into past for alerts timeseries. For example, if lookback=1h then range from now() to now()-1h will be scanned. (default 1h0m0s)\nApplied only to RemoteReadSpec"

fn spec.remoteRead.withOauth2

withOauth2(oauth2)

"OAuth2 defines OAuth2 configuration"

fn spec.remoteRead.withOauth2Mixin

withOauth2Mixin(oauth2)

"OAuth2 defines OAuth2 configuration"

Note: This function appends passed data to existing values

fn spec.remoteRead.withTlsConfig

withTlsConfig(tlsConfig)

"TLSConfig specifies TLSConfig configuration parameters."

fn spec.remoteRead.withTlsConfigMixin

withTlsConfigMixin(tlsConfig)

"TLSConfig specifies TLSConfig configuration parameters."

Note: This function appends passed data to existing values

fn spec.remoteRead.withUrl

withUrl(url)

"URL of the endpoint to send samples to."

obj spec.remoteRead.basicAuth

"BasicAuth allow an endpoint to authenticate over basic authentication"

fn spec.remoteRead.basicAuth.withPassword_file

withPassword_file(password_file)

"PasswordFile defines path to password file at disk\nmust be pre-mounted"

obj spec.remoteRead.basicAuth.password

"Password defines reference for secret with password value\nThe secret needs to be in the same namespace as scrape object"

fn spec.remoteRead.basicAuth.password.withKey

withKey(key)

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

fn spec.remoteRead.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.remoteRead.basicAuth.password.withOptional

withOptional(optional)

"Specify whether the Secret or its key must be defined"

obj spec.remoteRead.basicAuth.username

"Username defines reference for secret with username value\nThe secret needs to be in the same namespace as scrape object"

fn spec.remoteRead.basicAuth.username.withKey

withKey(key)

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

fn spec.remoteRead.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.remoteRead.basicAuth.username.withOptional

withOptional(optional)

"Specify whether the Secret or its key must be defined"

obj spec.remoteRead.bearerTokenSecret

"Optional bearer auth token to use for -remoteWrite.url"

fn spec.remoteRead.bearerTokenSecret.withKey

withKey(key)

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

fn spec.remoteRead.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.remoteRead.bearerTokenSecret.withOptional

withOptional(optional)

"Specify whether the Secret or its key must be defined"

obj spec.remoteWrite

"RemoteWrite Optional URL to remote-write compatible storage to persist\nvmalert state and rule results to.\nRule results will be persisted according to each rule.\nAlerts state will be persisted in the form of time series named ALERTS and ALERTS_FOR_STATE\nsee -remoteWrite.url docs in vmalerts for details.\nE.g. http://127.0.0.1:8428"

fn spec.remoteWrite.withBearerTokenFile

withBearerTokenFile(bearerTokenFile)

"Path to bearer token file"

fn spec.remoteWrite.withConcurrency

withConcurrency(concurrency)

"Defines number of readers that concurrently write into remote storage (default 1)"

fn spec.remoteWrite.withFlushInterval

withFlushInterval(flushInterval)

"Defines interval of flushes to remote write endpoint (default 5s)"

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\nvmalert supports it 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\nvmalert supports it since 1.79.0 version"

Note: This function appends passed data to existing values

fn spec.remoteWrite.withMaxBatchSize

withMaxBatchSize(maxBatchSize)

"Defines defines max number of timeseries to be flushed at once (default 1000)"

fn spec.remoteWrite.withMaxQueueSize

withMaxQueueSize(maxQueueSize)

"Defines the max number of pending datapoints to remote write endpoint (default 100000)"

fn spec.remoteWrite.withOauth2

withOauth2(oauth2)

"OAuth2 defines OAuth2 configuration"

fn spec.remoteWrite.withOauth2Mixin

withOauth2Mixin(oauth2)

"OAuth2 defines OAuth2 configuration"

Note: This function appends passed data to existing values

fn spec.remoteWrite.withTlsConfig

withTlsConfig(tlsConfig)

"TLSConfig specifies TLSConfig configuration parameters."

fn spec.remoteWrite.withTlsConfigMixin

withTlsConfigMixin(tlsConfig)

"TLSConfig specifies TLSConfig configuration parameters."

Note: This function appends passed data to existing values

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.resources

"Resources container resource request and limits, https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"

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.ruleNamespaceSelector

"RuleNamespaceSelector to be selected for VMRules discovery.\nWorks in combination with Selector.\nIf both nil - behaviour controlled by selectAllByDefault\nNamespaceSelector nil - only objects at VMAlert namespace."

fn spec.ruleNamespaceSelector.withMatchExpressions

withMatchExpressions(matchExpressions)

"matchExpressions is a list of label selector requirements. The requirements are ANDed."

fn spec.ruleNamespaceSelector.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.ruleNamespaceSelector.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.ruleNamespaceSelector.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.ruleNamespaceSelector.matchExpressions

"matchExpressions is a list of label selector requirements. The requirements are ANDed."

fn spec.ruleNamespaceSelector.matchExpressions.withKey

withKey(key)

"key is the label key that the selector applies to."

fn spec.ruleNamespaceSelector.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.ruleNamespaceSelector.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.ruleNamespaceSelector.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.ruleSelector

"RuleSelector selector to select which VMRules to mount for loading alerting\nrules from.\nWorks in combination with NamespaceSelector.\nIf both nil - behaviour controlled by selectAllByDefault\nNamespaceSelector nil - only objects at VMAlert namespace."

fn spec.ruleSelector.withMatchExpressions

withMatchExpressions(matchExpressions)

"matchExpressions is a list of label selector requirements. The requirements are ANDed."

fn spec.ruleSelector.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.ruleSelector.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.ruleSelector.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.ruleSelector.matchExpressions

"matchExpressions is a list of label selector requirements. The requirements are ANDed."

fn spec.ruleSelector.matchExpressions.withKey

withKey(key)

"key is the label key that the selector applies to."

fn spec.ruleSelector.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.ruleSelector.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.ruleSelector.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 vmalert 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.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 definition.\nVolumeMounts specified will be appended to other VolumeMounts in the VMAlert container,\nthat are generated as a result of StorageSpec objects."

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."