Skip to content

monitoring.v1.prometheus

"Prometheus defines a Prometheus deployment."

Index

Fields

fn new

new(name)

new returns an instance of Prometheus

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

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

fn spec.withAllowOverlappingBlocks

withAllowOverlappingBlocks(allowOverlappingBlocks)

"AllowOverlappingBlocks enables vertical compaction and vertical query merge in Prometheus. This is still experimental in Prometheus so it may change in any upcoming release."

fn spec.withBaseImage

withBaseImage(baseImage)

"Base image to use for a Prometheus deployment. Deprecated: use 'image' instead"

fn spec.withConfigMaps

withConfigMaps(configMaps)

"ConfigMaps is a list of ConfigMaps in the same namespace as the Prometheus object, which shall be mounted into the Prometheus Pods. The ConfigMaps are mounted into /etc/prometheus/configmaps/."

fn spec.withConfigMapsMixin

withConfigMapsMixin(configMaps)

"ConfigMaps is a list of ConfigMaps in the same namespace as the Prometheus object, which shall be mounted into the Prometheus Pods. The ConfigMaps are mounted into /etc/prometheus/configmaps/."

Note: This function appends passed data to existing values

fn spec.withContainers

withContainers(containers)

"Containers allows injecting additional containers or modifying operator generated containers. This can be used to allow adding an authentication proxy to a Prometheus pod or to change the behavior of an operator generated container. Containers described here modify an operator generated container if they share the same name and modifications are done via a strategic merge patch. The current container names are: prometheus, config-reloader, and thanos-sidecar. Overriding containers is entirely outside the scope of what the maintainers will support and by doing so, you accept that this behaviour may break at any time without notice."

fn spec.withContainersMixin

withContainersMixin(containers)

"Containers allows injecting additional containers or modifying operator generated containers. This can be used to allow adding an authentication proxy to a Prometheus pod or to change the behavior of an operator generated container. Containers described here modify an operator generated container if they share the same name and modifications are done via a strategic merge patch. The current container names are: prometheus, config-reloader, and thanos-sidecar. Overriding containers is entirely outside the scope of what the maintainers will support and by doing so, you accept that this behaviour may break at any time without notice."

Note: This function appends passed data to existing values

fn spec.withDisableCompaction

withDisableCompaction(disableCompaction)

"Disable prometheus compaction."

fn spec.withEnableAdminAPI

withEnableAdminAPI(enableAdminAPI)

"Enable access to prometheus web admin API. Defaults to the value of false. WARNING: Enabling the admin APIs enables mutating endpoints, to delete data, shutdown Prometheus, and more. Enabling this should be done with care and the user is advised to add additional authentication authorization via a proxy to ensure only clients authorized to perform these actions can do so. For more information see https://prometheus.io/docs/prometheus/latest/querying/api/#tsdb-admin-apis"

fn spec.withEnableFeatures

withEnableFeatures(enableFeatures)

"Enable access to Prometheus disabled features. By default, no features are enabled. Enabling disabled features is entirely outside the scope of what the maintainers will support and by doing so, you accept that this behaviour may break at any time without notice. For more information see https://prometheus.io/docs/prometheus/latest/disabled_features/"

fn spec.withEnableFeaturesMixin

withEnableFeaturesMixin(enableFeatures)

"Enable access to Prometheus disabled features. By default, no features are enabled. Enabling disabled features is entirely outside the scope of what the maintainers will support and by doing so, you accept that this behaviour may break at any time without notice. For more information see https://prometheus.io/docs/prometheus/latest/disabled_features/"

Note: This function appends passed data to existing values

fn spec.withEnforcedLabelLimit

withEnforcedLabelLimit(enforcedLabelLimit)

"Per-scrape limit on number of labels that will be accepted for a sample. If more than this number of labels are present post metric-relabeling, the entire scrape will be treated as failed. 0 means no limit. Only valid in Prometheus versions 2.27.0 and newer."

fn spec.withEnforcedLabelNameLengthLimit

withEnforcedLabelNameLengthLimit(enforcedLabelNameLengthLimit)

"Per-scrape limit on length of labels name that will be accepted for a sample. If a label name is longer than this number post metric-relabeling, the entire scrape will be treated as failed. 0 means no limit. Only valid in Prometheus versions 2.27.0 and newer."

fn spec.withEnforcedLabelValueLengthLimit

withEnforcedLabelValueLengthLimit(enforcedLabelValueLengthLimit)

"Per-scrape limit on length of labels value that will be accepted for a sample. If a label value is longer than this number post metric-relabeling, the entire scrape will be treated as failed. 0 means no limit. Only valid in Prometheus versions 2.27.0 and newer."

fn spec.withEnforcedNamespaceLabel

withEnforcedNamespaceLabel(enforcedNamespaceLabel)

"EnforcedNamespaceLabel If set, a label will be added to \n 1. all user-metrics (created by ServiceMonitor, PodMonitor and ProbeConfig object) and 2. in all PrometheusRule objects (except the ones excluded in prometheusRulesExcludedFromEnforce) to * alerting & recording rules and * the metrics used in their expressions (expr). \n Label name is this field's value. Label value is the namespace of the created object (mentioned above)."

fn spec.withEnforcedSampleLimit

withEnforcedSampleLimit(enforcedSampleLimit)

"EnforcedSampleLimit defines global limit on number of scraped samples that will be accepted. This overrides any SampleLimit set per ServiceMonitor or/and PodMonitor. It is meant to be used by admins to enforce the SampleLimit to keep overall number of samples/series under the desired limit. Note that if SampleLimit is lower that value will be taken instead."

fn spec.withEnforcedTargetLimit

withEnforcedTargetLimit(enforcedTargetLimit)

"EnforcedTargetLimit defines a global limit on the number of scraped targets. This overrides any TargetLimit set per ServiceMonitor or/and PodMonitor. It is meant to be used by admins to enforce the TargetLimit to keep the overall number of targets under the desired limit. Note that if TargetLimit is lower, that value will be taken instead, except if either value is zero, in which case the non-zero value will be used. If both values are zero, no limit is enforced."

fn spec.withEvaluationInterval

withEvaluationInterval(evaluationInterval)

"Interval between consecutive evaluations. Default: 1m"

fn spec.withExternalLabels

withExternalLabels(externalLabels)

"The labels to add to any time series or alerts when communicating with external systems (federation, remote storage, Alertmanager)."

fn spec.withExternalLabelsMixin

withExternalLabelsMixin(externalLabels)

"The labels to add to any time series or alerts when communicating with external systems (federation, remote storage, Alertmanager)."

Note: This function appends passed data to existing values

fn spec.withExternalUrl

withExternalUrl(externalUrl)

"The external URL the Prometheus instances will be available under. This is necessary to generate correct URLs. This is necessary if Prometheus is not served from root of a DNS name."

fn spec.withIgnoreNamespaceSelectors

withIgnoreNamespaceSelectors(ignoreNamespaceSelectors)

"IgnoreNamespaceSelectors if set to true will ignore NamespaceSelector settings from the podmonitor and servicemonitor configs, and they will only discover endpoints within their current namespace. Defaults to false."

fn spec.withImage

withImage(image)

"Image if specified has precedence over baseImage, tag and sha combinations. Specifying the version is still necessary to ensure the Prometheus Operator knows what version of Prometheus is being configured."

fn spec.withImagePullSecrets

withImagePullSecrets(imagePullSecrets)

"An optional list of references to secrets in the same namespace to use for pulling prometheus and alertmanager images from registries see http://kubernetes.io/docs/user-guide/images#specifying-imagepullsecrets-on-a-pod"

fn spec.withImagePullSecretsMixin

withImagePullSecretsMixin(imagePullSecrets)

"An optional list of references to secrets in the same namespace to use for pulling prometheus and alertmanager images from registries see http://kubernetes.io/docs/user-guide/images#specifying-imagepullsecrets-on-a-pod"

Note: This function appends passed data to existing values

fn spec.withInitContainers

withInitContainers(initContainers)

"InitContainers allows adding initContainers to the pod definition. Those can be used to e.g. fetch secrets for injection into the Prometheus configuration from external sources. Any errors during the execution of an initContainer will lead to a restart of the Pod. More info: https://kubernetes.io/docs/concepts/workloads/pods/init-containers/ InitContainers described here modify an operator generated init containers if they share the same name and modifications are done via a strategic merge patch. The current init container name is: init-config-reloader. Overriding init containers is entirely outside the scope of what the maintainers will support and by doing so, you accept that this behaviour may break at any time without notice."

fn spec.withInitContainersMixin

withInitContainersMixin(initContainers)

"InitContainers allows adding initContainers to the pod definition. Those can be used to e.g. fetch secrets for injection into the Prometheus configuration from external sources. Any errors during the execution of an initContainer will lead to a restart of the Pod. More info: https://kubernetes.io/docs/concepts/workloads/pods/init-containers/ InitContainers described here modify an operator generated init containers if they share the same name and modifications are done via a strategic merge patch. The current init container name is: init-config-reloader. Overriding init containers is entirely outside the scope of what the maintainers will support and by doing so, you accept that this behaviour may break at any time without notice."

Note: This function appends passed data to existing values

fn spec.withListenLocal

withListenLocal(listenLocal)

"ListenLocal makes the Prometheus server listen on loopback, so that it does not bind against the Pod IP."

fn spec.withLogFormat

withLogFormat(logFormat)

"Log format for Prometheus to be configured with."

fn spec.withLogLevel

withLogLevel(logLevel)

"Log level for Prometheus to be configured with."

fn spec.withNodeSelector

withNodeSelector(nodeSelector)

"Define which Nodes the Pods are scheduled on."

fn spec.withNodeSelectorMixin

withNodeSelectorMixin(nodeSelector)

"Define which Nodes the Pods are scheduled on."

Note: This function appends passed data to existing values

fn spec.withOverrideHonorLabels

withOverrideHonorLabels(overrideHonorLabels)

"OverrideHonorLabels if set to true overrides all user configured honor_labels. If HonorLabels is set in ServiceMonitor or PodMonitor to true, this overrides honor_labels to false."

fn spec.withOverrideHonorTimestamps

withOverrideHonorTimestamps(overrideHonorTimestamps)

"OverrideHonorTimestamps allows to globally enforce honoring timestamps in all scrape configs."

fn spec.withPaused

withPaused(paused)

"When a Prometheus deployment is paused, no actions except for deletion will be performed on the underlying objects."

fn spec.withPortName

withPortName(portName)

"Port name used for the pods and governing service. This defaults to web"

fn spec.withPriorityClassName

withPriorityClassName(priorityClassName)

"Priority class assigned to the Pods"

fn spec.withPrometheusExternalLabelName

withPrometheusExternalLabelName(prometheusExternalLabelName)

"Name of Prometheus external label used to denote Prometheus instance name. Defaults to the value of prometheus. External label will not be added when value is set to empty string (\"\")."

fn spec.withPrometheusRulesExcludedFromEnforce

withPrometheusRulesExcludedFromEnforce(prometheusRulesExcludedFromEnforce)

"PrometheusRulesExcludedFromEnforce - list of prometheus rules to be excluded from enforcing of adding namespace labels. Works only if enforcedNamespaceLabel set to true. Make sure both ruleNamespace and ruleName are set for each pair"

fn spec.withPrometheusRulesExcludedFromEnforceMixin

withPrometheusRulesExcludedFromEnforceMixin(prometheusRulesExcludedFromEnforce)

"PrometheusRulesExcludedFromEnforce - list of prometheus rules to be excluded from enforcing of adding namespace labels. Works only if enforcedNamespaceLabel set to true. Make sure both ruleNamespace and ruleName are set for each pair"

Note: This function appends passed data to existing values

fn spec.withQueryLogFile

withQueryLogFile(queryLogFile)

"QueryLogFile specifies the file to which PromQL queries are logged. Note that this location must be writable, and can be persisted using an attached volume. Alternatively, the location can be set to a stdout location such as /dev/stdout to log querie information to the default Prometheus log stream. This is only available in versions of Prometheus >= 2.16.0. For more details, see the Prometheus docs (https://prometheus.io/docs/guides/query-log/)"

fn spec.withRemoteRead

withRemoteRead(remoteRead)

"If specified, the remote_read spec. This is an experimental feature, it may change in any upcoming release in a breaking way."

fn spec.withRemoteReadMixin

withRemoteReadMixin(remoteRead)

"If specified, the remote_read spec. This is an experimental feature, it may change in any upcoming release in a breaking way."

Note: This function appends passed data to existing values

fn spec.withRemoteWrite

withRemoteWrite(remoteWrite)

"If specified, the remote_write spec. This is an experimental feature, it may change in any upcoming release in a breaking way."

fn spec.withRemoteWriteMixin

withRemoteWriteMixin(remoteWrite)

"If specified, the remote_write spec. This is an experimental feature, it may change in any upcoming release in a breaking way."

Note: This function appends passed data to existing values

fn spec.withReplicaExternalLabelName

withReplicaExternalLabelName(replicaExternalLabelName)

"Name of Prometheus external label used to denote replica name. Defaults to the value of prometheus_replica. External label will not be added when value is set to empty string (\"\")."

fn spec.withReplicas

withReplicas(replicas)

"Number of replicas of each shard to deploy for a Prometheus deployment. Number of replicas multiplied by shards is the total number of Pods created."

fn spec.withRetention

withRetention(retention)

"Time duration Prometheus shall retain data for. Default is '24h', and must match the regular expression [0-9]+(ms|s|m|h|d|w|y) (milliseconds seconds minutes hours days weeks years)."

fn spec.withRetentionSize

withRetentionSize(retentionSize)

"Maximum amount of disk space used by blocks. Supported units: B, KB, MB, GB, TB, PB, EB. Ex: 512MB."

fn spec.withRoutePrefix

withRoutePrefix(routePrefix)

"The route prefix Prometheus registers HTTP handlers for. This is useful, if using ExternalURL and a proxy is rewriting HTTP routes of a request, and the actual ExternalURL is still true, but the server serves requests under a different route prefix. For example for use with kubectl proxy."

fn spec.withScrapeInterval

withScrapeInterval(scrapeInterval)

"Interval between consecutive scrapes. Default: 1m"

fn spec.withScrapeTimeout

withScrapeTimeout(scrapeTimeout)

"Number of seconds to wait for target to respond before erroring."

fn spec.withSecrets

withSecrets(secrets)

"Secrets is a list of Secrets in the same namespace as the Prometheus object, which shall be mounted into the Prometheus Pods. The Secrets are mounted into /etc/prometheus/secrets/."

fn spec.withSecretsMixin

withSecretsMixin(secrets)

"Secrets is a list of Secrets in the same namespace as the Prometheus object, which shall be mounted into the Prometheus Pods. The Secrets are mounted into /etc/prometheus/secrets/."

Note: This function appends passed data to existing values

fn spec.withServiceAccountName

withServiceAccountName(serviceAccountName)

"ServiceAccountName is the name of the ServiceAccount to use to run the Prometheus Pods."

fn spec.withSha

withSha(sha)

"SHA of Prometheus container image to be deployed. Defaults to the value of version. Similar to a tag, but the SHA explicitly deploys an immutable container image. Version and Tag are ignored if SHA is set. Deprecated: use 'image' instead. The image digest can be specified as part of the image URL."

fn spec.withShards

withShards(shards)

"EXPERIMENTAL: Number of shards to distribute targets onto. Number of replicas multiplied by shards is the total number of Pods created. Note that scaling down shards will not reshard data onto remaining instances, it must be manually moved. Increasing shards will not reshard data either but it will continue to be available from the same instances. To query globally use Thanos sidecar and Thanos querier or remote write data to a central location. Sharding is done on the content of the __address__ target meta-label."

fn spec.withTag

withTag(tag)

"Tag of Prometheus container image to be deployed. Defaults to the value of version. Version is ignored if Tag is set. Deprecated: use 'image' instead. The image tag can be specified as part of the image URL."

fn spec.withTolerations

withTolerations(tolerations)

"If specified, the pod's tolerations."

fn spec.withTolerationsMixin

withTolerationsMixin(tolerations)

"If specified, the pod's tolerations."

Note: This function appends passed data to existing values

fn spec.withTopologySpreadConstraints

withTopologySpreadConstraints(topologySpreadConstraints)

"If specified, the pod's topology spread constraints."

fn spec.withTopologySpreadConstraintsMixin

withTopologySpreadConstraintsMixin(topologySpreadConstraints)

"If specified, the pod's topology spread constraints."

Note: This function appends passed data to existing values

fn spec.withVersion

withVersion(version)

"Version of Prometheus to be deployed."

fn spec.withVolumeMounts

withVolumeMounts(volumeMounts)

"VolumeMounts allows configuration of additional VolumeMounts on the output StatefulSet definition. VolumeMounts specified will be appended to other VolumeMounts in the prometheus container, that are generated as a result of StorageSpec objects."

fn spec.withVolumeMountsMixin

withVolumeMountsMixin(volumeMounts)

"VolumeMounts allows configuration of additional VolumeMounts on the output StatefulSet definition. VolumeMounts specified will be appended to other VolumeMounts in the prometheus container, that are generated as a result of StorageSpec objects."

Note: This function appends passed data to existing values

fn spec.withVolumes

withVolumes(volumes)

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

fn spec.withVolumesMixin

withVolumesMixin(volumes)

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

Note: This function appends passed data to existing values

fn spec.withWalCompression

withWalCompression(walCompression)

"Enable compression of the write-ahead log using Snappy. This flag is only available in versions of Prometheus >= 2.11.0."

obj spec.additionalAlertManagerConfigs

"AdditionalAlertManagerConfigs allows specifying a key of a Secret containing additional Prometheus AlertManager configurations. AlertManager configurations specified are appended to the configurations generated by the Prometheus Operator. Job configurations specified must have the form as specified in the official Prometheus documentation: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#alertmanager_config. As AlertManager configs are appended, the user is responsible to make sure it is valid. Note that using this feature may expose the possibility to break upgrades of Prometheus. It is advised to review Prometheus release notes to ensure that no incompatible AlertManager configs are going to break Prometheus after the upgrade."

fn spec.additionalAlertManagerConfigs.withKey

withKey(key)

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

fn spec.additionalAlertManagerConfigs.withName

withName(name)

"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"

fn spec.additionalAlertManagerConfigs.withOptional

withOptional(optional)

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

obj spec.additionalAlertRelabelConfigs

"AdditionalAlertRelabelConfigs allows specifying a key of a Secret containing additional Prometheus alert relabel configurations. Alert relabel configurations specified are appended to the configurations generated by the Prometheus Operator. Alert relabel configurations specified must have the form as specified in the official Prometheus documentation: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#alert_relabel_configs. As alert relabel configs are appended, the user is responsible to make sure it is valid. Note that using this feature may expose the possibility to break upgrades of Prometheus. It is advised to review Prometheus release notes to ensure that no incompatible alert relabel configs are going to break Prometheus after the upgrade."

fn spec.additionalAlertRelabelConfigs.withKey

withKey(key)

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

fn spec.additionalAlertRelabelConfigs.withName

withName(name)

"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"

fn spec.additionalAlertRelabelConfigs.withOptional

withOptional(optional)

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

obj spec.additionalScrapeConfigs

"AdditionalScrapeConfigs allows specifying a key of a Secret containing additional Prometheus scrape configurations. Scrape configurations specified are appended to the configurations generated by the Prometheus Operator. Job configurations specified must have the form as specified in the official Prometheus documentation: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#scrape_config. As scrape configs are appended, the user is responsible to make sure it is valid. Note that using this feature may expose the possibility to break upgrades of Prometheus. It is advised to review Prometheus release notes to ensure that no incompatible scrape configs are going to break Prometheus after the upgrade."

fn spec.additionalScrapeConfigs.withKey

withKey(key)

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

fn spec.additionalScrapeConfigs.withName

withName(name)

"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"

fn spec.additionalScrapeConfigs.withOptional

withOptional(optional)

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

obj spec.affinity

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

obj spec.affinity.nodeAffinity

"Describes node affinity scheduling rules for the pod."

fn spec.affinity.nodeAffinity.withPreferredDuringSchedulingIgnoredDuringExecution

withPreferredDuringSchedulingIgnoredDuringExecution(preferredDuringSchedulingIgnoredDuringExecution)

"The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding \"weight\" to the sum if the node matches the corresponding matchExpressions; the node(s) with the highest sum are the most preferred."

fn spec.affinity.nodeAffinity.withPreferredDuringSchedulingIgnoredDuringExecutionMixin

withPreferredDuringSchedulingIgnoredDuringExecutionMixin(preferredDuringSchedulingIgnoredDuringExecution)

"The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding \"weight\" to the sum if the node matches the corresponding matchExpressions; the node(s) with the highest sum are the most preferred."

Note: This function appends passed data to existing values

obj spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution

"The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding \"weight\" to the sum if the node matches the corresponding matchExpressions; the node(s) with the highest sum are the most preferred."

fn spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.withWeight

withWeight(weight)

"Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100."

obj spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference

"A node selector term, associated with the corresponding weight."

fn spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.withMatchExpressions

withMatchExpressions(matchExpressions)

"A list of node selector requirements by node's labels."

fn spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.withMatchExpressionsMixin

withMatchExpressionsMixin(matchExpressions)

"A list of node selector requirements by node's labels."

Note: This function appends passed data to existing values

fn spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.withMatchFields

withMatchFields(matchFields)

"A list of node selector requirements by node's fields."

fn spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.withMatchFieldsMixin

withMatchFieldsMixin(matchFields)

"A list of node selector requirements by node's fields."

Note: This function appends passed data to existing values

obj spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.matchExpressions

"A list of node selector requirements by node's labels."

fn spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.matchExpressions.withKey

withKey(key)

"The label key that the selector applies to."

fn spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.matchExpressions.withOperator

withOperator(operator)

"Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt."

fn spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.matchExpressions.withValues

withValues(values)

"An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch."

fn spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.matchExpressions.withValuesMixin

withValuesMixin(values)

"An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch."

Note: This function appends passed data to existing values

obj spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.matchFields

"A list of node selector requirements by node's fields."

fn spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.matchFields.withKey

withKey(key)

"The label key that the selector applies to."

fn spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.matchFields.withOperator

withOperator(operator)

"Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt."

fn spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.matchFields.withValues

withValues(values)

"An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch."

fn spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.matchFields.withValuesMixin

withValuesMixin(values)

"An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch."

Note: This function appends passed data to existing values

obj spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution

"If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to an update), the system may or may not try to eventually evict the pod from its node."

fn spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.withNodeSelectorTerms

withNodeSelectorTerms(nodeSelectorTerms)

"Required. A list of node selector terms. The terms are ORed."

fn spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.withNodeSelectorTermsMixin

withNodeSelectorTermsMixin(nodeSelectorTerms)

"Required. A list of node selector terms. The terms are ORed."

Note: This function appends passed data to existing values

obj spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms

"Required. A list of node selector terms. The terms are ORed."

fn spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.withMatchExpressions

withMatchExpressions(matchExpressions)

"A list of node selector requirements by node's labels."

fn spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.withMatchExpressionsMixin

withMatchExpressionsMixin(matchExpressions)

"A list of node selector requirements by node's labels."

Note: This function appends passed data to existing values

fn spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.withMatchFields

withMatchFields(matchFields)

"A list of node selector requirements by node's fields."

fn spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.withMatchFieldsMixin

withMatchFieldsMixin(matchFields)

"A list of node selector requirements by node's fields."

Note: This function appends passed data to existing values

obj spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchExpressions

"A list of node selector requirements by node's labels."

fn spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchExpressions.withKey

withKey(key)

"The label key that the selector applies to."

fn spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchExpressions.withOperator

withOperator(operator)

"Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt."

fn spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchExpressions.withValues

withValues(values)

"An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch."

fn spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchExpressions.withValuesMixin

withValuesMixin(values)

"An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch."

Note: This function appends passed data to existing values

obj spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchFields

"A list of node selector requirements by node's fields."

fn spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchFields.withKey

withKey(key)

"The label key that the selector applies to."

fn spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchFields.withOperator

withOperator(operator)

"Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt."

fn spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchFields.withValues

withValues(values)

"An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch."

fn spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchFields.withValuesMixin

withValuesMixin(values)

"An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch."

Note: This function appends passed data to existing values

obj spec.affinity.podAffinity

"Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s))."

fn spec.affinity.podAffinity.withPreferredDuringSchedulingIgnoredDuringExecution

withPreferredDuringSchedulingIgnoredDuringExecution(preferredDuringSchedulingIgnoredDuringExecution)

"The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding \"weight\" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred."

fn spec.affinity.podAffinity.withPreferredDuringSchedulingIgnoredDuringExecutionMixin

withPreferredDuringSchedulingIgnoredDuringExecutionMixin(preferredDuringSchedulingIgnoredDuringExecution)

"The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding \"weight\" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred."

Note: This function appends passed data to existing values

fn spec.affinity.podAffinity.withRequiredDuringSchedulingIgnoredDuringExecution

withRequiredDuringSchedulingIgnoredDuringExecution(requiredDuringSchedulingIgnoredDuringExecution)

"If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied."

fn spec.affinity.podAffinity.withRequiredDuringSchedulingIgnoredDuringExecutionMixin

withRequiredDuringSchedulingIgnoredDuringExecutionMixin(requiredDuringSchedulingIgnoredDuringExecution)

"If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied."

Note: This function appends passed data to existing values

obj spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution

"The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding \"weight\" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred."

fn spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.withWeight

withWeight(weight)

"weight associated with matching the corresponding podAffinityTerm, in the range 1-100."

obj spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm

"Required. A pod affinity term, associated with the corresponding weight."

fn spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.withNamespaces

withNamespaces(namespaces)

"namespaces specifies which namespaces the labelSelector applies to (matches against); null or empty list means \"this pod's namespace\

fn spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.withNamespacesMixin

withNamespacesMixin(namespaces)

"namespaces specifies which namespaces the labelSelector applies to (matches against); null or empty list means \"this pod's namespace\

Note: This function appends passed data to existing values

fn spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.withTopologyKey

withTopologyKey(topologyKey)

"This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed."

obj spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector

"A label query over a set of resources, in this case pods."

fn spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.withMatchExpressions

withMatchExpressions(matchExpressions)

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

fn spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.withMatchExpressionsMixin

withMatchExpressionsMixin(matchExpressions)

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

Note: This function appends passed data to existing values

fn spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.withMatchLabels

withMatchLabels(matchLabels)

"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is \"key\", the operator is \"In\", and the values array contains only \"value\". The requirements are ANDed."

fn spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.withMatchLabelsMixin

withMatchLabelsMixin(matchLabels)

"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is \"key\", the operator is \"In\", and the values array contains only \"value\". The requirements are ANDed."

Note: This function appends passed data to existing values

obj spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.matchExpressions

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

fn spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.matchExpressions.withKey

withKey(key)

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

fn spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.matchExpressions.withOperator

withOperator(operator)

"operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist."

fn spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.matchExpressions.withValues

withValues(values)

"values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch."

fn spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.matchExpressions.withValuesMixin

withValuesMixin(values)

"values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch."

Note: This function appends passed data to existing values

obj spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution

"If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied."

fn spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.withNamespaces

withNamespaces(namespaces)

"namespaces specifies which namespaces the labelSelector applies to (matches against); null or empty list means \"this pod's namespace\

fn spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.withNamespacesMixin

withNamespacesMixin(namespaces)

"namespaces specifies which namespaces the labelSelector applies to (matches against); null or empty list means \"this pod's namespace\

Note: This function appends passed data to existing values

fn spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.withTopologyKey

withTopologyKey(topologyKey)

"This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed."

obj spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector

"A label query over a set of resources, in this case pods."

fn spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.withMatchExpressions

withMatchExpressions(matchExpressions)

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

fn spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.withMatchExpressionsMixin

withMatchExpressionsMixin(matchExpressions)

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

Note: This function appends passed data to existing values

fn spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.withMatchLabels

withMatchLabels(matchLabels)

"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is \"key\", the operator is \"In\", and the values array contains only \"value\". The requirements are ANDed."

fn spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.withMatchLabelsMixin

withMatchLabelsMixin(matchLabels)

"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is \"key\", the operator is \"In\", and the values array contains only \"value\". The requirements are ANDed."

Note: This function appends passed data to existing values

obj spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.matchExpressions

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

fn spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.matchExpressions.withKey

withKey(key)

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

fn spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.matchExpressions.withOperator

withOperator(operator)

"operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist."

fn spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.matchExpressions.withValues

withValues(values)

"values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch."

fn spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.matchExpressions.withValuesMixin

withValuesMixin(values)

"values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch."

Note: This function appends passed data to existing values

obj spec.affinity.podAntiAffinity

"Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s))."

fn spec.affinity.podAntiAffinity.withPreferredDuringSchedulingIgnoredDuringExecution

withPreferredDuringSchedulingIgnoredDuringExecution(preferredDuringSchedulingIgnoredDuringExecution)

"The scheduler will prefer to schedule pods to nodes that satisfy the anti-affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling anti-affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding \"weight\" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred."

fn spec.affinity.podAntiAffinity.withPreferredDuringSchedulingIgnoredDuringExecutionMixin

withPreferredDuringSchedulingIgnoredDuringExecutionMixin(preferredDuringSchedulingIgnoredDuringExecution)

"The scheduler will prefer to schedule pods to nodes that satisfy the anti-affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling anti-affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding \"weight\" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred."

Note: This function appends passed data to existing values

fn spec.affinity.podAntiAffinity.withRequiredDuringSchedulingIgnoredDuringExecution

withRequiredDuringSchedulingIgnoredDuringExecution(requiredDuringSchedulingIgnoredDuringExecution)

"If the anti-affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the anti-affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied."

fn spec.affinity.podAntiAffinity.withRequiredDuringSchedulingIgnoredDuringExecutionMixin

withRequiredDuringSchedulingIgnoredDuringExecutionMixin(requiredDuringSchedulingIgnoredDuringExecution)

"If the anti-affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the anti-affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied."

Note: This function appends passed data to existing values

obj spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution

"The scheduler will prefer to schedule pods to nodes that satisfy the anti-affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling anti-affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding \"weight\" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred."

fn spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.withWeight

withWeight(weight)

"weight associated with matching the corresponding podAffinityTerm, in the range 1-100."

obj spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm

"Required. A pod affinity term, associated with the corresponding weight."

fn spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.withNamespaces

withNamespaces(namespaces)

"namespaces specifies which namespaces the labelSelector applies to (matches against); null or empty list means \"this pod's namespace\

fn spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.withNamespacesMixin

withNamespacesMixin(namespaces)

"namespaces specifies which namespaces the labelSelector applies to (matches against); null or empty list means \"this pod's namespace\

Note: This function appends passed data to existing values

fn spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.withTopologyKey

withTopologyKey(topologyKey)

"This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed."

obj spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector

"A label query over a set of resources, in this case pods."

fn spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.withMatchExpressions

withMatchExpressions(matchExpressions)

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

fn spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.withMatchExpressionsMixin

withMatchExpressionsMixin(matchExpressions)

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

Note: This function appends passed data to existing values

fn spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.withMatchLabels

withMatchLabels(matchLabels)

"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is \"key\", the operator is \"In\", and the values array contains only \"value\". The requirements are ANDed."

fn spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.withMatchLabelsMixin

withMatchLabelsMixin(matchLabels)

"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is \"key\", the operator is \"In\", and the values array contains only \"value\". The requirements are ANDed."

Note: This function appends passed data to existing values

obj spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.matchExpressions

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

fn spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.matchExpressions.withKey

withKey(key)

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

fn spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.matchExpressions.withOperator

withOperator(operator)

"operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist."

fn spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.matchExpressions.withValues

withValues(values)

"values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch."

fn spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.matchExpressions.withValuesMixin

withValuesMixin(values)

"values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch."

Note: This function appends passed data to existing values

obj spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution

"If the anti-affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the anti-affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied."

fn spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.withNamespaces

withNamespaces(namespaces)

"namespaces specifies which namespaces the labelSelector applies to (matches against); null or empty list means \"this pod's namespace\

fn spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.withNamespacesMixin

withNamespacesMixin(namespaces)

"namespaces specifies which namespaces the labelSelector applies to (matches against); null or empty list means \"this pod's namespace\

Note: This function appends passed data to existing values

fn spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.withTopologyKey

withTopologyKey(topologyKey)

"This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed."

obj spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector

"A label query over a set of resources, in this case pods."

fn spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.withMatchExpressions

withMatchExpressions(matchExpressions)

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

fn spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.withMatchExpressionsMixin

withMatchExpressionsMixin(matchExpressions)

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

Note: This function appends passed data to existing values

fn spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.withMatchLabels

withMatchLabels(matchLabels)

"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is \"key\", the operator is \"In\", and the values array contains only \"value\". The requirements are ANDed."

fn spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.withMatchLabelsMixin

withMatchLabelsMixin(matchLabels)

"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is \"key\", the operator is \"In\", and the values array contains only \"value\". The requirements are ANDed."

Note: This function appends passed data to existing values

obj spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.matchExpressions

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

fn spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.matchExpressions.withKey

withKey(key)

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

fn spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.matchExpressions.withOperator

withOperator(operator)

"operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist."

fn spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.matchExpressions.withValues

withValues(values)

"values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch."

fn spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.matchExpressions.withValuesMixin

withValuesMixin(values)

"values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch."

Note: This function appends passed data to existing values

obj spec.alerting

"Define details regarding alerting."

fn spec.alerting.withAlertmanagers

withAlertmanagers(alertmanagers)

"AlertmanagerEndpoints Prometheus should fire alerts against."

fn spec.alerting.withAlertmanagersMixin

withAlertmanagersMixin(alertmanagers)

"AlertmanagerEndpoints Prometheus should fire alerts against."

Note: This function appends passed data to existing values

obj spec.alerting.alertmanagers

"AlertmanagerEndpoints Prometheus should fire alerts against."

fn spec.alerting.alertmanagers.withApiVersion

withApiVersion(apiVersion)

"Version of the Alertmanager API that Prometheus uses to send alerts. It can be \"v1\" or \"v2\"."

fn spec.alerting.alertmanagers.withBearerTokenFile

withBearerTokenFile(bearerTokenFile)

"BearerTokenFile to read from filesystem to use when authenticating to Alertmanager."

fn spec.alerting.alertmanagers.withName

withName(name)

"Name of Endpoints object in Namespace."

fn spec.alerting.alertmanagers.withNamespace

withNamespace(namespace)

"Namespace of Endpoints object."

fn spec.alerting.alertmanagers.withPathPrefix

withPathPrefix(pathPrefix)

"Prefix for the HTTP path alerts are pushed to."

fn spec.alerting.alertmanagers.withPort

withPort(port)

"Port the Alertmanager API is exposed on."

fn spec.alerting.alertmanagers.withScheme

withScheme(scheme)

"Scheme to use when firing alerts."

fn spec.alerting.alertmanagers.withTimeout

withTimeout(timeout)

"Timeout is a per-target Alertmanager timeout when pushing alerts."

obj spec.alerting.alertmanagers.authorization

"Authorization section for this alertmanager endpoint"

fn spec.alerting.alertmanagers.authorization.withType

withType(type)

"Set the authentication type. Defaults to Bearer, Basic will cause an error"

obj spec.alerting.alertmanagers.authorization.credentials

"The secret's key that contains the credentials of the request"

fn spec.alerting.alertmanagers.authorization.credentials.withKey

withKey(key)

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

fn spec.alerting.alertmanagers.authorization.credentials.withName

withName(name)

"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"

fn spec.alerting.alertmanagers.authorization.credentials.withOptional

withOptional(optional)

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

obj spec.alerting.alertmanagers.tlsConfig

"TLS Config to use for alertmanager connection."

fn spec.alerting.alertmanagers.tlsConfig.withCaFile

withCaFile(caFile)

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

fn spec.alerting.alertmanagers.tlsConfig.withCertFile

withCertFile(certFile)

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

fn spec.alerting.alertmanagers.tlsConfig.withInsecureSkipVerify

withInsecureSkipVerify(insecureSkipVerify)

"Disable target certificate validation."

fn spec.alerting.alertmanagers.tlsConfig.withKeyFile

withKeyFile(keyFile)

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

fn spec.alerting.alertmanagers.tlsConfig.withServerName

withServerName(serverName)

"Used to verify the hostname for the targets."

obj spec.alerting.alertmanagers.tlsConfig.ca

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

obj spec.alerting.alertmanagers.tlsConfig.ca.configMap

"ConfigMap containing data to use for the targets."

fn spec.alerting.alertmanagers.tlsConfig.ca.configMap.withKey

withKey(key)

"The key to select."

fn spec.alerting.alertmanagers.tlsConfig.ca.configMap.withName

withName(name)

"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"

fn spec.alerting.alertmanagers.tlsConfig.ca.configMap.withOptional

withOptional(optional)

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

obj spec.alerting.alertmanagers.tlsConfig.ca.secret

"Secret containing data to use for the targets."

fn spec.alerting.alertmanagers.tlsConfig.ca.secret.withKey

withKey(key)

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

fn spec.alerting.alertmanagers.tlsConfig.ca.secret.withName

withName(name)

"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"

fn spec.alerting.alertmanagers.tlsConfig.ca.secret.withOptional

withOptional(optional)

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

obj spec.alerting.alertmanagers.tlsConfig.cert

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

obj spec.alerting.alertmanagers.tlsConfig.cert.configMap

"ConfigMap containing data to use for the targets."

fn spec.alerting.alertmanagers.tlsConfig.cert.configMap.withKey

withKey(key)

"The key to select."

fn spec.alerting.alertmanagers.tlsConfig.cert.configMap.withName

withName(name)

"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"

fn spec.alerting.alertmanagers.tlsConfig.cert.configMap.withOptional

withOptional(optional)

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

obj spec.alerting.alertmanagers.tlsConfig.cert.secret

"Secret containing data to use for the targets."

fn spec.alerting.alertmanagers.tlsConfig.cert.secret.withKey

withKey(key)

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

fn spec.alerting.alertmanagers.tlsConfig.cert.secret.withName

withName(name)

"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"

fn spec.alerting.alertmanagers.tlsConfig.cert.secret.withOptional

withOptional(optional)

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

obj spec.alerting.alertmanagers.tlsConfig.keySecret

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

fn spec.alerting.alertmanagers.tlsConfig.keySecret.withKey

withKey(key)

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

fn spec.alerting.alertmanagers.tlsConfig.keySecret.withName

withName(name)

"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"

fn spec.alerting.alertmanagers.tlsConfig.keySecret.withOptional

withOptional(optional)

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

obj spec.apiserverConfig

"APIServerConfig allows specifying a host and auth methods to access apiserver. If left empty, Prometheus is assumed to run inside of the cluster and will discover API servers automatically and use the pod's CA certificate and bearer token file at /var/run/secrets/kubernetes.io/serviceaccount/."

fn spec.apiserverConfig.withBearerToken

withBearerToken(bearerToken)

"Bearer token for accessing apiserver."

fn spec.apiserverConfig.withBearerTokenFile

withBearerTokenFile(bearerTokenFile)

"File to read bearer token for accessing apiserver."

fn spec.apiserverConfig.withHost

withHost(host)

"Host of apiserver. A valid string consisting of a hostname or IP followed by an optional port number"

obj spec.apiserverConfig.authorization

"Authorization section for accessing apiserver"

fn spec.apiserverConfig.authorization.withCredentialsFile

withCredentialsFile(credentialsFile)

"File to read a secret from, mutually exclusive with Credentials (from SafeAuthorization)"

fn spec.apiserverConfig.authorization.withType

withType(type)

"Set the authentication type. Defaults to Bearer, Basic will cause an error"

obj spec.apiserverConfig.authorization.credentials

"The secret's key that contains the credentials of the request"

fn spec.apiserverConfig.authorization.credentials.withKey

withKey(key)

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

fn spec.apiserverConfig.authorization.credentials.withName

withName(name)

"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"

fn spec.apiserverConfig.authorization.credentials.withOptional

withOptional(optional)

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

obj spec.apiserverConfig.basicAuth

"BasicAuth allow an endpoint to authenticate over basic authentication"

obj spec.apiserverConfig.basicAuth.password

"The secret in the service monitor namespace that contains the password for authentication."

fn spec.apiserverConfig.basicAuth.password.withKey

withKey(key)

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

fn spec.apiserverConfig.basicAuth.password.withName

withName(name)

"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"

fn spec.apiserverConfig.basicAuth.password.withOptional

withOptional(optional)

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

obj spec.apiserverConfig.basicAuth.username

"The secret in the service monitor namespace that contains the username for authentication."

fn spec.apiserverConfig.basicAuth.username.withKey

withKey(key)

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

fn spec.apiserverConfig.basicAuth.username.withName

withName(name)

"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"

fn spec.apiserverConfig.basicAuth.username.withOptional

withOptional(optional)

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

obj spec.apiserverConfig.tlsConfig

"TLS Config to use for accessing apiserver."

fn spec.apiserverConfig.tlsConfig.withCaFile

withCaFile(caFile)

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

fn spec.apiserverConfig.tlsConfig.withCertFile

withCertFile(certFile)

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

fn spec.apiserverConfig.tlsConfig.withInsecureSkipVerify

withInsecureSkipVerify(insecureSkipVerify)

"Disable target certificate validation."

fn spec.apiserverConfig.tlsConfig.withKeyFile

withKeyFile(keyFile)

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

fn spec.apiserverConfig.tlsConfig.withServerName

withServerName(serverName)

"Used to verify the hostname for the targets."

obj spec.apiserverConfig.tlsConfig.ca

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

obj spec.apiserverConfig.tlsConfig.ca.configMap

"ConfigMap containing data to use for the targets."

fn spec.apiserverConfig.tlsConfig.ca.configMap.withKey

withKey(key)

"The key to select."

fn spec.apiserverConfig.tlsConfig.ca.configMap.withName

withName(name)

"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"

fn spec.apiserverConfig.tlsConfig.ca.configMap.withOptional

withOptional(optional)

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

obj spec.apiserverConfig.tlsConfig.ca.secret

"Secret containing data to use for the targets."

fn spec.apiserverConfig.tlsConfig.ca.secret.withKey

withKey(key)

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

fn spec.apiserverConfig.tlsConfig.ca.secret.withName

withName(name)

"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"

fn spec.apiserverConfig.tlsConfig.ca.secret.withOptional

withOptional(optional)

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

obj spec.apiserverConfig.tlsConfig.cert

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

obj spec.apiserverConfig.tlsConfig.cert.configMap

"ConfigMap containing data to use for the targets."

fn spec.apiserverConfig.tlsConfig.cert.configMap.withKey

withKey(key)

"The key to select."

fn spec.apiserverConfig.tlsConfig.cert.configMap.withName

withName(name)

"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"

fn spec.apiserverConfig.tlsConfig.cert.configMap.withOptional

withOptional(optional)

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

obj spec.apiserverConfig.tlsConfig.cert.secret

"Secret containing data to use for the targets."

fn spec.apiserverConfig.tlsConfig.cert.secret.withKey

withKey(key)

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

fn spec.apiserverConfig.tlsConfig.cert.secret.withName

withName(name)

"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"

fn spec.apiserverConfig.tlsConfig.cert.secret.withOptional

withOptional(optional)

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

obj spec.apiserverConfig.tlsConfig.keySecret

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

fn spec.apiserverConfig.tlsConfig.keySecret.withKey

withKey(key)

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

fn spec.apiserverConfig.tlsConfig.keySecret.withName

withName(name)

"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"

fn spec.apiserverConfig.tlsConfig.keySecret.withOptional

withOptional(optional)

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

obj spec.arbitraryFSAccessThroughSMs

"ArbitraryFSAccessThroughSMs configures whether configuration based on a service monitor can access arbitrary files on the file system of the Prometheus container e.g. bearer token files."

fn spec.arbitraryFSAccessThroughSMs.withDeny

withDeny(deny)

obj spec.containers

"Containers allows injecting additional containers or modifying operator generated containers. This can be used to allow adding an authentication proxy to a Prometheus pod or to change the behavior of an operator generated container. Containers described here modify an operator generated container if they share the same name and modifications are done via a strategic merge patch. The current container names are: prometheus, config-reloader, and thanos-sidecar. Overriding containers is entirely outside the scope of what the maintainers will support and by doing so, you accept that this behaviour may break at any time without notice."

fn spec.containers.withArgs

withArgs(args)

"Arguments to the entrypoint. The docker image's CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell"

fn spec.containers.withArgsMixin

withArgsMixin(args)

"Arguments to the entrypoint. The docker image's CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell"

Note: This function appends passed data to existing values

fn spec.containers.withCommand

withCommand(command)

"Entrypoint array. Not executed within a shell. The docker image's ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell"

fn spec.containers.withCommandMixin

withCommandMixin(command)

"Entrypoint array. Not executed within a shell. The docker image's ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell"

Note: This function appends passed data to existing values

fn spec.containers.withEnv

withEnv(env)

"List of environment variables to set in the container. Cannot be updated."

fn spec.containers.withEnvFrom

withEnvFrom(envFrom)

"List of sources to populate environment variables in the container. The keys defined within a source must be a C_IDENTIFIER. All invalid keys will be reported as an event when the container is starting. When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by an Env with a duplicate key will take precedence. Cannot be updated."

fn spec.containers.withEnvFromMixin

withEnvFromMixin(envFrom)

"List of sources to populate environment variables in the container. The keys defined within a source must be a C_IDENTIFIER. All invalid keys will be reported as an event when the container is starting. When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by an Env with a duplicate key will take precedence. Cannot be updated."

Note: This function appends passed data to existing values

fn spec.containers.withEnvMixin

withEnvMixin(env)

"List of environment variables to set in the container. Cannot be updated."

Note: This function appends passed data to existing values

fn spec.containers.withImage

withImage(image)

"Docker image name. More info: https://kubernetes.io/docs/concepts/containers/images This field is optional to allow higher level config management to default or override container images in workload controllers like Deployments and StatefulSets."

fn spec.containers.withImagePullPolicy

withImagePullPolicy(imagePullPolicy)

"Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images"

fn spec.containers.withName

withName(name)

"Name of the container specified as a DNS_LABEL. Each container in a pod must have a unique name (DNS_LABEL). Cannot be updated."

fn spec.containers.withPorts

withPorts(ports)

"List of ports to expose from the container. Exposing a port here gives the system additional information about the network connections a container uses, but is primarily informational. Not specifying a port here DOES NOT prevent that port from being exposed. Any port which is listening on the default \"0.0.0.0\" address inside a container will be accessible from the network. Cannot be updated."

fn spec.containers.withPortsMixin

withPortsMixin(ports)

"List of ports to expose from the container. Exposing a port here gives the system additional information about the network connections a container uses, but is primarily informational. Not specifying a port here DOES NOT prevent that port from being exposed. Any port which is listening on the default \"0.0.0.0\" address inside a container will be accessible from the network. Cannot be updated."

Note: This function appends passed data to existing values

fn spec.containers.withStdin

withStdin(stdin)

"Whether this container should allocate a buffer for stdin in the container runtime. If this is not set, reads from stdin in the container will always result in EOF. Default is false."

fn spec.containers.withStdinOnce

withStdinOnce(stdinOnce)

"Whether the container runtime should close the stdin channel after it has been opened by a single attach. When stdin is true the stdin stream will remain open across multiple attach sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the first client attaches to stdin, and then remains open and accepts data until the client disconnects, at which time stdin is closed and remains closed until the container is restarted. If this flag is false, a container processes that reads from stdin will never receive an EOF. Default is false"

fn spec.containers.withTerminationMessagePath

withTerminationMessagePath(terminationMessagePath)

"Optional: Path at which the file to which the container's termination message will be written is mounted into the container's filesystem. Message written is intended to be brief final status, such as an assertion failure message. Will be truncated by the node if greater than 4096 bytes. The total message length across all containers will be limited to 12kb. Defaults to /dev/termination-log. Cannot be updated."

fn spec.containers.withTerminationMessagePolicy

withTerminationMessagePolicy(terminationMessagePolicy)

"Indicate how the termination message should be populated. File will use the contents of terminationMessagePath to populate the container status message on both success and failure. FallbackToLogsOnError will use the last chunk of container log output if the termination message file is empty and the container exited with an error. The log output is limited to 2048 bytes or 80 lines, whichever is smaller. Defaults to File. Cannot be updated."

fn spec.containers.withTty

withTty(tty)

"Whether this container should allocate a TTY for itself, also requires 'stdin' to be true. Default is false."

fn spec.containers.withVolumeDevices

withVolumeDevices(volumeDevices)

"volumeDevices is the list of block devices to be used by the container."

fn spec.containers.withVolumeDevicesMixin

withVolumeDevicesMixin(volumeDevices)

"volumeDevices is the list of block devices to be used by the container."

Note: This function appends passed data to existing values

fn spec.containers.withVolumeMounts

withVolumeMounts(volumeMounts)

"Pod volumes to mount into the container's filesystem. Cannot be updated."

fn spec.containers.withVolumeMountsMixin

withVolumeMountsMixin(volumeMounts)

"Pod volumes to mount into the container's filesystem. Cannot be updated."

Note: This function appends passed data to existing values

fn spec.containers.withWorkingDir

withWorkingDir(workingDir)

"Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. Cannot be updated."

obj spec.containers.env

"List of environment variables to set in the container. Cannot be updated."

fn spec.containers.env.withName

withName(name)

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

fn spec.containers.env.withValue

withValue(value)

"Variable references $(VAR_NAME) are expanded using the previous defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to \"\"."

obj spec.containers.env.valueFrom

"Source for the environment variable's value. Cannot be used if value is not empty."

obj spec.containers.env.valueFrom.configMapKeyRef

"Selects a key of a ConfigMap."

fn spec.containers.env.valueFrom.configMapKeyRef.withKey

withKey(key)

"The key to select."

fn spec.containers.env.valueFrom.configMapKeyRef.withName

withName(name)

"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"

fn spec.containers.env.valueFrom.configMapKeyRef.withOptional

withOptional(optional)

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

obj spec.containers.env.valueFrom.fieldRef

"Selects a field of the pod: supports metadata.name, metadata.namespace, metadata.labels, metadata.annotations, spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs."

fn spec.containers.env.valueFrom.fieldRef.withApiVersion

withApiVersion(apiVersion)

"Version of the schema the FieldPath is written in terms of, defaults to \"v1\"."

fn spec.containers.env.valueFrom.fieldRef.withFieldPath

withFieldPath(fieldPath)

"Path of the field to select in the specified API version."

obj spec.containers.env.valueFrom.resourceFieldRef

"Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported."

fn spec.containers.env.valueFrom.resourceFieldRef.withContainerName

withContainerName(containerName)

"Container name: required for volumes, optional for env vars"

fn spec.containers.env.valueFrom.resourceFieldRef.withDivisor

withDivisor(divisor)

"Specifies the output format of the exposed resources, defaults to \"1\

fn spec.containers.env.valueFrom.resourceFieldRef.withResource

withResource(resource)

"Required: resource to select"

obj spec.containers.env.valueFrom.secretKeyRef

"Selects a key of a secret in the pod's namespace"

fn spec.containers.env.valueFrom.secretKeyRef.withKey

withKey(key)

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

fn spec.containers.env.valueFrom.secretKeyRef.withName

withName(name)

"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"

fn spec.containers.env.valueFrom.secretKeyRef.withOptional

withOptional(optional)

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

obj spec.containers.envFrom

"List of sources to populate environment variables in the container. The keys defined within a source must be a C_IDENTIFIER. All invalid keys will be reported as an event when the container is starting. When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by an Env with a duplicate key will take precedence. Cannot be updated."

fn spec.containers.envFrom.withPrefix

withPrefix(prefix)

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

obj spec.containers.envFrom.configMapRef

"The ConfigMap to select from"

fn spec.containers.envFrom.configMapRef.withName

withName(name)

"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"

fn spec.containers.envFrom.configMapRef.withOptional

withOptional(optional)

"Specify whether the ConfigMap must be defined"

obj spec.containers.envFrom.secretRef

"The Secret to select from"

fn spec.containers.envFrom.secretRef.withName

withName(name)

"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"

fn spec.containers.envFrom.secretRef.withOptional

withOptional(optional)

"Specify whether the Secret must be defined"

obj spec.containers.lifecycle

"Actions that the management system should take in response to container lifecycle events. Cannot be updated."

obj spec.containers.lifecycle.postStart

"PostStart is called immediately after a container is created. If the handler fails, the container is terminated and restarted according to its restart policy. Other management of the container blocks until the hook completes. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks"

obj spec.containers.lifecycle.postStart.exec

"One and only one of the following should be specified. Exec specifies the action to take."

fn spec.containers.lifecycle.postStart.exec.withCommand

withCommand(command)

"Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy."

fn spec.containers.lifecycle.postStart.exec.withCommandMixin

withCommandMixin(command)

"Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy."

Note: This function appends passed data to existing values

obj spec.containers.lifecycle.postStart.httpGet

"HTTPGet specifies the http request to perform."

fn spec.containers.lifecycle.postStart.httpGet.withHost

withHost(host)

"Host name to connect to, defaults to the pod IP. You probably want to set \"Host\" in httpHeaders instead."

fn spec.containers.lifecycle.postStart.httpGet.withHttpHeaders

withHttpHeaders(httpHeaders)

"Custom headers to set in the request. HTTP allows repeated headers."

fn spec.containers.lifecycle.postStart.httpGet.withHttpHeadersMixin

withHttpHeadersMixin(httpHeaders)

"Custom headers to set in the request. HTTP allows repeated headers."

Note: This function appends passed data to existing values

fn spec.containers.lifecycle.postStart.httpGet.withPath

withPath(path)

"Path to access on the HTTP server."

fn spec.containers.lifecycle.postStart.httpGet.withPort

withPort(port)

"Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME."

fn spec.containers.lifecycle.postStart.httpGet.withScheme

withScheme(scheme)

"Scheme to use for connecting to the host. Defaults to HTTP."

obj spec.containers.lifecycle.postStart.httpGet.httpHeaders

"Custom headers to set in the request. HTTP allows repeated headers."

fn spec.containers.lifecycle.postStart.httpGet.httpHeaders.withName

withName(name)

"The header field name"

fn spec.containers.lifecycle.postStart.httpGet.httpHeaders.withValue

withValue(value)

"The header field value"

obj spec.containers.lifecycle.postStart.tcpSocket

"TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported TODO: implement a realistic TCP lifecycle hook"

fn spec.containers.lifecycle.postStart.tcpSocket.withHost

withHost(host)

"Optional: Host name to connect to, defaults to the pod IP."

fn spec.containers.lifecycle.postStart.tcpSocket.withPort

withPort(port)

"Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME."

obj spec.containers.lifecycle.preStop

"PreStop is called immediately before a container is terminated due to an API request or management event such as liveness/startup probe failure, preemption, resource contention, etc. The handler is not called if the container crashes or exits. The reason for termination is passed to the handler. The Pod's termination grace period countdown begins before the PreStop hooked is executed. Regardless of the outcome of the handler, the container will eventually terminate within the Pod's termination grace period. Other management of the container blocks until the hook completes or until the termination grace period is reached. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks"

obj spec.containers.lifecycle.preStop.exec

"One and only one of the following should be specified. Exec specifies the action to take."

fn spec.containers.lifecycle.preStop.exec.withCommand

withCommand(command)

"Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy."

fn spec.containers.lifecycle.preStop.exec.withCommandMixin

withCommandMixin(command)

"Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy."

Note: This function appends passed data to existing values

obj spec.containers.lifecycle.preStop.httpGet

"HTTPGet specifies the http request to perform."

fn spec.containers.lifecycle.preStop.httpGet.withHost

withHost(host)

"Host name to connect to, defaults to the pod IP. You probably want to set \"Host\" in httpHeaders instead."

fn spec.containers.lifecycle.preStop.httpGet.withHttpHeaders

withHttpHeaders(httpHeaders)

"Custom headers to set in the request. HTTP allows repeated headers."

fn spec.containers.lifecycle.preStop.httpGet.withHttpHeadersMixin

withHttpHeadersMixin(httpHeaders)

"Custom headers to set in the request. HTTP allows repeated headers."

Note: This function appends passed data to existing values

fn spec.containers.lifecycle.preStop.httpGet.withPath

withPath(path)

"Path to access on the HTTP server."

fn spec.containers.lifecycle.preStop.httpGet.withPort

withPort(port)

"Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME."

fn spec.containers.lifecycle.preStop.httpGet.withScheme

withScheme(scheme)

"Scheme to use for connecting to the host. Defaults to HTTP."

obj spec.containers.lifecycle.preStop.httpGet.httpHeaders

"Custom headers to set in the request. HTTP allows repeated headers."

fn spec.containers.lifecycle.preStop.httpGet.httpHeaders.withName

withName(name)

"The header field name"

fn spec.containers.lifecycle.preStop.httpGet.httpHeaders.withValue

withValue(value)

"The header field value"

obj spec.containers.lifecycle.preStop.tcpSocket

"TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported TODO: implement a realistic TCP lifecycle hook"

fn spec.containers.lifecycle.preStop.tcpSocket.withHost

withHost(host)

"Optional: Host name to connect to, defaults to the pod IP."

fn spec.containers.lifecycle.preStop.tcpSocket.withPort

withPort(port)

"Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME."

obj spec.containers.livenessProbe

"Periodic probe of container liveness. Container will be restarted if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes"

fn spec.containers.livenessProbe.withFailureThreshold

withFailureThreshold(failureThreshold)

"Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1."

fn spec.containers.livenessProbe.withInitialDelaySeconds

withInitialDelaySeconds(initialDelaySeconds)

"Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes"

fn spec.containers.livenessProbe.withPeriodSeconds

withPeriodSeconds(periodSeconds)

"How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1."

fn spec.containers.livenessProbe.withSuccessThreshold

withSuccessThreshold(successThreshold)

"Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1."

fn spec.containers.livenessProbe.withTimeoutSeconds

withTimeoutSeconds(timeoutSeconds)

"Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes"

obj spec.containers.livenessProbe.exec

"One and only one of the following should be specified. Exec specifies the action to take."

fn spec.containers.livenessProbe.exec.withCommand

withCommand(command)

"Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy."

fn spec.containers.livenessProbe.exec.withCommandMixin

withCommandMixin(command)

"Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy."

Note: This function appends passed data to existing values

obj spec.containers.livenessProbe.httpGet

"HTTPGet specifies the http request to perform."

fn spec.containers.livenessProbe.httpGet.withHost

withHost(host)

"Host name to connect to, defaults to the pod IP. You probably want to set \"Host\" in httpHeaders instead."

fn spec.containers.livenessProbe.httpGet.withHttpHeaders

withHttpHeaders(httpHeaders)

"Custom headers to set in the request. HTTP allows repeated headers."

fn spec.containers.livenessProbe.httpGet.withHttpHeadersMixin

withHttpHeadersMixin(httpHeaders)

"Custom headers to set in the request. HTTP allows repeated headers."

Note: This function appends passed data to existing values

fn spec.containers.livenessProbe.httpGet.withPath

withPath(path)

"Path to access on the HTTP server."

fn spec.containers.livenessProbe.httpGet.withPort

withPort(port)

"Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME."

fn spec.containers.livenessProbe.httpGet.withScheme

withScheme(scheme)

"Scheme to use for connecting to the host. Defaults to HTTP."

obj spec.containers.livenessProbe.httpGet.httpHeaders

"Custom headers to set in the request. HTTP allows repeated headers."

fn spec.containers.livenessProbe.httpGet.httpHeaders.withName

withName(name)

"The header field name"

fn spec.containers.livenessProbe.httpGet.httpHeaders.withValue

withValue(value)

"The header field value"

obj spec.containers.livenessProbe.tcpSocket

"TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported TODO: implement a realistic TCP lifecycle hook"

fn spec.containers.livenessProbe.tcpSocket.withHost

withHost(host)

"Optional: Host name to connect to, defaults to the pod IP."

fn spec.containers.livenessProbe.tcpSocket.withPort

withPort(port)

"Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME."

obj spec.containers.ports

"List of ports to expose from the container. Exposing a port here gives the system additional information about the network connections a container uses, but is primarily informational. Not specifying a port here DOES NOT prevent that port from being exposed. Any port which is listening on the default \"0.0.0.0\" address inside a container will be accessible from the network. Cannot be updated."

fn spec.containers.ports.withContainerPort

withContainerPort(containerPort)

"Number of port to expose on the pod's IP address. This must be a valid port number, 0 < x < 65536."

fn spec.containers.ports.withHostIP

withHostIP(hostIP)

"What host IP to bind the external port to."

fn spec.containers.ports.withHostPort

withHostPort(hostPort)

"Number of port to expose on the host. If specified, this must be a valid port number, 0 < x < 65536. If HostNetwork is specified, this must match ContainerPort. Most containers do not need this."

fn spec.containers.ports.withName

withName(name)

"If specified, this must be an IANA_SVC_NAME and unique within the pod. Each named port in a pod must have a unique name. Name for the port that can be referred to by services."

fn spec.containers.ports.withProtocol

withProtocol(protocol)

"Protocol for port. Must be UDP, TCP, or SCTP. Defaults to \"TCP\"."

obj spec.containers.readinessProbe

"Periodic probe of container service readiness. Container will be removed from service endpoints if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes"

fn spec.containers.readinessProbe.withFailureThreshold

withFailureThreshold(failureThreshold)

"Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1."

fn spec.containers.readinessProbe.withInitialDelaySeconds

withInitialDelaySeconds(initialDelaySeconds)

"Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes"

fn spec.containers.readinessProbe.withPeriodSeconds

withPeriodSeconds(periodSeconds)

"How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1."

fn spec.containers.readinessProbe.withSuccessThreshold

withSuccessThreshold(successThreshold)

"Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1."

fn spec.containers.readinessProbe.withTimeoutSeconds

withTimeoutSeconds(timeoutSeconds)

"Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes"

obj spec.containers.readinessProbe.exec

"One and only one of the following should be specified. Exec specifies the action to take."

fn spec.containers.readinessProbe.exec.withCommand

withCommand(command)

"Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy."

fn spec.containers.readinessProbe.exec.withCommandMixin

withCommandMixin(command)

"Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy."

Note: This function appends passed data to existing values

obj spec.containers.readinessProbe.httpGet

"HTTPGet specifies the http request to perform."

fn spec.containers.readinessProbe.httpGet.withHost

withHost(host)

"Host name to connect to, defaults to the pod IP. You probably want to set \"Host\" in httpHeaders instead."

fn spec.containers.readinessProbe.httpGet.withHttpHeaders

withHttpHeaders(httpHeaders)

"Custom headers to set in the request. HTTP allows repeated headers."

fn spec.containers.readinessProbe.httpGet.withHttpHeadersMixin

withHttpHeadersMixin(httpHeaders)

"Custom headers to set in the request. HTTP allows repeated headers."

Note: This function appends passed data to existing values

fn spec.containers.readinessProbe.httpGet.withPath

withPath(path)

"Path to access on the HTTP server."

fn spec.containers.readinessProbe.httpGet.withPort

withPort(port)

"Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME."

fn spec.containers.readinessProbe.httpGet.withScheme

withScheme(scheme)

"Scheme to use for connecting to the host. Defaults to HTTP."

obj spec.containers.readinessProbe.httpGet.httpHeaders

"Custom headers to set in the request. HTTP allows repeated headers."

fn spec.containers.readinessProbe.httpGet.httpHeaders.withName

withName(name)

"The header field name"

fn spec.containers.readinessProbe.httpGet.httpHeaders.withValue

withValue(value)

"The header field value"

obj spec.containers.readinessProbe.tcpSocket

"TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported TODO: implement a realistic TCP lifecycle hook"

fn spec.containers.readinessProbe.tcpSocket.withHost

withHost(host)

"Optional: Host name to connect to, defaults to the pod IP."

fn spec.containers.readinessProbe.tcpSocket.withPort

withPort(port)

"Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME."

obj spec.containers.resources

"Compute Resources required by this container. Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/"

fn spec.containers.resources.withLimits

withLimits(limits)

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

fn spec.containers.resources.withLimitsMixin

withLimitsMixin(limits)

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

Note: This function appends passed data to existing values

fn spec.containers.resources.withRequests

withRequests(requests)

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

fn spec.containers.resources.withRequestsMixin

withRequestsMixin(requests)

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

Note: This function appends passed data to existing values

obj spec.containers.securityContext

"Security options the pod should run with. More info: https://kubernetes.io/docs/concepts/policy/security-context/ More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/"

fn spec.containers.securityContext.withAllowPrivilegeEscalation

withAllowPrivilegeEscalation(allowPrivilegeEscalation)

"AllowPrivilegeEscalation controls whether a process can gain more privileges than its parent process. This bool directly controls if the no_new_privs flag will be set on the container process. AllowPrivilegeEscalation is true always when the container is: 1) run as Privileged 2) has CAP_SYS_ADMIN"

fn spec.containers.securityContext.withPrivileged

withPrivileged(privileged)

"Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false."

fn spec.containers.securityContext.withProcMount

withProcMount(procMount)

"procMount denotes the type of proc mount to use for the containers. The default is DefaultProcMount which uses the container runtime defaults for readonly paths and masked paths. This requires the ProcMountType feature flag to be enabled."

fn spec.containers.securityContext.withReadOnlyRootFilesystem

withReadOnlyRootFilesystem(readOnlyRootFilesystem)

"Whether this container has a read-only root filesystem. Default is false."

fn spec.containers.securityContext.withRunAsGroup

withRunAsGroup(runAsGroup)

"The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence."

fn spec.containers.securityContext.withRunAsNonRoot

withRunAsNonRoot(runAsNonRoot)

"Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence."

fn spec.containers.securityContext.withRunAsUser

withRunAsUser(runAsUser)

"The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence."

obj spec.containers.securityContext.capabilities

"The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime."

fn spec.containers.securityContext.capabilities.withAdd

withAdd(add)

"Added capabilities"

fn spec.containers.securityContext.capabilities.withAddMixin

withAddMixin(add)

"Added capabilities"

Note: This function appends passed data to existing values

fn spec.containers.securityContext.capabilities.withDrop

withDrop(drop)

"Removed capabilities"

fn spec.containers.securityContext.capabilities.withDropMixin

withDropMixin(drop)

"Removed capabilities"

Note: This function appends passed data to existing values

obj spec.containers.securityContext.seLinuxOptions

"The SELinux context to be applied to the container. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence."

fn spec.containers.securityContext.seLinuxOptions.withLevel

withLevel(level)

"Level is SELinux level label that applies to the container."

fn spec.containers.securityContext.seLinuxOptions.withRole

withRole(role)

"Role is a SELinux role label that applies to the container."

fn spec.containers.securityContext.seLinuxOptions.withType

withType(type)

"Type is a SELinux type label that applies to the container."

fn spec.containers.securityContext.seLinuxOptions.withUser

withUser(user)

"User is a SELinux user label that applies to the container."

obj spec.containers.securityContext.windowsOptions

"The Windows specific settings applied to all containers. If unspecified, the options from the PodSecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence."

fn spec.containers.securityContext.windowsOptions.withGmsaCredentialSpec

withGmsaCredentialSpec(gmsaCredentialSpec)

"GMSACredentialSpec is where the GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field."

fn spec.containers.securityContext.windowsOptions.withGmsaCredentialSpecName

withGmsaCredentialSpecName(gmsaCredentialSpecName)

"GMSACredentialSpecName is the name of the GMSA credential spec to use."

fn spec.containers.securityContext.windowsOptions.withRunAsUserName

withRunAsUserName(runAsUserName)

"The UserName in Windows to run the entrypoint of the container process. Defaults to the user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence."

obj spec.containers.startupProbe

"StartupProbe indicates that the Pod has successfully initialized. If specified, no other probes are executed until this completes successfully. If this probe fails, the Pod will be restarted, just as if the livenessProbe failed. This can be used to provide different probe parameters at the beginning of a Pod's lifecycle, when it might take a long time to load data or warm a cache, than during steady-state operation. This cannot be updated. This is a beta feature enabled by the StartupProbe feature flag. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes"

fn spec.containers.startupProbe.withFailureThreshold

withFailureThreshold(failureThreshold)

"Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1."

fn spec.containers.startupProbe.withInitialDelaySeconds

withInitialDelaySeconds(initialDelaySeconds)

"Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes"

fn spec.containers.startupProbe.withPeriodSeconds

withPeriodSeconds(periodSeconds)

"How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1."

fn spec.containers.startupProbe.withSuccessThreshold

withSuccessThreshold(successThreshold)

"Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1."

fn spec.containers.startupProbe.withTimeoutSeconds

withTimeoutSeconds(timeoutSeconds)

"Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes"

obj spec.containers.startupProbe.exec

"One and only one of the following should be specified. Exec specifies the action to take."

fn spec.containers.startupProbe.exec.withCommand

withCommand(command)

"Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy."

fn spec.containers.startupProbe.exec.withCommandMixin

withCommandMixin(command)

"Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy."

Note: This function appends passed data to existing values

obj spec.containers.startupProbe.httpGet

"HTTPGet specifies the http request to perform."

fn spec.containers.startupProbe.httpGet.withHost

withHost(host)

"Host name to connect to, defaults to the pod IP. You probably want to set \"Host\" in httpHeaders instead."

fn spec.containers.startupProbe.httpGet.withHttpHeaders

withHttpHeaders(httpHeaders)

"Custom headers to set in the request. HTTP allows repeated headers."

fn spec.containers.startupProbe.httpGet.withHttpHeadersMixin

withHttpHeadersMixin(httpHeaders)

"Custom headers to set in the request. HTTP allows repeated headers."

Note: This function appends passed data to existing values

fn spec.containers.startupProbe.httpGet.withPath

withPath(path)

"Path to access on the HTTP server."

fn spec.containers.startupProbe.httpGet.withPort

withPort(port)

"Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME."

fn spec.containers.startupProbe.httpGet.withScheme

withScheme(scheme)

"Scheme to use for connecting to the host. Defaults to HTTP."

obj spec.containers.startupProbe.httpGet.httpHeaders

"Custom headers to set in the request. HTTP allows repeated headers."

fn spec.containers.startupProbe.httpGet.httpHeaders.withName

withName(name)

"The header field name"

fn spec.containers.startupProbe.httpGet.httpHeaders.withValue

withValue(value)

"The header field value"

obj spec.containers.startupProbe.tcpSocket

"TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported TODO: implement a realistic TCP lifecycle hook"

fn spec.containers.startupProbe.tcpSocket.withHost

withHost(host)

"Optional: Host name to connect to, defaults to the pod IP."

fn spec.containers.startupProbe.tcpSocket.withPort

withPort(port)

"Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME."

obj spec.containers.volumeDevices

"volumeDevices is the list of block devices to be used by the container."

fn spec.containers.volumeDevices.withDevicePath

withDevicePath(devicePath)

"devicePath is the path inside of the container that the device will be mapped to."

fn spec.containers.volumeDevices.withName

withName(name)

"name must match the name of a persistentVolumeClaim in the pod"

obj spec.containers.volumeMounts

"Pod volumes to mount into the container's filesystem. Cannot be updated."

fn spec.containers.volumeMounts.withMountPath

withMountPath(mountPath)

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

fn spec.containers.volumeMounts.withMountPropagation

withMountPropagation(mountPropagation)

"mountPropagation determines how mounts are propagated from the host to container and the other way around. When not set, MountPropagationNone is used. This field is beta in 1.10."

fn spec.containers.volumeMounts.withName

withName(name)

"This must match the Name of a Volume."

fn spec.containers.volumeMounts.withReadOnly

withReadOnly(readOnly)

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

fn spec.containers.volumeMounts.withSubPath

withSubPath(subPath)

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

fn spec.containers.volumeMounts.withSubPathExpr

withSubPathExpr(subPathExpr)

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

obj spec.imagePullSecrets

"An optional list of references to secrets in the same namespace to use for pulling prometheus and alertmanager images from registries see http://kubernetes.io/docs/user-guide/images#specifying-imagepullsecrets-on-a-pod"

fn spec.imagePullSecrets.withName

withName(name)

"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"

obj spec.initContainers

"InitContainers allows adding initContainers to the pod definition. Those can be used to e.g. fetch secrets for injection into the Prometheus configuration from external sources. Any errors during the execution of an initContainer will lead to a restart of the Pod. More info: https://kubernetes.io/docs/concepts/workloads/pods/init-containers/ InitContainers described here modify an operator generated init containers if they share the same name and modifications are done via a strategic merge patch. The current init container name is: init-config-reloader. Overriding init containers is entirely outside the scope of what the maintainers will support and by doing so, you accept that this behaviour may break at any time without notice."

fn spec.initContainers.withArgs

withArgs(args)

"Arguments to the entrypoint. The docker image's CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell"

fn spec.initContainers.withArgsMixin

withArgsMixin(args)

"Arguments to the entrypoint. The docker image's CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell"

Note: This function appends passed data to existing values

fn spec.initContainers.withCommand

withCommand(command)

"Entrypoint array. Not executed within a shell. The docker image's ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell"

fn spec.initContainers.withCommandMixin

withCommandMixin(command)

"Entrypoint array. Not executed within a shell. The docker image's ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell"

Note: This function appends passed data to existing values

fn spec.initContainers.withEnv

withEnv(env)

"List of environment variables to set in the container. Cannot be updated."

fn spec.initContainers.withEnvFrom

withEnvFrom(envFrom)

"List of sources to populate environment variables in the container. The keys defined within a source must be a C_IDENTIFIER. All invalid keys will be reported as an event when the container is starting. When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by an Env with a duplicate key will take precedence. Cannot be updated."

fn spec.initContainers.withEnvFromMixin

withEnvFromMixin(envFrom)

"List of sources to populate environment variables in the container. The keys defined within a source must be a C_IDENTIFIER. All invalid keys will be reported as an event when the container is starting. When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by an Env with a duplicate key will take precedence. Cannot be updated."

Note: This function appends passed data to existing values

fn spec.initContainers.withEnvMixin

withEnvMixin(env)

"List of environment variables to set in the container. Cannot be updated."

Note: This function appends passed data to existing values

fn spec.initContainers.withImage

withImage(image)

"Docker image name. More info: https://kubernetes.io/docs/concepts/containers/images This field is optional to allow higher level config management to default or override container images in workload controllers like Deployments and StatefulSets."

fn spec.initContainers.withImagePullPolicy

withImagePullPolicy(imagePullPolicy)

"Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images"

fn spec.initContainers.withName

withName(name)

"Name of the container specified as a DNS_LABEL. Each container in a pod must have a unique name (DNS_LABEL). Cannot be updated."

fn spec.initContainers.withPorts

withPorts(ports)

"List of ports to expose from the container. Exposing a port here gives the system additional information about the network connections a container uses, but is primarily informational. Not specifying a port here DOES NOT prevent that port from being exposed. Any port which is listening on the default \"0.0.0.0\" address inside a container will be accessible from the network. Cannot be updated."

fn spec.initContainers.withPortsMixin

withPortsMixin(ports)

"List of ports to expose from the container. Exposing a port here gives the system additional information about the network connections a container uses, but is primarily informational. Not specifying a port here DOES NOT prevent that port from being exposed. Any port which is listening on the default \"0.0.0.0\" address inside a container will be accessible from the network. Cannot be updated."

Note: This function appends passed data to existing values

fn spec.initContainers.withStdin

withStdin(stdin)

"Whether this container should allocate a buffer for stdin in the container runtime. If this is not set, reads from stdin in the container will always result in EOF. Default is false."

fn spec.initContainers.withStdinOnce

withStdinOnce(stdinOnce)

"Whether the container runtime should close the stdin channel after it has been opened by a single attach. When stdin is true the stdin stream will remain open across multiple attach sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the first client attaches to stdin, and then remains open and accepts data until the client disconnects, at which time stdin is closed and remains closed until the container is restarted. If this flag is false, a container processes that reads from stdin will never receive an EOF. Default is false"

fn spec.initContainers.withTerminationMessagePath

withTerminationMessagePath(terminationMessagePath)

"Optional: Path at which the file to which the container's termination message will be written is mounted into the container's filesystem. Message written is intended to be brief final status, such as an assertion failure message. Will be truncated by the node if greater than 4096 bytes. The total message length across all containers will be limited to 12kb. Defaults to /dev/termination-log. Cannot be updated."

fn spec.initContainers.withTerminationMessagePolicy

withTerminationMessagePolicy(terminationMessagePolicy)

"Indicate how the termination message should be populated. File will use the contents of terminationMessagePath to populate the container status message on both success and failure. FallbackToLogsOnError will use the last chunk of container log output if the termination message file is empty and the container exited with an error. The log output is limited to 2048 bytes or 80 lines, whichever is smaller. Defaults to File. Cannot be updated."

fn spec.initContainers.withTty

withTty(tty)

"Whether this container should allocate a TTY for itself, also requires 'stdin' to be true. Default is false."

fn spec.initContainers.withVolumeDevices

withVolumeDevices(volumeDevices)

"volumeDevices is the list of block devices to be used by the container."

fn spec.initContainers.withVolumeDevicesMixin

withVolumeDevicesMixin(volumeDevices)

"volumeDevices is the list of block devices to be used by the container."

Note: This function appends passed data to existing values

fn spec.initContainers.withVolumeMounts

withVolumeMounts(volumeMounts)

"Pod volumes to mount into the container's filesystem. Cannot be updated."

fn spec.initContainers.withVolumeMountsMixin

withVolumeMountsMixin(volumeMounts)

"Pod volumes to mount into the container's filesystem. Cannot be updated."

Note: This function appends passed data to existing values

fn spec.initContainers.withWorkingDir

withWorkingDir(workingDir)

"Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. Cannot be updated."

obj spec.initContainers.env

"List of environment variables to set in the container. Cannot be updated."

fn spec.initContainers.env.withName

withName(name)

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

fn spec.initContainers.env.withValue

withValue(value)

"Variable references $(VAR_NAME) are expanded using the previous defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to \"\"."

obj spec.initContainers.env.valueFrom

"Source for the environment variable's value. Cannot be used if value is not empty."

obj spec.initContainers.env.valueFrom.configMapKeyRef

"Selects a key of a ConfigMap."

fn spec.initContainers.env.valueFrom.configMapKeyRef.withKey

withKey(key)

"The key to select."

fn spec.initContainers.env.valueFrom.configMapKeyRef.withName

withName(name)

"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"

fn spec.initContainers.env.valueFrom.configMapKeyRef.withOptional

withOptional(optional)

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

obj spec.initContainers.env.valueFrom.fieldRef

"Selects a field of the pod: supports metadata.name, metadata.namespace, metadata.labels, metadata.annotations, spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs."

fn spec.initContainers.env.valueFrom.fieldRef.withApiVersion

withApiVersion(apiVersion)

"Version of the schema the FieldPath is written in terms of, defaults to \"v1\"."

fn spec.initContainers.env.valueFrom.fieldRef.withFieldPath

withFieldPath(fieldPath)

"Path of the field to select in the specified API version."

obj spec.initContainers.env.valueFrom.resourceFieldRef

"Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported."

fn spec.initContainers.env.valueFrom.resourceFieldRef.withContainerName

withContainerName(containerName)

"Container name: required for volumes, optional for env vars"

fn spec.initContainers.env.valueFrom.resourceFieldRef.withDivisor

withDivisor(divisor)

"Specifies the output format of the exposed resources, defaults to \"1\

fn spec.initContainers.env.valueFrom.resourceFieldRef.withResource

withResource(resource)

"Required: resource to select"

obj spec.initContainers.env.valueFrom.secretKeyRef

"Selects a key of a secret in the pod's namespace"

fn spec.initContainers.env.valueFrom.secretKeyRef.withKey

withKey(key)

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

fn spec.initContainers.env.valueFrom.secretKeyRef.withName

withName(name)

"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"

fn spec.initContainers.env.valueFrom.secretKeyRef.withOptional

withOptional(optional)

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

obj spec.initContainers.envFrom

"List of sources to populate environment variables in the container. The keys defined within a source must be a C_IDENTIFIER. All invalid keys will be reported as an event when the container is starting. When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by an Env with a duplicate key will take precedence. Cannot be updated."

fn spec.initContainers.envFrom.withPrefix

withPrefix(prefix)

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

obj spec.initContainers.envFrom.configMapRef

"The ConfigMap to select from"

fn spec.initContainers.envFrom.configMapRef.withName

withName(name)

"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"

fn spec.initContainers.envFrom.configMapRef.withOptional

withOptional(optional)

"Specify whether the ConfigMap must be defined"

obj spec.initContainers.envFrom.secretRef

"The Secret to select from"

fn spec.initContainers.envFrom.secretRef.withName

withName(name)

"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"

fn spec.initContainers.envFrom.secretRef.withOptional

withOptional(optional)

"Specify whether the Secret must be defined"

obj spec.initContainers.lifecycle

"Actions that the management system should take in response to container lifecycle events. Cannot be updated."

obj spec.initContainers.lifecycle.postStart

"PostStart is called immediately after a container is created. If the handler fails, the container is terminated and restarted according to its restart policy. Other management of the container blocks until the hook completes. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks"

obj spec.initContainers.lifecycle.postStart.exec

"One and only one of the following should be specified. Exec specifies the action to take."

fn spec.initContainers.lifecycle.postStart.exec.withCommand

withCommand(command)

"Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy."

fn spec.initContainers.lifecycle.postStart.exec.withCommandMixin

withCommandMixin(command)

"Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy."

Note: This function appends passed data to existing values

obj spec.initContainers.lifecycle.postStart.httpGet

"HTTPGet specifies the http request to perform."

fn spec.initContainers.lifecycle.postStart.httpGet.withHost

withHost(host)

"Host name to connect to, defaults to the pod IP. You probably want to set \"Host\" in httpHeaders instead."

fn spec.initContainers.lifecycle.postStart.httpGet.withHttpHeaders

withHttpHeaders(httpHeaders)

"Custom headers to set in the request. HTTP allows repeated headers."

fn spec.initContainers.lifecycle.postStart.httpGet.withHttpHeadersMixin

withHttpHeadersMixin(httpHeaders)

"Custom headers to set in the request. HTTP allows repeated headers."

Note: This function appends passed data to existing values

fn spec.initContainers.lifecycle.postStart.httpGet.withPath

withPath(path)

"Path to access on the HTTP server."

fn spec.initContainers.lifecycle.postStart.httpGet.withPort

withPort(port)

"Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME."

fn spec.initContainers.lifecycle.postStart.httpGet.withScheme

withScheme(scheme)

"Scheme to use for connecting to the host. Defaults to HTTP."

obj spec.initContainers.lifecycle.postStart.httpGet.httpHeaders

"Custom headers to set in the request. HTTP allows repeated headers."

fn spec.initContainers.lifecycle.postStart.httpGet.httpHeaders.withName

withName(name)

"The header field name"

fn spec.initContainers.lifecycle.postStart.httpGet.httpHeaders.withValue

withValue(value)

"The header field value"

obj spec.initContainers.lifecycle.postStart.tcpSocket

"TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported TODO: implement a realistic TCP lifecycle hook"

fn spec.initContainers.lifecycle.postStart.tcpSocket.withHost

withHost(host)

"Optional: Host name to connect to, defaults to the pod IP."

fn spec.initContainers.lifecycle.postStart.tcpSocket.withPort

withPort(port)

"Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME."

obj spec.initContainers.lifecycle.preStop

"PreStop is called immediately before a container is terminated due to an API request or management event such as liveness/startup probe failure, preemption, resource contention, etc. The handler is not called if the container crashes or exits. The reason for termination is passed to the handler. The Pod's termination grace period countdown begins before the PreStop hooked is executed. Regardless of the outcome of the handler, the container will eventually terminate within the Pod's termination grace period. Other management of the container blocks until the hook completes or until the termination grace period is reached. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks"

obj spec.initContainers.lifecycle.preStop.exec

"One and only one of the following should be specified. Exec specifies the action to take."

fn spec.initContainers.lifecycle.preStop.exec.withCommand

withCommand(command)

"Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy."

fn spec.initContainers.lifecycle.preStop.exec.withCommandMixin

withCommandMixin(command)

"Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy."

Note: This function appends passed data to existing values

obj spec.initContainers.lifecycle.preStop.httpGet

"HTTPGet specifies the http request to perform."

fn spec.initContainers.lifecycle.preStop.httpGet.withHost

withHost(host)

"Host name to connect to, defaults to the pod IP. You probably want to set \"Host\" in httpHeaders instead."

fn spec.initContainers.lifecycle.preStop.httpGet.withHttpHeaders

withHttpHeaders(httpHeaders)

"Custom headers to set in the request. HTTP allows repeated headers."

fn spec.initContainers.lifecycle.preStop.httpGet.withHttpHeadersMixin

withHttpHeadersMixin(httpHeaders)

"Custom headers to set in the request. HTTP allows repeated headers."

Note: This function appends passed data to existing values

fn spec.initContainers.lifecycle.preStop.httpGet.withPath

withPath(path)

"Path to access on the HTTP server."

fn spec.initContainers.lifecycle.preStop.httpGet.withPort

withPort(port)

"Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME."

fn spec.initContainers.lifecycle.preStop.httpGet.withScheme

withScheme(scheme)

"Scheme to use for connecting to the host. Defaults to HTTP."

obj spec.initContainers.lifecycle.preStop.httpGet.httpHeaders

"Custom headers to set in the request. HTTP allows repeated headers."

fn spec.initContainers.lifecycle.preStop.httpGet.httpHeaders.withName

withName(name)

"The header field name"

fn spec.initContainers.lifecycle.preStop.httpGet.httpHeaders.withValue

withValue(value)

"The header field value"

obj spec.initContainers.lifecycle.preStop.tcpSocket

"TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported TODO: implement a realistic TCP lifecycle hook"

fn spec.initContainers.lifecycle.preStop.tcpSocket.withHost

withHost(host)

"Optional: Host name to connect to, defaults to the pod IP."

fn spec.initContainers.lifecycle.preStop.tcpSocket.withPort

withPort(port)

"Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME."

obj spec.initContainers.livenessProbe

"Periodic probe of container liveness. Container will be restarted if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes"

fn spec.initContainers.livenessProbe.withFailureThreshold

withFailureThreshold(failureThreshold)

"Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1."

fn spec.initContainers.livenessProbe.withInitialDelaySeconds

withInitialDelaySeconds(initialDelaySeconds)

"Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes"

fn spec.initContainers.livenessProbe.withPeriodSeconds

withPeriodSeconds(periodSeconds)

"How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1."

fn spec.initContainers.livenessProbe.withSuccessThreshold

withSuccessThreshold(successThreshold)

"Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1."

fn spec.initContainers.livenessProbe.withTimeoutSeconds

withTimeoutSeconds(timeoutSeconds)

"Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes"

obj spec.initContainers.livenessProbe.exec

"One and only one of the following should be specified. Exec specifies the action to take."

fn spec.initContainers.livenessProbe.exec.withCommand

withCommand(command)

"Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy."

fn spec.initContainers.livenessProbe.exec.withCommandMixin

withCommandMixin(command)

"Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy."

Note: This function appends passed data to existing values

obj spec.initContainers.livenessProbe.httpGet

"HTTPGet specifies the http request to perform."

fn spec.initContainers.livenessProbe.httpGet.withHost

withHost(host)

"Host name to connect to, defaults to the pod IP. You probably want to set \"Host\" in httpHeaders instead."

fn spec.initContainers.livenessProbe.httpGet.withHttpHeaders

withHttpHeaders(httpHeaders)

"Custom headers to set in the request. HTTP allows repeated headers."

fn spec.initContainers.livenessProbe.httpGet.withHttpHeadersMixin

withHttpHeadersMixin(httpHeaders)

"Custom headers to set in the request. HTTP allows repeated headers."

Note: This function appends passed data to existing values

fn spec.initContainers.livenessProbe.httpGet.withPath

withPath(path)

"Path to access on the HTTP server."

fn spec.initContainers.livenessProbe.httpGet.withPort

withPort(port)

"Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME."

fn spec.initContainers.livenessProbe.httpGet.withScheme

withScheme(scheme)

"Scheme to use for connecting to the host. Defaults to HTTP."

obj spec.initContainers.livenessProbe.httpGet.httpHeaders

"Custom headers to set in the request. HTTP allows repeated headers."

fn spec.initContainers.livenessProbe.httpGet.httpHeaders.withName

withName(name)

"The header field name"

fn spec.initContainers.livenessProbe.httpGet.httpHeaders.withValue

withValue(value)

"The header field value"

obj spec.initContainers.livenessProbe.tcpSocket

"TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported TODO: implement a realistic TCP lifecycle hook"

fn spec.initContainers.livenessProbe.tcpSocket.withHost

withHost(host)

"Optional: Host name to connect to, defaults to the pod IP."

fn spec.initContainers.livenessProbe.tcpSocket.withPort

withPort(port)

"Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME."

obj spec.initContainers.ports

"List of ports to expose from the container. Exposing a port here gives the system additional information about the network connections a container uses, but is primarily informational. Not specifying a port here DOES NOT prevent that port from being exposed. Any port which is listening on the default \"0.0.0.0\" address inside a container will be accessible from the network. Cannot be updated."

fn spec.initContainers.ports.withContainerPort

withContainerPort(containerPort)

"Number of port to expose on the pod's IP address. This must be a valid port number, 0 < x < 65536."

fn spec.initContainers.ports.withHostIP

withHostIP(hostIP)

"What host IP to bind the external port to."

fn spec.initContainers.ports.withHostPort

withHostPort(hostPort)

"Number of port to expose on the host. If specified, this must be a valid port number, 0 < x < 65536. If HostNetwork is specified, this must match ContainerPort. Most containers do not need this."

fn spec.initContainers.ports.withName

withName(name)

"If specified, this must be an IANA_SVC_NAME and unique within the pod. Each named port in a pod must have a unique name. Name for the port that can be referred to by services."

fn spec.initContainers.ports.withProtocol

withProtocol(protocol)

"Protocol for port. Must be UDP, TCP, or SCTP. Defaults to \"TCP\"."

obj spec.initContainers.readinessProbe

"Periodic probe of container service readiness. Container will be removed from service endpoints if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes"

fn spec.initContainers.readinessProbe.withFailureThreshold

withFailureThreshold(failureThreshold)

"Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1."

fn spec.initContainers.readinessProbe.withInitialDelaySeconds

withInitialDelaySeconds(initialDelaySeconds)

"Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes"

fn spec.initContainers.readinessProbe.withPeriodSeconds

withPeriodSeconds(periodSeconds)

"How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1."

fn spec.initContainers.readinessProbe.withSuccessThreshold

withSuccessThreshold(successThreshold)

"Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1."

fn spec.initContainers.readinessProbe.withTimeoutSeconds

withTimeoutSeconds(timeoutSeconds)

"Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes"

obj spec.initContainers.readinessProbe.exec

"One and only one of the following should be specified. Exec specifies the action to take."

fn spec.initContainers.readinessProbe.exec.withCommand

withCommand(command)

"Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy."

fn spec.initContainers.readinessProbe.exec.withCommandMixin

withCommandMixin(command)

"Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy."

Note: This function appends passed data to existing values

obj spec.initContainers.readinessProbe.httpGet

"HTTPGet specifies the http request to perform."

fn spec.initContainers.readinessProbe.httpGet.withHost

withHost(host)

"Host name to connect to, defaults to the pod IP. You probably want to set \"Host\" in httpHeaders instead."

fn spec.initContainers.readinessProbe.httpGet.withHttpHeaders

withHttpHeaders(httpHeaders)

"Custom headers to set in the request. HTTP allows repeated headers."

fn spec.initContainers.readinessProbe.httpGet.withHttpHeadersMixin

withHttpHeadersMixin(httpHeaders)

"Custom headers to set in the request. HTTP allows repeated headers."

Note: This function appends passed data to existing values

fn spec.initContainers.readinessProbe.httpGet.withPath

withPath(path)

"Path to access on the HTTP server."

fn spec.initContainers.readinessProbe.httpGet.withPort

withPort(port)

"Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME."

fn spec.initContainers.readinessProbe.httpGet.withScheme

withScheme(scheme)

"Scheme to use for connecting to the host. Defaults to HTTP."

obj spec.initContainers.readinessProbe.httpGet.httpHeaders

"Custom headers to set in the request. HTTP allows repeated headers."

fn spec.initContainers.readinessProbe.httpGet.httpHeaders.withName

withName(name)

"The header field name"

fn spec.initContainers.readinessProbe.httpGet.httpHeaders.withValue

withValue(value)

"The header field value"

obj spec.initContainers.readinessProbe.tcpSocket

"TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported TODO: implement a realistic TCP lifecycle hook"

fn spec.initContainers.readinessProbe.tcpSocket.withHost

withHost(host)

"Optional: Host name to connect to, defaults to the pod IP."

fn spec.initContainers.readinessProbe.tcpSocket.withPort

withPort(port)

"Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME."

obj spec.initContainers.resources

"Compute Resources required by this container. Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/"

fn spec.initContainers.resources.withLimits

withLimits(limits)

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

fn spec.initContainers.resources.withLimitsMixin

withLimitsMixin(limits)

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

Note: This function appends passed data to existing values

fn spec.initContainers.resources.withRequests

withRequests(requests)

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

fn spec.initContainers.resources.withRequestsMixin

withRequestsMixin(requests)

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

Note: This function appends passed data to existing values

obj spec.initContainers.securityContext

"Security options the pod should run with. More info: https://kubernetes.io/docs/concepts/policy/security-context/ More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/"

fn spec.initContainers.securityContext.withAllowPrivilegeEscalation

withAllowPrivilegeEscalation(allowPrivilegeEscalation)

"AllowPrivilegeEscalation controls whether a process can gain more privileges than its parent process. This bool directly controls if the no_new_privs flag will be set on the container process. AllowPrivilegeEscalation is true always when the container is: 1) run as Privileged 2) has CAP_SYS_ADMIN"

fn spec.initContainers.securityContext.withPrivileged

withPrivileged(privileged)

"Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false."

fn spec.initContainers.securityContext.withProcMount

withProcMount(procMount)

"procMount denotes the type of proc mount to use for the containers. The default is DefaultProcMount which uses the container runtime defaults for readonly paths and masked paths. This requires the ProcMountType feature flag to be enabled."

fn spec.initContainers.securityContext.withReadOnlyRootFilesystem

withReadOnlyRootFilesystem(readOnlyRootFilesystem)

"Whether this container has a read-only root filesystem. Default is false."

fn spec.initContainers.securityContext.withRunAsGroup

withRunAsGroup(runAsGroup)

"The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence."

fn spec.initContainers.securityContext.withRunAsNonRoot

withRunAsNonRoot(runAsNonRoot)

"Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence."

fn spec.initContainers.securityContext.withRunAsUser

withRunAsUser(runAsUser)

"The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence."

obj spec.initContainers.securityContext.capabilities

"The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime."

fn spec.initContainers.securityContext.capabilities.withAdd

withAdd(add)

"Added capabilities"

fn spec.initContainers.securityContext.capabilities.withAddMixin

withAddMixin(add)

"Added capabilities"

Note: This function appends passed data to existing values

fn spec.initContainers.securityContext.capabilities.withDrop

withDrop(drop)

"Removed capabilities"

fn spec.initContainers.securityContext.capabilities.withDropMixin

withDropMixin(drop)

"Removed capabilities"

Note: This function appends passed data to existing values

obj spec.initContainers.securityContext.seLinuxOptions

"The SELinux context to be applied to the container. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence."

fn spec.initContainers.securityContext.seLinuxOptions.withLevel

withLevel(level)

"Level is SELinux level label that applies to the container."

fn spec.initContainers.securityContext.seLinuxOptions.withRole

withRole(role)

"Role is a SELinux role label that applies to the container."

fn spec.initContainers.securityContext.seLinuxOptions.withType

withType(type)

"Type is a SELinux type label that applies to the container."

fn spec.initContainers.securityContext.seLinuxOptions.withUser

withUser(user)

"User is a SELinux user label that applies to the container."

obj spec.initContainers.securityContext.windowsOptions

"The Windows specific settings applied to all containers. If unspecified, the options from the PodSecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence."

fn spec.initContainers.securityContext.windowsOptions.withGmsaCredentialSpec

withGmsaCredentialSpec(gmsaCredentialSpec)

"GMSACredentialSpec is where the GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field."

fn spec.initContainers.securityContext.windowsOptions.withGmsaCredentialSpecName

withGmsaCredentialSpecName(gmsaCredentialSpecName)

"GMSACredentialSpecName is the name of the GMSA credential spec to use."

fn spec.initContainers.securityContext.windowsOptions.withRunAsUserName

withRunAsUserName(runAsUserName)

"The UserName in Windows to run the entrypoint of the container process. Defaults to the user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence."

obj spec.initContainers.startupProbe

"StartupProbe indicates that the Pod has successfully initialized. If specified, no other probes are executed until this completes successfully. If this probe fails, the Pod will be restarted, just as if the livenessProbe failed. This can be used to provide different probe parameters at the beginning of a Pod's lifecycle, when it might take a long time to load data or warm a cache, than during steady-state operation. This cannot be updated. This is a beta feature enabled by the StartupProbe feature flag. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes"

fn spec.initContainers.startupProbe.withFailureThreshold

withFailureThreshold(failureThreshold)

"Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1."

fn spec.initContainers.startupProbe.withInitialDelaySeconds

withInitialDelaySeconds(initialDelaySeconds)

"Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes"

fn spec.initContainers.startupProbe.withPeriodSeconds

withPeriodSeconds(periodSeconds)

"How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1."

fn spec.initContainers.startupProbe.withSuccessThreshold

withSuccessThreshold(successThreshold)

"Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1."

fn spec.initContainers.startupProbe.withTimeoutSeconds

withTimeoutSeconds(timeoutSeconds)

"Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes"

obj spec.initContainers.startupProbe.exec

"One and only one of the following should be specified. Exec specifies the action to take."

fn spec.initContainers.startupProbe.exec.withCommand

withCommand(command)

"Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy."

fn spec.initContainers.startupProbe.exec.withCommandMixin

withCommandMixin(command)

"Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy."

Note: This function appends passed data to existing values

obj spec.initContainers.startupProbe.httpGet

"HTTPGet specifies the http request to perform."

fn spec.initContainers.startupProbe.httpGet.withHost

withHost(host)

"Host name to connect to, defaults to the pod IP. You probably want to set \"Host\" in httpHeaders instead."

fn spec.initContainers.startupProbe.httpGet.withHttpHeaders

withHttpHeaders(httpHeaders)

"Custom headers to set in the request. HTTP allows repeated headers."

fn spec.initContainers.startupProbe.httpGet.withHttpHeadersMixin

withHttpHeadersMixin(httpHeaders)

"Custom headers to set in the request. HTTP allows repeated headers."

Note: This function appends passed data to existing values

fn spec.initContainers.startupProbe.httpGet.withPath

withPath(path)

"Path to access on the HTTP server."

fn spec.initContainers.startupProbe.httpGet.withPort

withPort(port)

"Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME."

fn spec.initContainers.startupProbe.httpGet.withScheme

withScheme(scheme)

"Scheme to use for connecting to the host. Defaults to HTTP."

obj spec.initContainers.startupProbe.httpGet.httpHeaders

"Custom headers to set in the request. HTTP allows repeated headers."

fn spec.initContainers.startupProbe.httpGet.httpHeaders.withName

withName(name)

"The header field name"

fn spec.initContainers.startupProbe.httpGet.httpHeaders.withValue

withValue(value)

"The header field value"

obj spec.initContainers.startupProbe.tcpSocket

"TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported TODO: implement a realistic TCP lifecycle hook"

fn spec.initContainers.startupProbe.tcpSocket.withHost

withHost(host)

"Optional: Host name to connect to, defaults to the pod IP."

fn spec.initContainers.startupProbe.tcpSocket.withPort

withPort(port)

"Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME."

obj spec.initContainers.volumeDevices

"volumeDevices is the list of block devices to be used by the container."

fn spec.initContainers.volumeDevices.withDevicePath

withDevicePath(devicePath)

"devicePath is the path inside of the container that the device will be mapped to."

fn spec.initContainers.volumeDevices.withName

withName(name)

"name must match the name of a persistentVolumeClaim in the pod"

obj spec.initContainers.volumeMounts

"Pod volumes to mount into the container's filesystem. Cannot be updated."

fn spec.initContainers.volumeMounts.withMountPath

withMountPath(mountPath)

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

fn spec.initContainers.volumeMounts.withMountPropagation

withMountPropagation(mountPropagation)

"mountPropagation determines how mounts are propagated from the host to container and the other way around. When not set, MountPropagationNone is used. This field is beta in 1.10."

fn spec.initContainers.volumeMounts.withName

withName(name)

"This must match the Name of a Volume."

fn spec.initContainers.volumeMounts.withReadOnly

withReadOnly(readOnly)

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

fn spec.initContainers.volumeMounts.withSubPath

withSubPath(subPath)

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

fn spec.initContainers.volumeMounts.withSubPathExpr

withSubPathExpr(subPathExpr)

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

obj spec.podMetadata

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

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

obj spec.podMonitorNamespaceSelector

"Namespace's labels to match for PodMonitor discovery. If nil, only check own namespace."

fn spec.podMonitorNamespaceSelector.withMatchExpressions

withMatchExpressions(matchExpressions)

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

fn spec.podMonitorNamespaceSelector.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.podMonitorNamespaceSelector.withMatchLabels

withMatchLabels(matchLabels)

"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is \"key\", the operator is \"In\", and the values array contains only \"value\". The requirements are ANDed."

fn spec.podMonitorNamespaceSelector.withMatchLabelsMixin

withMatchLabelsMixin(matchLabels)

"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is \"key\", the operator is \"In\", and the values array contains only \"value\". The requirements are ANDed."

Note: This function appends passed data to existing values

obj spec.podMonitorNamespaceSelector.matchExpressions

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

fn spec.podMonitorNamespaceSelector.matchExpressions.withKey

withKey(key)

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

fn spec.podMonitorNamespaceSelector.matchExpressions.withOperator

withOperator(operator)

"operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist."

fn spec.podMonitorNamespaceSelector.matchExpressions.withValues

withValues(values)

"values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch."

fn spec.podMonitorNamespaceSelector.matchExpressions.withValuesMixin

withValuesMixin(values)

"values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch."

Note: This function appends passed data to existing values

obj spec.podMonitorSelector

"Experimental PodMonitors to be selected for target discovery. Deprecated: if neither this nor serviceMonitorSelector are specified, configuration is unmanaged."

fn spec.podMonitorSelector.withMatchExpressions

withMatchExpressions(matchExpressions)

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

fn spec.podMonitorSelector.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.podMonitorSelector.withMatchLabels

withMatchLabels(matchLabels)

"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is \"key\", the operator is \"In\", and the values array contains only \"value\". The requirements are ANDed."

fn spec.podMonitorSelector.withMatchLabelsMixin

withMatchLabelsMixin(matchLabels)

"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is \"key\", the operator is \"In\", and the values array contains only \"value\". The requirements are ANDed."

Note: This function appends passed data to existing values

obj spec.podMonitorSelector.matchExpressions

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

fn spec.podMonitorSelector.matchExpressions.withKey

withKey(key)

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

fn spec.podMonitorSelector.matchExpressions.withOperator

withOperator(operator)

"operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist."

fn spec.podMonitorSelector.matchExpressions.withValues

withValues(values)

"values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch."

fn spec.podMonitorSelector.matchExpressions.withValuesMixin

withValuesMixin(values)

"values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch."

Note: This function appends passed data to existing values

obj spec.probeNamespaceSelector

"Experimental Namespaces to be selected for Probe discovery. If nil, only check own namespace."

fn spec.probeNamespaceSelector.withMatchExpressions

withMatchExpressions(matchExpressions)

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

fn spec.probeNamespaceSelector.withMatchExpressionsMixin

withMatchExpressionsMixin(matchExpressions)

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

Note: This function appends passed data to existing values

fn spec.probeNamespaceSelector.withMatchLabels

withMatchLabels(matchLabels)

"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is \"key\", the operator is \"In\", and the values array contains only \"value\". The requirements are ANDed."

fn spec.probeNamespaceSelector.withMatchLabelsMixin

withMatchLabelsMixin(matchLabels)

"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is \"key\", the operator is \"In\", and the values array contains only \"value\". The requirements are ANDed."

Note: This function appends passed data to existing values

obj spec.probeNamespaceSelector.matchExpressions

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

fn spec.probeNamespaceSelector.matchExpressions.withKey

withKey(key)

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

fn spec.probeNamespaceSelector.matchExpressions.withOperator

withOperator(operator)

"operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist."

fn spec.probeNamespaceSelector.matchExpressions.withValues

withValues(values)

"values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch."

fn spec.probeNamespaceSelector.matchExpressions.withValuesMixin

withValuesMixin(values)

"values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch."

Note: This function appends passed data to existing values

obj spec.probeSelector

"Experimental Probes to be selected for target discovery."

fn spec.probeSelector.withMatchExpressions

withMatchExpressions(matchExpressions)

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

fn spec.probeSelector.withMatchExpressionsMixin

withMatchExpressionsMixin(matchExpressions)

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

Note: This function appends passed data to existing values

fn spec.probeSelector.withMatchLabels

withMatchLabels(matchLabels)

"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is \"key\", the operator is \"In\", and the values array contains only \"value\". The requirements are ANDed."

fn spec.probeSelector.withMatchLabelsMixin

withMatchLabelsMixin(matchLabels)

"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is \"key\", the operator is \"In\", and the values array contains only \"value\". The requirements are ANDed."

Note: This function appends passed data to existing values

obj spec.probeSelector.matchExpressions

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

fn spec.probeSelector.matchExpressions.withKey

withKey(key)

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

fn spec.probeSelector.matchExpressions.withOperator

withOperator(operator)

"operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist."

fn spec.probeSelector.matchExpressions.withValues

withValues(values)

"values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch."

fn spec.probeSelector.matchExpressions.withValuesMixin

withValuesMixin(values)

"values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch."

Note: This function appends passed data to existing values

obj spec.prometheusRulesExcludedFromEnforce

"PrometheusRulesExcludedFromEnforce - list of prometheus rules to be excluded from enforcing of adding namespace labels. Works only if enforcedNamespaceLabel set to true. Make sure both ruleNamespace and ruleName are set for each pair"

fn spec.prometheusRulesExcludedFromEnforce.withRuleName

withRuleName(ruleName)

"RuleNamespace - name of excluded rule"

fn spec.prometheusRulesExcludedFromEnforce.withRuleNamespace

withRuleNamespace(ruleNamespace)

"RuleNamespace - namespace of excluded rule"

obj spec.query

"QuerySpec defines the query command line flags when starting Prometheus."

fn spec.query.withLookbackDelta

withLookbackDelta(lookbackDelta)

"The delta difference allowed for retrieving metrics during expression evaluations."

fn spec.query.withMaxConcurrency

withMaxConcurrency(maxConcurrency)

"Number of concurrent queries that can be run at once."

fn spec.query.withMaxSamples

withMaxSamples(maxSamples)

"Maximum number of samples a single query can load into memory. Note that queries will fail if they would load more samples than this into memory, so this also limits the number of samples a query can return."

fn spec.query.withTimeout

withTimeout(timeout)

"Maximum time a query may take before being aborted."

obj spec.remoteRead

"If specified, the remote_read spec. This is an experimental feature, it may change in any upcoming release in a breaking way."

fn spec.remoteRead.withBearerToken

withBearerToken(bearerToken)

"Bearer token for remote read."

fn spec.remoteRead.withBearerTokenFile

withBearerTokenFile(bearerTokenFile)

"File to read bearer token for remote read."

fn spec.remoteRead.withName

withName(name)

"The name of the remote read queue, must be unique if specified. The name is used in metrics and logging in order to differentiate read configurations. Only valid in Prometheus versions 2.15.0 and newer."

fn spec.remoteRead.withProxyUrl

withProxyUrl(proxyUrl)

"Optional ProxyURL"

fn spec.remoteRead.withReadRecent

withReadRecent(readRecent)

"Whether reads should be made for queries for time ranges that the local storage should have complete data for."

fn spec.remoteRead.withRemoteTimeout

withRemoteTimeout(remoteTimeout)

"Timeout for requests to the remote read endpoint."

fn spec.remoteRead.withRequiredMatchers

withRequiredMatchers(requiredMatchers)

"An optional list of equality matchers which have to be present in a selector to query the remote read endpoint."

fn spec.remoteRead.withRequiredMatchersMixin

withRequiredMatchersMixin(requiredMatchers)

"An optional list of equality matchers which have to be present in a selector to query the remote read endpoint."

Note: This function appends passed data to existing values

fn spec.remoteRead.withUrl

withUrl(url)

"The URL of the endpoint to send samples to."

obj spec.remoteRead.authorization

"Authorization section for remote read"

fn spec.remoteRead.authorization.withCredentialsFile

withCredentialsFile(credentialsFile)

"File to read a secret from, mutually exclusive with Credentials (from SafeAuthorization)"

fn spec.remoteRead.authorization.withType

withType(type)

"Set the authentication type. Defaults to Bearer, Basic will cause an error"

obj spec.remoteRead.authorization.credentials

"The secret's key that contains the credentials of the request"

fn spec.remoteRead.authorization.credentials.withKey

withKey(key)

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

fn spec.remoteRead.authorization.credentials.withName

withName(name)

"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"

fn spec.remoteRead.authorization.credentials.withOptional

withOptional(optional)

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

obj spec.remoteRead.basicAuth

"BasicAuth for the URL."

obj spec.remoteRead.basicAuth.password

"The secret in the service monitor namespace that contains the password for authentication."

fn spec.remoteRead.basicAuth.password.withKey

withKey(key)

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

fn spec.remoteRead.basicAuth.password.withName

withName(name)

"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"

fn spec.remoteRead.basicAuth.password.withOptional

withOptional(optional)

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

obj spec.remoteRead.basicAuth.username

"The secret in the service monitor namespace that contains the username for authentication."

fn spec.remoteRead.basicAuth.username.withKey

withKey(key)

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

fn spec.remoteRead.basicAuth.username.withName

withName(name)

"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"

fn spec.remoteRead.basicAuth.username.withOptional

withOptional(optional)

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

obj spec.remoteRead.oauth2

"OAuth2 for the URL. Only valid in Prometheus versions 2.27.0 and newer."

fn spec.remoteRead.oauth2.withEndpointParams

withEndpointParams(endpointParams)

"Parameters to append to the token URL"

fn spec.remoteRead.oauth2.withEndpointParamsMixin

withEndpointParamsMixin(endpointParams)

"Parameters to append to the token URL"

Note: This function appends passed data to existing values

fn spec.remoteRead.oauth2.withScopes

withScopes(scopes)

"OAuth2 scopes used for the token request"

fn spec.remoteRead.oauth2.withScopesMixin

withScopesMixin(scopes)

"OAuth2 scopes used for the token request"

Note: This function appends passed data to existing values

fn spec.remoteRead.oauth2.withTokenUrl

withTokenUrl(tokenUrl)

"The URL to fetch the token from"

obj spec.remoteRead.oauth2.clientId

"The secret or configmap containing the OAuth2 client id"

obj spec.remoteRead.oauth2.clientId.configMap

"ConfigMap containing data to use for the targets."

fn spec.remoteRead.oauth2.clientId.configMap.withKey

withKey(key)

"The key to select."

fn spec.remoteRead.oauth2.clientId.configMap.withName

withName(name)

"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"

fn spec.remoteRead.oauth2.clientId.configMap.withOptional

withOptional(optional)

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

obj spec.remoteRead.oauth2.clientId.secret

"Secret containing data to use for the targets."

fn spec.remoteRead.oauth2.clientId.secret.withKey

withKey(key)

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

fn spec.remoteRead.oauth2.clientId.secret.withName

withName(name)

"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"

fn spec.remoteRead.oauth2.clientId.secret.withOptional

withOptional(optional)

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

obj spec.remoteRead.oauth2.clientSecret

"The secret containing the OAuth2 client secret"

fn spec.remoteRead.oauth2.clientSecret.withKey

withKey(key)

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

fn spec.remoteRead.oauth2.clientSecret.withName

withName(name)

"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"

fn spec.remoteRead.oauth2.clientSecret.withOptional

withOptional(optional)

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

obj spec.remoteRead.tlsConfig

"TLS Config to use for remote read."

fn spec.remoteRead.tlsConfig.withCaFile

withCaFile(caFile)

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

fn spec.remoteRead.tlsConfig.withCertFile

withCertFile(certFile)

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

fn spec.remoteRead.tlsConfig.withInsecureSkipVerify

withInsecureSkipVerify(insecureSkipVerify)

"Disable target certificate validation."

fn spec.remoteRead.tlsConfig.withKeyFile

withKeyFile(keyFile)

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

fn spec.remoteRead.tlsConfig.withServerName

withServerName(serverName)

"Used to verify the hostname for the targets."

obj spec.remoteRead.tlsConfig.ca

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

obj spec.remoteRead.tlsConfig.ca.configMap

"ConfigMap containing data to use for the targets."

fn spec.remoteRead.tlsConfig.ca.configMap.withKey

withKey(key)

"The key to select."

fn spec.remoteRead.tlsConfig.ca.configMap.withName

withName(name)

"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"

fn spec.remoteRead.tlsConfig.ca.configMap.withOptional

withOptional(optional)

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

obj spec.remoteRead.tlsConfig.ca.secret

"Secret containing data to use for the targets."

fn spec.remoteRead.tlsConfig.ca.secret.withKey

withKey(key)

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

fn spec.remoteRead.tlsConfig.ca.secret.withName

withName(name)

"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"

fn spec.remoteRead.tlsConfig.ca.secret.withOptional

withOptional(optional)

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

obj spec.remoteRead.tlsConfig.cert

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

obj spec.remoteRead.tlsConfig.cert.configMap

"ConfigMap containing data to use for the targets."

fn spec.remoteRead.tlsConfig.cert.configMap.withKey

withKey(key)

"The key to select."

fn spec.remoteRead.tlsConfig.cert.configMap.withName

withName(name)

"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"

fn spec.remoteRead.tlsConfig.cert.configMap.withOptional

withOptional(optional)

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

obj spec.remoteRead.tlsConfig.cert.secret

"Secret containing data to use for the targets."

fn spec.remoteRead.tlsConfig.cert.secret.withKey

withKey(key)

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

fn spec.remoteRead.tlsConfig.cert.secret.withName

withName(name)

"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"

fn spec.remoteRead.tlsConfig.cert.secret.withOptional

withOptional(optional)

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

obj spec.remoteRead.tlsConfig.keySecret

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

fn spec.remoteRead.tlsConfig.keySecret.withKey

withKey(key)

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

fn spec.remoteRead.tlsConfig.keySecret.withName

withName(name)

"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"

fn spec.remoteRead.tlsConfig.keySecret.withOptional

withOptional(optional)

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

obj spec.remoteWrite

"If specified, the remote_write spec. This is an experimental feature, it may change in any upcoming release in a breaking way."

fn spec.remoteWrite.withBearerToken

withBearerToken(bearerToken)

"Bearer token for remote write."

fn spec.remoteWrite.withBearerTokenFile

withBearerTokenFile(bearerTokenFile)

"File to read bearer token for remote write."

fn spec.remoteWrite.withHeaders

withHeaders(headers)

"Custom HTTP headers to be sent along with each remote write request. Be aware that headers that are set by Prometheus itself can't be overwritten. Only valid in Prometheus versions 2.25.0 and newer."

fn spec.remoteWrite.withHeadersMixin

withHeadersMixin(headers)

"Custom HTTP headers to be sent along with each remote write request. Be aware that headers that are set by Prometheus itself can't be overwritten. Only valid in Prometheus versions 2.25.0 and newer."

Note: This function appends passed data to existing values

fn spec.remoteWrite.withName

withName(name)

"The name of the remote write queue, must be unique if specified. The name is used in metrics and logging in order to differentiate queues. Only valid in Prometheus versions 2.15.0 and newer."

fn spec.remoteWrite.withProxyUrl

withProxyUrl(proxyUrl)

"Optional ProxyURL"

fn spec.remoteWrite.withRemoteTimeout

withRemoteTimeout(remoteTimeout)

"Timeout for requests to the remote write endpoint."

fn spec.remoteWrite.withSendExemplars

withSendExemplars(sendExemplars)

"Enables sending of exemplars over remote write. Note that exemplar-storage itself must be enabled using the enableFeature option for exemplars to be scraped in the first place. Only valid in Prometheus versions 2.27.0 and newer."

fn spec.remoteWrite.withUrl

withUrl(url)

"The URL of the endpoint to send samples to."

fn spec.remoteWrite.withWriteRelabelConfigs

withWriteRelabelConfigs(writeRelabelConfigs)

"The list of remote write relabel configurations."

fn spec.remoteWrite.withWriteRelabelConfigsMixin

withWriteRelabelConfigsMixin(writeRelabelConfigs)

"The list of remote write relabel configurations."

Note: This function appends passed data to existing values

obj spec.remoteWrite.authorization

"Authorization section for remote write"

fn spec.remoteWrite.authorization.withCredentialsFile

withCredentialsFile(credentialsFile)

"File to read a secret from, mutually exclusive with Credentials (from SafeAuthorization)"

fn spec.remoteWrite.authorization.withType

withType(type)

"Set the authentication type. Defaults to Bearer, Basic will cause an error"

obj spec.remoteWrite.authorization.credentials

"The secret's key that contains the credentials of the request"

fn spec.remoteWrite.authorization.credentials.withKey

withKey(key)

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

fn spec.remoteWrite.authorization.credentials.withName

withName(name)

"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"

fn spec.remoteWrite.authorization.credentials.withOptional

withOptional(optional)

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

obj spec.remoteWrite.basicAuth

"BasicAuth for the URL."

obj spec.remoteWrite.basicAuth.password

"The secret in the service monitor namespace that contains the password for authentication."

fn spec.remoteWrite.basicAuth.password.withKey

withKey(key)

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

fn spec.remoteWrite.basicAuth.password.withName

withName(name)

"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"

fn spec.remoteWrite.basicAuth.password.withOptional

withOptional(optional)

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

obj spec.remoteWrite.basicAuth.username

"The secret in the service monitor namespace that contains the username for authentication."

fn spec.remoteWrite.basicAuth.username.withKey

withKey(key)

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

fn spec.remoteWrite.basicAuth.username.withName

withName(name)

"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"

fn spec.remoteWrite.basicAuth.username.withOptional

withOptional(optional)

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

obj spec.remoteWrite.metadataConfig

"MetadataConfig configures the sending of series metadata to remote storage."

fn spec.remoteWrite.metadataConfig.withSend

withSend(send)

"Whether metric metadata is sent to remote storage or not."

fn spec.remoteWrite.metadataConfig.withSendInterval

withSendInterval(sendInterval)

"How frequently metric metadata is sent to remote storage."

obj spec.remoteWrite.oauth2

"OAuth2 for the URL. Only valid in Prometheus versions 2.27.0 and newer."

fn spec.remoteWrite.oauth2.withEndpointParams

withEndpointParams(endpointParams)

"Parameters to append to the token URL"

fn spec.remoteWrite.oauth2.withEndpointParamsMixin

withEndpointParamsMixin(endpointParams)

"Parameters to append to the token URL"

Note: This function appends passed data to existing values

fn spec.remoteWrite.oauth2.withScopes

withScopes(scopes)

"OAuth2 scopes used for the token request"

fn spec.remoteWrite.oauth2.withScopesMixin

withScopesMixin(scopes)

"OAuth2 scopes used for the token request"

Note: This function appends passed data to existing values

fn spec.remoteWrite.oauth2.withTokenUrl

withTokenUrl(tokenUrl)

"The URL to fetch the token from"

obj spec.remoteWrite.oauth2.clientId

"The secret or configmap containing the OAuth2 client id"

obj spec.remoteWrite.oauth2.clientId.configMap

"ConfigMap containing data to use for the targets."

fn spec.remoteWrite.oauth2.clientId.configMap.withKey

withKey(key)

"The key to select."

fn spec.remoteWrite.oauth2.clientId.configMap.withName

withName(name)

"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"

fn spec.remoteWrite.oauth2.clientId.configMap.withOptional

withOptional(optional)

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

obj spec.remoteWrite.oauth2.clientId.secret

"Secret containing data to use for the targets."

fn spec.remoteWrite.oauth2.clientId.secret.withKey

withKey(key)

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

fn spec.remoteWrite.oauth2.clientId.secret.withName

withName(name)

"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"

fn spec.remoteWrite.oauth2.clientId.secret.withOptional

withOptional(optional)

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

obj spec.remoteWrite.oauth2.clientSecret

"The secret containing the OAuth2 client secret"

fn spec.remoteWrite.oauth2.clientSecret.withKey

withKey(key)

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

fn spec.remoteWrite.oauth2.clientSecret.withName

withName(name)

"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"

fn spec.remoteWrite.oauth2.clientSecret.withOptional

withOptional(optional)

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

obj spec.remoteWrite.queueConfig

"QueueConfig allows tuning of the remote write queue parameters."

fn spec.remoteWrite.queueConfig.withBatchSendDeadline

withBatchSendDeadline(batchSendDeadline)

"BatchSendDeadline is the maximum time a sample will wait in buffer."

fn spec.remoteWrite.queueConfig.withCapacity

withCapacity(capacity)

"Capacity is the number of samples to buffer per shard before we start dropping them."

fn spec.remoteWrite.queueConfig.withMaxBackoff

withMaxBackoff(maxBackoff)

"MaxBackoff is the maximum retry delay."

fn spec.remoteWrite.queueConfig.withMaxRetries

withMaxRetries(maxRetries)

"MaxRetries is the maximum number of times to retry a batch on recoverable errors."

fn spec.remoteWrite.queueConfig.withMaxSamplesPerSend

withMaxSamplesPerSend(maxSamplesPerSend)

"MaxSamplesPerSend is the maximum number of samples per send."

fn spec.remoteWrite.queueConfig.withMaxShards

withMaxShards(maxShards)

"MaxShards is the maximum number of shards, i.e. amount of concurrency."

fn spec.remoteWrite.queueConfig.withMinBackoff

withMinBackoff(minBackoff)

"MinBackoff is the initial retry delay. Gets doubled for every retry."

fn spec.remoteWrite.queueConfig.withMinShards

withMinShards(minShards)

"MinShards is the minimum number of shards, i.e. amount of concurrency."

obj spec.remoteWrite.tlsConfig

"TLS Config to use for remote write."

fn spec.remoteWrite.tlsConfig.withCaFile

withCaFile(caFile)

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

fn spec.remoteWrite.tlsConfig.withCertFile

withCertFile(certFile)

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

fn spec.remoteWrite.tlsConfig.withInsecureSkipVerify

withInsecureSkipVerify(insecureSkipVerify)

"Disable target certificate validation."

fn spec.remoteWrite.tlsConfig.withKeyFile

withKeyFile(keyFile)

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

fn spec.remoteWrite.tlsConfig.withServerName

withServerName(serverName)

"Used to verify the hostname for the targets."

obj spec.remoteWrite.tlsConfig.ca

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

obj spec.remoteWrite.tlsConfig.ca.configMap

"ConfigMap containing data to use for the targets."

fn spec.remoteWrite.tlsConfig.ca.configMap.withKey

withKey(key)

"The key to select."

fn spec.remoteWrite.tlsConfig.ca.configMap.withName

withName(name)

"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"

fn spec.remoteWrite.tlsConfig.ca.configMap.withOptional

withOptional(optional)

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

obj spec.remoteWrite.tlsConfig.ca.secret

"Secret containing data to use for the targets."

fn spec.remoteWrite.tlsConfig.ca.secret.withKey

withKey(key)

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

fn spec.remoteWrite.tlsConfig.ca.secret.withName

withName(name)

"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"

fn spec.remoteWrite.tlsConfig.ca.secret.withOptional

withOptional(optional)

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

obj spec.remoteWrite.tlsConfig.cert

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

obj spec.remoteWrite.tlsConfig.cert.configMap

"ConfigMap containing data to use for the targets."

fn spec.remoteWrite.tlsConfig.cert.configMap.withKey

withKey(key)

"The key to select."

fn spec.remoteWrite.tlsConfig.cert.configMap.withName

withName(name)

"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"

fn spec.remoteWrite.tlsConfig.cert.configMap.withOptional

withOptional(optional)

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

obj spec.remoteWrite.tlsConfig.cert.secret

"Secret containing data to use for the targets."

fn spec.remoteWrite.tlsConfig.cert.secret.withKey

withKey(key)

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

fn spec.remoteWrite.tlsConfig.cert.secret.withName

withName(name)

"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"

fn spec.remoteWrite.tlsConfig.cert.secret.withOptional

withOptional(optional)

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

obj spec.remoteWrite.tlsConfig.keySecret

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

fn spec.remoteWrite.tlsConfig.keySecret.withKey

withKey(key)

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

fn spec.remoteWrite.tlsConfig.keySecret.withName

withName(name)

"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"

fn spec.remoteWrite.tlsConfig.keySecret.withOptional

withOptional(optional)

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

obj spec.remoteWrite.writeRelabelConfigs

"The list of remote write relabel configurations."

fn spec.remoteWrite.writeRelabelConfigs.withAction

withAction(action)

"Action to perform based on regex matching. Default is 'replace'"

fn spec.remoteWrite.writeRelabelConfigs.withModulus

withModulus(modulus)

"Modulus to take of the hash of the source label values."

fn spec.remoteWrite.writeRelabelConfigs.withRegex

withRegex(regex)

"Regular expression against which the extracted value is matched. Default is '(.*)'"

fn spec.remoteWrite.writeRelabelConfigs.withReplacement

withReplacement(replacement)

"Replacement value against which a regex replace is performed if the regular expression matches. Regex capture groups are available. Default is '$1'"

fn spec.remoteWrite.writeRelabelConfigs.withSeparator

withSeparator(separator)

"Separator placed between concatenated source label values. default is ';'."

fn spec.remoteWrite.writeRelabelConfigs.withSourceLabels

withSourceLabels(sourceLabels)

"The source labels select values from existing labels. Their content is concatenated using the configured separator and matched against the configured regular expression for the replace, keep, and drop actions."

fn spec.remoteWrite.writeRelabelConfigs.withSourceLabelsMixin

withSourceLabelsMixin(sourceLabels)

"The source labels select values from existing labels. Their content is concatenated using the configured separator and matched against the configured regular expression for the replace, keep, and drop actions."

Note: This function appends passed data to existing values

fn spec.remoteWrite.writeRelabelConfigs.withTargetLabel

withTargetLabel(targetLabel)

"Label to which the resulting value is written in a replace action. It is mandatory for replace actions. Regex capture groups are available."

obj spec.resources

"Define resources requests and limits for single Pods."

fn spec.resources.withLimits

withLimits(limits)

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

fn spec.resources.withLimitsMixin

withLimitsMixin(limits)

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

Note: This function appends passed data to existing values

fn spec.resources.withRequests

withRequests(requests)

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

fn spec.resources.withRequestsMixin

withRequestsMixin(requests)

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

Note: This function appends passed data to existing values

obj spec.ruleNamespaceSelector

"Namespaces to be selected for PrometheusRules discovery. If unspecified, only the same namespace as the Prometheus object is in is used."

fn spec.ruleNamespaceSelector.withMatchExpressions

withMatchExpressions(matchExpressions)

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

fn spec.ruleNamespaceSelector.withMatchExpressionsMixin

withMatchExpressionsMixin(matchExpressions)

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

Note: This function appends passed data to existing values

fn spec.ruleNamespaceSelector.withMatchLabels

withMatchLabels(matchLabels)

"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is \"key\", the operator is \"In\", and the values array contains only \"value\". The requirements are ANDed."

fn spec.ruleNamespaceSelector.withMatchLabelsMixin

withMatchLabelsMixin(matchLabels)

"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is \"key\", the operator is \"In\", and the values array contains only \"value\". The requirements are ANDed."

Note: This function appends passed data to existing values

obj spec.ruleNamespaceSelector.matchExpressions

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

fn spec.ruleNamespaceSelector.matchExpressions.withKey

withKey(key)

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

fn spec.ruleNamespaceSelector.matchExpressions.withOperator

withOperator(operator)

"operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist."

fn spec.ruleNamespaceSelector.matchExpressions.withValues

withValues(values)

"values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch."

fn spec.ruleNamespaceSelector.matchExpressions.withValuesMixin

withValuesMixin(values)

"values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch."

Note: This function appends passed data to existing values

obj spec.ruleSelector

"A selector to select which PrometheusRules to mount for loading alerting/recording rules from. Until (excluding) Prometheus Operator v0.24.0 Prometheus Operator will migrate any legacy rule ConfigMaps to PrometheusRule custom resources selected by RuleSelector. Make sure it does not match any config maps that you do not want to be migrated."

fn spec.ruleSelector.withMatchExpressions

withMatchExpressions(matchExpressions)

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

fn spec.ruleSelector.withMatchExpressionsMixin

withMatchExpressionsMixin(matchExpressions)

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

Note: This function appends passed data to existing values

fn spec.ruleSelector.withMatchLabels

withMatchLabels(matchLabels)

"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is \"key\", the operator is \"In\", and the values array contains only \"value\". The requirements are ANDed."

fn spec.ruleSelector.withMatchLabelsMixin

withMatchLabelsMixin(matchLabels)

"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is \"key\", the operator is \"In\", and the values array contains only \"value\". The requirements are ANDed."

Note: This function appends passed data to existing values

obj spec.ruleSelector.matchExpressions

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

fn spec.ruleSelector.matchExpressions.withKey

withKey(key)

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

fn spec.ruleSelector.matchExpressions.withOperator

withOperator(operator)

"operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist."

fn spec.ruleSelector.matchExpressions.withValues

withValues(values)

"values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch."

fn spec.ruleSelector.matchExpressions.withValuesMixin

withValuesMixin(values)

"values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch."

Note: This function appends passed data to existing values

obj spec.rules

"/--rules.*/ command-line arguments."

obj spec.rules.alert

"/--rules.alert.*/ command-line arguments"

fn spec.rules.alert.withForGracePeriod

withForGracePeriod(forGracePeriod)

"Minimum duration between alert and restored 'for' state. This is maintained only for alerts with configured 'for' time greater than grace period."

fn spec.rules.alert.withForOutageTolerance

withForOutageTolerance(forOutageTolerance)

"Max time to tolerate prometheus outage for restoring 'for' state of alert."

fn spec.rules.alert.withResendDelay

withResendDelay(resendDelay)

"Minimum amount of time to wait before resending an alert to Alertmanager."

obj spec.securityContext

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

fn spec.securityContext.withFsGroup

withFsGroup(fsGroup)

"A special supplemental group that applies to all containers in a pod. Some volume types allow the Kubelet to change the ownership of that volume to be owned by the pod: \n 1. The owning GID will be the FSGroup 2. The setgid bit is set (new files created in the volume will be owned by FSGroup) 3. The permission bits are OR'd with rw-rw---- \n If unset, the Kubelet will not modify the ownership and permissions of any volume."

fn spec.securityContext.withFsGroupChangePolicy

withFsGroupChangePolicy(fsGroupChangePolicy)

"fsGroupChangePolicy defines behavior of changing ownership and permission of the volume before being exposed inside Pod. This field will only apply to volume types which support fsGroup based ownership(and permissions). It will have no effect on ephemeral volume types such as: secret, configmaps and emptydir. Valid values are \"OnRootMismatch\" and \"Always\". If not specified defaults to \"Always\"."

fn spec.securityContext.withRunAsGroup

withRunAsGroup(runAsGroup)

"The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container."

fn spec.securityContext.withRunAsNonRoot

withRunAsNonRoot(runAsNonRoot)

"Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence."

fn spec.securityContext.withRunAsUser

withRunAsUser(runAsUser)

"The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container."

fn spec.securityContext.withSupplementalGroups

withSupplementalGroups(supplementalGroups)

"A list of groups applied to the first process run in each container, in addition to the container's primary GID. If unspecified, no groups will be added to any container."

fn spec.securityContext.withSupplementalGroupsMixin

withSupplementalGroupsMixin(supplementalGroups)

"A list of groups applied to the first process run in each container, in addition to the container's primary GID. If unspecified, no groups will be added to any container."

Note: This function appends passed data to existing values

fn spec.securityContext.withSysctls

withSysctls(sysctls)

"Sysctls hold a list of namespaced sysctls used for the pod. Pods with unsupported sysctls (by the container runtime) might fail to launch."

fn spec.securityContext.withSysctlsMixin

withSysctlsMixin(sysctls)

"Sysctls hold a list of namespaced sysctls used for the pod. Pods with unsupported sysctls (by the container runtime) might fail to launch."

Note: This function appends passed data to existing values

obj spec.securityContext.seLinuxOptions

"The SELinux context to be applied to all containers. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container."

fn spec.securityContext.seLinuxOptions.withLevel

withLevel(level)

"Level is SELinux level label that applies to the container."

fn spec.securityContext.seLinuxOptions.withRole

withRole(role)

"Role is a SELinux role label that applies to the container."

fn spec.securityContext.seLinuxOptions.withType

withType(type)

"Type is a SELinux type label that applies to the container."

fn spec.securityContext.seLinuxOptions.withUser

withUser(user)

"User is a SELinux user label that applies to the container."

obj spec.securityContext.sysctls

"Sysctls hold a list of namespaced sysctls used for the pod. Pods with unsupported sysctls (by the container runtime) might fail to launch."

fn spec.securityContext.sysctls.withName

withName(name)

"Name of a property to set"

fn spec.securityContext.sysctls.withValue

withValue(value)

"Value of a property to set"

obj spec.securityContext.windowsOptions

"The Windows specific settings applied to all containers. If unspecified, the options within a container's SecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence."

fn spec.securityContext.windowsOptions.withGmsaCredentialSpec

withGmsaCredentialSpec(gmsaCredentialSpec)

"GMSACredentialSpec is where the GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field."

fn spec.securityContext.windowsOptions.withGmsaCredentialSpecName

withGmsaCredentialSpecName(gmsaCredentialSpecName)

"GMSACredentialSpecName is the name of the GMSA credential spec to use."

fn spec.securityContext.windowsOptions.withRunAsUserName

withRunAsUserName(runAsUserName)

"The UserName in Windows to run the entrypoint of the container process. Defaults to the user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence."

obj spec.serviceMonitorNamespaceSelector

"Namespace's labels to match for ServiceMonitor discovery. If nil, only check own namespace."

fn spec.serviceMonitorNamespaceSelector.withMatchExpressions

withMatchExpressions(matchExpressions)

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

fn spec.serviceMonitorNamespaceSelector.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.serviceMonitorNamespaceSelector.withMatchLabels

withMatchLabels(matchLabels)

"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is \"key\", the operator is \"In\", and the values array contains only \"value\". The requirements are ANDed."

fn spec.serviceMonitorNamespaceSelector.withMatchLabelsMixin

withMatchLabelsMixin(matchLabels)

"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is \"key\", the operator is \"In\", and the values array contains only \"value\". The requirements are ANDed."

Note: This function appends passed data to existing values

obj spec.serviceMonitorNamespaceSelector.matchExpressions

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

fn spec.serviceMonitorNamespaceSelector.matchExpressions.withKey

withKey(key)

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

fn spec.serviceMonitorNamespaceSelector.matchExpressions.withOperator

withOperator(operator)

"operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist."

fn spec.serviceMonitorNamespaceSelector.matchExpressions.withValues

withValues(values)

"values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch."

fn spec.serviceMonitorNamespaceSelector.matchExpressions.withValuesMixin

withValuesMixin(values)

"values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch."

Note: This function appends passed data to existing values

obj spec.serviceMonitorSelector

"ServiceMonitors to be selected for target discovery. Deprecated: if neither this nor podMonitorSelector are specified, configuration is unmanaged."

fn spec.serviceMonitorSelector.withMatchExpressions

withMatchExpressions(matchExpressions)

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

fn spec.serviceMonitorSelector.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.serviceMonitorSelector.withMatchLabels

withMatchLabels(matchLabels)

"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is \"key\", the operator is \"In\", and the values array contains only \"value\". The requirements are ANDed."

fn spec.serviceMonitorSelector.withMatchLabelsMixin

withMatchLabelsMixin(matchLabels)

"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is \"key\", the operator is \"In\", and the values array contains only \"value\". The requirements are ANDed."

Note: This function appends passed data to existing values

obj spec.serviceMonitorSelector.matchExpressions

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

fn spec.serviceMonitorSelector.matchExpressions.withKey

withKey(key)

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

fn spec.serviceMonitorSelector.matchExpressions.withOperator

withOperator(operator)

"operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist."

fn spec.serviceMonitorSelector.matchExpressions.withValues

withValues(values)

"values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch."

fn spec.serviceMonitorSelector.matchExpressions.withValuesMixin

withValuesMixin(values)

"values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch."

Note: This function appends passed data to existing values

obj spec.storage

"Storage spec to specify how storage shall be used."

fn spec.storage.withDisableMountSubPath

withDisableMountSubPath(disableMountSubPath)

"Deprecated: subPath usage will be disabled by default in a future release, this option will become unnecessary. DisableMountSubPath 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 info: https://kubernetes.io/docs/concepts/storage/volumes/#emptydir"

fn spec.storage.emptyDir.withMedium

withMedium(medium)

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

fn spec.storage.emptyDir.withSizeLimit

withSizeLimit(sizeLimit)

"Total amount of local storage required for this EmptyDir volume. The size limit is also applicable for memory medium. The maximum usage on memory medium EmptyDir would be the minimum value between the SizeLimit specified here and the sum of memory limits of all containers in a pod. The default is nil which means that the limit is undefined. More info: http://kubernetes.io/docs/user-guide/volumes#emptydir"

obj spec.storage.volumeClaimTemplate

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

fn spec.storage.volumeClaimTemplate.withApiVersion

withApiVersion(apiVersion)

"APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More 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. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More 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 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 spec.storage.volumeClaimTemplate.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 spec.storage.volumeClaimTemplate.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 spec.storage.volumeClaimTemplate.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 spec.storage.volumeClaimTemplate.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"

obj spec.storage.volumeClaimTemplate.spec

"Spec defines the desired characteristics of a volume requested by a pod author. More 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. More 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. More 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)

"Name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1"

fn spec.storage.volumeClaimTemplate.spec.withVolumeMode

withVolumeMode(volumeMode)

"volumeMode defines what type of volume is required by the claim. Value 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

"This field can be used to specify either: * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot - Beta) * An existing PVC (PersistentVolumeClaim) * An existing custom resource/object that implements data population (Alpha) In order to use VolumeSnapshot object types, the appropriate feature gate must be enabled (VolumeSnapshotDataSource or AnyVolumeDataSource) If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source. If the specified data source is not supported, the volume will not be created and the failure will be reported as an event. In the future, we plan to support more data source types and the behavior of the provisioner may change."

fn spec.storage.volumeClaimTemplate.spec.dataSource.withApiGroup

withApiGroup(apiGroup)

"APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For 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.resources

"Resources represents the minimum resources the volume should have. More 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. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/"

fn spec.storage.volumeClaimTemplate.spec.resources.withLimitsMixin

withLimitsMixin(limits)

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

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. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/"

fn spec.storage.volumeClaimTemplate.spec.resources.withRequestsMixin

withRequestsMixin(requests)

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

Note: This function appends passed data to existing values

obj spec.storage.volumeClaimTemplate.spec.selector

"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 map is equivalent to an element of matchExpressions, whose key field is \"key\", the operator 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 map is equivalent to an element of matchExpressions, whose key field is \"key\", the operator 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. Valid 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, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge 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, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch."

Note: This function appends passed data to existing values

obj spec.thanos

"Thanos configuration allows configuring various aspects of a Prometheus server in a Thanos environment. \n This section is experimental, it may change significantly without deprecation notice in any release. \n This is experimental and may change significantly without backward compatibility in any release."

fn spec.thanos.withBaseImage

withBaseImage(baseImage)

"Thanos base image if other than default. Deprecated: use 'image' instead"

fn spec.thanos.withImage

withImage(image)

"Image if specified has precedence over baseImage, tag and sha combinations. Specifying the version is still necessary to ensure the Prometheus Operator knows what version of Thanos is being configured."

fn spec.thanos.withListenLocal

withListenLocal(listenLocal)

"ListenLocal makes the Thanos sidecar listen on loopback, so that it does not bind against the Pod IP."

fn spec.thanos.withLogFormat

withLogFormat(logFormat)

"LogFormat for Thanos sidecar to be configured with."

fn spec.thanos.withLogLevel

withLogLevel(logLevel)

"LogLevel for Thanos sidecar to be configured with."

fn spec.thanos.withMinTime

withMinTime(minTime)

"MinTime for Thanos sidecar to be configured with. Option can be a constant time in RFC3339 format or time duration relative to current time, such as -1d or 2h45m. Valid duration units are ms, s, m, h, d, w, y."

fn spec.thanos.withObjectStorageConfigFile

withObjectStorageConfigFile(objectStorageConfigFile)

"ObjectStorageConfigFile specifies the path of the object storage configuration file. When used alongside with ObjectStorageConfig, ObjectStorageConfigFile takes precedence."

fn spec.thanos.withReadyTimeout

withReadyTimeout(readyTimeout)

"ReadyTimeout is the maximum time Thanos sidecar will wait for Prometheus to start. Eg 10m"

fn spec.thanos.withSha

withSha(sha)

"SHA of Thanos container image to be deployed. Defaults to the value of version. Similar to a tag, but the SHA explicitly deploys an immutable container image. Version and Tag are ignored if SHA is set. Deprecated: use 'image' instead. The image digest can be specified as part of the image URL."

fn spec.thanos.withTag

withTag(tag)

"Tag of Thanos sidecar container image to be deployed. Defaults to the value of version. Version is ignored if Tag is set. Deprecated: use 'image' instead. The image tag can be specified as part of the image URL."

fn spec.thanos.withTracingConfigFile

withTracingConfigFile(tracingConfigFile)

"TracingConfig specifies the path of the tracing configuration file. When used alongside with TracingConfig, TracingConfigFile takes precedence."

fn spec.thanos.withVersion

withVersion(version)

"Version describes the version of Thanos to use."

obj spec.thanos.grpcServerTlsConfig

"GRPCServerTLSConfig configures the gRPC server from which Thanos Querier reads recorded rule data. Note: Currently only the CAFile, CertFile, and KeyFile fields are supported. Maps to the '--grpc-server-tls-*' CLI args."

fn spec.thanos.grpcServerTlsConfig.withCaFile

withCaFile(caFile)

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

fn spec.thanos.grpcServerTlsConfig.withCertFile

withCertFile(certFile)

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

fn spec.thanos.grpcServerTlsConfig.withInsecureSkipVerify

withInsecureSkipVerify(insecureSkipVerify)

"Disable target certificate validation."

fn spec.thanos.grpcServerTlsConfig.withKeyFile

withKeyFile(keyFile)

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

fn spec.thanos.grpcServerTlsConfig.withServerName

withServerName(serverName)

"Used to verify the hostname for the targets."

obj spec.thanos.grpcServerTlsConfig.ca

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

obj spec.thanos.grpcServerTlsConfig.ca.configMap

"ConfigMap containing data to use for the targets."

fn spec.thanos.grpcServerTlsConfig.ca.configMap.withKey

withKey(key)

"The key to select."

fn spec.thanos.grpcServerTlsConfig.ca.configMap.withName

withName(name)

"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"

fn spec.thanos.grpcServerTlsConfig.ca.configMap.withOptional

withOptional(optional)

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

obj spec.thanos.grpcServerTlsConfig.ca.secret

"Secret containing data to use for the targets."

fn spec.thanos.grpcServerTlsConfig.ca.secret.withKey

withKey(key)

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

fn spec.thanos.grpcServerTlsConfig.ca.secret.withName

withName(name)

"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"

fn spec.thanos.grpcServerTlsConfig.ca.secret.withOptional

withOptional(optional)

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

obj spec.thanos.grpcServerTlsConfig.cert

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

obj spec.thanos.grpcServerTlsConfig.cert.configMap

"ConfigMap containing data to use for the targets."

fn spec.thanos.grpcServerTlsConfig.cert.configMap.withKey

withKey(key)

"The key to select."

fn spec.thanos.grpcServerTlsConfig.cert.configMap.withName

withName(name)

"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"

fn spec.thanos.grpcServerTlsConfig.cert.configMap.withOptional

withOptional(optional)

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

obj spec.thanos.grpcServerTlsConfig.cert.secret

"Secret containing data to use for the targets."

fn spec.thanos.grpcServerTlsConfig.cert.secret.withKey

withKey(key)

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

fn spec.thanos.grpcServerTlsConfig.cert.secret.withName

withName(name)

"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"

fn spec.thanos.grpcServerTlsConfig.cert.secret.withOptional

withOptional(optional)

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

obj spec.thanos.grpcServerTlsConfig.keySecret

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

fn spec.thanos.grpcServerTlsConfig.keySecret.withKey

withKey(key)

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

fn spec.thanos.grpcServerTlsConfig.keySecret.withName

withName(name)

"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"

fn spec.thanos.grpcServerTlsConfig.keySecret.withOptional

withOptional(optional)

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

obj spec.thanos.objectStorageConfig

"ObjectStorageConfig configures object storage in Thanos. Alternative to ObjectStorageConfigFile, and lower order priority."

fn spec.thanos.objectStorageConfig.withKey

withKey(key)

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

fn spec.thanos.objectStorageConfig.withName

withName(name)

"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"

fn spec.thanos.objectStorageConfig.withOptional

withOptional(optional)

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

obj spec.thanos.resources

"Resources defines the resource requirements for the Thanos sidecar. If not provided, no requests/limits will be set"

fn spec.thanos.resources.withLimits

withLimits(limits)

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

fn spec.thanos.resources.withLimitsMixin

withLimitsMixin(limits)

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

Note: This function appends passed data to existing values

fn spec.thanos.resources.withRequests

withRequests(requests)

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

fn spec.thanos.resources.withRequestsMixin

withRequestsMixin(requests)

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

Note: This function appends passed data to existing values

obj spec.thanos.tracingConfig

"TracingConfig configures tracing in Thanos. This is an experimental feature, it may change in any upcoming release in a breaking way."

fn spec.thanos.tracingConfig.withKey

withKey(key)

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

fn spec.thanos.tracingConfig.withName

withName(name)

"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"

fn spec.thanos.tracingConfig.withOptional

withOptional(optional)

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

obj spec.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. When 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. If 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. Valid operators are Exists and Equal. Defaults to Equal. Exists is equivalent to wildcard for value, so that a pod can tolerate all taints of a particular category."

fn spec.tolerations.withTolerationSeconds

withTolerationSeconds(tolerationSeconds)

"TolerationSeconds represents the period of time the toleration (which must be of effect NoExecute, otherwise this field is ignored) tolerates the taint. By default, it is not set, which means tolerate the taint forever (do not evict). Zero and negative 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. If the operator is Exists, the value should be empty, otherwise just a regular string."

obj spec.topologySpreadConstraints

"If specified, the pod's topology spread constraints."

fn spec.topologySpreadConstraints.withMaxSkew

withMaxSkew(maxSkew)

"MaxSkew describes the degree to which pods may be unevenly distributed. It's the maximum permitted difference between the number of matching pods in any two topology domains of a given topology type. For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same labelSelector spread as 1/1/0: | zone1 | zone2 | zone3 | | P | P | | - if MaxSkew is 1, incoming pod can only be scheduled to zone3 to become 1/1/1; scheduling it onto zone1(zone2) would make the ActualSkew(2-0) on zone1(zone2) violate MaxSkew(1). - if MaxSkew is 2, incoming pod can be scheduled onto any zone. It's a required field. Default value is 1 and 0 is not allowed."

fn spec.topologySpreadConstraints.withTopologyKey

withTopologyKey(topologyKey)

"TopologyKey is the key of node labels. Nodes that have a label with this key and identical values are considered to be in the same topology. We consider each as a \"bucket\", and try to put balanced number of pods into each bucket. It's a required field."

fn spec.topologySpreadConstraints.withWhenUnsatisfiable

withWhenUnsatisfiable(whenUnsatisfiable)

"WhenUnsatisfiable indicates how to deal with a pod if it doesn't satisfy the spread constraint. - DoNotSchedule (default) tells the scheduler not to schedule it - ScheduleAnyway tells the scheduler to still schedule it It's considered as \"Unsatisfiable\" if and only if placing incoming pod on any topology violates \"MaxSkew\". For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same labelSelector spread as 3/1/1: | zone1 | zone2 | zone3 | | P P P | P | P | If WhenUnsatisfiable is set to DoNotSchedule, incoming pod can only be scheduled to zone2(zone3) to become 3/2/1(3/1/2) as ActualSkew(2-1) on zone2(zone3) satisfies MaxSkew(1). In other words, the cluster can still be imbalanced, but scheduler won't make it more imbalanced. It's a required field."

obj spec.topologySpreadConstraints.labelSelector

"LabelSelector is used to find matching pods. Pods that match this label selector are counted to determine the number of pods in their corresponding topology domain."

fn spec.topologySpreadConstraints.labelSelector.withMatchExpressions

withMatchExpressions(matchExpressions)

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

fn spec.topologySpreadConstraints.labelSelector.withMatchExpressionsMixin

withMatchExpressionsMixin(matchExpressions)

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

Note: This function appends passed data to existing values

fn spec.topologySpreadConstraints.labelSelector.withMatchLabels

withMatchLabels(matchLabels)

"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is \"key\", the operator is \"In\", and the values array contains only \"value\". The requirements are ANDed."

fn spec.topologySpreadConstraints.labelSelector.withMatchLabelsMixin

withMatchLabelsMixin(matchLabels)

"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is \"key\", the operator is \"In\", and the values array contains only \"value\". The requirements are ANDed."

Note: This function appends passed data to existing values

obj spec.topologySpreadConstraints.labelSelector.matchExpressions

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

fn spec.topologySpreadConstraints.labelSelector.matchExpressions.withKey

withKey(key)

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

fn spec.topologySpreadConstraints.labelSelector.matchExpressions.withOperator

withOperator(operator)

"operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist."

fn spec.topologySpreadConstraints.labelSelector.matchExpressions.withValues

withValues(values)

"values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch."

fn spec.topologySpreadConstraints.labelSelector.matchExpressions.withValuesMixin

withValuesMixin(values)

"values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch."

Note: This function appends passed data to existing values

obj spec.volumeMounts

"VolumeMounts allows configuration of additional VolumeMounts on the output StatefulSet definition. VolumeMounts specified will be appended to other VolumeMounts in the prometheus container, that are generated as a result of StorageSpec objects."

fn spec.volumeMounts.withMountPath

withMountPath(mountPath)

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

fn spec.volumeMounts.withMountPropagation

withMountPropagation(mountPropagation)

"mountPropagation determines how mounts are propagated from the host to container and the other way around. When not set, MountPropagationNone is used. This field is beta in 1.10."

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). Defaults to false."

fn spec.volumeMounts.withSubPath

withSubPath(subPath)

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

fn spec.volumeMounts.withSubPathExpr

withSubPathExpr(subPathExpr)

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

obj spec.volumes

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

fn spec.volumes.withName

withName(name)

"Volume's name. Must be a DNS_LABEL and unique within the pod. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

obj spec.volumes.awsElasticBlockStore

"AWSElasticBlockStore represents an AWS Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore"

fn spec.volumes.awsElasticBlockStore.withFsType

withFsType(fsType)

"Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore TODO: how do we prevent errors in the filesystem from compromising the machine"

fn spec.volumes.awsElasticBlockStore.withPartition

withPartition(partition)

"The partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as \"1\". Similarly, the volume partition for /dev/sda is \"0\" (or you can leave the property empty)."

fn spec.volumes.awsElasticBlockStore.withReadOnly

withReadOnly(readOnly)

"Specify \"true\" to force and set the ReadOnly property in VolumeMounts to \"true\". If omitted, the default is \"false\". More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore"

fn spec.volumes.awsElasticBlockStore.withVolumeID

withVolumeID(volumeID)

"Unique ID of the persistent disk resource in AWS (Amazon EBS volume). More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore"

obj spec.volumes.azureDisk

"AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod."

fn spec.volumes.azureDisk.withCachingMode

withCachingMode(cachingMode)

"Host Caching mode: None, Read Only, Read Write."

fn spec.volumes.azureDisk.withDiskName

withDiskName(diskName)

"The Name of the data disk in the blob storage"

fn spec.volumes.azureDisk.withDiskURI

withDiskURI(diskURI)

"The URI the data disk in the blob storage"

fn spec.volumes.azureDisk.withFsType

withFsType(fsType)

"Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified."

fn spec.volumes.azureDisk.withKind

withKind(kind)

"Expected values Shared: multiple blob disks per storage account Dedicated: single blob disk per storage account Managed: azure managed data disk (only in managed availability set). defaults to shared"

fn spec.volumes.azureDisk.withReadOnly

withReadOnly(readOnly)

"Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts."

obj spec.volumes.azureFile

"AzureFile represents an Azure File Service mount on the host and bind mount to the pod."

fn spec.volumes.azureFile.withReadOnly

withReadOnly(readOnly)

"Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts."

fn spec.volumes.azureFile.withSecretName

withSecretName(secretName)

"the name of secret that contains Azure Storage Account Name and Key"

fn spec.volumes.azureFile.withShareName

withShareName(shareName)

"Share Name"

obj spec.volumes.cephfs

"CephFS represents a Ceph FS mount on the host that shares a pod's lifetime"

fn spec.volumes.cephfs.withMonitors

withMonitors(monitors)

"Required: Monitors is a collection of Ceph monitors More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it"

fn spec.volumes.cephfs.withMonitorsMixin

withMonitorsMixin(monitors)

"Required: Monitors is a collection of Ceph monitors More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it"

Note: This function appends passed data to existing values

fn spec.volumes.cephfs.withPath

withPath(path)

"Optional: Used as the mounted root, rather than the full Ceph tree, default is /"

fn spec.volumes.cephfs.withReadOnly

withReadOnly(readOnly)

"Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it"

fn spec.volumes.cephfs.withSecretFile

withSecretFile(secretFile)

"Optional: SecretFile is the path to key ring for User, default is /etc/ceph/user.secret More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it"

fn spec.volumes.cephfs.withUser

withUser(user)

"Optional: User is the rados user name, default is admin More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it"

obj spec.volumes.cephfs.secretRef

"Optional: SecretRef is reference to the authentication secret for User, default is empty. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it"

fn spec.volumes.cephfs.secretRef.withName

withName(name)

"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"

obj spec.volumes.cinder

"Cinder represents a cinder volume attached and mounted on kubelets host machine. More info: https://examples.k8s.io/mysql-cinder-pd/README.md"

fn spec.volumes.cinder.withFsType

withFsType(fsType)

"Filesystem type to mount. Must be a filesystem type supported by the host operating system. Examples: \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified. More info: https://examples.k8s.io/mysql-cinder-pd/README.md"

fn spec.volumes.cinder.withReadOnly

withReadOnly(readOnly)

"Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/mysql-cinder-pd/README.md"

fn spec.volumes.cinder.withVolumeID

withVolumeID(volumeID)

"volume id used to identify the volume in cinder. More info: https://examples.k8s.io/mysql-cinder-pd/README.md"

obj spec.volumes.cinder.secretRef

"Optional: points to a secret object containing parameters used to connect to OpenStack."

fn spec.volumes.cinder.secretRef.withName

withName(name)

"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"

obj spec.volumes.configMap

"ConfigMap represents a configMap that should populate this volume"

fn spec.volumes.configMap.withDefaultMode

withDefaultMode(defaultMode)

"Optional: mode bits to use on created files by default. Must be a value between 0 and 0777. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set."

fn spec.volumes.configMap.withItems

withItems(items)

"If unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'."

fn spec.volumes.configMap.withItemsMixin

withItemsMixin(items)

"If unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'."

Note: This function appends passed data to existing values

fn spec.volumes.configMap.withName

withName(name)

"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"

fn spec.volumes.configMap.withOptional

withOptional(optional)

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

obj spec.volumes.configMap.items

"If unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'."

fn spec.volumes.configMap.items.withKey

withKey(key)

"The key to project."

fn spec.volumes.configMap.items.withMode

withMode(mode)

"Optional: mode bits to use on this file, must be a value between 0 and 0777. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set."

fn spec.volumes.configMap.items.withPath

withPath(path)

"The relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'."

obj spec.volumes.csi

"CSI (Container Storage Interface) represents storage that is handled by an external CSI driver (Alpha feature)."

fn spec.volumes.csi.withDriver

withDriver(driver)

"Driver is the name of the CSI driver that handles this volume. Consult with your admin for the correct name as registered in the cluster."

fn spec.volumes.csi.withFsType

withFsType(fsType)

"Filesystem type to mount. Ex. \"ext4\", \"xfs\", \"ntfs\". If not provided, the empty value is passed to the associated CSI driver which will determine the default filesystem to apply."

fn spec.volumes.csi.withReadOnly

withReadOnly(readOnly)

"Specifies a read-only configuration for the volume. Defaults to false (read/write)."

fn spec.volumes.csi.withVolumeAttributes

withVolumeAttributes(volumeAttributes)

"VolumeAttributes stores driver-specific properties that are passed to the CSI driver. Consult your driver's documentation for supported values."

fn spec.volumes.csi.withVolumeAttributesMixin

withVolumeAttributesMixin(volumeAttributes)

"VolumeAttributes stores driver-specific properties that are passed to the CSI driver. Consult your driver's documentation for supported values."

Note: This function appends passed data to existing values

obj spec.volumes.csi.nodePublishSecretRef

"NodePublishSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI NodePublishVolume and NodeUnpublishVolume calls. This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secret references are passed."

fn spec.volumes.csi.nodePublishSecretRef.withName

withName(name)

"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"

obj spec.volumes.downwardAPI

"DownwardAPI represents downward API about the pod that should populate this volume"

fn spec.volumes.downwardAPI.withDefaultMode

withDefaultMode(defaultMode)

"Optional: mode bits to use on created files by default. Must be a value between 0 and 0777. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set."

fn spec.volumes.downwardAPI.withItems

withItems(items)

"Items is a list of downward API volume file"

fn spec.volumes.downwardAPI.withItemsMixin

withItemsMixin(items)

"Items is a list of downward API volume file"

Note: This function appends passed data to existing values

obj spec.volumes.downwardAPI.items

"Items is a list of downward API volume file"

fn spec.volumes.downwardAPI.items.withMode

withMode(mode)

"Optional: mode bits to use on this file, must be a value between 0 and 0777. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set."

fn spec.volumes.downwardAPI.items.withPath

withPath(path)

"Required: Path is the relative path name of the file to be created. Must not be absolute or contain the '..' path. Must be utf-8 encoded. The first item of the relative path must not start with '..'"

obj spec.volumes.downwardAPI.items.fieldRef

"Required: Selects a field of the pod: only annotations, labels, name and namespace are supported."

fn spec.volumes.downwardAPI.items.fieldRef.withApiVersion

withApiVersion(apiVersion)

"Version of the schema the FieldPath is written in terms of, defaults to \"v1\"."

fn spec.volumes.downwardAPI.items.fieldRef.withFieldPath

withFieldPath(fieldPath)

"Path of the field to select in the specified API version."

obj spec.volumes.downwardAPI.items.resourceFieldRef

"Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported."

fn spec.volumes.downwardAPI.items.resourceFieldRef.withContainerName

withContainerName(containerName)

"Container name: required for volumes, optional for env vars"

fn spec.volumes.downwardAPI.items.resourceFieldRef.withDivisor

withDivisor(divisor)

"Specifies the output format of the exposed resources, defaults to \"1\

fn spec.volumes.downwardAPI.items.resourceFieldRef.withResource

withResource(resource)

"Required: resource to select"

obj spec.volumes.emptyDir

"EmptyDir represents a temporary directory that shares a pod's lifetime. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir"

fn spec.volumes.emptyDir.withMedium

withMedium(medium)

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

fn spec.volumes.emptyDir.withSizeLimit

withSizeLimit(sizeLimit)

"Total amount of local storage required for this EmptyDir volume. The size limit is also applicable for memory medium. The maximum usage on memory medium EmptyDir would be the minimum value between the SizeLimit specified here and the sum of memory limits of all containers in a pod. The default is nil which means that the limit is undefined. More info: http://kubernetes.io/docs/user-guide/volumes#emptydir"

obj spec.volumes.fc

"FC represents a Fibre Channel resource that is attached to a kubelet's host machine and then exposed to the pod."

fn spec.volumes.fc.withFsType

withFsType(fsType)

"Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified. TODO: how do we prevent errors in the filesystem from compromising the machine"

fn spec.volumes.fc.withLun

withLun(lun)

"Optional: FC target lun number"

fn spec.volumes.fc.withReadOnly

withReadOnly(readOnly)

"Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts."

fn spec.volumes.fc.withTargetWWNs

withTargetWWNs(targetWWNs)

"Optional: FC target worldwide names (WWNs)"

fn spec.volumes.fc.withTargetWWNsMixin

withTargetWWNsMixin(targetWWNs)

"Optional: FC target worldwide names (WWNs)"

Note: This function appends passed data to existing values

fn spec.volumes.fc.withWwids

withWwids(wwids)

"Optional: FC volume world wide identifiers (wwids) Either wwids or combination of targetWWNs and lun must be set, but not both simultaneously."

fn spec.volumes.fc.withWwidsMixin

withWwidsMixin(wwids)

"Optional: FC volume world wide identifiers (wwids) Either wwids or combination of targetWWNs and lun must be set, but not both simultaneously."

Note: This function appends passed data to existing values

obj spec.volumes.flexVolume

"FlexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin."

fn spec.volumes.flexVolume.withDriver

withDriver(driver)

"Driver is the name of the driver to use for this volume."

fn spec.volumes.flexVolume.withFsType

withFsType(fsType)

"Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. \"ext4\", \"xfs\", \"ntfs\". The default filesystem depends on FlexVolume script."

fn spec.volumes.flexVolume.withOptions

withOptions(options)

"Optional: Extra command options if any."

fn spec.volumes.flexVolume.withOptionsMixin

withOptionsMixin(options)

"Optional: Extra command options if any."

Note: This function appends passed data to existing values

fn spec.volumes.flexVolume.withReadOnly

withReadOnly(readOnly)

"Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts."

obj spec.volumes.flexVolume.secretRef

"Optional: SecretRef is reference to the secret object containing sensitive information to pass to the plugin scripts. This may be empty if no secret object is specified. If the secret object contains more than one secret, all secrets are passed to the plugin scripts."

fn spec.volumes.flexVolume.secretRef.withName

withName(name)

"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"

obj spec.volumes.flocker

"Flocker represents a Flocker volume attached to a kubelet's host machine. This depends on the Flocker control service being running"

fn spec.volumes.flocker.withDatasetName

withDatasetName(datasetName)

"Name of the dataset stored as metadata -> name on the dataset for Flocker should be considered as deprecated"

fn spec.volumes.flocker.withDatasetUUID

withDatasetUUID(datasetUUID)

"UUID of the dataset. This is unique identifier of a Flocker dataset"

obj spec.volumes.gcePersistentDisk

"GCEPersistentDisk represents a GCE Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk"

fn spec.volumes.gcePersistentDisk.withFsType

withFsType(fsType)

"Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk TODO: how do we prevent errors in the filesystem from compromising the machine"

fn spec.volumes.gcePersistentDisk.withPartition

withPartition(partition)

"The partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as \"1\". Similarly, the volume partition for /dev/sda is \"0\" (or you can leave the property empty). More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk"

fn spec.volumes.gcePersistentDisk.withPdName

withPdName(pdName)

"Unique name of the PD resource in GCE. Used to identify the disk in GCE. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk"

fn spec.volumes.gcePersistentDisk.withReadOnly

withReadOnly(readOnly)

"ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk"

obj spec.volumes.gitRepo

"GitRepo represents a git repository at a particular revision. DEPRECATED: GitRepo is deprecated. To provision a container with a git repo, mount an EmptyDir into an InitContainer that clones the repo using git, then mount the EmptyDir into the Pod's container."

fn spec.volumes.gitRepo.withDirectory

withDirectory(directory)

"Target directory name. Must not contain or start with '..'. If '.' is supplied, the volume directory will be the git repository. Otherwise, if specified, the volume will contain the git repository in the subdirectory with the given name."

fn spec.volumes.gitRepo.withRepository

withRepository(repository)

"Repository URL"

fn spec.volumes.gitRepo.withRevision

withRevision(revision)

"Commit hash for the specified revision."

obj spec.volumes.glusterfs

"Glusterfs represents a Glusterfs mount on the host that shares a pod's lifetime. More info: https://examples.k8s.io/volumes/glusterfs/README.md"

fn spec.volumes.glusterfs.withEndpoints

withEndpoints(endpoints)

"EndpointsName is the endpoint name that details Glusterfs topology. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod"

fn spec.volumes.glusterfs.withPath

withPath(path)

"Path is the Glusterfs volume path. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod"

fn spec.volumes.glusterfs.withReadOnly

withReadOnly(readOnly)

"ReadOnly here will force the Glusterfs volume to be mounted with read-only permissions. Defaults to false. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod"

obj spec.volumes.hostPath

"HostPath represents a pre-existing file or directory on the host machine that is directly exposed to the container. This is generally used for system agents or other privileged things that are allowed to see the host machine. Most containers will NOT need this. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath --- TODO(jonesdl) We need to restrict who can use host directory mounts and who can/can not mount host directories as read/write."

fn spec.volumes.hostPath.withPath

withPath(path)

"Path of the directory on the host. If the path is a symlink, it will follow the link to the real path. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath"

fn spec.volumes.hostPath.withType

withType(type)

"Type for HostPath Volume Defaults to \"\" More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath"

obj spec.volumes.iscsi

"ISCSI represents an ISCSI Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://examples.k8s.io/volumes/iscsi/README.md"

fn spec.volumes.iscsi.withChapAuthDiscovery

withChapAuthDiscovery(chapAuthDiscovery)

"whether support iSCSI Discovery CHAP authentication"

fn spec.volumes.iscsi.withChapAuthSession

withChapAuthSession(chapAuthSession)

"whether support iSCSI Session CHAP authentication"

fn spec.volumes.iscsi.withFsType

withFsType(fsType)

"Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#iscsi TODO: how do we prevent errors in the filesystem from compromising the machine"

fn spec.volumes.iscsi.withInitiatorName

withInitiatorName(initiatorName)

"Custom iSCSI Initiator Name. If initiatorName is specified with iscsiInterface simultaneously, new iSCSI interface : will be created for the connection."

fn spec.volumes.iscsi.withIqn

withIqn(iqn)

"Target iSCSI Qualified Name."

fn spec.volumes.iscsi.withIscsiInterface

withIscsiInterface(iscsiInterface)

"iSCSI Interface Name that uses an iSCSI transport. Defaults to 'default' (tcp)."

fn spec.volumes.iscsi.withLun

withLun(lun)

"iSCSI Target Lun number."

fn spec.volumes.iscsi.withPortals

withPortals(portals)

"iSCSI Target Portal List. The portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260)."

fn spec.volumes.iscsi.withPortalsMixin

withPortalsMixin(portals)

"iSCSI Target Portal List. The portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260)."

Note: This function appends passed data to existing values

fn spec.volumes.iscsi.withReadOnly

withReadOnly(readOnly)

"ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false."

fn spec.volumes.iscsi.withTargetPortal

withTargetPortal(targetPortal)

"iSCSI Target Portal. The Portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260)."

obj spec.volumes.iscsi.secretRef

"CHAP Secret for iSCSI target and initiator authentication"

fn spec.volumes.iscsi.secretRef.withName

withName(name)

"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"

obj spec.volumes.nfs

"NFS represents an NFS mount on the host that shares a pod's lifetime More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs"

fn spec.volumes.nfs.withPath

withPath(path)

"Path that is exported by the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs"

fn spec.volumes.nfs.withReadOnly

withReadOnly(readOnly)

"ReadOnly here will force the NFS export to be mounted with read-only permissions. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs"

fn spec.volumes.nfs.withServer

withServer(server)

"Server is the hostname or IP address of the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs"

obj spec.volumes.persistentVolumeClaim

"PersistentVolumeClaimVolumeSource represents a reference to a PersistentVolumeClaim in the same namespace. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims"

fn spec.volumes.persistentVolumeClaim.withClaimName

withClaimName(claimName)

"ClaimName is the name of a PersistentVolumeClaim in the same namespace as the pod using this volume. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims"

fn spec.volumes.persistentVolumeClaim.withReadOnly

withReadOnly(readOnly)

"Will force the ReadOnly setting in VolumeMounts. Default false."

obj spec.volumes.photonPersistentDisk

"PhotonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine"

fn spec.volumes.photonPersistentDisk.withFsType

withFsType(fsType)

"Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified."

fn spec.volumes.photonPersistentDisk.withPdID

withPdID(pdID)

"ID that identifies Photon Controller persistent disk"

obj spec.volumes.portworxVolume

"PortworxVolume represents a portworx volume attached and mounted on kubelets host machine"

fn spec.volumes.portworxVolume.withFsType

withFsType(fsType)

"FSType represents the filesystem type to mount Must be a filesystem type supported by the host operating system. Ex. \"ext4\", \"xfs\". Implicitly inferred to be \"ext4\" if unspecified."

fn spec.volumes.portworxVolume.withReadOnly

withReadOnly(readOnly)

"Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts."

fn spec.volumes.portworxVolume.withVolumeID

withVolumeID(volumeID)

"VolumeID uniquely identifies a Portworx volume"

obj spec.volumes.projected

"Items for all in one resources secrets, configmaps, and downward API"

fn spec.volumes.projected.withDefaultMode

withDefaultMode(defaultMode)

"Mode bits to use on created files by default. Must be a value between 0 and 0777. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set."

fn spec.volumes.projected.withSources

withSources(sources)

"list of volume projections"

fn spec.volumes.projected.withSourcesMixin

withSourcesMixin(sources)

"list of volume projections"

Note: This function appends passed data to existing values

obj spec.volumes.projected.sources

"list of volume projections"

obj spec.volumes.projected.sources.configMap

"information about the configMap data to project"

fn spec.volumes.projected.sources.configMap.withItems

withItems(items)

"If unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'."

fn spec.volumes.projected.sources.configMap.withItemsMixin

withItemsMixin(items)

"If unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'."

Note: This function appends passed data to existing values

fn spec.volumes.projected.sources.configMap.withName

withName(name)

"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"

fn spec.volumes.projected.sources.configMap.withOptional

withOptional(optional)

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

obj spec.volumes.projected.sources.configMap.items

"If unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'."

fn spec.volumes.projected.sources.configMap.items.withKey

withKey(key)

"The key to project."

fn spec.volumes.projected.sources.configMap.items.withMode

withMode(mode)

"Optional: mode bits to use on this file, must be a value between 0 and 0777. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set."

fn spec.volumes.projected.sources.configMap.items.withPath

withPath(path)

"The relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'."

obj spec.volumes.projected.sources.downwardAPI

"information about the downwardAPI data to project"

fn spec.volumes.projected.sources.downwardAPI.withItems

withItems(items)

"Items is a list of DownwardAPIVolume file"

fn spec.volumes.projected.sources.downwardAPI.withItemsMixin

withItemsMixin(items)

"Items is a list of DownwardAPIVolume file"

Note: This function appends passed data to existing values

obj spec.volumes.projected.sources.downwardAPI.items

"Items is a list of DownwardAPIVolume file"

fn spec.volumes.projected.sources.downwardAPI.items.withMode

withMode(mode)

"Optional: mode bits to use on this file, must be a value between 0 and 0777. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set."

fn spec.volumes.projected.sources.downwardAPI.items.withPath

withPath(path)

"Required: Path is the relative path name of the file to be created. Must not be absolute or contain the '..' path. Must be utf-8 encoded. The first item of the relative path must not start with '..'"

obj spec.volumes.projected.sources.downwardAPI.items.fieldRef

"Required: Selects a field of the pod: only annotations, labels, name and namespace are supported."

fn spec.volumes.projected.sources.downwardAPI.items.fieldRef.withApiVersion

withApiVersion(apiVersion)

"Version of the schema the FieldPath is written in terms of, defaults to \"v1\"."

fn spec.volumes.projected.sources.downwardAPI.items.fieldRef.withFieldPath

withFieldPath(fieldPath)

"Path of the field to select in the specified API version."

obj spec.volumes.projected.sources.downwardAPI.items.resourceFieldRef

"Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported."

fn spec.volumes.projected.sources.downwardAPI.items.resourceFieldRef.withContainerName

withContainerName(containerName)

"Container name: required for volumes, optional for env vars"

fn spec.volumes.projected.sources.downwardAPI.items.resourceFieldRef.withDivisor

withDivisor(divisor)

"Specifies the output format of the exposed resources, defaults to \"1\

fn spec.volumes.projected.sources.downwardAPI.items.resourceFieldRef.withResource

withResource(resource)

"Required: resource to select"

obj spec.volumes.projected.sources.secret

"information about the secret data to project"

fn spec.volumes.projected.sources.secret.withItems

withItems(items)

"If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'."

fn spec.volumes.projected.sources.secret.withItemsMixin

withItemsMixin(items)

"If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'."

Note: This function appends passed data to existing values

fn spec.volumes.projected.sources.secret.withName

withName(name)

"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"

fn spec.volumes.projected.sources.secret.withOptional

withOptional(optional)

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

obj spec.volumes.projected.sources.secret.items

"If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'."

fn spec.volumes.projected.sources.secret.items.withKey

withKey(key)

"The key to project."

fn spec.volumes.projected.sources.secret.items.withMode

withMode(mode)

"Optional: mode bits to use on this file, must be a value between 0 and 0777. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set."

fn spec.volumes.projected.sources.secret.items.withPath

withPath(path)

"The relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'."

obj spec.volumes.projected.sources.serviceAccountToken

"information about the serviceAccountToken data to project"

fn spec.volumes.projected.sources.serviceAccountToken.withAudience

withAudience(audience)

"Audience is the intended audience of the token. A recipient of a token must identify itself with an identifier specified in the audience of the token, and otherwise should reject the token. The audience defaults to the identifier of the apiserver."

fn spec.volumes.projected.sources.serviceAccountToken.withExpirationSeconds

withExpirationSeconds(expirationSeconds)

"ExpirationSeconds is the requested duration of validity of the service account token. As the token approaches expiration, the kubelet volume plugin will proactively rotate the service account token. The kubelet will start trying to rotate the token if the token is older than 80 percent of its time to live or if the token is older than 24 hours.Defaults to 1 hour and must be at least 10 minutes."

fn spec.volumes.projected.sources.serviceAccountToken.withPath

withPath(path)

"Path is the path relative to the mount point of the file to project the token into."

obj spec.volumes.quobyte

"Quobyte represents a Quobyte mount on the host that shares a pod's lifetime"

fn spec.volumes.quobyte.withGroup

withGroup(group)

"Group to map volume access to Default is no group"

fn spec.volumes.quobyte.withReadOnly

withReadOnly(readOnly)

"ReadOnly here will force the Quobyte volume to be mounted with read-only permissions. Defaults to false."

fn spec.volumes.quobyte.withRegistry

withRegistry(registry)

"Registry represents a single or multiple Quobyte Registry services specified as a string as host:port pair (multiple entries are separated with commas) which acts as the central registry for volumes"

fn spec.volumes.quobyte.withTenant

withTenant(tenant)

"Tenant owning the given Quobyte volume in the Backend Used with dynamically provisioned Quobyte volumes, value is set by the plugin"

fn spec.volumes.quobyte.withUser

withUser(user)

"User to map volume access to Defaults to serivceaccount user"

fn spec.volumes.quobyte.withVolume

withVolume(volume)

"Volume is a string that references an already created Quobyte volume by name."

obj spec.volumes.rbd

"RBD represents a Rados Block Device mount on the host that shares a pod's lifetime. More info: https://examples.k8s.io/volumes/rbd/README.md"

fn spec.volumes.rbd.withFsType

withFsType(fsType)

"Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#rbd TODO: how do we prevent errors in the filesystem from compromising the machine"

fn spec.volumes.rbd.withImage

withImage(image)

"The rados image name. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it"

fn spec.volumes.rbd.withKeyring

withKeyring(keyring)

"Keyring is the path to key ring for RBDUser. Default is /etc/ceph/keyring. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it"

fn spec.volumes.rbd.withMonitors

withMonitors(monitors)

"A collection of Ceph monitors. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it"

fn spec.volumes.rbd.withMonitorsMixin

withMonitorsMixin(monitors)

"A collection of Ceph monitors. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it"

Note: This function appends passed data to existing values

fn spec.volumes.rbd.withPool

withPool(pool)

"The rados pool name. Default is rbd. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it"

fn spec.volumes.rbd.withReadOnly

withReadOnly(readOnly)

"ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it"

fn spec.volumes.rbd.withUser

withUser(user)

"The rados user name. Default is admin. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it"

obj spec.volumes.rbd.secretRef

"SecretRef is name of the authentication secret for RBDUser. If provided overrides keyring. Default is nil. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it"

fn spec.volumes.rbd.secretRef.withName

withName(name)

"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"

obj spec.volumes.scaleIO

"ScaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes."

fn spec.volumes.scaleIO.withFsType

withFsType(fsType)

"Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. \"ext4\", \"xfs\", \"ntfs\". Default is \"xfs\"."

fn spec.volumes.scaleIO.withGateway

withGateway(gateway)

"The host address of the ScaleIO API Gateway."

fn spec.volumes.scaleIO.withProtectionDomain

withProtectionDomain(protectionDomain)

"The name of the ScaleIO Protection Domain for the configured storage."

fn spec.volumes.scaleIO.withReadOnly

withReadOnly(readOnly)

"Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts."

fn spec.volumes.scaleIO.withSslEnabled

withSslEnabled(sslEnabled)

"Flag to enable/disable SSL communication with Gateway, default false"

fn spec.volumes.scaleIO.withStorageMode

withStorageMode(storageMode)

"Indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned. Default is ThinProvisioned."

fn spec.volumes.scaleIO.withStoragePool

withStoragePool(storagePool)

"The ScaleIO Storage Pool associated with the protection domain."

fn spec.volumes.scaleIO.withSystem

withSystem(system)

"The name of the storage system as configured in ScaleIO."

fn spec.volumes.scaleIO.withVolumeName

withVolumeName(volumeName)

"The name of a volume already created in the ScaleIO system that is associated with this volume source."

obj spec.volumes.scaleIO.secretRef

"SecretRef references to the secret for ScaleIO user and other sensitive information. If this is not provided, Login operation will fail."

fn spec.volumes.scaleIO.secretRef.withName

withName(name)

"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"

obj spec.volumes.secret

"Secret represents a secret that should populate this volume. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret"

fn spec.volumes.secret.withDefaultMode

withDefaultMode(defaultMode)

"Optional: mode bits to use on created files by default. Must be a value between 0 and 0777. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set."

fn spec.volumes.secret.withItems

withItems(items)

"If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'."

fn spec.volumes.secret.withItemsMixin

withItemsMixin(items)

"If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'."

Note: This function appends passed data to existing values

fn spec.volumes.secret.withOptional

withOptional(optional)

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

fn spec.volumes.secret.withSecretName

withSecretName(secretName)

"Name of the secret in the pod's namespace to use. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret"

obj spec.volumes.secret.items

"If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'."

fn spec.volumes.secret.items.withKey

withKey(key)

"The key to project."

fn spec.volumes.secret.items.withMode

withMode(mode)

"Optional: mode bits to use on this file, must be a value between 0 and 0777. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set."

fn spec.volumes.secret.items.withPath

withPath(path)

"The relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'."

obj spec.volumes.storageos

"StorageOS represents a StorageOS volume attached and mounted on Kubernetes nodes."

fn spec.volumes.storageos.withFsType

withFsType(fsType)

"Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified."

fn spec.volumes.storageos.withReadOnly

withReadOnly(readOnly)

"Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts."

fn spec.volumes.storageos.withVolumeName

withVolumeName(volumeName)

"VolumeName is the human-readable name of the StorageOS volume. Volume names are only unique within a namespace."

fn spec.volumes.storageos.withVolumeNamespace

withVolumeNamespace(volumeNamespace)

"VolumeNamespace specifies the scope of the volume within StorageOS. If no namespace is specified then the Pod's namespace will be used. This allows the Kubernetes name scoping to be mirrored within StorageOS for tighter integration. Set VolumeName to any name to override the default behaviour. Set to \"default\" if you are not using namespaces within StorageOS. Namespaces that do not pre-exist within StorageOS will be created."

obj spec.volumes.storageos.secretRef

"SecretRef specifies the secret to use for obtaining the StorageOS API credentials. If not specified, default values will be attempted."

fn spec.volumes.storageos.secretRef.withName

withName(name)

"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"

obj spec.volumes.vsphereVolume

"VsphereVolume represents a vSphere volume attached and mounted on kubelets host machine"

fn spec.volumes.vsphereVolume.withFsType

withFsType(fsType)

"Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified."

fn spec.volumes.vsphereVolume.withStoragePolicyID

withStoragePolicyID(storagePolicyID)

"Storage Policy Based Management (SPBM) profile ID associated with the StoragePolicyName."

fn spec.volumes.vsphereVolume.withStoragePolicyName

withStoragePolicyName(storagePolicyName)

"Storage Policy Based Management (SPBM) profile name."

fn spec.volumes.vsphereVolume.withVolumePath

withVolumePath(volumePath)

"Path that identifies vSphere volume vmdk"

obj spec.web

"WebSpec defines the web command line flags when starting Prometheus."

fn spec.web.withPageTitle

withPageTitle(pageTitle)

"The prometheus web page title"

obj spec.web.tlsConfig

"WebTLSConfig defines the TLS parameters for HTTPS."

fn spec.web.tlsConfig.withCipherSuites

withCipherSuites(cipherSuites)

"List of supported cipher suites for TLS versions up to TLS 1.2. If empty, Go default cipher suites are used. Available cipher suites are documented in the go documentation: https://golang.org/pkg/crypto/tls/#pkg-constants"

fn spec.web.tlsConfig.withCipherSuitesMixin

withCipherSuitesMixin(cipherSuites)

"List of supported cipher suites for TLS versions up to TLS 1.2. If empty, Go default cipher suites are used. Available cipher suites are documented in the go documentation: https://golang.org/pkg/crypto/tls/#pkg-constants"

Note: This function appends passed data to existing values

fn spec.web.tlsConfig.withClientAuthType

withClientAuthType(clientAuthType)

"Server policy for client authentication. Maps to ClientAuth Policies. For more detail on clientAuth options: https://golang.org/pkg/crypto/tls/#ClientAuthType"

fn spec.web.tlsConfig.withCurvePreferences

withCurvePreferences(curvePreferences)

"Elliptic curves that will be used in an ECDHE handshake, in preference order. Available curves are documented in the go documentation: https://golang.org/pkg/crypto/tls/#CurveID"

fn spec.web.tlsConfig.withCurvePreferencesMixin

withCurvePreferencesMixin(curvePreferences)

"Elliptic curves that will be used in an ECDHE handshake, in preference order. Available curves are documented in the go documentation: https://golang.org/pkg/crypto/tls/#CurveID"

Note: This function appends passed data to existing values

fn spec.web.tlsConfig.withMaxVersion

withMaxVersion(maxVersion)

"Maximum TLS version that is acceptable. Defaults to TLS13."

fn spec.web.tlsConfig.withMinVersion

withMinVersion(minVersion)

"Minimum TLS version that is acceptable. Defaults to TLS12."

fn spec.web.tlsConfig.withPreferServerCipherSuites

withPreferServerCipherSuites(preferServerCipherSuites)

"Controls whether the server selects the client's most preferred cipher suite, or the server's most preferred cipher suite. If true then the server's preference, as expressed in the order of elements in cipherSuites, is used."

obj spec.web.tlsConfig.cert

"Contains the TLS certificate for the server."

obj spec.web.tlsConfig.cert.configMap

"ConfigMap containing data to use for the targets."

fn spec.web.tlsConfig.cert.configMap.withKey

withKey(key)

"The key to select."

fn spec.web.tlsConfig.cert.configMap.withName

withName(name)

"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"

fn spec.web.tlsConfig.cert.configMap.withOptional

withOptional(optional)

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

obj spec.web.tlsConfig.cert.secret

"Secret containing data to use for the targets."

fn spec.web.tlsConfig.cert.secret.withKey

withKey(key)

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

fn spec.web.tlsConfig.cert.secret.withName

withName(name)

"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"

fn spec.web.tlsConfig.cert.secret.withOptional

withOptional(optional)

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

obj spec.web.tlsConfig.client_ca

"Contains the CA certificate for client certificate authentication to the server."

obj spec.web.tlsConfig.client_ca.configMap

"ConfigMap containing data to use for the targets."

fn spec.web.tlsConfig.client_ca.configMap.withKey

withKey(key)

"The key to select."

fn spec.web.tlsConfig.client_ca.configMap.withName

withName(name)

"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"

fn spec.web.tlsConfig.client_ca.configMap.withOptional

withOptional(optional)

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

obj spec.web.tlsConfig.client_ca.secret

"Secret containing data to use for the targets."

fn spec.web.tlsConfig.client_ca.secret.withKey

withKey(key)

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

fn spec.web.tlsConfig.client_ca.secret.withName

withName(name)

"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"

fn spec.web.tlsConfig.client_ca.secret.withOptional

withOptional(optional)

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

obj spec.web.tlsConfig.keySecret

"Secret containing the TLS key for the server."

fn spec.web.tlsConfig.keySecret.withKey

withKey(key)

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

fn spec.web.tlsConfig.keySecret.withName

withName(name)

"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"

fn spec.web.tlsConfig.keySecret.withOptional

withOptional(optional)

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