Skip to content

operator.v1beta1.vmAuth

"VMAuth is the Schema for the vmauths API"

Index

Fields

fn new

new(name)

new returns an instance of VMAuth

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"

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

"VMAuthSpec defines the desired state of VMAuth"

fn spec.withAffinity

withAffinity(affinity)

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

fn spec.withAffinityMixin

withAffinityMixin(affinity)

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

Note: This function appends passed data to existing values

fn spec.withConfigMaps

withConfigMaps(configMaps)

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

fn spec.withConfigMapsMixin

withConfigMapsMixin(configMaps)

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

Note: This function appends passed data to existing values

fn spec.withConfigReloaderExtraArgs

withConfigReloaderExtraArgs(configReloaderExtraArgs)

"ConfigReloaderExtraArgs that will be passed to VMAuths config-reloader container\nfor example resyncInterval: \"30s\

fn spec.withConfigReloaderExtraArgsMixin

withConfigReloaderExtraArgsMixin(configReloaderExtraArgs)

"ConfigReloaderExtraArgs that will be passed to VMAuths config-reloader container\nfor example resyncInterval: \"30s\

Note: This function appends passed data to existing values

fn spec.withConfigReloaderImageTag

withConfigReloaderImageTag(configReloaderImageTag)

"ConfigReloaderImageTag defines image:tag for config-reloader container"

fn spec.withConfigSecret

withConfigSecret(configSecret)

"ConfigSecret is the name of a Kubernetes Secret in the same namespace as the\nVMAuth object, which contains auth configuration for vmauth,\nconfiguration must be inside secret key: config.yaml.\nIt must be created and managed manually.\nIf it's defined, configuration for vmauth becomes unmanaged and operator'll not create any related secrets/config-reloaders\nDeprecated, use externalConfig.secretRef instead"

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

withDefault_url(default_url)

"DefaultURLs backend url for non-matching paths filter\nusually used for default backend with error message"

fn spec.withDefault_urlMixin

withDefault_urlMixin(default_url)

"DefaultURLs backend url for non-matching paths filter\nusually used for default backend with error message"

Note: This function appends passed data to existing values

fn spec.withDisableSelfServiceScrape

withDisableSelfServiceScrape(disableSelfServiceScrape)

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

fn spec.withDiscover_backend_ips

withDiscover_backend_ips(discover_backend_ips)

"DiscoverBackendIPs instructs discovering URLPrefix backend IPs via DNS."

fn spec.withDnsPolicy

withDnsPolicy(dnsPolicy)

"DNSPolicy sets DNS policy for the pod"

fn spec.withDrop_src_path_prefix_parts

withDrop_src_path_prefix_parts(drop_src_path_prefix_parts)

"DropSrcPathPrefixParts is the number of /-delimited request path prefix parts to drop before proxying the request to backend.\nSee here for more details."

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

withHeaders(headers)

"Headers represent additional http headers, that vmauth uses\nin form of [\"header_key: header_value\"]\nmultiple values for header key:\n[\"header_key: value1,value2\"]\nit's available since 1.68.0 version of vmauth"

fn spec.withHeadersMixin

withHeadersMixin(headers)

"Headers represent additional http headers, that vmauth uses\nin form of [\"header_key: header_value\"]\nmultiple values for header key:\n[\"header_key: value1,value2\"]\nit's available since 1.68.0 version of vmauth"

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

withLoad_balancing_policy(load_balancing_policy)

"LoadBalancingPolicy defines load balancing policy to use for backend urls.\nSupported policies: least_loaded, first_available.\nSee here for more details (default \"least_loaded\")"

fn spec.withLogFormat

withLogFormat(logFormat)

"LogFormat for VMAuth to be configured with."

fn spec.withLogLevel

withLogLevel(logLevel)

"LogLevel for victoria metrics single to be configured with."

fn spec.withMax_concurrent_requests

withMax_concurrent_requests(max_concurrent_requests)

"MaxConcurrentRequests defines max concurrent requests per user\n300 is default value for vmauth"

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

withResponse_headers(response_headers)

"ResponseHeaders represent additional http headers, that vmauth adds for request response\nin form of [\"header_key: header_value\"]\nmultiple values for header key:\n[\"header_key: value1,value2\"]\nit's available since 1.93.0 version of vmauth"

fn spec.withResponse_headersMixin

withResponse_headersMixin(response_headers)

"ResponseHeaders represent additional http headers, that vmauth adds for request response\nin form of [\"header_key: header_value\"]\nmultiple values for header key:\n[\"header_key: value1,value2\"]\nit's available since 1.93.0 version of vmauth"

Note: This function appends passed data to existing values

fn spec.withRetry_status_codes

withRetry_status_codes(retry_status_codes)

"RetryStatusCodes defines http status codes in numeric format for request retries\ne.g. [429,503]"

fn spec.withRetry_status_codesMixin

withRetry_status_codesMixin(retry_status_codes)

"RetryStatusCodes defines http status codes in numeric format for request retries\ne.g. [429,503]"

Note: This function appends passed data to existing values

fn spec.withRevisionHistoryLimitCount

withRevisionHistoryLimitCount(revisionHistoryLimitCount)

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

fn spec.withRuntimeClassName

withRuntimeClassName(runtimeClassName)

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

fn spec.withSchedulerName

withSchedulerName(schedulerName)

"SchedulerName - defines kubernetes scheduler name"

fn spec.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 userSelector.\nwith selectAllByDefault: true and empty userSelector and userNamespaceSelector\nOperator selects all exist users\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 vmauth VMServiceScrape spec"

fn spec.withServiceScrapeSpecMixin

withServiceScrapeSpecMixin(serviceScrapeSpec)

"ServiceScrapeSpec that will be added to vmauth VMServiceScrape spec"

Note: This function appends passed data to existing values

fn spec.withStartupProbe

withStartupProbe(startupProbe)

"StartupProbe that will be added to CRD pod"

fn spec.withStartupProbeMixin

withStartupProbeMixin(startupProbe)

"StartupProbe that will be added to CRD pod"

Note: This function appends passed data to existing values

fn spec.withTerminationGracePeriodSeconds

withTerminationGracePeriodSeconds(terminationGracePeriodSeconds)

"TerminationGracePeriodSeconds period for container graceful termination"

fn spec.withTolerations

withTolerations(tolerations)

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

fn spec.withTolerationsMixin

withTolerationsMixin(tolerations)

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

Note: This function appends passed data to existing values

fn spec.withTopologySpreadConstraints

withTopologySpreadConstraints(topologySpreadConstraints)

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

fn spec.withTopologySpreadConstraintsMixin

withTopologySpreadConstraintsMixin(topologySpreadConstraints)

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

Note: This function appends passed data to existing values

fn spec.withUnauthorizedAccessConfig

withUnauthorizedAccessConfig(unauthorizedAccessConfig)

"UnauthorizedAccessConfig configures access for un authorized users"

fn spec.withUnauthorizedAccessConfigMixin

withUnauthorizedAccessConfigMixin(unauthorizedAccessConfig)

"UnauthorizedAccessConfig configures access for un authorized users"

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.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\nThis is an alpha field and requires enabling the\nDynamicResourceAllocation feature gate.\n\nThis field is immutable. It can only be set for containers."

fn spec.configReloaderResources.withClaimsMixin

withClaimsMixin(claims)

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

Note: This function appends passed data to existing values

fn spec.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\nThis is an alpha field and requires enabling the\nDynamicResourceAllocation feature gate.\n\nThis field is immutable. It can only be set for containers."

fn spec.configReloaderResources.claims.withName

withName(name)

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

obj spec.dnsConfig

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

fn spec.dnsConfig.withNameservers

withNameservers(nameservers)

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

fn spec.dnsConfig.withNameserversMixin

withNameserversMixin(nameservers)

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

Note: This function appends passed data to existing values

fn spec.dnsConfig.withOptions

withOptions(options)

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

fn spec.dnsConfig.withOptionsMixin

withOptionsMixin(options)

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

Note: This function appends passed data to existing values

fn spec.dnsConfig.withSearches

withSearches(searches)

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

fn spec.dnsConfig.withSearchesMixin

withSearchesMixin(searches)

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

Note: This function appends passed data to existing values

obj spec.dnsConfig.options

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

fn spec.dnsConfig.options.withName

withName(name)

"Required."

fn spec.dnsConfig.options.withValue

withValue(value)

obj spec.externalConfig

"ExternalConfig defines a source of external VMAuth configuration.\nIf it's defined, configuration for vmauth becomes unmanaged and operator'll not create any related secrets/config-reloaders"

fn spec.externalConfig.withLocalPath

withLocalPath(localPath)

"LocalPath contains static path to a config, which is managed externally for cases\nwhen using secrets is not applicable, e.g.: Vault sidecar."

obj spec.externalConfig.secretRef

"SecretRef defines selector for externally managed secret which contains configuration"

fn spec.externalConfig.secretRef.withKey

withKey(key)

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

fn spec.externalConfig.secretRef.withName

withName(name)

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

fn spec.externalConfig.secretRef.withOptional

withOptional(optional)

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

obj spec.extraEnvs

"ExtraEnvs that will be passed to the application container"

fn spec.extraEnvs.withName

withName(name)

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

fn spec.extraEnvs.withValue

withValue(value)

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

obj spec.hostAliases

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

fn spec.hostAliases.withHostnames

withHostnames(hostnames)

"Hostnames for the above IP address."

fn spec.hostAliases.withHostnamesMixin

withHostnamesMixin(hostnames)

"Hostnames for the above IP address."

Note: This function appends passed data to existing values

fn spec.hostAliases.withIp

withIp(ip)

"IP address of the host file entry."

obj spec.host_aliases

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

fn spec.host_aliases.withHostnames

withHostnames(hostnames)

"Hostnames for the above IP address."

fn spec.host_aliases.withHostnamesMixin

withHostnamesMixin(hostnames)

"Hostnames for the above IP address."

Note: This function appends passed data to existing values

fn spec.host_aliases.withIp

withIp(ip)

"IP address of the host file entry."

obj spec.image

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

fn spec.image.withPullPolicy

withPullPolicy(pullPolicy)

"PullPolicy describes how to pull docker image"

fn spec.image.withRepository

withRepository(repository)

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

fn spec.image.withTag

withTag(tag)

"Tag contains desired docker image version"

obj spec.imagePullSecrets

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

fn spec.imagePullSecrets.withName

withName(name)

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

obj spec.ingress

"Ingress enables ingress configuration for VMAuth."

fn spec.ingress.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.ingress.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.ingress.withClass_name

withClass_name(class_name)

"ClassName defines ingress class name for VMAuth"

fn spec.ingress.withExtraRules

withExtraRules(extraRules)

"ExtraRules - additional rules for ingress,\nmust be checked for correctness by user."

fn spec.ingress.withExtraRulesMixin

withExtraRulesMixin(extraRules)

"ExtraRules - additional rules for ingress,\nmust be checked for correctness by user."

Note: This function appends passed data to existing values

fn spec.ingress.withExtraTls

withExtraTls(extraTls)

"ExtraTLS - additional TLS configuration for ingress\nmust be checked for correctness by user."

fn spec.ingress.withExtraTlsMixin

withExtraTlsMixin(extraTls)

"ExtraTLS - additional TLS configuration for ingress\nmust be checked for correctness by user."

Note: This function appends passed data to existing values

fn spec.ingress.withHost

withHost(host)

"Host defines ingress host parameter for default rule\nIt will be used, only if TlsHosts is empty"

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

fn spec.ingress.withTlsHosts

withTlsHosts(tlsHosts)

"TlsHosts configures TLS access for ingress, tlsSecretName must be defined for it."

fn spec.ingress.withTlsHostsMixin

withTlsHostsMixin(tlsHosts)

"TlsHosts configures TLS access for ingress, tlsSecretName must be defined for it."

Note: This function appends passed data to existing values

fn spec.ingress.withTlsSecretName

withTlsSecretName(tlsSecretName)

"TlsSecretName defines secretname at the VMAuth namespace with cert and key\nhttps://kubernetes.io/docs/concepts/services-networking/ingress/#tls"

obj spec.ingress.extraRules

"ExtraRules - additional rules for ingress,\nmust be checked for correctness by user."

fn spec.ingress.extraRules.withHost

withHost(host)

"host is the fully qualified domain name of a network host, as defined by RFC 3986.\nNote the following deviations from the \"host\" part of the\nURI as defined in RFC 3986:\n1. IPs are not allowed. Currently an IngressRuleValue can only apply to\n the IP in the Spec of the parent Ingress.\n2. The : delimiter is not respected because ports are not allowed.\n\t Currently the port of an Ingress is implicitly :80 for http and\n\t :443 for https.\nBoth these may change in the future.\nIncoming requests are matched against the host before the\nIngressRuleValue. If the host is unspecified, the Ingress routes all\ntraffic based on the specified IngressRuleValue.\n\nhost can be \"precise\" which is a domain name without the terminating dot of\na network host (e.g. \"foo.bar.com\") or \"wildcard\", which is a domain name\nprefixed with a single wildcard label (e.g. \".foo.com\").\nThe wildcard character '' must appear by itself as the first DNS label and\nmatches only a single label. You cannot have a wildcard label by itself (e.g. Host == \"*\").\nRequests will be matched against the Host field in the following way:\n1. If host is precise, the request matches this rule if the http host header is equal to Host.\n2. If host is a wildcard, then the request matches this rule if the http host header\nis to equal to the suffix (removing the first label) of the wildcard rule."

obj spec.ingress.extraRules.http

"HTTPIngressRuleValue is a list of http selectors pointing to backends.\nIn the example: http:///? -> backend where\nwhere parts of the url correspond to RFC 3986, this resource will be used\nto match against everything after the last '/' and before the first '?'\nor '#'."

fn spec.ingress.extraRules.http.withPaths

withPaths(paths)

"paths is a collection of paths that map requests to backends."

fn spec.ingress.extraRules.http.withPathsMixin

withPathsMixin(paths)

"paths is a collection of paths that map requests to backends."

Note: This function appends passed data to existing values

obj spec.ingress.extraRules.http.paths

"paths is a collection of paths that map requests to backends."

fn spec.ingress.extraRules.http.paths.withPath

withPath(path)

"path is matched against the path of an incoming request. Currently it can\ncontain characters disallowed from the conventional \"path\" part of a URL\nas defined by RFC 3986. Paths must begin with a '/' and must be present\nwhen using PathType with value \"Exact\" or \"Prefix\"."

fn spec.ingress.extraRules.http.paths.withPathType

withPathType(pathType)

"pathType determines the interpretation of the path matching. PathType can\nbe one of the following values:\n Exact: Matches the URL path exactly.\n Prefix: Matches based on a URL path prefix split by '/'. Matching is\n done on a path element by element basis. A path element refers is the\n list of labels in the path split by the '/' separator. A request is a\n match for path p if every p is an element-wise prefix of p of the\n request path. Note that if the last element of the path is a substring\n of the last element in request path, it is not a match (e.g. /foo/bar\n matches /foo/bar/baz, but does not match /foo/barbaz).\n* ImplementationSpecific: Interpretation of the Path matching is up to\n the IngressClass. Implementations can treat this as a separate PathType\n or treat it identically to Prefix or Exact path types.\nImplementations are required to support all path types."

obj spec.ingress.extraRules.http.paths.backend

"backend defines the referenced service endpoint to which the traffic\nwill be forwarded to."

obj spec.ingress.extraRules.http.paths.backend.resource

"resource is an ObjectRef to another Kubernetes resource in the namespace\nof the Ingress object. If resource is specified, a service.Name and\nservice.Port must not be specified.\nThis is a mutually exclusive setting with \"Service\"."

fn spec.ingress.extraRules.http.paths.backend.resource.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.ingress.extraRules.http.paths.backend.resource.withKind

withKind(kind)

"Kind is the type of resource being referenced"

fn spec.ingress.extraRules.http.paths.backend.resource.withName

withName(name)

"Name is the name of resource being referenced"

obj spec.ingress.extraRules.http.paths.backend.service

"service references a service as a backend.\nThis is a mutually exclusive setting with \"Resource\"."

fn spec.ingress.extraRules.http.paths.backend.service.withName

withName(name)

"name is the referenced service. The service must exist in\nthe same namespace as the Ingress object."

obj spec.ingress.extraRules.http.paths.backend.service.port

"port of the referenced service. A port name or port number\nis required for a IngressServiceBackend."

fn spec.ingress.extraRules.http.paths.backend.service.port.withName

withName(name)

"name is the name of the port on the Service.\nThis is a mutually exclusive setting with \"Number\"."

fn spec.ingress.extraRules.http.paths.backend.service.port.withNumber

withNumber(number)

"number is the numerical port number (e.g. 80) on the Service.\nThis is a mutually exclusive setting with \"Name\"."

obj spec.ingress.extraTls

"ExtraTLS - additional TLS configuration for ingress\nmust be checked for correctness by user."

fn spec.ingress.extraTls.withHosts

withHosts(hosts)

"hosts is a list of hosts included in the TLS certificate. The values in\nthis list must match the name/s used in the tlsSecret. Defaults to the\nwildcard host setting for the loadbalancer controller fulfilling this\nIngress, if left unspecified."

fn spec.ingress.extraTls.withHostsMixin

withHostsMixin(hosts)

"hosts is a list of hosts included in the TLS certificate. The values in\nthis list must match the name/s used in the tlsSecret. Defaults to the\nwildcard host setting for the loadbalancer controller fulfilling this\nIngress, if left unspecified."

Note: This function appends passed data to existing values

fn spec.ingress.extraTls.withSecretName

withSecretName(secretName)

"secretName is the name of the secret used to terminate TLS traffic on\nport 443. Field is left optional to allow TLS routing based on SNI\nhostname alone. If the SNI host in a listener conflicts with the \"Host\"\nheader field used by an IngressRule, the SNI host is used for termination\nand value of the \"Host\" header is used for routing."

obj spec.ip_filters

"IPFilters defines per target src ip filters\nsupported only with enterprise version of vmauth"

fn spec.ip_filters.withAllow_list

withAllow_list(allow_list)

fn spec.ip_filters.withAllow_listMixin

withAllow_listMixin(allow_list)

Note: This function appends passed data to existing values

fn spec.ip_filters.withDeny_list

withDeny_list(deny_list)

fn spec.ip_filters.withDeny_listMixin

withDeny_listMixin(deny_list)

Note: This function appends passed data to existing values

obj spec.license

"License allows to configure license key to be used for enterprise features.\nUsing license key is supported starting from VictoriaMetrics v1.94.0.\nSee here"

fn spec.license.withKey

withKey(key)

"Enterprise license key. This flag is available only in VictoriaMetrics enterprise.\nTo request a trial license, go to"

obj spec.license.keyRef

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

fn spec.license.keyRef.withKey

withKey(key)

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

fn spec.license.keyRef.withName

withName(name)

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

fn spec.license.keyRef.withOptional

withOptional(optional)

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

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 VMAuth 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\nThis is an alpha field and requires enabling the\nDynamicResourceAllocation feature gate.\n\nThis field is immutable. It can only be set for containers."

fn spec.resources.withClaimsMixin

withClaimsMixin(claims)

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

Note: This function appends passed data to existing values

fn spec.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\nThis is an alpha field and requires enabling the\nDynamicResourceAllocation feature gate.\n\nThis field is immutable. It can only be set for containers."

fn spec.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 vmsingle 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.tlsConfig

"TLSConfig specifies TLSConfig configuration parameters."

fn spec.tlsConfig.withCaFile

withCaFile(caFile)

"Path to the CA cert in the container to use for the targets."

fn spec.tlsConfig.withCertFile

withCertFile(certFile)

"Path to the client cert file in the container for the targets."

fn spec.tlsConfig.withInsecureSkipVerify

withInsecureSkipVerify(insecureSkipVerify)

"Disable target certificate validation."

fn spec.tlsConfig.withKeyFile

withKeyFile(keyFile)

"Path to the client key file in the container for the targets."

fn spec.tlsConfig.withServerName

withServerName(serverName)

"Used to verify the hostname for the targets."

obj spec.tlsConfig.ca

"Stuct containing the CA cert to use for the targets."

obj spec.tlsConfig.ca.configMap

"ConfigMap containing data to use for the targets."

fn spec.tlsConfig.ca.configMap.withKey

withKey(key)

"The key to select."

fn spec.tlsConfig.ca.configMap.withName

withName(name)

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

fn spec.tlsConfig.ca.configMap.withOptional

withOptional(optional)

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

obj spec.tlsConfig.ca.secret

"Secret containing data to use for the targets."

fn spec.tlsConfig.ca.secret.withKey

withKey(key)

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

fn spec.tlsConfig.ca.secret.withName

withName(name)

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

fn spec.tlsConfig.ca.secret.withOptional

withOptional(optional)

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

obj spec.tlsConfig.cert

"Struct containing the client cert file for the targets."

obj spec.tlsConfig.cert.configMap

"ConfigMap containing data to use for the targets."

fn spec.tlsConfig.cert.configMap.withKey

withKey(key)

"The key to select."

fn spec.tlsConfig.cert.configMap.withName

withName(name)

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

fn spec.tlsConfig.cert.configMap.withOptional

withOptional(optional)

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

obj spec.tlsConfig.cert.secret

"Secret containing data to use for the targets."

fn spec.tlsConfig.cert.secret.withKey

withKey(key)

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

fn spec.tlsConfig.cert.secret.withName

withName(name)

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

fn spec.tlsConfig.cert.secret.withOptional

withOptional(optional)

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

obj spec.tlsConfig.keySecret

"Secret containing the client key file for the targets."

fn spec.tlsConfig.keySecret.withKey

withKey(key)

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

fn spec.tlsConfig.keySecret.withName

withName(name)

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

fn spec.tlsConfig.keySecret.withOptional

withOptional(optional)

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

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

"UnauthorizedAccessConfig configures access for un authorized users"

fn spec.unauthorizedAccessConfig.withDiscover_backend_ips

withDiscover_backend_ips(discover_backend_ips)

"DiscoverBackendIPs instructs discovering URLPrefix backend IPs via DNS."

fn spec.unauthorizedAccessConfig.withDrop_src_path_prefix_parts

withDrop_src_path_prefix_parts(drop_src_path_prefix_parts)

"DropSrcPathPrefixParts is the number of /-delimited request path prefix parts to drop before proxying the request to backend.\nSee here for more details."

fn spec.unauthorizedAccessConfig.withHeaders

withHeaders(headers)

"RequestHeaders represent additional http headers, that vmauth uses\nin form of [\"header_key: header_value\"]\nmultiple values for header key:\n[\"header_key: value1,value2\"]\nit's available since 1.68.0 version of vmauth"

fn spec.unauthorizedAccessConfig.withHeadersMixin

withHeadersMixin(headers)

"RequestHeaders represent additional http headers, that vmauth uses\nin form of [\"header_key: header_value\"]\nmultiple values for header key:\n[\"header_key: value1,value2\"]\nit's available since 1.68.0 version of vmauth"

Note: This function appends passed data to existing values

fn spec.unauthorizedAccessConfig.withLoad_balancing_policy

withLoad_balancing_policy(load_balancing_policy)

"LoadBalancingPolicy defines load balancing policy to use for backend urls.\nSupported policies: least_loaded, first_available.\nSee here for more details (default \"least_loaded\")"

fn spec.unauthorizedAccessConfig.withResponse_headers

withResponse_headers(response_headers)

"ResponseHeaders represent additional http headers, that vmauth adds for request response\nin form of [\"header_key: header_value\"]\nmultiple values for header key:\n[\"header_key: value1,value2\"]\nit's available since 1.93.0 version of vmauth"

fn spec.unauthorizedAccessConfig.withResponse_headersMixin

withResponse_headersMixin(response_headers)

"ResponseHeaders represent additional http headers, that vmauth adds for request response\nin form of [\"header_key: header_value\"]\nmultiple values for header key:\n[\"header_key: value1,value2\"]\nit's available since 1.93.0 version of vmauth"

Note: This function appends passed data to existing values

fn spec.unauthorizedAccessConfig.withRetry_status_codes

withRetry_status_codes(retry_status_codes)

"RetryStatusCodes defines http status codes in numeric format for request retries\nCan be defined per target or at VMUser.spec level\ne.g. [429,503]"

fn spec.unauthorizedAccessConfig.withRetry_status_codesMixin

withRetry_status_codesMixin(retry_status_codes)

"RetryStatusCodes defines http status codes in numeric format for request retries\nCan be defined per target or at VMUser.spec level\ne.g. [429,503]"

Note: This function appends passed data to existing values

fn spec.unauthorizedAccessConfig.withSrc_headers

withSrc_headers(src_headers)

"SrcHeaders is an optional list of headers, which must match request headers."

fn spec.unauthorizedAccessConfig.withSrc_headersMixin

withSrc_headersMixin(src_headers)

"SrcHeaders is an optional list of headers, which must match request headers."

Note: This function appends passed data to existing values

fn spec.unauthorizedAccessConfig.withSrc_hosts

withSrc_hosts(src_hosts)

"SrcHosts is an optional list of regular expressions, which must match the request hostname."

fn spec.unauthorizedAccessConfig.withSrc_hostsMixin

withSrc_hostsMixin(src_hosts)

"SrcHosts is an optional list of regular expressions, which must match the request hostname."

Note: This function appends passed data to existing values

fn spec.unauthorizedAccessConfig.withSrc_paths

withSrc_paths(src_paths)

"SrcPaths is an optional list of regular expressions, which must match the request path."

fn spec.unauthorizedAccessConfig.withSrc_pathsMixin

withSrc_pathsMixin(src_paths)

"SrcPaths is an optional list of regular expressions, which must match the request path."

Note: This function appends passed data to existing values

fn spec.unauthorizedAccessConfig.withSrc_query_args

withSrc_query_args(src_query_args)

"SrcQueryArgs is an optional list of query args, which must match request URL query args."

fn spec.unauthorizedAccessConfig.withSrc_query_argsMixin

withSrc_query_argsMixin(src_query_args)

"SrcQueryArgs is an optional list of query args, which must match request URL query args."

Note: This function appends passed data to existing values

fn spec.unauthorizedAccessConfig.withUrl_prefix

withUrl_prefix(url_prefix)

"UrlPrefix contains backend url prefixes for the proxied request url."

fn spec.unauthorizedAccessConfig.withUrl_prefixMixin

withUrl_prefixMixin(url_prefix)

"UrlPrefix contains backend url prefixes for the proxied request url."

Note: This function appends passed data to existing values

obj spec.userNamespaceSelector

"UserNamespaceSelector Namespaces to be selected for VMAuth discovery.\nWorks in combination with Selector.\nNamespaceSelector nil - only objects at VMAuth namespace.\nSelector nil - only objects at NamespaceSelector namespaces.\nIf both nil - behaviour controlled by selectAllByDefault"

fn spec.userNamespaceSelector.withMatchExpressions

withMatchExpressions(matchExpressions)

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

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

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

fn spec.userNamespaceSelector.matchExpressions.withKey

withKey(key)

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

fn spec.userNamespaceSelector.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.userNamespaceSelector.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.userNamespaceSelector.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.userSelector

"UserSelector defines VMUser to be selected for config file generation.\nWorks in combination with NamespaceSelector.\nNamespaceSelector nil - only objects at VMAuth namespace.\nIf both nil - behaviour controlled by selectAllByDefault"

fn spec.userSelector.withMatchExpressions

withMatchExpressions(matchExpressions)

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

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

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

fn spec.userSelector.matchExpressions.withKey

withKey(key)

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

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

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