operator.v1beta1.vmAlertmanager

"VMAlertmanager represents Victoria-Metrics deployment for Alertmanager."

Index

fn new(name)
obj metadata
obj spec

Fields

fn new

new(name)

new returns an instance of VMAlertmanager

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

"Specification of the desired behavior of the VMAlertmanager cluster. More info:\nhttps://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#spec-and-status"

fn spec.withAdditionalPeers

withAdditionalPeers(additionalPeers)

"AdditionalPeers allows injecting a set of additional Alertmanagers to peer with to form a highly available cluster."

fn spec.withAdditionalPeersMixin

withAdditionalPeersMixin(additionalPeers)

"AdditionalPeers allows injecting a set of additional Alertmanagers to peer with to form a highly available cluster."

Note: This function appends passed data to existing values

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

fn spec.withClaimTemplatesMixin

withClaimTemplatesMixin(claimTemplates)

"ClaimTemplates allows adding additional VolumeClaimTemplates for StatefulSet"

Note: This function appends passed data to existing values

fn spec.withClusterAdvertiseAddress

withClusterAdvertiseAddress(clusterAdvertiseAddress)

"ClusterAdvertiseAddress is the explicit address to advertise in cluster.\nNeeds to be provided for non RFC1918 [1] (public) addresses.\n[1] RFC1918: https://tools.ietf.org/html/rfc1918"

fn spec.withClusterDomainName

withClusterDomainName(clusterDomainName)

"ClusterDomainName defines domain name suffix for in-cluster dns addresses\naka .cluster.local\nused to build pod peer addresses for in-cluster communication"

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

withConfigRawYaml(configRawYaml)

"ConfigRawYaml - raw configuration for alertmanager,\nit helps it to start without secret.\npriority -> hardcoded ConfigRaw -> ConfigRaw, provided by user -> ConfigSecret."

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

withConfigSecret(configSecret)

"ConfigSecret is the name of a Kubernetes Secret in the same namespace as the\nVMAlertmanager object, which contains configuration for this VMAlertmanager,\nconfiguration must be inside secret key: alertmanager.yaml.\nIt must be created by user.\ninstance. Defaults to 'vmalertmanager-'\nThe secret is mounted into /etc/alertmanager/config."

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

withDisableNamespaceMatcher(disableNamespaceMatcher)

"DisableNamespaceMatcher disables top route namespace label matcher for VMAlertmanagerConfig\nIt may be useful if alert doesn't have namespace label for some reason"

fn spec.withDisableRouteContinueEnforce

withDisableRouteContinueEnforce(disableRouteContinueEnforce)

"DisableRouteContinueEnforce cancel the behavior for VMAlertmanagerConfig that always enforce first-level route continue to true"

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

withEnforcedTopRouteMatchers(enforcedTopRouteMatchers)

"EnforcedTopRouteMatchers defines label matchers to be added for the top route\nof VMAlertmanagerConfig\nIt allows to make some set of labels required for alerts.\nhttps://prometheus.io/docs/alerting/latest/configuration/#matcher"

fn spec.withEnforcedTopRouteMatchersMixin

withEnforcedTopRouteMatchersMixin(enforcedTopRouteMatchers)

"EnforcedTopRouteMatchers defines label matchers to be added for the top route\nof VMAlertmanagerConfig\nIt allows to make some set of labels required for alerts.\nhttps://prometheus.io/docs/alerting/latest/configuration/#matcher"

Note: This function appends passed data to existing values

fn spec.withExternalURL

withExternalURL(externalURL)

"ExternalURL the VMAlertmanager instances will be available under. This is\nnecessary to generate correct URLs. This is necessary if VMAlertmanager is not\nserved from root of a DNS name."

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.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.\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.withListenLocal

withListenLocal(listenLocal)

"ListenLocal makes the VMAlertmanager server listen on loopback, so that it\ndoes not bind against the Pod IP. Note this is only for the VMAlertmanager\nUI, not the gossip communication."

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 VMAlertmanager to be configured with."

fn spec.withLogLevel

withLogLevel(logLevel)

"Log level for VMAlertmanager 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\nHas no effect for VLogs and VMSingle"

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

fn spec.withPortName

withPortName(portName)

"PortName used for the pods and governing service.\nThis defaults to web"

fn spec.withPriorityClassName

withPriorityClassName(priorityClassName)

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

fn spec.withRetention

withRetention(retention)

"Retention Time duration VMAlertmanager shall retain data for. Default is '120h',\nand must match the regular expression [0-9]+(ms|s|m|h) (milliseconds seconds minutes hours)."

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

withRollingUpdateStrategy(rollingUpdateStrategy)

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

fn spec.withRoutePrefix

withRoutePrefix(routePrefix)

"RoutePrefix VMAlertmanager registers HTTP handlers for. This is useful,\nif using ExternalURL and a proxy is rewriting HTTP routes of a request,\nand the actual ExternalURL is still true, but the server serves requests\nunder a different route prefix. For example for use with kubectl proxy."

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 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 ConfigSelector.\nwith selectAllByDefault: true and undefined ConfigSelector and ConfigNamespaceSelector\nOperator selects all exist alertManagerConfigs\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.withServiceScrapeSpec

withServiceScrapeSpec(serviceScrapeSpec)

"ServiceScrapeSpec that will be added to vmalertmanager VMServiceScrape spec"

fn spec.withServiceScrapeSpecMixin

withServiceScrapeSpecMixin(serviceScrapeSpec)

"ServiceScrapeSpec that will be added to vmalertmanager 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.withTemplates

withTemplates(templates)

"Templates is a list of ConfigMap key references for ConfigMaps in the same namespace as the VMAlertmanager\nobject, which shall be mounted into the VMAlertmanager Pods.\nThe Templates are mounted into /etc/vm/templates//."

fn spec.withTemplatesMixin

withTemplatesMixin(templates)

"Templates is a list of ConfigMap key references for ConfigMaps in the same namespace as the VMAlertmanager\nobject, which shall be mounted into the VMAlertmanager Pods.\nThe Templates are mounted into /etc/vm/templates//."

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

"ClaimTemplates allows adding additional VolumeClaimTemplates for StatefulSet"

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

" ConfigNamespaceSelector defines namespace selector for VMAlertmanagerConfig.\nWorks in combination with Selector.\nNamespaceSelector nil - only objects at VMAlertmanager namespace.\nSelector nil - only objects at NamespaceSelector namespaces.\nIf both nil - behaviour controlled by selectAllByDefault"

fn spec.configNamespaceSelector.withMatchExpressions

withMatchExpressions(matchExpressions)

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

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

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

fn spec.configNamespaceSelector.matchExpressions.withKey

withKey(key)

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

fn spec.configNamespaceSelector.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.configNamespaceSelector.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.configNamespaceSelector.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.configSelector

"ConfigSelector defines selector for VMAlertmanagerConfig, result config will be merged with with Raw or Secret config.\nWorks in combination with NamespaceSelector.\nNamespaceSelector nil - only objects at VMAlertmanager namespace.\nSelector nil - only objects at NamespaceSelector namespaces.\nIf both nil - behaviour controlled by selectAllByDefault"

fn spec.configSelector.withMatchExpressions

withMatchExpressions(matchExpressions)

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

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

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

fn spec.configSelector.matchExpressions.withKey

withKey(key)

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

fn spec.configSelector.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.configSelector.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.configSelector.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.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.gossipConfig

"GossipConfig defines gossip TLS configuration for Alertmanager cluster"

obj spec.gossipConfig.tls_client_config

"TLSClientConfig defines client TLS configuration for alertmanager"

fn spec.gossipConfig.tls_client_config.withCa_file

withCa_file(ca_file)

"CAFile defines path to the pre-mounted file with CA\nmutually exclusive with CASecretRef"

fn spec.gossipConfig.tls_client_config.withCert_file

withCert_file(cert_file)

"CertFile defines path to the pre-mounted file with certificate\nmutually exclusive with CertSecretRef"

fn spec.gossipConfig.tls_client_config.withInsecure_skip_verify

withInsecure_skip_verify(insecure_skip_verify)

"Cert defines reference for secret with CA content under given key\nmutually exclusive with CertFile"

fn spec.gossipConfig.tls_client_config.withKey_file

withKey_file(key_file)

"KeyFile defines path to the pre-mounted file with certificate key\nmutually exclusive with KeySecretRef"

fn spec.gossipConfig.tls_client_config.withServer_name

withServer_name(server_name)

"ServerName indicates a name of a server"

obj spec.gossipConfig.tls_client_config.ca_secret_ref

"CA defines reference for secret with CA content under given key\nmutually exclusive with CAFile"

fn spec.gossipConfig.tls_client_config.ca_secret_ref.withKey

withKey(key)

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

fn spec.gossipConfig.tls_client_config.ca_secret_ref.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.gossipConfig.tls_client_config.ca_secret_ref.withOptional

withOptional(optional)

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

obj spec.gossipConfig.tls_client_config.cert_secret_ref

"CertSecretRef defines reference for secret with certificate content under given key\nmutually exclusive with CertFile"

fn spec.gossipConfig.tls_client_config.cert_secret_ref.withKey

withKey(key)

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

fn spec.gossipConfig.tls_client_config.cert_secret_ref.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.gossipConfig.tls_client_config.cert_secret_ref.withOptional

withOptional(optional)

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

obj spec.gossipConfig.tls_client_config.key_secret_ref

"Key defines reference for secret with certificate key content under given key\nmutually exclusive with KeyFile"

fn spec.gossipConfig.tls_client_config.key_secret_ref.withKey

withKey(key)

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

fn spec.gossipConfig.tls_client_config.key_secret_ref.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.gossipConfig.tls_client_config.key_secret_ref.withOptional

withOptional(optional)

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

obj spec.gossipConfig.tls_server_config

"TLSServerConfig defines server TLS configuration for alertmanager"

fn spec.gossipConfig.tls_server_config.withCert_file

withCert_file(cert_file)

"CertFile defines path to the pre-mounted file with certificate\nmutually exclusive with CertSecretRef"

fn spec.gossipConfig.tls_server_config.withCipher_suites

withCipher_suites(cipher_suites)

"CipherSuites defines list of supported cipher suites for TLS versions up to TLS 1.2\nhttps://golang.org/pkg/crypto/tls/#pkg-constants"

fn spec.gossipConfig.tls_server_config.withCipher_suitesMixin

withCipher_suitesMixin(cipher_suites)

"CipherSuites defines list of supported cipher suites for TLS versions up to TLS 1.2\nhttps://golang.org/pkg/crypto/tls/#pkg-constants"

Note: This function appends passed data to existing values

fn spec.gossipConfig.tls_server_config.withClient_auth_type

withClient_auth_type(client_auth_type)

"Cert defines reference for secret with CA content under given key\nmutually exclusive with CertFile\nClientAuthType defines server policy for client authentication\nIf you want to enable client authentication (aka mTLS), you need to use RequireAndVerifyClientCert\nNote, mTLS is supported only at enterprise version of VictoriaMetrics components"

fn spec.gossipConfig.tls_server_config.withClient_ca_file

withClient_ca_file(client_ca_file)

"ClientCAFile defines path to the pre-mounted file with CA\nmutually exclusive with ClientCASecretRef"

fn spec.gossipConfig.tls_server_config.withCurve_preferences

withCurve_preferences(curve_preferences)

"CurvePreferences defines elliptic curves that will be used in an ECDHE handshake, in preference order.\nhttps://golang.org/pkg/crypto/tls/#CurveID"

fn spec.gossipConfig.tls_server_config.withCurve_preferencesMixin

withCurve_preferencesMixin(curve_preferences)

"CurvePreferences defines elliptic curves that will be used in an ECDHE handshake, in preference order.\nhttps://golang.org/pkg/crypto/tls/#CurveID"

Note: This function appends passed data to existing values

fn spec.gossipConfig.tls_server_config.withKey_file

withKey_file(key_file)

"KeyFile defines path to the pre-mounted file with certificate key\nmutually exclusive with KeySecretRef"

fn spec.gossipConfig.tls_server_config.withMax_version

withMax_version(max_version)

"MaxVersion maximum TLS version that is acceptable."

fn spec.gossipConfig.tls_server_config.withMin_version

withMin_version(min_version)

"MinVersion minimum TLS version that is acceptable."

fn spec.gossipConfig.tls_server_config.withPrefer_server_cipher_suites

withPrefer_server_cipher_suites(prefer_server_cipher_suites)

"PreferServerCipherSuites controls whether the server selects the\nclient's most preferred ciphersuite"

obj spec.gossipConfig.tls_server_config.cert_secret_ref

"CertSecretRef defines reference for secret with certificate content under given key\nmutually exclusive with CertFile"

fn spec.gossipConfig.tls_server_config.cert_secret_ref.withKey

withKey(key)

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

fn spec.gossipConfig.tls_server_config.cert_secret_ref.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.gossipConfig.tls_server_config.cert_secret_ref.withOptional

withOptional(optional)

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

obj spec.gossipConfig.tls_server_config.client_ca_secret_ref

"ClientCASecretRef defines reference for secret with CA content under given key\nmutually exclusive with ClientCAFile"

fn spec.gossipConfig.tls_server_config.client_ca_secret_ref.withKey

withKey(key)

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

fn spec.gossipConfig.tls_server_config.client_ca_secret_ref.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.gossipConfig.tls_server_config.client_ca_secret_ref.withOptional

withOptional(optional)

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

obj spec.gossipConfig.tls_server_config.key_secret_ref

"Key defines reference for secret with certificate key content under given key\nmutually exclusive with KeyFile"

fn spec.gossipConfig.tls_server_config.key_secret_ref.withKey

withKey(key)

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

fn spec.gossipConfig.tls_server_config.key_secret_ref.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.gossipConfig.tls_server_config.key_secret_ref.withOptional

withOptional(optional)

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

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.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 alertmanager 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.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.serviceSpec

"ServiceSpec that will be added to vmalertmanager 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.storage

"Storage is the definition of how storage will be used by the VMAlertmanager\ninstances."

fn spec.storage.withDisableMountSubPath

withDisableMountSubPath(disableMountSubPath)

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

obj spec.storage.emptyDir

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

fn spec.storage.emptyDir.withMedium

withMedium(medium)

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

fn spec.storage.emptyDir.withSizeLimit

withSizeLimit(sizeLimit)

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

obj spec.storage.volumeClaimTemplate

"A PVC spec to be used by the VMAlertManager StatefulSets."

fn spec.storage.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.storage.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.storage.volumeClaimTemplate.metadata

"EmbeddedMetadata contains metadata relevant to an EmbeddedResource."

fn spec.storage.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.storage.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.storage.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.storage.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.storage.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.storage.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.storage.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.storage.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.storage.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.storage.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.storage.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.storage.volumeClaimTemplate.spec.withVolumeName

withVolumeName(volumeName)

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

obj spec.storage.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.storage.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.storage.volumeClaimTemplate.spec.dataSource.withKind

withKind(kind)

"Kind is the type of resource being referenced"

fn spec.storage.volumeClaimTemplate.spec.dataSource.withName

withName(name)

"Name is the name of resource being referenced"

obj spec.storage.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.storage.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.storage.volumeClaimTemplate.spec.dataSourceRef.withKind

withKind(kind)

"Kind is the type of resource being referenced"

fn spec.storage.volumeClaimTemplate.spec.dataSourceRef.withName

withName(name)

"Name is the name of resource being referenced"

fn spec.storage.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.storage.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.storage.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.storage.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.storage.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.storage.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.storage.volumeClaimTemplate.spec.selector

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

fn spec.storage.volumeClaimTemplate.spec.selector.withMatchExpressions

withMatchExpressions(matchExpressions)

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

fn spec.storage.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.storage.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.storage.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.storage.volumeClaimTemplate.spec.selector.matchExpressions

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

fn spec.storage.volumeClaimTemplate.spec.selector.matchExpressions.withKey

withKey(key)

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

fn spec.storage.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.storage.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.storage.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.templates

"Templates is a list of ConfigMap key references for ConfigMaps in the same namespace as the VMAlertmanager\nobject, which shall be mounted into the VMAlertmanager Pods.\nThe Templates are mounted into /etc/vm/templates//."

fn spec.templates.withKey

withKey(key)

"The ConfigMap key to refer to."

fn spec.templates.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.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."

obj spec.webConfig

"WebConfig defines configuration for webserver\nhttps://github.com/prometheus/alertmanager/blob/main/docs/https.md"

fn spec.webConfig.withBasic_auth_users

withBasic_auth_users(basic_auth_users)

"BasicAuthUsers Usernames and hashed passwords that have full access to the web server\nPasswords must be hashed with bcrypt"

fn spec.webConfig.withBasic_auth_usersMixin

withBasic_auth_usersMixin(basic_auth_users)

"BasicAuthUsers Usernames and hashed passwords that have full access to the web server\nPasswords must be hashed with bcrypt"

Note: This function appends passed data to existing values

obj spec.webConfig.http_server_config

"HTTPServerConfig defines http server configuration for alertmanager web server"

fn spec.webConfig.http_server_config.withHeaders

withHeaders(headers)

"Headers defines list of headers that can be added to HTTP responses."

fn spec.webConfig.http_server_config.withHeadersMixin

withHeadersMixin(headers)

"Headers defines list of headers that can be added to HTTP responses."

Note: This function appends passed data to existing values

fn spec.webConfig.http_server_config.withHttp2

withHttp2(http2)

"HTTP2 enables HTTP/2 support. Note that HTTP/2 is only supported with TLS.\nThis can not be changed on the fly."

obj spec.webConfig.tls_server_config

"TLSServerConfig defines server TLS configuration for alertmanager"

fn spec.webConfig.tls_server_config.withCert_file

withCert_file(cert_file)

"CertFile defines path to the pre-mounted file with certificate\nmutually exclusive with CertSecretRef"

fn spec.webConfig.tls_server_config.withCipher_suites

withCipher_suites(cipher_suites)

"CipherSuites defines list of supported cipher suites for TLS versions up to TLS 1.2\nhttps://golang.org/pkg/crypto/tls/#pkg-constants"

fn spec.webConfig.tls_server_config.withCipher_suitesMixin

withCipher_suitesMixin(cipher_suites)

"CipherSuites defines list of supported cipher suites for TLS versions up to TLS 1.2\nhttps://golang.org/pkg/crypto/tls/#pkg-constants"

Note: This function appends passed data to existing values

fn spec.webConfig.tls_server_config.withClient_auth_type

withClient_auth_type(client_auth_type)

"Cert defines reference for secret with CA content under given key\nmutually exclusive with CertFile\nClientAuthType defines server policy for client authentication\nIf you want to enable client authentication (aka mTLS), you need to use RequireAndVerifyClientCert\nNote, mTLS is supported only at enterprise version of VictoriaMetrics components"

fn spec.webConfig.tls_server_config.withClient_ca_file

withClient_ca_file(client_ca_file)

"ClientCAFile defines path to the pre-mounted file with CA\nmutually exclusive with ClientCASecretRef"

fn spec.webConfig.tls_server_config.withCurve_preferences

withCurve_preferences(curve_preferences)

"CurvePreferences defines elliptic curves that will be used in an ECDHE handshake, in preference order.\nhttps://golang.org/pkg/crypto/tls/#CurveID"

fn spec.webConfig.tls_server_config.withCurve_preferencesMixin

withCurve_preferencesMixin(curve_preferences)

"CurvePreferences defines elliptic curves that will be used in an ECDHE handshake, in preference order.\nhttps://golang.org/pkg/crypto/tls/#CurveID"

Note: This function appends passed data to existing values

fn spec.webConfig.tls_server_config.withKey_file

withKey_file(key_file)

"KeyFile defines path to the pre-mounted file with certificate key\nmutually exclusive with KeySecretRef"

fn spec.webConfig.tls_server_config.withMax_version

withMax_version(max_version)

"MaxVersion maximum TLS version that is acceptable."

fn spec.webConfig.tls_server_config.withMin_version

withMin_version(min_version)

"MinVersion minimum TLS version that is acceptable."

fn spec.webConfig.tls_server_config.withPrefer_server_cipher_suites

withPrefer_server_cipher_suites(prefer_server_cipher_suites)

"PreferServerCipherSuites controls whether the server selects the\nclient's most preferred ciphersuite"

obj spec.webConfig.tls_server_config.cert_secret_ref

"CertSecretRef defines reference for secret with certificate content under given key\nmutually exclusive with CertFile"

fn spec.webConfig.tls_server_config.cert_secret_ref.withKey

withKey(key)

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

fn spec.webConfig.tls_server_config.cert_secret_ref.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.webConfig.tls_server_config.cert_secret_ref.withOptional

withOptional(optional)

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

obj spec.webConfig.tls_server_config.client_ca_secret_ref

"ClientCASecretRef defines reference for secret with CA content under given key\nmutually exclusive with ClientCAFile"

fn spec.webConfig.tls_server_config.client_ca_secret_ref.withKey

withKey(key)

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

fn spec.webConfig.tls_server_config.client_ca_secret_ref.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.webConfig.tls_server_config.client_ca_secret_ref.withOptional

withOptional(optional)

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

obj spec.webConfig.tls_server_config.key_secret_ref

"Key defines reference for secret with certificate key content under given key\nmutually exclusive with KeyFile"

fn spec.webConfig.tls_server_config.key_secret_ref.withKey

withKey(key)

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

fn spec.webConfig.tls_server_config.key_secret_ref.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.webConfig.tls_server_config.key_secret_ref.withOptional

withOptional(optional)

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